PeopleTools 8.4: SQR for PeopleSoft Language Reference PeopleTools 8.4: SQR for PeopleSoft Language Reference SKU Tr84SQL-B 0302 PeopleBooks Contributors: Teams from PeopleSoft Product Documentation and Development. Copyright © 2002 PeopleSoft, Inc. All rights reserved. Printed in the United States. All material contained in this documentation is proprietary and confidential to PeopleSoft, Inc. ("PeopleSoft"), protected by copyright laws and subject to the nondisclosure provisions of the applicable PeopleSoft agreement. No part of this documentation may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, including, but not limited to, electronic, graphic, mechanical, photocopying, recording, or otherwise without the prior written permission of PeopleSoft. This documentation is subject to change without notice, and PeopleSoft does not warrant that the material contained in this documentation is free of errors. Any errors found in this document should be reported to PeopleSoft in writing. The copyrighted software that accompanies this document is licensed for use only in strict accordance with the applicable license agreement which should be read carefully as it governs the terms of use of the software and this document, including the disclosure thereof. PeopleSoft, the PeopleSoft logo, PeopleTools, PS/nVision, PeopleCode, PeopleBooks, PeopleTalk, and Vantive are registered trademarks, and "People power the internet." and Pure Internet Architecture are trademarks of PeopleSoft, Inc. All other company and product names may be trademarks of their respective owners. The information contained herein is subject to change without notice. Contents SQR for PeopleSoft Language Reference Preface About This PeopleBook..................................................................................................... ix Before You Begin.............................................................................................................. ix PeopleSoft Application Fundamentals ............................................................................... x Related Documentation ...................................................................................................... x Hard-copy Documentation.......................................................................................... xi PeopleBooks Standard Field Definitions........................................................................... xi Typographical Conventions and Visual Cues.................................................................. xiii Page and Panel Introductory Table.................................................................................. xiv Comments and Suggestions...............................................................................................xv Chapter 1 Understanding SQR for PeopleSoft Understanding SQR for PeopleSoft Tools....................................................................... 1-1 Understanding SQR......................................................................................................... 1-1 SQR Program Structure ............................................................................................ 1-2 SQR Syntax Conventions.......................................................................................... 1-3 Rules for Entering SQR Commands ......................................................................... 1-3 Understanding the SQR Command Line ......................................................................... 1-4 SQR Command-Line Arguments.............................................................................. 1-4 SQR Command-Line Flags....................................................................................... 1-5 Understanding SQR Data Elements .............................................................................. 1-13 Columns .................................................................................................................. 1-13 Variables ................................................................................................................. 1-14 Literals .................................................................................................................... 1-18 Viewing Sample Reports............................................................................................... 1-18 Chapter 2 SQR Command Reference ADD.......................................................................................................................... 2-2 ALTER-COLOR-MAP............................................................................................. 2-2 ALTER-CONNECTION .......................................................................................... 2-4 ALTER-LOCALE..................................................................................................... 2-6 ALTER-PRINTER.................................................................................................. 2-13 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL CONTENTS iii SQR FOR PEOPLESOFT LANGUAGE REFERENCE ALTER-REPORT ................................................................................................... 2-15 ARRAY-ADD, ARRAY-DIVIDE, ARRAY-MULTIPLY, ARRAY-SUBTRACT............................................................................................. 2-16 ASK......................................................................................................................... 2-19 BEGIN-DOCUMENT............................................................................................. 2-20 BEGIN-EXECUTE ................................................................................................. 2-21 BEGIN-FOOTING.................................................................................................. 2-24 BEGIN-HEADING ................................................................................................. 2-25 BEGIN-PROCEDURE............................................................................................ 2-27 BEGIN-PROGRAM................................................................................................ 2-30 BEGIN-SELECT..................................................................................................... 2-30 BEGIN-SETUP ....................................................................................................... 2-34 BEGIN-SQL............................................................................................................ 2-35 BREAK ................................................................................................................... 2-40 CALL, CALL SYSTEM ........................................................................................ 2-40 CLEAR-ARRAY .................................................................................................... 2-46 CLOSE .................................................................................................................... 2-46 COLUMNS ............................................................................................................. 2-47 COMMIT ................................................................................................................ 2-48 CONCAT ................................................................................................................ 2-49 CONNECT .............................................................................................................. 2-50 CREATE-ARRAY .................................................................................................. 2-51 CREATE-COLOR-PALETTE................................................................................ 2-54 #DEBUG ................................................................................................................. 2-55 DECLARE-CHART................................................................................................ 2-56 DECLARE-COLOR-MAP...................................................................................... 2-65 DECLARE-CONNECTION ................................................................................... 2-66 DECLARE-IMAGE ................................................................................................ 2-68 DECLARE-LAYOUT............................................................................................. 2-69 DECLARE-PRINTER ............................................................................................ 2-76 DECLARE-PROCEDURE ..................................................................................... 2-83 DECLARE-REPORT.............................................................................................. 2-85 DECLARE-TOC ..................................................................................................... 2-87 DECLARE-VARIABLE......................................................................................... 2-89 #DEFINE................................................................................................................. 2-92 DISPLAY ................................................................................................................ 2-93 DIVIDE ................................................................................................................... 2-97 DO ........................................................................................................................... 2-98 #ELSE ..................................................................................................................... 2-99 ELSE ..................................................................................................................... 2-100 CONTENTS iv PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE ENCODE .............................................................................................................. 2-100 END-DECLARE, END-DOCUMENT, END-EVALUATE, END-FOOTING, END-HEADING................................................................................................... 2-101 #END-IF, #ENDIF................................................................................................ 2-102 END-IF ................................................................................................................. 2-102 END-PROCEDURE, END-PROGRAM, END-SELECT, END-SETUP, END-SQL, END-WHILE, END-EXECUTE ....................................................... 2-102 EVALUATE ......................................................................................................... 2-103 EXECUTE (SYBASE and MS-SQL Server)........................................................ 2-105 EXIT-SELECT...................................................................................................... 2-108 EXTRACT ............................................................................................................ 2-109 FIND ..................................................................................................................... 2-110 GET....................................................................................................................... 2-111 GET-COLOR ........................................................................................................ 2-113 GOTO ................................................................................................................... 2-115 GRAPHIC BOX, GRAPHIC HORZ-LINE, GRAPHIC VERT-LINE................. 2-115 #IF ......................................................................................................................... 2-118 IF ........................................................................................................................... 2-120 #IFDEF ................................................................................................................. 2-121 #IFNDEF............................................................................................................... 2-122 #INCLUDE ........................................................................................................... 2-122 INPUT................................................................................................................... 2-123 LAST-PAGE......................................................................................................... 2-126 LET ....................................................................................................................... 2-127 LOAD-LOOKUP .................................................................................................. 2-158 LOOKUP .............................................................................................................. 2-162 LOWERCASE ...................................................................................................... 2-163 MBTOSBS............................................................................................................ 2-164 MOVE................................................................................................................... 2-164 MULTIPLY .......................................................................................................... 2-168 NEW-PAGE.......................................................................................................... 2-169 NEW-REPORT..................................................................................................... 2-170 NEXT-COLUMN ................................................................................................. 2-171 NEXT-LISTING ................................................................................................... 2-172 OPEN .................................................................................................................... 2-174 PAGE-NUMBER.................................................................................................. 2-176 POSITION ............................................................................................................ 2-177 PRINT ................................................................................................................... 2-178 PRINT-BAR-CODE ............................................................................................. 2-197 PRINT-CHART .................................................................................................... 2-200 PRINT-DIRECT ................................................................................................... 2-208 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL CONTENTS v SQR FOR PEOPLESOFT LANGUAGE REFERENCE PRINT-IMAGE..................................................................................................... 2-209 PUT ....................................................................................................................... 2-210 READ.................................................................................................................... 2-212 ROLLBACK ......................................................................................................... 2-215 SBTOMBS ............................................................................................................ 2-215 SECURITY ........................................................................................................... 2-216 SET-COLOR......................................................................................................... 2-217 SET-GENERATIONS .......................................................................................... 2-219 SET-LEVELS ....................................................................................................... 2-219 SET-MEMBERS................................................................................................... 2-220 SHOW ................................................................................................................... 2-220 STOP ..................................................................................................................... 2-225 STRING ................................................................................................................ 2-226 SUBTRACT.......................................................................................................... 2-227 TOC-ENTRY ........................................................................................................ 2-228 UNSTRING........................................................................................................... 2-229 UPPERCASE ........................................................................................................ 2-230 USE ....................................................................................................................... 2-230 USE-COLUMN..................................................................................................... 2-231 USE-PRINTER-TYPE .......................................................................................... 2-232 USE-PROCEDURE .............................................................................................. 2-232 USE-REPORT....................................................................................................... 2-234 WHILE .................................................................................................................. 2-235 WRITE .................................................................................................................. 2-237 Chapter 3 Generating HTML Output HTML General Purpose Procedures................................................................................ 3-1 HTML Heading Procedures............................................................................................. 3-5 HTML Highlighting Procedures...................................................................................... 3-7 HTML Hypertext Link Procedures................................................................................ 3-10 HTML List Procedures .................................................................................................. 3-11 HTML Table Procedures ............................................................................................... 3-16 Chapter 4 Invoking SQR Execute Running SQR Execute..................................................................................................... 4-1 SQR Execute Flags.................................................................................................... 4-1 CONTENTS vi PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Chapter 5 Using SQR Print Understanding SQR Print ................................................................................................ 5-1 Generating Output from the Command Line................................................................... 5-1 SQR Print Command-Line Flags..................................................................................... 5-2 Generating Output in Microsoft Windows ...................................................................... 5-5 Chapter 6 Avoiding Older SQR Commands Understanding Older SQR Commands............................................................................ 6-1 Older SQR Command Details ......................................................................................... 6-2 BEGIN-REPORT...................................................................................................... 6-2 DATE-TIME............................................................................................................. 6-2 DECLARE PRINTER............................................................................................... 6-4 DECLARE PROCEDURE ..................................................................................... 6-10 DOLLAR-SYMBOL .............................................................................................. 6-11 GRAPHIC FONT.................................................................................................... 6-13 MONEY-SYMBOL ................................................................................................ 6-14 NO-FORMFEED .................................................................................................... 6-16 PAGE-SIZE ............................................................................................................ 6-16 PRINT …CODE ..................................................................................................... 6-17 PRINTER-DEINIT ................................................................................................. 6-18 PRINTER-INIT....................................................................................................... 6-18 Chapter 7 Using SQR Sample Programs Understanding SQR Samples .......................................................................................... 7-1 SQR Sample Programs.............................................................................................. 7-1 Chapter 8 Using the PSSQR.INI File Installation of PSSQR.INI ............................................................................................... 8-1 [Default-Settings] Section ............................................................................................... 8-2 Processing-Limits Section ............................................................................................... 8-6 [Environment: environment] Sections ............................................................................. 8-8 [Locale:locale-name] Section.......................................................................................... 8-9 [Fonts] Section............................................................................................................... 8-11 Adding [Fonts] entries ............................................................................................ 8-12 Specifying Character Sets in Windows................................................................... 8-12 [HTML-Images] Section ............................................................................................... 8-12 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL CONTENTS vii SQR FOR PEOPLESOFT LANGUAGE REFERENCE [PDF Fonts] Section ...................................................................................................... 8-13 [Enhanced-HTML] Section ........................................................................................... 8-14 [Colors] Section ............................................................................................................. 8-14 Chapter 9 Understanding SQR Messages Unnumbered Messages.................................................................................................... 9-1 Numbered Messages........................................................................................................ 9-3 Glossary Index CONTENTS viii PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR for PeopleSoft Language Reference Preface This reference describes and demonstrates the structure, command set, and syntax of the Structured Query Report (SQR) language. It also provides a directory to the library of sample SQR programs, an overview of the SQR initialization file, and a listing of SQR messages. This reference is intended for SQR and SQL developers who must report on data from a wide range of enterprise Data Sources. Before using this reference, familiarize yourself with the Data Sources from which you are reporting and the connectivity between those Data Sources and your operating system. The “About This PeopleBook” section contains general product line information, such as related documentation, common page elements, and typographical conventions. This book also contains a glossary with useful terms that are used in PeopleBooks. See PeopleSoft Glossary. About This PeopleBook This book provides you with the information that you need for implementing and using PeopleTools 8.4 applications. Complete documentation for this release is provided on the CDROM PT84PBR0. Note. Your access to PeopleSoft PeopleBooks depends on which PeopleSoft applications you've licensed. You may not have access to all of the PeopleBooks. This section contains information that you should know before you begin working with PeopleSoft products and documentation, including PeopleSoft-specific documentation conventions, information specific to each PeopleSoft product line, and information on ordering additional copies of our documentation. Before You Begin To benefit fully from the information covered in this book, you should have a basic understanding of how to use PeopleSoft applications. We recommend that you complete at least one PeopleSoft introductory training course. You should be familiar with navigating the system and adding, updating, and deleting information by using PeopleSoft windows, menus, and pages. You should also be PEOPLESOFT PROPRIETARY AND CONFIDENTIAL PREFACE ix SQR FOR PEOPLESOFT LANGUAGE REFERENCE comfortable using the World Wide Web and the Microsoft® Windows or Windows NT graphical user interface. Because we assume that you already know how to navigate the PeopleSoft system, much of the information in these books is not procedural. That is, these books do not typically provide step-by-step instructions on using tables, pages, and menus. Instead, we provide you with the information that you need to use the system most effectively and to implement your PeopleSoft application according to your organizational or departmental needs. PeopleBooks expand on the material covered in PeopleSoft training classes. PeopleSoft Application Fundamentals Each PeopleSoft application PeopleBook provides implementation and processing information for your PeopleSoft database. However, there is additional, essential information describing the setup and design of your database contained in a companion volume of documentation called PeopleSoft Application Fundamentals. PeopleSoft Application Fundamentals contains important topics that apply to many or all PeopleSoft applications across each product line. Whether you are implementing only one PeopleSoft application, some combination of products within a product line, or an entire PeopleSoft system, you should be familiar with the contents of this central PeopleBook. It contains fundamental information such as setting up control tables and administering security. The PeopleSoft Applications Fundamentals PeopleBook contains common information pertinent to all applications in each product line, such as defining general options. If you're upgrading from a previous PeopleSoft release, you may notice that we've removed some topics or topic headings from the individual application PeopleBooks and consolidated them in this single reference book. You’ll now find only application-specific information in your individual application PeopleBooks. This makes the documentation as a whole less redundant. Throughout each PeopleBook, we provide cross-references to PeopleSoft Application Fundamentals and other PeopleBooks. Related Documentation You can order printed, bound versions of the complete PeopleSoft documentation delivered on your PeopleBooks CD-ROM and additional copies of the PeopleBooks CDs through the Documentation section of the PeopleSoft Customer Connection website: http://www.peoplesoft.com/corp/en/login.asp You can find updates and additional documentation for this release, as well as previous releases, on PeopleSoft Customer Connection (http://www.peoplesoft.com/corp/en/login.asp ). Through the Documentation section of Customer Connection, you can download files to add to your PeopleBook library. You'll find a variety of useful and timely materials, including updates to the full PeopleSoft documentation delivered on your PeopleBooks CD. PREFACE x PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Important! Before you upgrade, it is imperative that you check PeopleSoft Customer Connection for updates to the upgrade instructions. We continually post updates as we refine the upgrade process. Hard-copy Documentation To order printed, bound volumes of the complete PeopleSoft documentation delivered on your PeopleBooks CD-ROM, visit the PeopleSoft Press website from the Documentation section of PeopleSoft Customer Connection. The PeopleSoft Press website is a joint venture between PeopleSoft and Consolidated Publications Incorporated (CPI), our book print vendor. We make printed documentation available for each major release shortly after the software is shipped. Customers and partners can order printed PeopleSoft documentation by using any of the following methods: Internet From the main PeopleSoft Internet site, go to the Documentation section of Customer Connection. You can find order information under the Ordering PeopleBooks topic. Use a Customer Connection ID, credit card, or purchase order to place your order. PeopleSoft Internet site: http://www.peoplesoft.com/. Telephone Email Contact Consolidated Publishing Incorporated (CPI) at 800 888 3559. Send email to CPI at
[email protected]. PeopleBooks Standard Field Definitions Throughout our product documentation, you will encounter fields and buttons that are used on many application pages or panels. This section lists the most common fields and buttons and provides standard definitions. Field Definition As of Date Business Unit The last date for which a report or process includes data. An identification code 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. Freeflow text up to 30 characters. Description PEOPLESOFT PROPRIETARY AND CONFIDENTIAL PREFACE xi SQR FOR PEOPLESOFT LANGUAGE REFERENCE Field Definition Effective Date Date on which a table row becomes effective; the date that an action begins. For example, if you want 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. For more information about effective dates, see Understanding Effective Dates in Using PeopleSoft Applications. EmplID (employee ID) Language or Language Code Unique identification code for an individual associated with your organization. The language in which you want the field labels and report headings of your reports to print. The field values appear as you enter them. Language also refers to the language spoken by an employee, applicant, or non-employee. Process Frequency group box Designates the appropriate frequency in the Process Frequency group box: Once executes the request the next time the batch process runs. After the batch process runs, the process frequency is automatically set to Don't Run. Always executes the request every time the batch process runs. Don't Run ignores the request when the batch process runs. Report ID Report Manager The report identifier. This button takes you to 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). This button takes you to the Process List page, where you can view the status of submitted process requests. This button takes you to the Process Scheduler request page, where you can specify the location where a process or job runs and the process output format. Process Monitor Run For more information about the Report List page, the Process List page, and the Process Scheduler, see Process Scheduler Basics in the PeopleTools documentation. Request ID A request identification that represents a set of selection criteria for a report or process. PREFACE xii PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Field Definition User ID SetID The system identifier for the individual who generates a transaction. An identification code that represents a set of control table information or TableSets. A TableSet is a group of tables (records) necessary to define your company’s structure and processing options. Freeflow text up to 15 characters. Short Description Typographical Conventions and Visual Cues We use a number of standard conventions and visual cues in our online documentation. The following list contains our typographical conventions and visual cues: (monospace font) Indicates a PeopleCode program or other program example. Indicates field names and other page elements, such as buttons and group box labels, when these elements are documented below the page on which they appear. When we refer to these elements elsewhere in the documentation, we set them in Normal style (not in bold). We also use boldface when we refer to navigational paths, menu names, or process actions (such as Save and Run). Bold Italics Indicates a PeopleSoft or other book-length publication. We also use italics for emphasis and to indicate specific field values. When we cite a field value under the page on which it appears, we use this style: field value. We also use italics when we refer to words as words or letters as letters, as in the following: Enter the number 0, not 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 W. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL PREFACE xiii If the note is preceded by Important!. Here's an example: For more information. capitalized titles in normal font refer to sections and specific topics within the PeopleBook. Gives the system name of the panel or process as specified in the PeopleTools Application Designer. Provides the path for accessing the page or process.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Cross-references The phrase For more information indicates where you can find additional documentation on the topic at hand. Note. For example. Pay very close attention to these warning messages. see Documentation on CDROM in About These PeopleBooks: Additional Resources. Text in this bar indicates information that you should pay particular attention to as you work with your PeopleSoft system. the note is crucial and includes information that concerns what you need to do for the system to function properly. separated by colons (:). We include the navigational path to the referenced topic. SetID and Calendar ID are required to open the Detail Calendar page. Not all of the information will be available for all pages or panels. the Object Name of the Detail Calendar panel is DETAIL_CALENDAR1. Page and Panel Introductory Table In the documentation. Capitalized titles in italics indicate the title of a PeopleBook. Navigation Prerequisites Access Requirements PREFACE xiv PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . each page or panel description in the application includes an introductory table with pertinent information about the page. For example. Warning! Text within this bar indicates a crucial configuration consideration. Specifies the keys and other information necessary to access the page. Specifies which objects must have been defined before you use the page or process. Text in this bar indicates cross-references to related or additional information. Usage Object Name Describes how you would use the page or process. Please send your suggestions to: PeopleSoft Product Documentation Manager PeopleSoft. or what you would like to see changed about our documentation. and other PeopleSoft reference and training materials.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Comments and Suggestions Your comments are important to us. we will pay careful attention to your comments and suggestions. We are always improving our product communications for you. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL PREFACE xv . PeopleBooks. CA 94588 Or send comments by email to the authors of the PeopleSoft documentation at: DOC@PEOPLESOFT. 4460 Hacienda Drive Pleasanton.COM While we cannot guarantee to answer every email message. Inc. We encourage you to tell us what you like. . The procedural design of SQR makes development. SQR command line. 4GL reporting language with a lexicon of over 110 commands. SQR data elements. SQR Samples is a library of SQR programs and output that provides a framework for creating configured reports. SQR. The SQR for PeopleSoft tools make it possible to create clear. With SQR. Understanding SQR SQR is a specialized programming language for accessing. and reporting enterprise data.CHAPTER 1 Understanding SQR for PeopleSoft This chapter provides overviews of: • • • • • SQR for PeopleSoft tools. implementation. manipulating. you build complex procedures that perform multiple calls to multiple Data Sources and implement nested. SQR has several important benefits: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-1 . hierarchical. or object-oriented program logic. and distribution of complex reports more systematic and efficient than most reporting tools. • • • SQR Execute enables you to run previously compiled SQR programs. This reference describes the following SQR for PeopleSoft tools: • SQR is a flexible. Understanding SQR for PeopleSoft Tools SQR for PeopleSoft is a powerful enterprise reporting system that provides direct access to multiple Data Sources. Sample reports. SQR Print enables you to configure reports for most printers. elegant reports from complex arrays of information systems. BEGIN-SETUP {setup commands}. SQR syntax conventions.. SQR Program Structure SQR for PeopleSoft processes source code from a standard text file and generates your report. The following examples show the general structure of SQR. Rules for entering SQR commands. such as complex tabular reports. and layout. END-HEADING BEGIN-FOOTING {footing_lines} {footing commands}. and interactive query and display. PDF. With SQR. END-FOOTING • The PROGRAM section runs the procedures contained in the report. such as mailing labels. produce special formats. This section describes: • • • SQR program structure.. and form letters.. The high-level programming capabilities that SQR provides enable you to add procedural logic and control to Data Source calls. multiple page reports. Multiple platform availability.. SQR enables you to generate a variety of output types. and create HTML. headers.. footers.. END-SETUP • The HEADING and FOOTING sections specify what is printed in the header and footer on each page of the report. table load and unload.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • • • • Flexibility and scalability. Comprehensive facilities for combined report and data processing. You can use SQR to write other types of applications. 1-2 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . such as database manipulation and maintenance. • The SETUP section describes overall characteristics of the report. Multiple Data Source compatibility. BEGIN-HEADING {heading_lines} {heading commands}. you design reports by defining the page size. You can display data in columns. or configured output for laser printers and phototypesetters. The text file containing source code comprises a simple set of sections that you delimit with BEGIN-section and END-section commands. otherwise. SQR commands and arguments are specified in bold uppercase. Important! If you are copying codes directly from the examples in the PDF file. Each comment line must begin with an exclamation point. Ellipses indicate that the preceding parameter can be repeated. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-3 . braces. Parentheses must enclose an argument or element. A vertical bar separates alternatives inside brackets. or parentheses.. .. () BOLD UPPERCASE Italic A comma separates multiple arguments. An exclamation point begins a single-line comment that extends to the end of the line. | ! ' Braces enclose required items. Many SQR programmers use uppercase for SQR commands. you receive an error message. Information and values that you must supply are specified in italics. Square brackets enclose optional items. change the slanted quotes to regular quotes. END-PROCEDURE SQR Syntax Conventions The following table describes the SQR syntax conventions. but SQR ignores case as it compiles your source code. A single quote starts and ends a literal text constant or any argument with more than one word... BEGIN-PROCEDURE {procedure_name} {procedure commands}. Rules for Entering SQR Commands Use these command rules as you develop SQR programs: • SQR commands are not case-sensitive. END-PROGRAM • The PROCEDURE section accomplishes the tasks associated with producing the report...SQR FOR PEOPLESOFT LANGUAGE REFERENCE BEGIN-PROGRAM {commands}. Symbol Description {} [] . On UNIX-based systems. Understanding the SQR Command Line SQR for PeopleSoft comprises SQR.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • • • • • You must separate command names and arguments by at least one space or tab character. If entered as “?” or omitted.sqr.. enter the following command: SQR [program][connectivity][flags. the executable names are SQRW. Argument Description program Name of your text file containing source code. This rule about typing quotation and exclamation marks twice in the report does not apply in the DOCUMENT section of form-letter reports. SQRWP. SQR ignores hyphens and carriage returns in commands.][args. you must precede it with a backslash (\). however. DON'T is typed DON''T. you can develop commands that extend beyond one line. SQR for PeopleSoft prompts you for the report program name. Each has a command-line interface. type these symbols twice to indicate that they are text. Note. and SQR Print. For example. To display the exclamation point (!) or single quote (') symbols in your report. SQR Execute..][@file.... See Also “Invoking SQR Execute” “Using SQR Print” SQR Command-Line Arguments The following table describes the SQR command-line arguments. You can break a line in any position between words except inside a quoted string. You can use a hyphen (-) at the end of a line to indicate that it continues on the next line. 1-4 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . To begin running SQR. If you are running this under Microsoft Windows. The default file type or extension is .] Note. however. You must begin each comment line with an exclamation point (!). and SQRWV. SQRWT. You must begin each command on a new line.. if your shell uses the question character as a WILD CARD character. You must enter arguments on the command line in the sequence that the program expects—first all ASK arguments.2cme. Username/[Password] flags args. If entered as “?” or omitted. Data_Source_Name/[Username]/[Password] • Oracle: Your username and password for the database. followed by INPUT arguments. Database[/username/password] • ODBC: Name that you give to the ODBC driver when you set up the driver. SQR for PeopleSoft prompts you for the information. Any of the flags listed under SQR Command-Line Flags . Arguments used by SQR for PeopleSoft while the program is running.. your username. and an optional connection string for the database (for example. in order. Each flag begins with a hyphen (-). Arguments listed here are used by the ASK and INPUT commands rather than prompting the user. and the password for the database. and args) can be specified in this file for non-Microsoft Windows platforms. and your username and password for the database. [Username]/[Password[@Database]] • SYBASE: Your username and password for the database.. followed by INPUT arguments. in order. @file. Arguments listed in the file are processed one at a time—first all ASK arguments. • DB2: Subsystem name and SQL authorization ID. connectivity. This port has been certified against DB2 and Microsoft SQL Server.com). the argument must follow the flag with no intervening space... Ssname/SQLid • Microsoft Windows or DB2: Name of the database. When a flag takes an argument. The command-line arguments (program. SQR Command-Line Flags SQR supports a number of command-line flags. The following table describes the SQR command-line flags. [Database] / [Username] / [Password] • Informix: Name of the database. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-5 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Description connectivity Information needed by SQR for PeopleSoft to connect to the database. File containing program arguments—one argument per line. @sales. -BURST:P generates the report output. (Microsoft Windows. {n}-{m}. If no number is entered after -D. The printer type must be LP. The Page range selection feature of . The setting -BURST:P is equivalent to -BURST:P0. the display is ignored. The default is 10 rows. the display scrolls continuously. See SQR for PeopleSoft Developer’s Guide. {l} is the level on which to burst. Callable SQR) Forces the communication box to use. -BURST:P and -BURST:S require -PRINTER:EH or -PRINTER:HT. otherwise. The setting -BURST:S is equivalent to -BURST:S1. {l} is the number of logical report pages that each . See SQR for PeopleSoft Developer’s Guide. which overrides any USE command in the SQR program. “Working With HTML. The value for nn is the maximum number of lines to display before pausing.HTM file contains and {s} is the page selection: {n}. each BEGIN-SELECT command can also have its own -B flag for further optimization. “Working With HTML”. grouped by report page numbers. (ODBC. Inside a program. In -BURST:P[ {l} . all rows are retrieved.” -BURST:T generates the Table of Contents file only.when using -PRINTER:HT or -BURST:P1 when using -PRINTER:EH. or {n}-. (Non-Microsoft Windows) Causes SQR for PeopleSoft to display the report output on the terminal at the same time that it is being written to the output file. {s}] …] ]. -B controls the setting for all BEGIN-SELECT commands. 1-6 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . If the program is producing more than one report. This is useful when you want to run the same report more than once but want only a single output file. -BURST:S generates the report output according to the symbolic Table of Contents entries set in the program with the level argument of the TOC-ENTRY command. When used on the command line. -DBdatabase (SYBASE) Causes the SQR program to use the specified database.1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -A Appends the output to an existing output file carrying the same name as the source of the output. SYBASE CT-Lib) Indicates the number of rows to buffer each time SQR for PeopleSoft retrieves data from the database. {s} [. If the file does not exist. Note. the display is for the first report only. -BURST:T requires -PRINTER:HT -Bnn -BURST:{xx} -C -CB -Dnn (Microsoft Windows) Specifies that the Cancel dialog box appears while the program runs so that you can easily stop the program. In -BURST:S[ {l} ]. -{m}. a new one is created. Note. Oracle. Regardless of the setting. “Bursting” and Demand Paging. Specifies the type of bursting to perform.BURST:P requires -PRINTER:HT. Note. SQR for PeopleSoft generates HTML designed for Netscape. Note. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-7 . Note. SQR for PeopleSoft usually checks for the applet in a default directory. When set to IE. no file is created. When set to ALL. Note. not the person writing it). or V30. When set to NETSCAPE. SQR for PeopleSoft must know where it resides. If no errors occur. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified.html.csv file from the report data. the default directory for these applets is IMAGES. and displays HTML. Also associates a BQD (query format file) icon with {report}. See the DEFAULT argument for the DECLAREVARIABLE command in “SQR Command Reference. -DNT:DECIMAL:20. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified.bqd file from the report data. -EH_BQD:file Associates the BQD icon with the specified file. The value for xx can be INTEGER.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -DEBUG [xxx] Compiles lines preceded by #DEBUG. Note. See “SQR Command Reference. -EH_CSV:file Associates the CSV icon with the specified file. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. -EH_CSV Generates a {report}. Note. Without this flag. FLOAT.err. To specify a precision for DECIMAL. -EH_BROWSER:xx Generates HTML. For example. If you include an applet. When set to BASIC. SQR for PeopleSoft generates HTML designed for Microsoft Internet Explorer. SQR for PeopleSoft generates HTML suitable for all browsers. Specifies the default behavior for numeric variables. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified.” DECLAREVARIABLE. determines the browser. SQR for PeopleSoft ignores these lines. The DEFAULT argument in the DECLARE-VARIABLE command takes precedence. Directs error messages to the named file or to the default file program. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified.bqd in the navigation bar.” #DEBUG. append it with a colon delimiter (:). SQR for PeopleSoft generates Frame. DECIMAL. which contains JavaScript to determine the browser on the user’s machine (that is. -DNT: {xx} -E[file] -EH_APPLETS:dir -EH_BQD Generates a {report}. Specifies the directory location of the enhanced HTML applets. if used. the person reading the report. Note. -EH_FULLHTML:xx Specifies the level of the generated enhanced HTML code. For upward compatibility. but does not create an HTML file.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -EH_CSVONLY Creates a CSV file. -EH_LANGUAGE:xx Sets the language used for the HTML navigation bar. You can specify English.zip if {file} is not specified. Note. Note. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. Note. 32.pdf in the navigation bar. a value of TRUE is equivalent to 40 and FALSE is 30. -EH_IMAGES:dir Specifies the directory path for the . German. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. Note.GIF files used by the navigation bar. Portuguese. -EH_KEEP Copies (does not move) the files when used in conjunction with EH_ZIP. or 40. -EH_Icons:dir Specifies the directory in which the HTML should find the referenced icons. Note. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. This can be 30. -EH_XML:file Associates the Extensible Markup Language (XML) icon with the specified file. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. or Spanish. French. Note. Note. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. -EH_PDF Associates a PDF icon with {report}. 1-8 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. Note. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. -EH_ZIP[:file] Moves the generated files to the specified file or {report}. -EH_Scale:{nn} Sets the scaling factor from 50 to 200. Note. This flag is applicable only when either the -PRINTER:EH or the -PRINTER:EP flag is specified. Specify the file name and directory for different operating systems as follows: • VMS Directory character is ] or : -FSYS$USER:[REPORTS] -FSYS$SCRATCH: -F[file | directory] • UNIX Directory character is / -F$HOME/reports/ • MVS Directory character is ( -FDSN:SQR.lis. The default action places the LIS in a source file called LIS in the same library as the member {program}. specify -F with the new name. If the new name does not specify a library.). OpenVMS) Specifies the file attributes to use for the report output file. separated by commas (. If no data is printed.lis in the same directory as the program. To use the current directory.REPORTS( -Gfile_mode -Gfile_attributes (VM) Specifies the file mode to use when the report output file is created. If the new name does not specify a directory. The output file is not created until data is actually printed on the page. program. specify -F without an argument. no output file is created.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -F[library| file(member)] (AS400) Overrides the default output file name library/lis(program). -GPRINT=YES | NO PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-9 . use -FSQRDIR/LIS(file). (MVS) -GPRINT=YES causes the SQR report output file to have ANSI control characters written to the first column of each record of the file. You can specify up to 10 sets of attributes. (VMS. specify -F without an argument. To change the name of the output file. no output file is created.sqr file. To use the current library. Overrides the default output file name. The default action places the program. the file is created in the current directory. If no data is printed. the file is created in the current library. To specify an alternate file name. specify -F with the new name. The output file is not created until data is actually printed on the page. -GPRINT=NO omits the control characters. To change the name of the output file. if your shell uses semicolons as command delimiters. See SQR for PeopleSoft Developer’s Guide. AS400) Suppresses printer control characters from column 1. under UNIX: sqr myreport sammy/baker . you must precede each semicolon with a backslash (\).log if no file is specified. See the “SQR Command Reference. Directs log messages to the specified file or to program. LOAD-LOOKUP: • s = SQR./usr/sqr/ incl/ -ID -KEEP (Non-Microsoft Windows) Displays the copyright banner on the console. The directory names must be separated by either commas (. By default. or complex reports. • i = Case-insensitive. • d = DB. For example. large. sorted by operating system. -NOLIS -O[file] -P -PB 1-10 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . • c = Case-sensitive. See the -F flag for a list of directory characters.). Prevents the creation of LIS files. -LL{s | d}{c | i} -Mfile Defines a startup file containing sizes to assign to internal parameters— extremely small. Instead.” LOAD-LOOKUP.log is used in the current working directory.) or semicolons (.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -Idir_list Specifies the list of directories that SQR for PeopleSoft searches when processing the #INCLUDE directive if the include file does not exist in the current directory and no path was specified for the file. (MVS.I/home/sqr/inc/. the file sqr. (Informix) Causes column data to retain trailing blanks. SPF files are created. Mfiles are text files that have individual switches in the INI files that are unique to a run. Creates SPF file output and LIS files for each report that your program generates. “Printing Issues ” for information about LIS and SPF files. Always append the directory character to the end of each directory name. For UNIX-based systems. -PRINTER:EH • EP = Enhanced HTML or PDF. To also create an SPF file. Note. -PRINTER:HT • LP = Line printer.0 HTML files with the report content inside of <PRE></PRE> tags. and checked for correct syntax. Type EH produces reports in which content is fully formatted with version 3.htm file output.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -PRINTER:xx Uses printer type xx when creating output files. -RS Saves the program in a runtime file. -PRINTER:HP • HT = HTML 2. Types EH and HT produce . -PRINTER:PS • WP = Microsoft Windows. the executable version is saved in a file with the name program. SQR for PeopleSoft does not prompt ASK variables after compilation. For example. Queries are validated and compiled. HP.0 or 3. {Printer Name} is the name assigned to your printer. To specify a Microsoft Windows printer that is not the default. -PRINTER:LP • PD = PDF. use -KEEP. The xx represents: • EH = Enhanced HTML. Then.sqt. enter PRINTER:WP:{Printer Name}. -PRINTER:EP • HP = HP LaserJet. to send output to a Microsoft Windows printer named NewPrinter.2 HTML tags. use -PRINTER:WP:NewPrinter. If your printer name has spaces. -PRINTER:PD • PS = PostScript. The program is scanned. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-11 .0. -PRINTER:WP Types LP. and PS produce files with the . compiled. Type HT produces version 2. enclose the entire argument in quotes. the WP extension sends the output to the default Microsoft Windows printer.lis extension. On Microsoft Windows systems. Prevents SQR for PeopleSoft from logging on to the database. Note. SQR for PeopleSoft does not prompt ASK variables after compilation. For example: sqr myprog / -xl -XLFF Prevents trailing form feed. Programs that you run in this mode cannot contain SQL statements. Requests for input are made in Microsoft Windows dialog boxes.. End of Run message. -XL enables you to run SQR for PeopleSoft without accessing the database. (OS400/DB2. This skips all syntax and query checking. You still must supply at least an empty slash (/) on the command line as a placeholder for the connectivity information. Specifies that you want to test your report for nn pages. -Tnn -T{B} -T{Z} (MVS/DB2) -TZ prevents SQR for PeopleSoft from removing trailing zeros from the decimal portion of numeric columns. (OS400/DB2) -TZ trims trailing zeros from the decimal portion of numeric columns. Prevents user interaction during a program run. (MVS/DB2) Prevents SQR for PeopleSoft from removing trailing blanks from database character columns. -S Requests that the status of all cursors be displayed at the end of the report run. SYBASE CT-Lib. (Microsoft Windows) Do not use the communication box. To save time during testing. an error is produced and the program ends. ODBC) Trims trailing blanks from database character columns. Status includes the text of each SQL statement. (Non-Microsoft Windows) Suppresses the SQR banner and the SQR. This information can be used for debugging SQL statements and enhancing performance and tuning.. and processing begins immediately. the number of times each was compiled and run and the total number of rows selected. (Callable SQR) Suppresses the database commit when the report has finished running. If the program is producing more than one report. -Vserver -XB -XC -XCB -XI -XL (SYBASE) Uses the named server.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -RT Uses the runtime file saved with the -RS flag. The output appears directly on the screen. 1-12 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . SQR for PeopleSoft ignores all ORDER BY clauses in SELECT statements. If an ASK or INPUT command requires user input. SQR for PeopleSoft stops after producing the specified number of pages defined for the first report. This flag implicitly invokes the -KEEP flag to create program. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-13 . Sets the full path and name of an alternate registry.lis file at the end of a line. Specifies the full path and name of the SQR error message file.properties The registry.properties file makes it possible for SQR for PeopleSoft to access Data Sources for which DDO drivers have been loaded and configured. only the first report file is passed to the viewer.htm file is produced. SQR.properties file on an NT system: c:\PeopleTools\properties\registry. See “SQR Command Reference.INI. This occurs when only a single . Preserves the trailing blanks in a . Prevents SQR for PeopleSoft from generating the table of contents for the report. Multiple .dat. In the case of multiple output files. -XNAV -XP -XTB -XTOC -ZIF{file} -ZIV -ZMF{file} -ZRF{file} Understanding SQR Data Elements Each SQR data element begins with a special character that denotes the type of data element.htm files generated with -PRINTER:HT. This flag is ignored when either -PRINTER:EH or PRINTER:HT is also specified.err file.” BEGIN-SELECT. (SYBASE) Prevents SQR for PeopleSoft from creating temporary stored procedures.spf file. Prevents SQR for PeopleSoft from creating the navigation bar in . Error messages are sent to an . sqrerr.spf.properties file lists Data Sources that SQR for PeopleSoft can access.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -XMB (Microsoft Windows) Disables the error message display so that you can run a program without interruption from error message boxes.properties file. The following path is a common default path to the registry. The information in the registry. Sets the full path and name of the SQR initialization file. See the -E flag.htm files generated from a single report always contain the navigation bar. Invokes the SPF Viewer after generating the program. SQR data elements include: • • • Columns Variables Literals Columns Columns are fields defined in the database. See SQR for PeopleSoft Builder User’s Guide.” • Variable names are not case-sensitive. INTEGER. It can be any type of column. Variable Rules The following rules govern the use of variables in SQR: • Variables can be almost any name of almost any length. Numeric variables can be one of three types: FLOAT. number. you can use a name in uppercase on one line and lowercase on the next. in which case they are known in that procedure only. $state_name or #total_cost. # begins a numeric variable. Marker locations identify positions to begin for printing in a BEGIN-DOCUMENT paragraph. See the “SQR Command Reference. • • • • $ begins a text or date variable. For example. it is declared automatically for columns defined in a query. “Hyphens and Underscores. Except for dynamic columns and database or aggregate functions. Variables Variables are storage places for text or numbers that you define and manipulate. • Variables and columns are known globally throughout a report. • • • SQR for PeopleSoft initializes variables to null (text and date) or zero (numeric). except when used in a local procedure (one with arguments or declared with the LOCAL argument). such as character. A command can grow to whatever length the memory of your computer can accommodate.” DECLARE-VARIABLE.” BEGIN-PROCEDURE. 1-14 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR FOR PEOPLESOFT LANGUAGE REFERENCE The character & begins a database column or expression name. @ begins a variable name for a marker location. That is. • Do not use an underscore (_) or colon (:) as the first character of a two-variable name. See “SQR Command Reference. % begins a list variable. or DECIMAL. both refer to the same variable. or date. Normally this variable is checked from inside an ON-ERROR procedure. Current date and time on the local machine when SQR for PeopleSoft starts running the process. the variables apply to the current report. This is equivalent to ROWCOUNT in Oracle and Sybase. Line numbers are referenced in PRINT and other SQR commands used for positioning the data on the page. #sql-count $sql-error #sql-status $sqr-encodingconsole {sqr-encodingconsole} $sqr-encodingdatabase {sqr-encodingdatabase} Character data retrieved from and inserted into the database. This value is the physical line on the page. The value of #SQL-STATUS is set whenever a BEGIN-SELECT command is run. Text message from the database explaining an error. Current page number. Variable Description #currentcolumn $current-date #current-line Current column on the page. #return-status is initialized to the “success” return value for the operating system. Therefore. Optional page headers and footers. defined with BEGIN-HEADING and BEGIN-FOOTING commands. Name of encoding for character data written to the log file or console. See “SQR Command Reference. or DELETE). Count of the rows affected by a DML statement (INSERT.” READ. consult the proper database manual to fully interpret its meaning. The following table describes the SQR reserved variables. SQR for PeopleSoft reserves a library of predefined variables for general use. Value to return to the operating system when SQR for PeopleSoft exits. Can be set in your report. The actual meaning of #SQL-STATUS is database dependent. UPDATE. not the line in the report body.SQR FOR PEOPLESOFT LANGUAGE REFERENCE SQR Reserved Variables When you create multiple reports. This variable is rewritten when a new error is encountered. so its value describes the error condition (whereas the $SQL-ERROR variable contains the error message). See SQR for PeopleSoft Developer's Guide. Line 2 of the heading is different from line 2 of the report body or footing. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-15 . Current line on the page. #end-file #page-count #return-status Set to 1 if the end of the file occurs when reading a flat file. have their own line sequences. #sqr-pid is unique for each run of SQR. Text string shown with the -ID flag. and UNIX. Maximum number of columns. SQR version. Process ID of the current SQR process. This variable contains the name of the computer on which SQR for PeopleSoft is currently running. Name of encoding for character data written to files used with the OPEN command. {sqr-hostname} $sqr-locale #sqr-max-lines #sqr-maxcolumns #sqr-pid $sqr-platform. WINDOWS-NT. ODBC. Valid values are YES and NO. SYBASE. A plus symbol (+) at the end of the name indicates that an argument used in the locale has changed. Report generated by SQR for PeopleSoft (for example. Name of the current locale being used. and ORACLE. an LIS file or a PostScript file). The hardware or operating system type for which SQR was compiled. Valid values are ASCII. MVS. 1-16 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . {sqr-platform} $sqr-program $sqr-ver Name of encoding for character data read from files used with the OPEN command. Name of the SQR process file. {sqr-encoding} sqr-hostname. Name of encoding for SQR source files and include files. this variable is automatically updated to reflect the new layout. Valid values are DB2.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Variable Description $sqr-encodingfile-input {sqr-encodingfile-input} $sqr-encodingfile-output {sqr-encodingfile-output} $sqr-encodingreport-output {sqr-encodingreport-output} $sqr-encodingsource {sqr-encodingsource} $sqr-database. When a new report is selected. When a new report is selected. Valid values are VMS. INFORMIX. this variable is automatically updated to reflect the new layout. as determined by the layout. {sqr-dbcs} sqr-encoding. This variable is useful in creating unique temporary names. {sqr-database} $sqr-dbcs. Name of the default encoding as defined by the ENCODING environment variable when SQR for PeopleSoft is invoked. Database type for which SQR was compiled. as determined by the layout. Specifies whether SQR for PeopleSoft recognizes double-byte character strings. and SJIS. JEUC. Maximum number of lines. that is. define it using the following syntax: let %listname=LIST(col_var|num_var|str_var|str_lit|num_lit[.. num_var2|str_var2. there is no need to predefine..#colname List Variable Arguments The value between the brackets indicates either the number of rows in the list for the definition case or the row in the list to modify or assign. Create list variables with the LET command and a list of variables.]) • Assigning a list variable: Assign a list variable using the following syntax: let %listname|%listname[num_var|num_lit]=list(col_var|str_var |num_var|str_lit|num_lit[. Before you assign a list variable. List Variables List variables contain an ordered collection of SQR variables and are nonrecursive. For multirow lists. $sqr-report reflects the actual name of the file to use. and the DEFAULT-NUMERIC setting applies. assign the types based on the given variable types. Name of the report output file. the assignment must be compatible with the types given in the definition. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR FOR PEOPLESOFT 1-17 ..) Working with list variables includes the following tasks: • Defining a list variable: You can use a list variable to hold multiple rows of information.. as specified by the -F flag or NEW-REPORT command.. Indicate list variables with the percent (%) symbol...…]) • Accessing a list variable: Access a list variable using the following syntax: let str_var|num_var=%listname[num_var|num_lit]... you cannot nest lists inside lists.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Variable Description $username $sqr-report Database username specified on the command line.colname'[. For example: LET %LIST1 = LIST (num_var1|str_var1. If there are no brackets.]) or let %listname[num_lit]=list(NUMBER|DATE|TEXT$colname |'. The underlying storage depends on the contents. A NUMBER field has the same characteristics as an undeclared #var. For example. Assignment of a numeric column to a string variable returns the string representation of the numeric value.21.” These programs are stored in the SQR for PeopleSoft directory SAMPLE. assignment of a date variable to a string variable returns the default-edit-mask representation of the date. Assignment is prohibited only between Date and Numeric types. For example. Viewing Sample Reports To see a quick overview of how an SQR report looks. For example: 'Hello' • Numerals 0–9 begin numeric literals. • A single quote begins and ends a text literal. Numeric literals can also be expressed in scientific form.2E5. You can modify these reports to meet your needs. view the sample reports listed in “SQR Samples. Literals Literals are text or numeric constants. –543. See Also SQR for PeopleSoft Developer’s Guide 1-18 UNDERSTANDING SQR FOR PEOPLESOFT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 1. Numerals that include digits with an optional decimal point and leading sign are acceptable numeric literals.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The usual SQR rules for variable assignment apply to list access. which consists of the line. A column of any type. The minimum position. make sure you change the slanted quotes to regular quotes or you will receive an error message. column.10. &address &price &date1 $your_name #total_cost $date1 'abc' 12 $string #number $date &string &number &date 'Company Confidential' 12345. Integer literal defined in a program.67 12345 123 (5. and use the abbreviations described in the following table. A variable of any type. (). Abbreviation Description Example txt_col num_col date_col txt_var num_var date_var any_lit any_var any_col txt_lit num_lit int_lit nn position Text column retrievable from a database. A literal of any type.CHAPTER 2 SQR Command Reference This chapter describes and demonstrates each command in the SQR lexicon. Warning! If you are copying codes directly from the examples in the PDF file. The commands in this section follow the conventions listed in the table from the Introduction.30) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-1 . Numeric literal defined in a program. A variable explicitly defined as a date variable. Text literal defined in a program. The position qualifier. Numeric variable defined in a program. Date or datetime column retrievable from a database. means to use the current line and column position on the page for the length of the field being printed. String variable defined in a program. Integer literal used as an argument to a command. Numeric column retrievable from a database. and length specification. The source is always first and the destination is always second. A numeric destination variable that contains the result after execution.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ADD Syntax ADD{src_num_lit | _var | _col} TO dst_num_var [ROUND=nn] Description Adds one number to another. Float variables are stored as double precision floating point numbers. The source value is added to the destination variable and the result is placed in the destination. Parameters Parameter src_num_lit | _var | _col Description A numeric source value added to the contents of dst_num_var. Rounds the result to the specified number of digits to the right of the decimal point. When dealing with money-related values (dollars and cents). this argument is not appropriate. dst_num_var ROUND Example add add add 10 to #counter to #new_count round=2 to #total #counter &price See Also The LET command for information about complex arithmetic expressions. For float variables. use decimal variables rather than float variables. For decimal variables. this value can be from 0 to the precision of the variable. ALTER-COLOR-MAP Syntax ALTER-COLOR-MAP 2-2 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . this value can be from 0 to 15. For integer variables. These inaccuracies can appear due to the way floating point numbers are represented by different hardware and software implementations and also due to inaccuracies that can be introduced when converting between floating point and decimal. and small inaccuracies can appear when adding many numbers in succession. 128) silver=(192.128.0.255) yellow=(255.255. only literal values are allowed. Defines the RGB value of the color you want to alter. 'Default' is used during execution when a referenced color is not defined in the runtime environment.0. the underscore (_) character. For example. You cannot use this command to define a new color. red_lit | _var | _col. A color_name is composed of the alphanumeric characters (A-Z.255.0) blue=(0. This command enables you to dynamically alter a defined color. The name 'default' is reserved and may be assigned a value. (193.SQR FOR PEOPLESOFT LANGUAGE REFERENCE NAME = {color_name_lit | _var | _col} VALUE = ({color_name_lit | _var | _col} | {rgb}) Description Dynamically alters a defined color. The ALTER-COLOR-MAP command is allowed wherever the PRINT command is allowed. It must start with an alpha (A-Z) character. light blue. VALUE {color_name_lit | _var | _col} {rgb} The default colors implicitly installed with SQR include: • • • • • • • • black = (0. 0-9). blue_lit | _var | _col where each component is a value in the range of 000 to 255. In the BEGIN-SETUP section. For example. It is case insensitive. green_lit | _var | _col.192.0) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-3 . Parameters Parameter NAME Description Defines the name of the color you want to alter. and the hyphen (-) character.0.0) white=(255.0) green=(0. 230).255) gray=(128. The name 'none' is reserved and cannot be assigned a value. 233.192) red=(255.255. A name in the format (RGBredgreenblue) cannot be assigned a value. 233. 229) end-declare end-setup begin-program alter-color-map name = 'light_blue' value = (193.0) teal=(0.1) set-color print-text-foreground = ($print-foreground) end-program See Also The DECLARE-COLOR-MAP.0.128) aqua=(0.0) maroon=(128. 230) print 'Yellow Submarine' () foreground = ('yellow') background = ('light_blue') get-color print-text-foreground = ($print-foreground) set-color print-text-foreground = ('purple') print 'Barney' (+1.0.0) navy=(0.0.255) lime=(0.0.128.255) Example begin-setup declare-color-map light_blue = (193.128.128) olive=(128. 222.128.255.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • • • • • • • • purple=(128.128) fuchsia=(255. ALTER-CONNECTION Syntax ALTER-CONNECTION NAME=connection_name [DSN={uq_txt_lit|_var}] [USER={uq_txt_lit|_var}] 2-4 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . SET-COLOR AND GET-COLOR commands in this section. sysnr= 00. The logical datasource name as recorded in the Registry.SQR FOR PEOPLESOFT LANGUAGE REFERENCE [PASSWORD={uq_txt_lit|_var}] [PARAMETERS=keyword_str=attr_str.ashost=starfish. There is no syntax restriction on these entries apart from the delimiting semi-colons (. and then use that connection in both the table creation logic of BEGIN-SQL and the row fetching logic of BEGIN-SELECT. This optional keyword prevents SQR from automatically creating additional logins to Data Sources that are busy handling a previous query. [. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-5 .client=600. you should code the CONNECTION as NODUPLICATE=TRUE. The keywords must match the logon property names listed for a Data Source in its property file. You can use this command to override the default connection logon parameters.. DSN USER. you must fetch from the temporary table using the same login in which it was created.logon. keyword_str=attr_str. Creating a new login in such cases is the default behavior for SQR.properties file.) and equal signs (=). Traditional logon semantics. Defines a list of keyword-attribute pairs required by a datasource driver for logon. allowing a single CONNECTION declaration to be used in a subquery. PASSWORD PARAMETERS = keyword_str=attr_str. Here.]] Description Alters the data source logon parameters prior to logon.. causes problems when doing both DDL (BEGIN-SQL) and DML (BEGINSELECT) against temporary tables in certain vendors Data Sources. while allowing dynamic logins as-needed.language=EN..logon. This behavior. NO-DUPLICATE=TRUE|FALSE (default is FALSE) Example alter-connection name=PT814 password=psswd parameters=logon. In such cases.logon. Parameters Parameter connection_name Description A user-defined name for describing a datasource connection. .{txt_lit12|_var12})] Description Selects a locale or changes locale parameters used for printing date. currency. A locale is a set of preferences for language. Space restrictions dictate the wrapped line in the preceding example.{txt_lit7 |_var7})] [MONTHS-CASE={txt_var|DEFAULT|SYSTEM|UPPER|LOWER|EDIT |NO-CHANGE}] [MONTHS-FULL=({txt_lit1|_var1}..SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. Do not wrap the lines in the 'parameters=' line...{txt_lit12|_var12})] [MONTHS-SHORT=({txt_lit1|_var1}. and the presentation of charts and numbers. ALTER-LOCALE Syntax ALTER-LOCALE [LOCALE={txt_lit _var|DEFAULT|SYSTEM}] [NUMBER-EDIT-MASK={txt_lit|_var|DEFAULT|SYSTEM}] [MONEY-EDIT-MASK={txt_lit|_var|DEFAULT|SYSTEM}] [DATE-EDIT-MASK={txt_lit|_var|DEFAULT|SYSTEM}] [INPUT-DATE-EDIT-MASK={txt_lit|_var|DEFAULT|SYSTEM}] [MONEY-SIGN={txt_lit|_var|DEFAULT|SYSTEM}] [MONEY-SIGN-LOCATION={txt_var|DEFAULT|SYSTEM|LEFT |RIGHT}] [THOUSAND-SEPARATOR={txt_lit|_var|DEFAULT|SYSTEM}] [DECIMAL-SEPARATOR={txt_lit|_var|DEFAULT|SYSTEM}] [DATE-SEPARATOR={txt_lit|_var|DEFAULT|SYSTEM}] [TIME-SEPARATOR={txt_lit|_var|DEFAULT|SYSTEM}] [EDIT-OPTION-NA={txt_lit|_var|DEFAULT|SYSTEM}] [EDIT-OPTION-AM={txt_lit|_var|DEFAULT|SYSTEM}] [EDIT-OPTION-PM={txt_lit|_var|DEFAULT|SYSTEM}] [EDIT-OPTION-BC={txt_lit|_var|DEFAULT|SYSTEM}] [EDIT-OPTION-AD={txt_lit|_var|DEFAULT|SYSTEM}] [DAY-OF-WEEK-CASE={txt_var|DEFAULT|SYSTEM|UPPER|LOWER |EDIT|NO-CHANGE}] [DAY-OF-WEEK-FULL=({txt_lit1|_var1}.. See Also The DECLARE-CONNECTIONS command. 2-6 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL ..{txt_lit7 |_var7})] [DAY-OF-WEEK-SHORT=({txt_lit1|_var1}.. and money data and for data accepted by the INPUT command.. numeric. 'Dec') MONEY-EDIT-MASK DATE. 'July'. This provides upwards compatibility for older SQR programs. 'Mar'. SQR uses the same default as the NUMBER-EDIT.0 or later. 'May'. 'Aug'. 'April'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The SYSTEM locale represents the behavior of older versions of SQR prior to Version 4.' '/' ':' 'n/a' 'am' 'pm' 'bc' 'ad' EDIT ('Sunday'. the default locale is set to SYSTEM. SQR uses the default database date format. 'Jul'. When you install SQR for PeopleSoft Version 4. 'Sep'. 'Sat') EDIT ('January'. 'Fri'. 'Jun'. 'Monday'. 'Apr'. The SYSTEM locale settings are described in the following table. '$' LEFT '. 'Wed'.MASK keyword. 'December') ('Jan'. 'Tuesday'. SQR uses a default date edit mask with the INPUT command. 'September'. and DISPLAY commands format the number with six digits to the right of the decimal point and left justifies the number. 'Saturday') ('Sun'. 'Oct'. 'October'. 'Mon'.' '. 'February'. Keyword Value NUMBER-EDIT-MASK The PRINT command prints two digits to the right of the decimal point and left justifies the number in the field.0. 'June'. 'Nov'. 'Feb'. 'May'. 'Friday'. See the Sample Date Edit Masks table for a listing of the date edit mask. 'Thu'. 'November'.EDIT-MASK INPUT-DATE-EDIT-MASK MONEY-SIGN MONEY-SIGN-LOCATION THOUSAND-SEPARATOR DECIMAL-SEPARATOR DATE-SEPARATOR TIME-SEPARATOR EDIT-OPTION-NA EDIT-OPTION-AM EDIT-OPTION-PM EDIT-OPTION-BC EDIT-OPTION-AD DAY-OF-WEEK-CASE DAY-OF-WEEK-FULL DAY-OF-WEEK-SHORT MONTHS-CASE MONTHS-FULL MONTHS-SHORT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-7 . SHOW. 'Tue'. 'Wednesday'. 'August'. See the Date Time section for more details. The MOVE. 'March'. 'Thursday'. Valid values are LEFT and RIGHT. Specifies the characters that replace the $ or other currency symbol used in edit masks. Specifies the character to replace the '/' character. underscore. Specifies the numeric edit mask to use with the keyword NUMBER in a PRINT. For information about Edit Masks. Specifies the character to replace the '. you cannot define it in the SQR.' edit character. SHOW. If this field is omitted. The default date edit mask to used with the keyword DATE in the PRINT. The locale name is case-insensitive and is limited to the following character set: A-Z. NUMBER-EDIT-MASK MONEY-EDIT-MASK DATE-EDIT-MASK INPUT-DATE-EDIT-MASK MONEY-SIGN MONEY-SIGN-LOCATION THOUSAND-SEPARATOR DECIMAL-SEPARATOR DATE-SEPARATOR TIME-SEPARATOR EDIT-OPTION-NA 2-8 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Specifies the numeric edit mask to use with the keyword MONEY in a PRINT. however.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Note.INI file. Specifies the character to replace the '. Many of the settings can have a value of DEFAULT or SYSTEM. or the LET functions datetostr() or strtodate().' edit character. Specifies the characters to use with the 'na' option. This name must be defined in the SQR. then the current locale is used. You can alter the system locale using the ALTER-LOCALE command. or DISPLAY command. specifying DEFAULT retrieves the value from the corresponding setting of the default locale as identified in the [Default-Settings] section of the SQR. or DISPLAY command. see "PRINT". or DISPLAY command. Parameter LOCALE Description Specifies the name of the locale to use. For a given setting. SHOW.INI file. MOVE. Specifies where to place the MONEY-SIGN characters. SHOW. The default date format to use with the INPUT command when TYPE=DATE is specified with the command or the input variable is a date variable. MOVE. Specifies the character to replace the ':' character. specifying the keyword SYSTEM retrieves the value from the corresponding setting of the system locale. Similarly. MOVE. or hyphen.INI file. The current locale can be determined by printing the reserved variable $sqr-locale. 0-9. LOWER. Use EDIT to follow the case specified with the format code in the edit mask. Specifies the abbreviated names for the months of the year. ignoring the case of the format code in the edit mask. Specifies how the case for the MONTHS-FULL or MONTHS-SHORT entries are affected when used with the format codes 'MONTH' or 'MON'. EDIT. LOWER. Specifies the characters to replace 'BC'. and NO-CHANGE. SQR for PeopleSoft considers the first month of the year to be January. Valid values are UPPER. Specifies the characters which to replace 'PM'. DAY-OF-WEEK-FULL DAY-OF-WEEK-SHORT MONTHS-CASE MONTHS-FULL MONTHS-SHORT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-9 . Use NO-CHANGE to ignore the case of the format code and output the day of week explicitly listed in the DAY-OF-WEEK-FULL or DAY-OFWEEK-SHORT entries. SQR considers the first day of the week to be Sunday.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter EDIT-OPTION-AM EDIT-OPTION-PM EDIT-OPTION-BC EDIT-OPTION-AD DAY-OF-WEEK-CASE Description Specifies the characters to replace 'AM'. Valid values are UPPER. All 12 months must be specified. SQR considers the first day of the week to be Sunday. Specifies the full names for the months of the year. SQR for PeopleSoft considers the first month of the year to be January. UPPER and LOWER force the output to either all uppercase or lowercase. All 12 abbreviations must be specified. EDIT. Use EDIT to follow the case specified with the format code in the edit mask. You must specify all seven days. and NO-CHANGE. Specifies how the case for the DAY-OF-WEEKFULL or DAY-OF-WEEK. ignoring the case of the format code in the edit mask. Specifies the full names for the days of the week. Use NOCHANGE to ignore the case of the format code and output the month explicitly listed in the MONTHS-FULL or MONTHS-SHORT entries. You must specify all seven abbreviations. Specifies the abbreviated names for the days of the week.SHORT entries are affected when used with the format codes 'DAY' or 'DY'. UPPER and LOWER force the output to either all uppercase or lowercase. Specifies the characters to replace 'AD'. 99' show #value edit '$$$$. $edit) show 'With NUMBER option show 'With MONEY option #Value = ' #value number #Value = ' #value money $Date $Date = ' $date date = ' $date show 'Without NUMBER option #Value = ' #value show 'With DATE option show 'Without DATE option Produces the following output: With NUMBER option With MONEY option #Value = #Value = $ $Date $Date 123.999.000000 With DATE option Without DATE option ! ! Reset locale to SQR defaults and assign a multi-character ! money-sign. 1995 = 01-JAN-95 2-10 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .999.999.99' = 'Mon DD.456.99' ! Australian dollars = Jan 01. ! begin-setup declare-variable date $date $date1 $date2 $date3 end-declare end-setup ! ! Set default masks ! alter-locale number-edit-mask = '9.999.999.999. YYYY' let #value = 123456 let $edit = 'Mon DD YYYY HH:MI:SS' let $date = strtodate('Jan 01 1995 11:22:33'.99' money-edit-mask date-edit-mask = '$999.999.456.$$$$999.999.00 123.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example ! ! The following program segments will illustrate the various ! ALTER-LOCALE features. ! alter-Locale locale = 'System' money-sign = 'AU$' let #value = 123456 show #value edit '$999.00 Without NUMBER option #Value = 123456. 99' show #value edit '$$$$.456.' let #value = 123456 show #value edit '999.999.999.456. ! the leading space.999.456.00 AU$ 123.99' Produces the following output: 123.999.$$$$999.999. ! alter-locale money-sign = ' AU$' money-sign-location = right let #value = 123456 show #value edit '$999.00 ! ! Move the money-sign to the right side of the value.456.00 ! ! Reset locale to SQR defaults and change the date and time ! separators ! alter-locale locale = 'System' date-separator = '-' time-separator = '.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Produces the following output: AU$ 123.00 AU$123.999.00 AU$ ! ! Reset locale to SQR defaults and flip the thousand and ! decimal separator characters. ! alter-locale locale = 'System' thousand-separator = '. $edit) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-11 .456.99' ! Australian dollars Note Produces the following output: 123.' let $edit = 'Mon/DD/YYYY HH:MI:SS' let $date = strtodate('Jan/01/1995 11:22:33'.999.' decimal-separator = '. 999.' edit-option-pm = 'p.d.33 ! ! Reset locale to SQR defaults and change the text used with ! the edit options 'na'. $edit) let $date2 = strtodate('Feb 28 1995 12:01'. 'Mon DD YYYY') let $date3 = strtodate('Mar 15 1995'. 'pm'.m.' edit-option-bc = 'b. 'Mon DD YYYY') show 'System:' show show $date1 edit 'Month DD YYYY' ' is ' $date1 edit 'Day' show $date2 edit 'Month DD YYYY' ' is ' $date2 edit 'Day' show $date3 edit 'Month DD YYYY' ' is ' $date3 edit 'Day' alter-locale locale = 'German' show 2-12 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .m.M.999. 'bc. ! ! Input some dates using the 'system' locale and ! output using other locales from the SQR.c.' edit-option-ad = 'a. $edit) show $value edit '999.' let $value = '' let $edit = 'Mon DD YYYY HH:MI' let $date1 = strtodate('Jan 01 1995 11:59'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE show $date edit :$edit Produces the following output: Jan-01-1995 11. ! alter-locale locale = 'System' let $date1 = strtodate('Jan 01 1995'. Feb 28 1995 12:01:00 p.99Na' show $date1 edit 'Mon DD YYYY HH:MI:SS PM' show $date2 edit 'Mon DD YYYY HH:MI:SS pm' Produces the following output: Not/Applicable Jan 01 1995 11:59:00 A. 'am'.m.999. 'Mon DD YYYY') let $date2 = strtodate('Feb 28 1995'.INI file.22. 'ad' ! alter-locale locale = 'System' edit-option-na = 'not/applicable' edit-option-am = 'a. AND SHOW commands in this section. ALTER-PRINTER Syntax ALTER-PRINTER [POINT-SIZE={point_size_num_lit|_var}] [FONT-TYPE={font_type|txt_var}] [SYMBOL-SET={symbol_set_id|txt_var}] PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-13 . MOVE.SQR FOR PEOPLESOFT LANGUAGE REFERENCE show 'German:' show show $date1 edit 'DD Month YYYY' ' ist ' $date1 edit 'Day' show $date2 edit 'DD Month YYYY' ' ist ' $date2 edit 'Day' show $date3 edit 'DD Month YYYY' ' ist ' $date3 edit 'Day' alter-locale locale = 'Spanish' show show 'Spanish:' show show $date1 edit 'DD Month YYYY' ' es ' $date1 edit 'Day' show $date2 edit 'DD Month YYYY' ' es ' $date2 edit 'Day' show $date3 edit 'DD Month YYYY' ' es ' $date3 edit 'Day' Produces the following output: System: January 01 1995 is Sunday February 28 1995 is Tuesday March 15 1995 is Wednesday German: 01 Januar 1995 ist Sonntag 28 Februar 1995 ist Dienstag 15 März 1995 ist Mittwoch Spanish: 01 enero 1995 es domingo 28 febrero 1995 es martes 15 marzo 1995 es miércoles See Also The DISPLAY. PRINT.INI in PSSQR.INI. LET. PSSQR. SQR FOR PEOPLESOFT LANGUAGE REFERENCE [FONT={font_int_lit|_var}] [PITCH={pitch_num_lit|_var}] Description Alters printer parameters at runtime. If an attribute does not apply to the current printer. PITCH See the "DECLARE-PRINTER Command Arguments" Table for information about these arguments. however. ALTER-PRINTER attempts to change the attributes of the current printer for the current report. 3 = Courier and 4 = Helvetica.SPF file is kept (see the -KEEP command line flag) and later printed on an HP LaserJet. the symbol set 12U can be used. ALTER-PRINTER is ignored if it specifies proportional fonts for a report printed on a line printer. See Also The DECLARE-PRINTER command. Specifies the new font type. Parameters Parameter POINT-SIZE FONT-TYPE SYMBOL-SET FONT Description Specifies the new font point size. Specifies the new symbol set identifier. it is ignored. 2-14 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Specifies the new font as a number. Enter PROPORTIONAL or FIXED. alter-printer font=4 ! Helvetica ! PC-850 Multilingual symbol-set=12U If the output prints to a PostScript printer. For example. You can place the ALTER-PRINTER command in any part of an SQR program except the SETUP section. if the . the attributes are changed for that report as well. (For example. When your program is creating multiple reports and the printer is shared by another report. Example Change the font and symbol set for the current printer.) Specifies the new pitch in characters per inch. the SYMBOL-SET argument is ignored. SQR FOR PEOPLESOFT LANGUAGE REFERENCE ALTER-REPORT Syntax ALTER-REPORT [HEADING={heading_name_txt_lit|_var|_col}] [HEADING-SIZE={heading_size_int_lit|_var|_col}] [FOOTING={footing_name_txt_lit|_var|_col}] [FOOTING-SIZE={heading_size_int_lit|_var|_col}] Description Alters some of the report-specific functionality.0) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-15 . FOOTING FOOTING-SIZE Example begin-footing 2 name=confidental print 'Company Confidential' (1.1.HEADING and/or BEGIN-FOOTING section and the page has not been written to. Parameters Parameter HEADING HEADING-SIZE Description Specifies the name of the BEGIN-HEADING section to use. If the ALTER-REPORT command was not invoked from within a BEGIN.0) center page-number (2. This command gives you the ability to dynamically change those heading and/or footing sections that are active for the current report. You can also change how much space the heading and/or footing sections occupy. If no HEADING or FOOTING value is set then the HEADING-SIZE and/or FOOTING-SIZE values affect the HEADING/FOOTING currently being used. Specifies the amount of space the BEGIN-HEADING section will occupies in the page.37. otherwise it takes effect for the next page. then the assignment takes effect immediately. Specifies the amount of space the BEGIN-FOOTING section will occupies in the page. Specifies the name of the BEGIN-FOOTING section to use. If the HEADING or FOOTING value is set to 'DEFAULT' then that section reverts to whatever was in effect when the report was initiated. If the HEADING or FOOTING value is set to 'NONE' then that section is disabled for the current report. . 2-16 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .. ARRAY-MULTIPLY{src_num_lit|_var|_col}. The following information applies to the array arithmetic commands: • The array must first be created using the CREATE-ARRAY command...SQR FOR PEOPLESOFT LANGUAGE REFERENCE end-footing begin-footing 2 page-number (2. Description These four commands perform arithmetic on one or more elements in an array. ARRAY-SUBTRACT Syntax ARRAY-ADD{src_num_lit|_var|_col}.TO dst_array_name (element_lit|_var|_col)[field [(occurs_lit|_var|_col)]].1.TIMES dst_array_name (element_int_lit|_var|_col)[field [(occurs_lit|_var|_col)]]. The BEGIN-HEADING command.. ARRAY-MULTIPLY. ARRAY-SUBTRACT{src_num_lit|_var|_col}....FROM dst_array_name (element_int_lit|_var|_col)[field [(occurs_lit|_var|_col)]].... ARRAY-DIVIDE{src_num_lit|_var|_col}.0) center See Also The BEGIN-FOOTING command....0) end-footing begin-report alter-report footing = 'Proprietary' footing-size = 6 depth .. . ARRAY-ADD.. ARRAY-DIVIDE.INTO dst_array_name (element_int_lit|_var|_col)[field [(occurs_lit|_var|_col)]].37.. end-report ! Increase name=proprietary print 'Company Proprietary' (1. the results are placed into consecutively defined fields in the array. • • Parameters Parameter src_num_lit|_var|_col Description Source values are added to. the result field is unchanged. or subtracted from the respective destination array fields. They cannot be of type DATE. and SQR continues executing. If fields are not listed. or TEXT. array-multiply 2 2 2 times percentages(#i) p(0) p(1) p(2) The following example divides the #i2'th occurrence of the salesman field of the #j'th element of the commissions array by 100. array-subtract #lost #count 1 from stats(#j2) loses tot sequence The following example multiplies occurrences 0 through 2 of the field p in the #i'th element of the percentages array by 2. Destination array fields contain the results after the operation. tot and sequence of the #j2'th element of the stats array. CHAR. a warning message appears. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-17 . or INTEGER. array-add &salary #comm to emps(#j) The following example subtracts #lost. If an occurrence is not specified the zeroth (0) occurrence is used. The #j'th element of the array is used. multiplied times. All variables must be numeric in type.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • • • The four array arithmetic commands perform on one or more source numbers. and 1 from the fields loses. dst_array_name ( element_int_lit|_var|_col) [ field [ ( occurs_lit|_var|_col) ] ] Example The following example adds &salary and #comm to the first two fields defined in the emps array. divided into. All fields must be of the type NUMBER. placing the result into the corresponding field in the array. FLOAT. If fields are listed. at the specified occurrence of the field. Array element and field occurrence numbers can be numeric literals (123) or numeric variables (#j) and can be from zero (0) to one less than the size of the array. array-divide 100 into commissions(#j) salesman(#i2) The following example uses the ARRAY-ADD command in an SQR program. DECIMAL. All variables must be numeric in type. results are placed into those fields. If division by zero is attempted. #count. 000 end-setup begin-program do Main end-program begin-procedure Main local ! Show original contents of the arrays. PUT. and LET commands for information about using arrays.000 field=Comm:number=5000 initialize to 5.22) money end-procedure See Also The CREATE-ARRAY command for information about creating an array. 1) money (. The GET.22) money let #salary = 1000 let #commission = 1000 let #j = 0 ! address the array row with variable "#j" #commission TO emps(#j) ! Add 1000 (in variables) to each column of row 0 (the 1st and only row) array-add #salary ! retrieved the new "added" values get #sal #com FROM emps(0) Salary Comm print #sal print #com (+1. 1) ! one row ! initialize to ! (+1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE begin-setup ! declare arrays create-array name=emps size=1 needed for this example field=Salary:number=35000 35. 1) (+1. 3) bold underline (.25) bold underline (+1.1) money (. The CLEAR-ARRAY command for information about clearing or initializing an array. 2-18 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . then the modified arrays ! array-add ! retrieve values from the only row of array "emps" get #sal #com FROM emps(0) Salary Comm print 'Array-Add' print 'Add 1000 to each column' print 'Salary' print 'Comm' print #sal print #com (+1. state takes the value entered by the user in response to the prompt Enter state for this report. See "SQR Command-line Flags" in the Introduction section for more information. Parameters Parameter Substitution_variable Prompt Description The variable to be used as the substitution variable. command-line arguments. An optional literal text string to be displayed as a prompt if the value for the substitution variable is not entered on the command line or in an argument file.. city. Example In the following example. begin-setup ask state 'Enter state for this report' end-setup . PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-19 . Each variable can be referenced multiple times. ASK is used only in the SETUP section and must appear prior to any substitution variable references. Substitutions are made as the program is compiled and are saved in the SQT file. zip from customers where state = '{state}' end-select See Also The INPUT command for information about input at runtime. Variables are referenced by enclosing the variable name in braces.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ASK Syntax ASK substitution_variable [prompt] Description Retrieves values for a compile-time substitution variable. or as entries in the @file on the command line. The retrieval can be by user input. If the substitution variable is text or date. for example. You cannot break the ASK command across program lines. '{state_name}'.. begin-select name. The value of the substitution variable replaces the reference variable in the program. state. surround the brackets by single quotes. Database columns.. and so on. A document paragraph enables you to write free-form text to create form letters..1) . SQR for PeopleSoft Builder Developer's Guide. invoices.SQR FOR PEOPLESOFT LANGUAGE REFERENCE SQR for PeopleSoft Developer's Guide. “Compiling Programs and Using SQR Execute”. BEGIN-DOCUMENT Syntax BEGIN-DOCUMENT position END-DOCUMENT Description Begins a DOCUMENT paragraph. “Creating Form Letters” (for a full example of the BEGIN-DOCUMENT command). A document must be executed before you can reference its document markers. SQR variables. Their location in the document determines where they are printed on the page. Example begin-document (1. Note also that if the variables being printed inside a document paragraph are variable in length.b Dear $firstname . the actual location of a document marker may not be known by SQR until the document itself has been executed. Because documents can be printed at relative positions on the page. You should not use tabs inside a document paragraph. Parameters Parameter position Description The location on the page where the document begins. 2-20 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . To indent text or field use the spacebar. Note. you might want to manipulate the variable outside the DOCUMENT paragraph. end-document See Also The END-DOCUMENT command. The position can be fixed or relative to the current position. and document markers can be referenced within a document. A global SQR variable containing the row set being retrieved.m-|all}) |FROM PARAMETER=txt_lit|txt_var END-SELECT] END-EXECUTE Description Begins a new construct.argi[IN|INOUT]]…]])] |COMMAND=txt_lit|txt_var |GETDATA=txt_lit|txt_var] [BEGIN-SELECT[BEFORE=sqr_procedure[(arg1[. the syntax of BEGIN-SELECT varies as shown in the following syntax: Parameters Parameter CONNECTION Description Identifies a name previously specified using the DECLARE-CONNECTION construct. Row Set Variable. Identifies the location in the datasource of the object being queried.SQR FOR PEOPLESOFT LANGUAGE REFERENCE BEGIN-EXECUTE Syntax BEGIN-EXECUTE [CONNECTION=uq_txt_lit] [ON-ERROR=procedure[(arg1[. If you do not specify a name.argi]…]])]] [AFTER=sqr_procedure[(arg1[.argi]…]])]]] col-name type=char|text|number|date[edit-mask] [on-break]… FROM ROWSETS=({m. Name is not case-sensitive.argi].. and password (PASSWORD). The default connection is defined by the command-line entries for datasource (DSN).n-m. Identifies a list or scalar variable that receives the status of the stored procedure. In a BEGIN-EXECUTE paragraph. username (USER).-n. Declares a procedure to execute if an error occurs. SQR Server uses the default connection.. ON-ERROR RSV STATUS SCHEMA PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-21 .)]] [RSV=num_var] [STATUS=list_var|num_var|txt_var] [SCHEMA=txt_lit|txt_var] [PROCEDURE=txt_lit|txt_var [PARAMETERS=(arg1[IN|INOUT|NULL[. Numeric literals or #variables are allowed. including SAP R/3 and JDBC. If you do not specify the keywords IN or INOUT. If you specify more than one row set. where it might be used to specify such things as Level. Command. Names the rowsets from which to retrieve the column variables. Available only for SAP R/3 datasources. with the minor difference being that the properties here specified alter the flow of returned information. Available for use with all datasource types. This argument names an output parameter containing one or more rows from which the column variables are to be retrieved. or Include-Column. Special case addition to the BEGIN-SELECT syntax. Specifies a (set of) keyword/value pairs that represent modifications to be made to the Properties of the datasource (specified by the CONNECTION = statement). Getdata). This string can include embedded SQR variables. PROPERTIES = ( 'SetColumn' = 5 ) Example begin-setup 2-22 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Scalar and/or list variables of the form list_var | num_lit | txt_lit | txt_var | num_var | any_col. If the datasource is SAP R/3.and alterconnection. Special case addition to the BEGIN-SELECT syntax. IN is the default.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter PROCEDURE Description The name of the datasource-stored procedure to be executed. The name may include spaces. This is a similar concept to the PARAMETERS = statement in Declare. use identical column name/type signatures. and they must not overlap as in this example: (1-3. PARAMETER_LIST COMMAND BEFORE/AFTER FROM ROWSET FROM PARAMETER GETDATA PROPERTIES = (txt_var | strlit = txt_var | strlit | num_var | num_lit | any_col. Specify all parameters in order. Supports the Java (DDO) GetData paradigm for data access. An arbitrary number of such pairs can be specified. A text string you pass to the datasource without modification by SQR. An application of this statement would be in the MDB setting. For example. this procedure is a BAPI. 2-4). Row set numbers must be sequential from left-to-right within the parentheses. Use only in conjunction with PROCEDURE keyword. Names an SQR procedure to be executed before or after the row set. Can be used in conjunction with any data-access model (Procedure. leaving any parameters unnamed causes a syntax error. Generation. The procedure is not performed unless at least one row is returned from the specified rowsets. … ) Note. This results in a Null value for that parameter position. To ignore a parameter. fill its position with the keyword NULL. as opposed to just setting login properties. 'recalculate') print 'proc ran OK. $ship_method.+2) from Rowsets=(1) End-Select End-Execute See Also The EXECUTE command. end-declare alter-connection name=SAPR3 password=$pword Begin-Execute connection=SAPR3 rsv=#theRow status=#theStatus on-error=it_failed(#theStatus) procedure='CreditHistory version 5' parameters=(%parm1.+5) edit 999 Begin-Select before=do_eject after=cleanup city &col=char (1. #howMany) declare-connection SAPR3 user=scott parameters=clientno=5.node=starfish. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-23 .1) print #theStatus (.1) on-break level=1 after=city-tot keyval type=number (1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE declare-variable date $when_ordered text $ship_method integer #theRow integer #theStatus integer #howMany end-declare end-setup input #howMany type=integer input $pword let %parm1 = list($when_ordered. status is ' (+1.+1) rcvd type=date (0. . you can ignore this argument. which override the ALL setting. You must define the report_name in a DECLARE-REPORT paragraph. This argument is required only for a program with multiple reports. Specifies the reports to which this footing applies. there can be only one for each Table of Contents.REPORTS=(ALL) can be followed by other BEGIN-FOOTING sections for specific reports. there can be only one for each report... however. If you are writing a program that produces a single report. Note that the parentheses are required.report_namei]. Parameters Parameter footing_lines_int_lit FOR-REPORTS Description The number of lines to be reserved at the bottom of each page. 2-24 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .)] [FOR-TOCS=(toc_name1[. The FOOTING section defines and controls information to be printed at the bottom of each page. the footing is applied to all reports. A BEGIN-FOOTING section with FOR. You can also specify FOR-TOCS=(ALL). You can specify more than one BEGIN-FOOTING section.)] [NAME={footing_name}] END-FOOTING Description Begins the FOOTING section. If you do not use DECLARE-REPORT. Note that the parentheses are required. You can print outside the Footing area of the report. You must define the toc_name in a DECLARE-TOC paragraph. You can also specify FOR-REPORTS=(ALL). The BEGIN-FOOTING section can be shared between reports and Table of Contents. which override the ALL setting. however.toc_namei]..SQR FOR PEOPLESOFT LANGUAGE REFERENCE BEGIN-FOOTING Syntax BEGIN-FOOTING footing_lines_int_lit [FOR-REPORTS=(report_name1[. A BEGIN-FOOTING section with FOR-TOCS=(ALL) can be followed by other BEGIN-FOOTING sections for a specific Table of Contents. from the Footing. but you cannot print into the Footing area from the body. You can specify more than one BEGIN-FOOTING section. that is into the body area. 0) center page-number (2. Example begin-footing 2 for-reports=(customer.)] [FOR-TOCS=(toc_name1[.1) let $page = roman(#page-count) ! ROMAN numerals print $page (.. The DECLARE-TOC command for information about Table of Contents..0) center page-number (2. The END-FOOTING command. summary) print 'Company Confidential' (1. toc_namei].64) end-footing ! For all reports See Also The ALTER-REPORT command for information about dynamic headings/footings.. The DECLARE-REPORT command for information about programs with multiple reports.1. This is used in conjunction with the ALTER-REPORT command. BEGIN-HEADING Syntax BEGIN-HEADING heading_lines_int_lit [FOR-REPORTS=(report_name1[.0) end-footing begin-footing 2 for-tocs=(all) print 'Table of Contents' (2.37.. The name cannot be NONE or DEFAULT.0) end-footing begin-footing 2 print 'Division Report' (1. The DECLARE-LAYOUT command for information about page layout. Specifies the name to be associated with this footing section.)] [NAME={footing_name}] END-HEADING PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-25 .37.1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter FOR-TOCS NAME Description Specifies the Table of Contents to which this heading applies. report_namei]. This is required only for a program with multiple reports. A BEGIN-HEADING section with FOR. the heading is applied to all reports. which override the ALL setting. Specifies the reports to which this heading applies. ! 2nd is blank. Parameters Parameter heading_lines_int_lit FOR-REPORTS Description The number of lines to be reserved at the top of each page. but you cannot print into the heading area from the body. 2-26 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . however. The BEGIN-HEADING section can be shared between reports and Table of Contents. You can print outside the heading area of the report. there can be only one for each Table of Contents. This option cannot be used if FOR-REPORTS or FOR-TOCS is also specified. Note that the parentheses are required. you can ignore this argument.1) edit MM/DD/YY print 'Sales for the Month of ' (1. The name cannot be NONE or DEFAULT. You can specify more than one BEGIN-HEADING section.30) print $month () ! Use 2 lines for ! heading. that is into the body area. Note that the parentheses are required. You must define the toc_name in a DECLARE-TOC paragraph. from the heading. This is used in conjunction with the ALTERREPORT command. The HEADING section defines and controls information to be printed at the top of each page. there can be only one for each report. Specifies the name to be associated with this heading section. If you do not use DECLARE-REPORT. A BEGIN-HEADING section with FOR.TOCS=(ALL) can be specified followed by other BEGIN-HEADING sections for specific Table of Contents. You can also specify FOR-TOCS=(ALL). FOR-TOCS NAME Example begin-heading 2 print $current-date (1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Begins a HEADING section.REPORTS=(ALL) can be specified followed by other BEGIN-HEADING sections for specific reports. Specifies the Table of Contents to which this heading applies. You must define the report_name in a DECLARE-REPORT paragraph. however. If you are writing a program that produces a single report. which override the ALL setting. You can also specify FOR-REPORTS=(ALL). You can specify more than one BEGIN-HEADING section. The DECLARE-LAYOUT command for information about page layout. That is. variables declared within the procedure are available only within the procedure. SQR maintains only one copy of the local variables and they are persistent. In addition.. It modularizes functions and provides standard execution control. unlike C or Pascal. even when the same variable name is used elsewhere in the program. Procedures contain other commands and paragraphs (for example. The procedure name must be unique.. That is. The END-HEADING command. The DECLARE-TOC command for information about Table of Contents. SQL. SELECT. Arguments passed by a DO command to a procedure must match in number: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-27 . variables or columns defined within a procedure are known and can be referenced outside the procedure. The DECLARE-REPORT command for information about programs with multiple reports.1) bold center end-heading See Also The ALTER-REPORT command for information about dynamic headings/footings. A procedure is one of the most powerful parts of the SQR language. DOCUMENT). The name is referenced in DO commands. By default.SQR FOR PEOPLESOFT LANGUAGE REFERENCE end-heading begin-heading 2 for-tocs=(all) print 'Table of Contents' (1. BEGIN-PROCEDURE Syntax BEGIN-PROCEDURE procedure_name [LOCAL|(arg1 [. However. SQR procedure can be called recursively.)] END-PROCEDURE Description Begins a procedure. any query defined in a local procedure will have local database column variable names assigned that do not conflict with similarly named columns defined in queries in other procedures. procedures are global. A procedure is local when the word LOCAL appears after the procedure name or when the procedure is declared with arguments. argi]. or a database dependent format (see the Default Database Formats table). the date string must be in the format specified by the SQR_DB_DATE_FORMAT setting. #. the format listed in the Default Database Formats table is used. (Example: #_amount) Note. Parameters Parameter procedure_name Description Specifies a unique name for this procedure. If this has not been set. INTEGER.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • Database text or date columns. Date variables or columns can be passed to procedure date or string arguments. such as #sql-status and $sql-error. LOCAL 2-28 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . string variables. and numeric literals can be passed to procedure numeric arguments. numeric variables. Database numeric columns. If this has not been set. FLOAT) can be passed to procedure numeric arguments without regard to the argument type of the procedure. For DATE columns the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. All the SQR reserved variables. are global variables. Numeric variables (DECIMAL. When passing a date variable or column to a string argument. the first database-dependent format as listed in the Default Database Formats table. Specifies that this is a local procedure. Within a local procedure. If passing a date string to a date argument. they must be referenced using the leading underscore: #_sql-status or $_sql-error. after the initial $. • • • To reference or declare global variables from a local procedure. For TIME columns the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. or &. SQR automatically converts the numeric values upon entering and leaving the procedure as required. and literals can be passed to procedure string arguments. or the databaseindependent format SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]. If this has not been set. Procedure names are not case-sensitive. add a leading underscore to the variable name. the date is converted to a string according to the following rules: For DATETIME columns and SQR DATE variables SQR uses the format specified by the SQR_DB_DATE_FORMAT setting. the format listed in the TIME Column Formats table is used. Example The following example shows a procedure. 12. and type. No parameters are passed to printlist.+1) (. or date variables ($arg). PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-29 . Description Specifies arguments to be passed to or returned from the procedure.20) $a $b (.. &county_name.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter arg1 [.. $b) print print print $_deptname (+2. end-procedure In the preceding example the value for :#answer is returned to #amount in the calling DO command. argi]. numeric variables (#arg). The arguments of the BEGIN-PROCEDURE and DO commands must match in number. order.. :#answer) . 'OH'. five arguments are passed to the Calc procedure: do Calc (&tax. Arguments can be either string variables ($arg). #months. . $state. main. let #answer = . that also executes the procedure print-list. #amount) begin-procedure Calc(#rate. begin-procedure main begin-select name address phone do print_list from custlist order by name end-select end-procedure ! main In the following example.. $county. place a colon (:) before the variable name. The following example references global variables: begin-procedure print-it ($a. . If you want to return a value passed back to the calling DO command.5. for each row returned from the SELECT statement.+1) ! $deptname is ! declared outside ! this procedure end-procedure See Also The DO and END-PROCEDURE commands. . SQR starts program execution at the BEGIN-PROGRAM section. After processing the commands in the SETUP section. though other commands can be used.argi].. This is the only required section in an SQR program. if any. Example begin-program do startup do main do finish end-program See Also The BEGIN-REPORT. The PROGRAM section typically contains a list of DO commands. and END-PROGRAM command.. BEGIN-SELECT Syntax BEGIN-SELECT[DISTINCT][-Cnn][-Bnn][-XP][-NR][-SORTnn] [-LOCK{RR|CS|RO|RL|XX}][-DBdatabase] [-DBconnectionstring] [LOOPS=nn][ON-ERROR=procedure[(arg1[..SQR FOR PEOPLESOFT LANGUAGE REFERENCE BEGIN-PROGRAM Syntax BEGIN-PROGRAM END-PROGRAM Description Begins the program section of an SQR program.)]] {column} [&synonym] {expression &synonym} {[$columnname] &synonym = (char | number | date)} [SQR commands] FROM {table.. BEGIN-SETUP.|[table:$tablename]} [additional SQL] [$variable] END-SELECT 2-30 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Oracle.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Begins a SELECT paragraph. is 10 rows. An overall setting for a program can be indicated on the SQR command line with -B. The default. however. Otherwise.SELECT can be placed inside a BEGIN-PROGRAM section. (ODBC. The arguments can span multiple lines. do not use the first character position unless the continuation character terminated the previous line. all rows are selected. this option is rarely needed. Parameters Note. without using -B. A SELECT paragraph must be inside a PROCEDURE or BEGIN-PROGRAM section. Note that SELECT * FROM is not a valid SQR SQL statement. which can be overridden by a separate -B flag on each BEGIN-SELECT command. SQLBase) Sets the context area size (buffer size for query) to larger or smaller than the default. BEGIN. Parameter DISTINCT Description Specifies that you want to eliminate duplicate rows from your query. -Cnn -Bnn PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-31 . (Ingres. This is for performance purposes only. Oracle. SYBASE CT-Lib) Sets the number of rows to retrieve at one time. the argument will be misconstrued as a SELECT column. Regardless of this setting. A SELECT paragraph is the principal means of retrieving data from the database and printing it in a report. If the dynamic query variable changes often and the query contains bind variables. This disables the potential performance optimization created by stored procedures. a new stored procedure is created. if you do not change variables frequently during execution. Note also that -XP is available as a command-line flag. However. You can also use -XP if the username/password to your program does not have permission to create stored procedures. -SORTnn -LOCK -DBdatabase 2-32 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Each time the dynamic query variable changes in value. -NR (SQLBase) Specifies that No Recovery mode is to be used when connecting to the database for this SELECT paragraph. (SQLBase) Specifies the size of the sort buffer in characters. In that case. If you change the variables frequently during execution and you do not want SQR to automatically create stored procedure. the use of stored procedures may optimize your program's performance. When -XP is specified. SQR generates a new SQL statement using the current value of any bind variables each time the BEGIN-SELECT is executed. (SQLBase) Defines the types of locking (isolation level) for the session. you create many stored procedures if you do not use XP. See the SQLBase documentation for a full explanation of the different isolation levels. do not use this argument. -XP improves performance when you use bind variables and dynamic query variables in the same query. Use XX to inhibit setting the default level (RR). use this flag. (SQLBase) Specifies the default database name for this SELECT paragraph only.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter -XP Description (SYBASE) Prevents the creation of a stored procedure for the SELECT paragraph. After the specified number has been processed.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter -DBconnectionstring Description (ODBC) Specifies the ODBC connection string for this SELECT paragraph only. column.30) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-33 .). and zip columns because of the "distinct" keyword.UID=scott. See "Column Variables" on in the SQR for PeopleSoft Developer's Guide. UID. and Zip define the column positions of these rows.. Connection string options are always separated by a semicolon (. LOOPS Specifies the number of rows to retrieve. Declares a procedure to execute if an error occurs due to incorrect SQL syntax. Other driver-specific options may be added to the connection string using driverdefined keywords. A connection string has the following syntax: DSN=data_source_name[. the SELECT loop exits. The numbers within parentheses accompanying City. and password. Column names can not have spaces in front of them. a connection string for an Oracle database named "ora8" might look like the following: 'DSN=ora7. You can optionally specify arguments to be passed to the ON-ERROR procedure. respectively). user ID.keyword=value[. See your ODBC driver documentation for available options. or literal.1. begin-select distinct city (1. State. state. ON-ERROR Example In this example.]]] This option enables you to combine data from multiple databases in one program. Arguments can be any variable. SELECT paragraphs without dynamic variables are checked for errors before the program is processed and therefore do not require a special error procedure.keywo rd=value [. and PWD are keywords common to all drivers (representing: name.. For example. duplicate rows are not selected for the city.. Error trapping should be used in conjunction with dynamic query variables.PWD=tiger' where DSN. ” The END-SELECT and EXIT-SELECT commands. This section is optional. The commands used in the SETUP section cannot be used elsewhere unless specified. A runtime error is produced if the database table.) CREATE-ARRAY 2-34 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . BEGIN-SETUP Syntax BEGIN-SETUP END-SETUP Description Begins a SETUP section. the first two columns may. be present when the statement is compiled. BEGIN-HEADING. but if included. The column cust_id is declared to be a number.+2. The SETUP section should be the first section in the program. begin-select [$col_var_char] [$col_var_num] cust_id from [$table_name] [$where clause] [$order_by_clause] end-select loops=100 &col1=char &col2=number &id=number See Also SQR for PeopleSoft Developer's Guide.2) (1. and BEGIN-FOOTING section. as identified by the variable $table_name. it is processed prior to the BEGIN-PROGRAM.6) from custlist order by city In this example. declares it to be something other than a number. The SETUP section can include the following commands: ASK BEGIN-SQL (This command can also be used in BEGIN-PROCEDURE paragraphs. “Selecting Data From the Database” and “Dynamic SQL and Error Checking. The SETUP section contains commands that determine the overall characteristics of the program.SQR FOR PEOPLESOFT LANGUAGE REFERENCE state zip end-select (0.+3. or may not. BEGIN-SQL.) DECLARE-CHART DECLARE-IMAGE DECLARE-LAYOUT DECLARE-PRINTER DECLARE-PROCEDURE DECLARE-REPORT DECLARE-VARIABLE (This command can also be used in LOCAL procedures.0 end-declare end-setup See Also The ASK.0 right-margin=1.) DECLARE-TOC LOAD-LOOKUP (This command can also be used in the other sections of an SQR program. 11) left-margin=1. BEGIN-SQL Syntax BEGIN-SQL[-Cnn][-XP][-NR][-SORTnn] [-LOCK{RR|CS|RO|RL|XX}] [-DBdatabase][-DBconnectionstring] [ON-ERROR=procedure[(arg1[. and USE commands. CREATE-ARRAY.SQR FOR PEOPLESOFT LANGUAGE REFERENCE (This command can also be used in the other sections of an SQR program.. LOAD-LOOKUP.argi].)](non-setup) |[ON-ERROR={STOP|WARN|SKIP}](insetup) END-SQL PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-35 .) USE (SYBASE and Microsoft SQL Server only) Example begin-setup declare-layout customer_list paper-size=(8..5. Columns and variables can be referenced in the SQL statements.56...SQL paragraph causes a commit of outstanding inserts. SYBASE. end-sql For Oracle stored procedures: begin-sql begin #dept_number :=get_dept_no($dept_name). BEGIN-SETUP.. #v :=var2. or BEGIN-PROGRAM section. begin varpl :='abcdefg'. the last must be terminated by a semicolon (. stored procedures are implemented using PL/SQL in the BEGIN-SQL paragraph.. For some databases such as ORACLE. var2 number (8. $v2 :='1230894asd'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Begins an SQL paragraph. which has its own BEGIN-SELECT paragraph. $v1 :=varpl. See the following Oracle example. For Oracle PL/SQL: begin-sql declare varpl varchar2 (25). Only non-SELECT statements can be used (except SELECT INTO for SYBASE and Microsoft SQL Server). For this reason. each statement except. This requires an additional semicolon at the end of each PL/SQL statement. and the -C flag is used. all are assigned the same context area size or logical connection number. using DDL statements within a BEGIN.2).. For Oracle. updates.... 2-36 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . of course. and Microsoft SQL Server. PL/SQL is supported in a BEGIN-SQL paragraph. If a single paragraph contains more than one SQL statement. ensure that these are done in the proper order or unpredictable results may occur. BEGIN-SQL starts all SQL statements except SELECT. Stored Procedures For Ingres. and deletes and releases cursors. This paragraph can reside in a BEGIN-PROCEDURE. Oracle PL/SQL For Oracle. If a single paragraph contains more than one SQL statement. var2 :=1234.. SQR supports stored procedures with the EXECUTE command. end.). . this option is rarely needed. However. This disables the performance optimization created by stored procedures. use this flag. See the SQLBase documentation for a full explanation of the different isolation levels. SQR generates a new SQL statement using the current value of the bind variables each time the BEGIN-SQL is executed. When -XP is specified. Each time the dynamic query variable changes in value. In that case. Oracle. SQLBase) Sets the context area size (buffer size for query) to larger or smaller than the default. you create many stored procedures if you do not use XP. the use of stored procedures optimizes the performance of the program. a new stored procedure is created.SQR FOR PEOPLESOFT LANGUAGE REFERENCE end. do not use this argument. -XP -NR (SQLBase) Specifies that No Recovery mode is to be used when connecting to the database for this SQL paragraph. If you change the variables frequently during execution and you do not want SQR to automatically create stored procedures. (SYBASE) Prevents the creation of a stored procedure for the SQL paragraph. (SQLBase) Specifies the size of the sort buffer in characters. You may also use it if your program does not have permission to create stored procedures. If the dynamic query variable changes often and the query contains bind variables. if you do not change variables frequently during execution. end-sql Parameters Parameter -Cnn Description (Ingres. (SQLBase) Defines the types of locking (isolation level) for this SQL paragraph. (SQLBase) Specifies the default database name for this SQL paragraph only. Use XX to inhibit setting the default level (RR). -SORTnn -LOCK -DBdatabase PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-37 . -XP improves performance when you use bind variables and dynamic query variables in the same query. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter -DBconnectionstring Description (ODBC) Specifies the ODBC connection string for this SQL paragraph only. respectively). user ID. and PWD are keywords common to all drivers (representing name. Connection string options are always separated by a semicolon (.PWD=tiger' where DSN.keyword=valu e[. a connection string for an Oracle named "ora8" might look like the following: 'DSN=ora8. If it is not specified. the default connection is used. Other driver-specific options may be added to the connection string using driverdefined keywords. UID. and password.. For example. Connection=connstr This option is used with SQR for DDO. See your ODBC driver documentation for available options..UID=scott.]]] This option enables you to combine data from multiple databases in one program. A connection string has the following syntax: DSN=data_source_name[. It specifies the name of a datasource previously declared using the DECLARE-CONNECTION construct. 2-38 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .)..keyword=value[. control returns to the next SQL statement. insert into orders values ($customer_name.” The END-SQL. The procedure is invoked when an error occurs in any SQL statement in the paragraph. column. or literal. SQR reports any error and then halts. “Dynamic SQL and Error Checking” and “ Using DML and DDL.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter ON-ERROR Description Declares a procedure to execute if an error occurs due to incorrect SQL syntax except when executed in a BEGIN-SETUP section. you can trap errors. SKIP Ignore any errors and run the program. report or log them. You can optionally specify arguments to be passed to the ON-ERROR procedure. if an error procedure is declared. WARN Run the program but with a warning message. If ON-ERROR is used in the SETUP section. After the error procedure ends. it is a condition flag supporting the following conditions: STOP Do not run the program. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-39 . if any. BEGIN-PROCEDURE. Example begin-sql update orders set invoice_num = #next_invoice_num where order_num = &order_num end-sql begin sql delete orders where order_num = &order_num..) end-sql See Also SQR for PeopleSoft Developer's Guide.. and continue processing.. The -S command-line flag. and EXECUTE commands. Arguments can be any variable. By default. #order_num. END-WHILE loop or within an EVALUATE command. See Also The WHILE and EVALUATE commands. This command is used inside a WHILE . CALL. Its arguments. Warning! PeopleSoft recommends that the ucall function not use any database calls as it may cause erroneous results. CALL has the following format: CALL your_sub USING source destination [param_literal] CALL SYSTEM USING command status [WAIT|NOWAIT] The CALL SYSTEM is a special subroutine which is provided as part of SQR to enable the program to issue operating system commands. and WAIT|NOWAIT are described previously.. CALL SYSTEM Syntax CALL subroutine USING {src_txt_lit|_var|_col}|{ src_num_lit|_var|_col} {dst_txt_var|_num_var} [param] To issue operating system commands from within an SQR program. Used in an SQR program. 2-40 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . status.SQR FOR PEOPLESOFT LANGUAGE REFERENCE BREAK Syntax BREAK Description Causes an exit from within an EVALUATE or WHILE command. command. Execution then continues to the command immediately following the END-WHILE or END-EVALUATE. You can write your own subroutines to perform tasks that are awkward in SQR. use the following syntax: CALL SYSTEM USING command status [ WAIT | NOWAIT ] Description Issues an operating system command or calls a subroutine that you have written in another language such as C or COBOL and passes the specified parameters.. Subroutines can be written in any language. SQR FOR PEOPLESOFT LANGUAGE REFERENCE The values of the source and destination variables and the parameter's literal value are passed to your subroutine. Destination double floating point. add a reference to it in UCALL. Return values are placed into strdes or dbldes depending on whether your destination argument for CALL is a string or numeric variable. By reference with a maximum of 31 characters. a value is placed in the destination variable. The ucall function takes the following arguments: Argument Description How Passed callname strsrc strdes dblsrc dbldes param Name of the subroutine. Upon return from the subroutine. (Alternatively. You must add your subroutine to the link command file—in UNIX it is called SQRMAKE. null terminated. By reference with a maximum of 255 characters. You must relink SQR to CALL after compiling a user defined function that becomes another SQR function. (Optionally. No checking is performed. Source double floating point. By reference. By reference.MAK—if you have created a new object file. null terminated.C contains sample subroutines written in C. It must be a literal. null terminated. your arguments are processed as follows: • • Calling arguments are copied into the variables depending on the type of argument. you could rewrite ucall in another language instead). You must write the subroutine and call it in one of the supplied ucall routines. Your subroutine and calling SQR program are responsible for passing the correct string or numeric variables and optional parameter string to the subroutine. The source file UCALL. you could add your routine to the bottom of the UCALL source module that is already included in the link). passing along the arguments you need. in NT it is called SQREXT. To access your subroutine. Destination string. Strings are placed into strsrc. When you use the CALL command. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-41 . By reference with a maximum of 80 characters. Subroutine parameter string. The destination arguments can also be used to pass values to your subroutine. By reference with a maximum of 255 characters. and numerics are placed into dblsrc. Source string. variable (decimal. A value less than 32 indicates an error. See the "UCALL Subroutine Arguments" table for more information. float. the DCL $STATUS value). The status must be a numeric variable. or literal that is to be input to the called subroutine. Contains the status returned by the operating system. or integer) into which the called subroutine is to place the return result. variable. Specifies a numeric column. Specifies a text or numeric variable (decimal. string variable. 2-42 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . If the SPAWNing of the subordinate DCL session is successful.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter subroutine src_txt_lit|_var|_col Description Specifies the name of your subroutine. or column. The value returned in status is system-dependent as shown in the following table. Any other value is the system error code. The command can be a quoted string. src_num_lit|_var|_col dst_txt_var|_num_var param Specifies an optional alphanumeric string of characters to be passed as a parameter to the subroutine. Specifies a text column. or integer). then the value returned is the status back from the DCL session (for example. Specifies that this CALL command issues an operating system command. float. Specifies the operating system command to execute. or literal which is to be input to the called subroutine. and UNIX PC/Windows VAX/VMS Zero (0) indicates success. SYSTEM command status System Value Returned OS/2. If the SPAWNing of the subordinate DCL session is unsuccessful the failing status from the LIB$SPAWN function is returned. For Windows. Some operating systems let you invoke a secondary command processor to enter one or more commands and then return to SQR.'. ! VAX/VMS ! call system using 'spawn' #vms_status ! Unix ! let $shell = getenv('SHELL') if isblank($shell) let $shell = '/bin/sh' end-if (Type 'exit' to return to SQR) (Type 'logout' to return to SQR) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-43 . ! Convert these to ! dashes call sqroot using #n #n2 ! Put square root of ! #n into #n2 call sqroot using &hnvr #j ! Hnvr is numeric ! database column call system using 'dir' #s ! Get directory listing The following example uses the SYSTEM argument to issue an operating system command.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter WAIT|NOWAIT Description (Windows and VMS only) . the default is NOWAIT. For VMS. SYSTEM invokes a secondary command processor.WAIT specifies that SQR suspend its execution until the CALL SYSTEM command has finished processing. the default is WAIT. Example See these sample subroutines included in the UCALL source file: • • • TODASH shows how strings can be manipulated. The following code calls these subroutines: call todash using $addr $newaddr '/. NOWAIT specifies that SQR start the CALL SYSTEM command but continue its own processing while that command is in progress. On UNIX operating systems the behavior is always WAIT. SQROOT demonstrates how to access numerics. add "else if. strdes). static void initcap CC_ARGL((strsrc. The function accepts two parameters. Add the prototype for the initcap function: static void initcap CC_ARGS((char *. /* If other subroutines. else sq999("Unknown CALLed subroutine: return. strdes)) CC_ARG(char *."initcap") == 0) initcap(strsrc. dbldes. dblsrc.. callname).SQR FOR PEOPLESOFT LANGUAGE REFERENCE call system using $shell #unix_status !Windows 98/NT (Type 'exit' to return to SQR) ! let $comspec = getenv('COMSPEC') let $cmd = comspec || '/c' ||$comspec || ' /k' call system using $cmd #win_status wait The following step-by-step example shows how to add a user-defined subroutine to SQR so that it can be invoked from SQR using the CALL command. char cChar. Specifically. Modify the ucall routine in the UCALL. The routine name must be lowercase.c file. params)) . strdes) string */ { int nIndex. To add initcap function to SQR." statement for each */ else if (strcmp(callname. which makes the first letter of a string uppercase. which was provided with SQR: 1.C file. int nToUpCase. the C function initcap. however. strsrc. add the initcap routine listed in the following example.. } %s\n".C file. strdes.. At the end of the ucall. is added. The first parameter is the string to which the initcap function is applied. in your SQR program it can be referenced either uppercase or lowercase. 3. The second is the resultant string.. For this example. /* Pointer to source /* Pointer to destination 2-44 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 2. char *)). strsrc) string */ CC_LARG(char *. add an else if statement at the end of the if statement to check for the initcap function: void ucall CC_ARGL((callname. the following modifications are needed to the UCALL. } else { nToUpCase = 1. the following is an example of a simple SQR program which uses the initcap function: begin-program input $name 'Enter the first name '! Get the first name ! from the user lowercase $name name to ! Set the first ! all lower case call initcap using $name $capname ! Now set the first ! character to upper case input $last 'Enter the last name ' ! Get the last name from the ! user lowercase $last name to all ! Set the last PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-45 . nToUpCase = 0. nIndex++) { if (isalnum(cChar)) { if (nToUpCase) strdes[nIndex] = islower(cChar) ? toupper(cChar) : cChar. cChar = strsrc[nIndex]. else strdes[nIndex] = isupper(cChar) ? tolower(cChar) : cChar. for (nIndex = 0. } } strdes[nIndex] = '\0'. strdes[nIndex] = cChar. recompile UCALL. Finally.C source module. The macros give the programmer the ability to define a fully prototyped function without having to worry if the C compiler supports the feature.C and relink SQR. The CC_ARG macros are defined in the UCALL. After these modifications.SQR FOR PEOPLESOFT LANGUAGE REFERENCE nToUpCase = 1. See the programming manual for your particular machine for details. } Note. numeric fields are reset to zero.c that can be used in the context of an expression and that can pass and/or return any number of arguments. CLEAR-ARRAY Syntax CLEAR-ARRAY NAME=array_name Description Resets each field of an array to its initial value. If no initial value was specified. . Parameters Parameter NAME Description Specifies the name of the array to be cleared. The CLEAR-ARRAY command resets each field of the named array to the initial value specified for that field in the CREATE-ARRAY command. text fields are reset to null. . and date fields are reset to null. CLEAR-ARRAY also releases all memory used by the specified array and returns it to its pristine state.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ! lower case call initcap using $last $caplast ! Now set the first ! character to upper case . CLOSE Syntax CLOSE {filenum_lit|_var_col} 2-46 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . See Also The LET command for information about user-defined functions using ufunc. Example clear-array name=custs See Also The CREATE-ARRAY command. Example close 5 close #j See Also The OPEN. The COLUMNS command applies only to the current report. you must specify the COLUMNS command for each report. If you want to print columns in more than one report. It sets the first column as current. depending on how you use the NEXT-COLUMN and USE-COLUMN commands.. READ. Parameters Parameter filenum_lit|_var_col Description Specifies the number assigned to the file in the OPEN command. COLUMNS can be used for printing data either down the page or across the page. COLUMNS defines the left-most position of one or more columns within the current page layout. specified by its file number. Description Defines logical columns to be used for PRINT commands. Closes a flat file that has been previously opened using the OPEN command. and WRITE commands. The USE-COLUMN 0 turns off columns.. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-47 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Closes a file. COLUMNS Syntax COLUMNS {int_lit|_var|_col}[int_lit|_var|_col]. See USE-COLUMN. Parameters Parameter int_lit|_var|_col Description Specifies the left margin position of each column. When the application completes. Used with some databases. unpredictable errors can occur. or deleted. ORACLE. updates. &update_date) end-sql ! Begin Transaction occurred previously 2-48 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . For SYBASE and Microsoft SQL Server. for callable SQR.SQR FOR PEOPLESOFT LANGUAGE REFERENCE See Also The NEXT-COLUMN. COMMIT is an SQR command and should not be used within an SQL paragraph. For this reason. ODBC. NEXT-LISTING. Example add 1 to #updates_done if #updates_done > 50 commit move 0 to #updates_done end-if For SYBASE: . COMMIT Syntax COMMIT Description Causes a database commit. can also cause the database to do a commit. A database commit releases the locks on the records that have been inserted. NEW-PAGE. and USE-REPORT commands. begin-sql insert into custlog values (&cust_num. updated. Other commands or options. use BEGIN TRANSACTION and COMMIT TRANSACTION within SQL paragraphs as in the following code segment. If used in an SQL paragraph. The COMMIT command can be used with SQR servers for DB2. a commit is performed automatically unless a ROLLBACK was done or. Informix.. USE-COLUMN. it should not be used within the scope of an active SELECT paragraph or unpredictable results may occur. COMMIT is useful when you are doing many inserts. it also has other effects.. and SQLBase. or deletes in an SQL paragraph. such as the CONNECT command and the use of DDL statements for some databases with a BEGIN-SQL paragraph. the -XC flag was set. Ingres. Note. the format specified by the SQR_DB_DATE_FORMAT setting. the first databasedependent format as listed in the Default Database Formats table is used. Edit masks can be changed dynamically by placing them in a string variable and referencing the variable name preceded by a colon (:). rows begin transaction transaction end-sql move 0 to #inserts end-if . • PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-49 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE add 1 to #inserts if #inserts >= 50 begin-sql commit transaction. If this has not been set. ! One more Commit Transaction is needed ! Begin next ! Commit every 50 Warning! Any data being changed by a current transaction is locked by the database and cannot be retrieved in a SELECT paragraph until the transaction is completed by a COMMIT or ROLLBACK statement (or COMMIT TRANSACTION or ROLLBACK TRANSACTION statement for SYBASE or Microsoft SQL Server). the format listed in the Default Database Formats table is used. "PRINT" for information about the use of edit masks. or literal with a string variable. If an edit mask is not specified. CONCAT Syntax CONCAT {src_any_lit|_var|_col} WITH dst_txt_var[[:$]edit_mask] Description Concatenates a variable. If this has not been set. the source can be a date variable or column. The contents of the source field are appended to the end of the destination field.. Also. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. For DATE columns. See the command. column. CONCAT can optionally edit the source field before appending it. the date is converted to a string according to the following rules: • For DATETIME columns and SQR DATE variables.. the format as listed in the TIME Column Formats table is used. column.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • For TIME columns.. 2-50 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .)]] Description Logs off the database and logs on under a new username and password. CONNECT Syntax CONNECT {txt_lit|_var|_col}[ON-ERROR=procedure[(arg1 [. concat $date1 with $string Concatenate a date. dst_txt_var edit_mask Example concat &zip_plus_4 with $zip '-xxxx' concat &descrip with $rec :$desc_edit variable. Parameters Parameter src_any_lit|_var|_col Description Specifies the source field to be concatenated with the dst_txt_var field. ! Edit zip plus 4. argi]. Specifies an optional edit mask. or literal. If this has not been set. Contains the result after execution. ! Edit mask in ! See Also The PRINT command for information about edit masks. Warning! The username/password is not encrypted. so beware of security issues. All database cursors or logons are closed before the CONNECT occurs. The new username and password can be stored in a string variable. You should not issue a CONNECT within a SELECT or an SQL paragraph while a query is actively fetching or manipulating data from the database. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. The LET command for string functions.. the reserved variable $username is set to the new username. After each CONNECT. The STRING and UNSTRING commands. store it in an array. a summary could be printed followed by the data previously stored in the array. For example. and gather statistics at the same time. You can optionally specify arguments to be passed to the ON-ERROR procedure. column. If no ON-ERROR procedure is specified and the logon fails. a SELECT paragraph can retrieve data.. The CREATE-ARRAY command can be used in any section of a program. You can define arrays to store intermediate results or data retrieved from the database. Arguments can be any variable. When the query finishes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter txt_lit|_var|_col ON-ERROR Description Specifies a username and password for the logon. or literal. Description Creates an array of fields to store and process data. Note.. SQR creates arrays before a program starts to execute. Specifies a procedure to be executed if the logon fails. Commands to process arrays include the following: CREATE-ARRAY CLEAR-ARRAY GET PUT ARRAY-ADD ARRAY-SUBTRACT ARRAY-MULTIPLY ARRAY-DIVIDE LET PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-51 . Example connect connect $new-user 'sqr/test' on-error=bad-logon($new_user) CREATE-ARRAY Syntax CREATE-ARRAY NAME=array_name SIZE=nn {FIELD=name:type[:occurs] [={init_value_txt_lit|_num_lit}]}. SQR halts with an error message. Defines the number of elements in the array. Sample array Parameters Parameter NAME Description Names the array. SIZE 2-52 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . All name fields are initialized to "Unknown". and all rate fields are initialized to 10. The emps array will contain 10 elements. The rate is referenced by rate(0) or rate(1). The name is referenced in other array commands. and phone is a simple field. Both array elements and field occurrences are referenced beginning with zero (0). The following CREATE-ARRAY command defines the array: create-array name=emps size=10 field=name:char='Unknown' field=rate:number:2=10. all phone fields are initialized to "None". rate has two occurrences.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The maximum number of arrays in a program is 128. Figure is a representation of an array emps with three fields. the maximum number of fields per array is 200. 0 through 9.50.50 field=phone:char='None' The name is a simple field (one occurrence). If no initialization value is specified. that is. You can specify an initialization value for each field. they can be repeated any number of times. INTEGER Whole numbers. DATE Same as date variable. For dates. All occurrences of a multiply occurring field are set to the same value. See the Date Edit Format Codes table for a description of the format codes. Example create-array name=custs size=100 field=name:char field=no:number field=state:char field=zip:char field=contacts:char:5 field=last-contacted:date PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-53 . NUMBER Uses the DEFAULT-NUMERIC type. character fields are set to null.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter FIELD Description Defines each field or column in the array. OCCURS Fields can optionally have a number of occurrences (occurs ). FLOAT. INTEGER) are set to zero. FLOAT Double precision floating point numbers. CHAR (or TEXT) Character string. the initialization string must be formatted as 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'. See the DECLARE-VARIABLE command. Each field is set to this value when the array is created and when the CLEAR-ARRAY command is executed. Each field must be defined as type: DECIMAL[(p)] Decimal numbers with an optional precision (p). and date fields are set to null. numeric fields (DECIMAL. g. ARRAY-SUBTRACT. Parameters Parameter NAME COLOR_1 COLOR_2 COLOR_n Description Specifies the name of the color palette. The DECLARE-VARIABLE. This can be expressed as (r.SQR FOR PEOPLESOFT LANGUAGE REFERENCE See Also The sample report CUSTOMR4. a numeric variable. PUT. No gaps are permitted in the palette. ARRAY-DIVIDE.b) where r. ARRAY-ADD. Specifies the first color in the palette. There is no limit to the number of palettes that can be defined in a program. and b are either a numeric literal (0 to 255). LET. This command enables you to create a palette of colors. ARRAY-MULTIPLY. Specifies the n'th color in the palette. or variable that is the name of a color. CREATE-COLOR-PALETTE Syntax CREATE-COLOR-PALETTE NAME = {palette_name_txt_lit} COLOR_1 = {rgb_value} COLOR_2 = {rgb_value} [COLOR_n] = {rgb_value} Description Create a color palette. GET.SQR included with SQR. Specifies the second color in the palette. It can also be expressed as a (c) where c is a string literal. or a numeric column.ARRAY commands. and CLEAR. {rgb} Example begin-report create-color-palette name = 'funky' color_1 = ('blue') color_2 = ('red') color_3 = ('orange') 2-54 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . column. Designates a color reference. You can specify up to 64 colors in the palette.g. The LOAD-LOOKUP command for an alternative way to store database tables in memory. . and debugb. for each -DEBUGxx letter. When this flag is used. any command (including other compiler directives) preceded by the word #DEBUG is processed. debuga. a substitution variable is defined. other commands are ignored. three substitution variables are defined: debug. This is useful for placing DISPLAY.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Print-Chart Groovy Color-Palette = 'Funky' end-report See Also The DECLARE-CHART command. PRINT or other commands in your program for testing and for deactivating them when the report goes into production. #DEBUG Syntax #DEBUG[x. The PRINT-CHART command. SHOW. These characters are used to match any letters or digits appended to the #DEBUG preprocess command inside the program. These variables can be referenced in #IFDEF commands to turn whole sections of code on or off for debugging.]SQR_Command Description Causes the current command to be processed during a debugging session. Example The following SQR command line contains the -DEBUG flag with no suffixes: sqr myprog sammy/baker -debug PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-55 . In addition. if the flag -DEBUGab is used on the command line.. Commands without any suffix always match. Parameters Parameter x Description Is any letter or digit. other commands are ignored. The -DEBUG flag can contain a suffix up to 10 letters or digits. For example. #DEBUG commands with one or more matching suffix characters are processed. A -DEBUG[xx] flag in the SQR command line enables conditional compilation of SQR commands. but the fourth...SQR FOR PEOPLESOFT LANGUAGE REFERENCE The following SHOW command in the program executes if invoked with the previous command line because the -DEBUG flag was used: #debug show 'The total is ' #grand-tot 999.999 In the following example.chart_depth_int_lit)] [TITLE=title_txt_lit] [SUB-TITLE=subtitle_txt_lit] [FILL=fill_lit] [3D-EFFECTS=3d_effects_lit] [BORDER=border_lit] [POINT-MARKERS=point_markers_lit] [TYPE=chart_type_lit] [LEGEND=legend_lit] 2-56 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . DECLARE-CHART Syntax DECLARE-CHART chart_name [DATA-LABELS=data_labels_lit] [COLOR-PALETTE=color_palette_lit] [ITEM-COLOR=(chart_item_keyword_lit. and c: sqr myprog sammy/baker -debugabc In the following program segment. and #IFNDEF commands.' show 'Deleting row.' The following example shows the use of an #IF with a #DEBUG: #debuga #debuga #debuga #if {platform}='unix' show 'Platform is UNIX' #endif See Also The #IF. the command line contains the -DEBUG flag with the suffixes a.' show 'Finished query. beginning "#debuge". b. color_value_lit |(r. the first three #DEBUG commands are compiled. is not because its suffix does not match any of the suffixes on the -DEBUG flag: #debuga #debug #debugb #debuge show 'Now selecting rows. #IFDEF.' show 'Inserting new row.b)] [CHART-SIZE=(chart_width_int_lit.999.g. SQR FOR PEOPLESOFT LANGUAGE REFERENCE [LEGEND-TITLE=legend_title_txt_lit] [LEGEND-PLACEMENT=legend_placement_lit] [LEGEND-PRESENTATION=legend_presentation_lit] [PIE-SEGMENT-QUANTITY-DISPLAY= pie_segement_quantity_display_lit] [PIE-SEGMENT-PERCENT-DISPLAY= pie_segement_percent_display_lit] [PIE-SEGMENT-EXPLODE=pie_segement_explode_lit] [X-AXIS-LABEL=x_axis_label_txt_lit] [X-AXIS-MIN-VALUE={x_axis_min_value_lit|_num_lit}] [X-AXIS-MAX-VALUE={x_axis_max_value_lit|_num_lit}] [X-AXIS-SCALE=x_axis_scale_lit] [X-AXIS-MAJOR-TICK-MARKS=x_axis_major_tick_marks_lit] [X-AXIS-MINOR-TICK-MARKS=x_axis_minor_tick_marks_lit] [X-AXIS-MAJOR-INCREMENT= {x_axis_major_increment_lit|_num_lit}] [X-AXIS-MINOR-INCREMENT= x_axis_minor_increment_num_lit] [X-AXIS-TICK-MARK-PLACEMENT= x_axis_tick_mark_placement_lit] [X-AXIS-GRID=x_axis_grid_lit] [Y-AXIS-LABEL=y_axis_label_lit] [Y-AXIS-MIN-VALUE={y_axis_min_value_lit|_num_lit}] [Y-AXIS-MAX-VALUE={y_axis_max_value_lit|_num_lit}] [Y-AXIS-SCALE=y_axis_scale_lit] [Y-AXIS-MAJOR-TICK-MARKS=y_axis_major_tick_marks_lit] [Y-AXIS-MINOR-TICK-MARKS=y_axis_minor_tick_marks_lit] [Y-AXIS-MAJOR-INCREMENT= {y_axis_major_increment_lit|_num_lit}] [Y-AXIS-MINOR-INCREMENT= y_axis_minor_increment_num_lit] [Y-AXIS-TICK-MARK-PLACEMENT= y_axis_tick_mark_placement_lit] [Y-AXIS-GRID=y_axis_grid_lit] END-DECLARE Note. This command may only appear in the SETUP section. it must be defined in PRINT-CHART. Description Defines the attributes of a chart that can later be displayed using PRINT-CHART. The DECLARE-CHART command can define the attributes of a chart to be printed as part of a report. A chart defined using DECLARE-CHART is printed by referencing its name in the PRINT-CHART command. If CHART-SIZE is not defined. Some or all of the chart attributes may be overridden at runtime PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-57 . 0) Users can specify any number of palettes.238) Color_2 = (0.0. DECLARE-CHART is useful when the basic properties of a chart are common to many PRINT-CHART commands. If there are more data points in the data sets than defines colors in the palette.FILL options. All DECLARE-CHART attributes can be overridden as part of the PRINT-CHART command. 255) Color_3 = (0. 0.PALETTE command. The following code demonstrates the use of a color palette: Print-Chart test_Chart COLOR-PALETTE = 'Test-Palette' 2-58 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The following code demonstrates how to create the color palette: Create-Color-Palette Name = 'Test-Palette' Color_1 = (100. After a color palette has been defined. the palette resets and continues to set the data point colors from Color_1 to Color_n. Note.COLOR and CHART.COL OR=N GRAYSCALE COLOR CROSSHATCH NONE GRAYSCALE COLOR COLOR-CROSSHATCH NONE GRAYSCALE GRAYSCALE CROSSHATCH NONE Specifying Chart Data Series Colors Color palettes are used in the New Graphics to set the colors of each data point in a data series.SQR FOR PEOPLESOFT LANGUAGE REFERENCE with the PRINT-CHART command. CHART.COLO R=Y PRINTER. it can be used within the DECLARE.CHART and PRINT-CHART commands to specify the color palette to be used. the FILL specification in the DECLARE-PRINTER command can influence the appearance of the chart. Attributes can be used in any order.FI LL= PRINTER. Specifying the color palette to be used in a Business Chart is done by creating a SQR COLOR-PALETTE using the CREATE-COLOR. As such. and the first instance is regarded as the actual value. with the exception of chart-name. The following table lists the final appearance of the chart with a combination of values for PRINTER. Columns are not supported within the DECLARE-CHART command or the PRINT-CHART command.133. Also.0) Color_4 = (0.0. with up to 64 colors defined in each palette. which must follow the DECLARE-CHART keyword.255) Color_5 = (0. Attributes that are specified more than once produce a warning.255. The following is a list of chart item keywords that are valid for ITEM-COLOR: • • • • • • • • • • • • ChartBackground .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note.Area within the text box specified for the X Axis label FooterForeground . This is a requirement of the New Graphics. Specifying Chart Item Colors Users can specify the foreground and background colors of the individual areas within a Business Chart using ITEM-COLOR = (rgb-value) within the DECLARE-CHART and PRINT-CHART commands. For now. either local or remote. The size of the chart frame in standard SQR coordinate units. SQR for UNIX requires a x-windows server running when NewGraphics=TRUE. because there is currently no method to run Java-based graphics on a UNIX system without a graphic display.Area within the X and Y Axis of a chart PlotAreaForeground . The default values are underlined.Text color of the X Axis label LegendBackground .Text color of the Title and Subtitle FooterBackground .Area within the box defining the legend LegendForeground . PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-59 .Area that includes the body of the chart ChartAreaForeground .Text and Line color of chart area HeaderBackground . The following DECLARE-CHART Command Arguments table describes other arguments for the DECLARE-CHART command.Text and outline color of the legend ChartAreaBackground .Text and line colors of the chart area PlotAreaBackground .Background color of entire chart area ChartForeground .Area within the text box specified for the Title and SubTitle HeaderForeground .Text and line colors of the plot area Parameters Parameter chart_name CHART-SIZE Description A unique name to be used for referencing a chart. A valid SQR colorpalette must be defined to use COLOR-PALETTE. then it could appear in a GRAYSCALE fashion. piesegments.) that represent the data loaded in the chart. If YES. no numeric values are displayed. If NO. Specifies a subtitle for the chart. NewGraphics—Sets the color palette to be used to color the individual data points in each chart (example: Bar. FILL GRAYSCALE | COLOR | CROSSHATCH | NONE 3D-EFFECTS YES | NO BORDER YES | NO 2-60 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . point).g. CROSSHATCH uses patterns to fill the shapes representing each data set. SQR prints the numeric value above the individual data points. all graph shapes are filled with white. GRAYSCALE varies the density of black dots.b) color to set the color of the chart item. NewGraphics—Set to color an individual item in a chart. the chart is displayed in the default 2D mode. then a border is drawn around the chart. COLOR sends color instructions to the current printer. 3D-EFFECTS gives your chart depth if set to YES. slice. and so on. then no border is displayed around the chart. Specify a chart item and a valid (r. If set to NO. If the current printer does not support color. Specifies the type of filling that is applied to the shapes (bars. That text is placed below the title regardless of whether TITLE is specified.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choices Description DATA-LABELS Yes|No NewGraphics—If YES. COLORPALETTE palette_name ITEM-COLOR ChartBackground|ChartForeground HeaderBackground|HeaderForeground FooterBackground|FooterForeground LegendBackground|LegendForeground ChartAreaBackground|ChartAreaForeground PlotAreaBackground TITLE SUB-TITLE NONE | text NONE | text Specifies a title for the chart. If NO. That text is placed at the top of the chart. With NONE. then the legend is presented within the chart border. or LOWER) is the vertical position. The first portion of the placement parameter (CENTER. MIN selects the smallest segment. MAX selects the largest segment. then point markers are displayed for line charts. then percent-of-total figures is presented for each pie segment.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choices Description POINTMARKERS TYPE YES | NO If YES. Controls what pie segments are exploded (selected) within the pie chart. This third field should be a CHAR and values of 'YES' or 'Y' indicate that the segment should be exploded. STACKED-BAR | 100%-BAR | OVERLAPPED-BAR | FLOATING-BAR | HISTOGRAM | AREA | STACKED-AREA | 100%-AREA | XY-SCATTER-PLOT | HIGH-LOW-CLOSE YES | NO NONE | text LEGEND LEGEND-TITLE YES. If USE-3RD-DATACOLUMN. Places the legend in the specified location on the chart. If OUTSIDE. If YES. displays a legend. but outside of the region represented by the two axes. If YES. and the second portion is the horizontal. LINE | PIE | BAR. then point markers are not displayed. then the legend is presented inside the area defined by the two axes. then the quantity is presented for each pie segment. If NO. PIE-SEGMENTQUANTITYDISPLAY PIE-SEGMENTPERCENTDISPLAY PIE-SEGMENTEXPLODE YES | NO YES | NO NONE | MAX |MIN | USE-3RD-DATA-COLUMN PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-61 . If NONE. then the third field in the DATA-ARRAY is used to determine which pie segments are exploded. See the "Business Charts" section in the SQR for PeopleSoft Developer's Guide. NO does not display a legend. LEGENDPLACEMENT CENTER-RIGHT | CENTER-LEFT | UPPER-RIGHT | UPPER-LEFT | UPPER-CENTER | LOWER-RIGHT | LOWER-LEFT | LOWER-CENTER | INSIDE | OUTSIDE LEGENDPRESENTATION If INSIDE. Specifies the type of chart. then no title is displayed in the legend box. Specifies the title for the legend. UPPER. The maximum value on the axis. the scale is LINEAR. The minimum value on the axis.MARKS LOG | LINEAR YES | NO Y-AXIS-MAJORTICK. The maximum value on the axis.AXIS-MAX-VALUE. AUTOSCALE directs SQR to calculate an appropriate minimum value. If there are data values that are greater than Y. LOG specifies a logarithmic scale for the axis. then they are not displayed. then they are not displayed. according to the X-AXIS-SCALE setting spaced by X-AXIS-MAJOR-INCREMENT. If there are data values that are greater than X. AUTOSCALE | number Y-AXIS-MINVALUE AUTOSCALE | number X-AXIS-MAXVALUE AUTOSCALE | number Y-AXIS-MAXVALUE AUTOSCALE | number X-AXIS-SCALE or Y-AXIS-SCALE X-AXIS-MAJORTICK. The minimum value on the axis. If there are data values that are less than X-AXIS. then they are not displayed. then they are not displayed. Otherwise.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choices Description X-AXIS-LABEL or Y-AXIS-LABEL X-AXIS-MINVALUE NONE | text Specifies a line of text to be displayed below (or alongside) the tick-mark labels on the axis. YES specifies the display tick-marks along the axis between X-AXIS-MIN-VALUE and X-AXIS-MAX-VALUE. AUTOSCALE directs SQR to calculate an appropriate maximum value.MIN-VALUE. according to the Y-AXIS-SCALE setting spaced by Y-AXIS-MAJOR-INCREMENT. YES displays the tick-marks along the axis between Y-AXIS-MIN-VALUE and Y-AXIS-MAX-VALUE. AUTOSCALE directs SQR to calculate an appropriate minimum value.MIN-VALUE.AXIS-MAX-VALUE. AUTOSCALE directs SQR to calculate an appropriate maximum value. If there are data values that are less than Y-AXIS.MARKS YES | NO 2-62 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . If NO. according to the X-AXIS-SCALE setting spaced by X-AXIS-MINOR-INCREMENT. These must be set for the XAXIS.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choices Description X-AXIS-MINORTICK. Y-AXIS-MINORTICK. according to the Y-AXIS-SCALE setting spaced by Y-AXIS-MINOR-INCREMENT. DATA-ARRAY. INSIDE (or OUTSIDE) directs SQR to place the tick-marks on the inside (or outside) of the axis only. for each region. AUTOSCALE directs SQR to determine an appropriate increment. Specifies for SQR the increment used for spacing the minor tick-marks on the axis. the no grid line is drawn on this axis.MINOR-TICK-MARKS and the Y-AXIS. begin-setup declare-chart base_sales_chart chart-size title sub-title fill = (30. If YES. the SUB-TITLE.MARKS YES | NO YES displays the tick-marks along the axis between X-AXIS-MIN-VALUE and X-AXIS-MAX-VALUE.MARKS YES | NO X-AXIS-MAJORINCREMENT or Y-AXIS-MAJORINCREMENT X-AXIS-MINORINCREMENT or Y-AXIS-MINORINCREMENT AUTOSCALE | number number X-AXIS-TICKMARKPLACEMENT or Y-AXIS-TICKMARKPLACEMENT X-AXIS-GRID or Y-AXIS-GRID INSIDE | OUTSIDE | BOTH YES | NO Example This example declares a basic sales chart using DECLARE-CHART. and other elements are overridden to provide the chart with the specific features desired. BOTH directs SQR to draw the tick-marks such that they appear on both sides of the axis.MINOR-TICKMARKS to be displayed. YES displays the tick-marks along the axis between Y-AXIS-MIN-VALUE and Y-AXIS-MAX-VALUE. Specifies for SQR the increment used for spacing the major tick-marks on the axis. 20 ) = 'Quarterly Sales' = none = color PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-63 . Then. then a dashed grid line is drawn for each major tick-mark on the axis. SQR FOR PEOPLESOFT LANGUAGE REFERENCE 3d-effects type legend-title x-axis-grid end-declare = yes = stacked-bar = 'Product' = yes end-setup begin-program print-chart base_sales_chart sub-title data-array data-array-row-count data-array-column-count y-axis-max-value y-axis-min-value legend = no = 'Region I' = reg1_sales = #rows_reg1 = 2 = #max_of_all_regions = #min_of_all_regions print-chart base_sales_chart sub-title data-array data-array-row-count data-array-column-count y-axis-max-value y-axis-min-value legend = no = 'Region II' = reg2_sales = #rows_reg2 = 2 = #max_of_all_regions = #min_of_all_regions end-program begin-procedure chart_region_sales ($sub. #rows. #cols. 15 ) sub-title data-array data-array-row-count data-array-column-count data-array-column-labels 'Q3'. 'Q2'. 2-64 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . #max_of_all_regions. #min_of_all_regions) print-chart base_sales_chart (20. $ary. 'Q4' ) = $sub = all sales = #rows = #cols = ('Q1'. END-DECLARE Description Defines colors in an SQR report. It must start with an alpha (A-Z) character. It is case insensitive. 'Default' is used during execution when a referenced color is not defined in the runtime environment. . The name 'none' is reserved and cannot be assigned a value. The DECLARE-COLOR-MAP command in the BEGIN-SETUP section defines or redefines colors in an SQR report. You can define an endless number of entries.SQR FOR PEOPLESOFT LANGUAGE REFERENCE y-axis-max-value y-axis-min-value chart-size = #max_of_all_regions = #min_of_all_regions = (50. 30) end-procedure See Also The PRINT-CHART command. the underscore (_) character. The name 'default' is reserved and can be assigned a value. and the hyphen (-) character. 0-9). . PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-65 . Parameters Parameter color_name Description A color_name is composed of the alphanumeric characters (A-Z. DECLARE-COLOR-MAP Syntax In the SETUP section: DECLARE-COLOR-MAP color_name = ({rgb}) color_name = ({rgb}) . A name in the format (RGBredgreenblue) cannot be assigned a value. blue_lit | _var | _col where each component is a value in the range of 000 to 255.192) red=(255.0) teal=(0.128) fuchsia=(255.128.0) blue=(0.0) maroon=(128.0.0.128) aqua=(0. and GET-COLOR commands in this section. SET-COLOR. The default colors implicitly installed with SQR include: black = (0.255) lime=(0.0) navy=(0.128. 229) end-declare end-setup See Also The ALTER-COLOR-MAP.0) green=(0.0.0) purple=(128.0.128. only literal values are allowed.255.255) Example begin-setup declare-color-map light_blue = (193.255.0. DECLARE-CONNECTION Syntax In the SETUP section: DECLARE-CONNECTION connection_name_txt_lit 2-66 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . In the BEGINSETUP section.192.255) gray=(128.0) white=(255.128) olive=(128.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter {rgb} Description red_lit | _var | _col. 222. green_lit | _var | _col.128) silver=(192.0.255) yellow=(255.255.255.0.128. Can be used to override the default connection logon parameters. Defines a list of keyword-attribute pairs required by a datasource driver for logon. Traditional logon semantics. Parameters Parameter connection_name Description A user-defined name for describing a datasource connection.]] END-DECLARE In the body of the report: DECLARE-CONNECTION connection_name DSN={uq_txt_lit|_var} [USER={uq_txt_lit|_var}] [PASSWORD={uq_txt_lit|_var}] [PARAMETERS=keyword_str=attr_str. DSN USER.[..[..]] END-DECLARE Description Defines the datasource logon parameters prior to logon. There is no syntax restriction on these entries apart from the delimiting semi-colons (. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-67 .properties file)..) and equal signs (=).. PASSWORD PARAMETERS = keyword_str=attr_str.. The logical datasource name as recorded in the DDO Registry (Registry. keyword_str=attr_str.SQR FOR PEOPLESOFT LANGUAGE REFERENCE DSN={uq_txt_lit} [USER={uq_txt_lit}] [PASSWORD={uq_txt_lit}] [PARAMETERS=keyword_str=attr_str.keyword_str=attr_str . The keywords must match the logon property names listed for a datasource.. size. In such cases.height_num_lit)] [SOURCE=file_name_lit] END-DECLARE Note. and SOURCE are not defined in DECLARE-IMAGE. Description Declares the type. Here. while allowing dynamic logins as-needed. you should code the CONNECTION as NODUPLICATE=TRUE. they must be defined in PRINT-IMAGE. Example declare-connection SAPR3-1 dsn=SAPR3 username=guest password=guest end-declare See Also The ALTER-CONNECTION command. This behavior. Creating a new login in such cases is the default behavior for SQR. DECLARE-IMAGE Syntax DECLARE-IMAGE image_name [TYPE=image_type_lit] [IMAGE-SIZE=(width_num_lit. which allows a single CONNECTION declaration to be used in a subquery. causes problems when doing both DDL (BEGIN-SQL) and DML (BEGINSELECT) against temporary tables in certain vendors datasources. If TYPE. IMAGE-SIZE. and then use that connection in both the table creation logic of BEGIN-SQL and the row fetching logic of BEGIN-SELECT.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter NO-DUPLICATE=TRUE|FALSE (default is FALSE) Description This optional keyword prevents SQR from automatically creating additional logins to datasources that are busy handling a previous query. 2-68 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and source of an image to be printed. you must fetch from the temporary table using the same login in which it was created. Types can be EPS-FILE. If the file is not in the SQRDIR directory. Specifies the width and height of the image in SQR coordinates. JPEG-FILE. Example declare-image officer-signature type source image-size end-declare = eps-file = 'off_sherman. Note. or has incomplete header information. or having a diagonal line through it in the case of POSTSCRIPT) appears where the image is expected. This image can then be placed in a report at the position specified in the PRINT-IMAGE command. HPGL-FILE. The file must be in the SQRDIR directory or you must specify the full path. the full path or no path should be given. then a box (either shaded. Specifies the name of a file containing the image. because you must know where you execute the file from. If the image file is unrecognizable. 5) See Also The PRINT-IMAGE command. A relative path will not do.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The DECLARE-IMAGE command defines and names an image. paper_depth_num_lit[uom]}|{paper_name})] [FORMFEED=form_feed_lit] [ORIENTATION=orientation_lit] PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-69 . for HP printers. GIF-FILE. or BMPFILE (for Windows). DECLARE-LAYOUT Syntax DECLARE-LAYOUT layout_name [PAPER-SIZE=({paper_width_num_lit[uom]. TYPE IMAGE-SIZE SOURCE Note. Parameters Parameter image_name Description Specifies a unique name for referencing the image declaration. Specifies the image type.eps' = (40. Each layout name must be unique. SQR maps its line and column positions on the page by using a grid determined by the LINE-HEIGHT and CHAR-WIDTH arguments. That is. a layout named DEFAULT is created with the default attribute values shown in the DECLARE-LAYOUT Command Arguments table. see the DECLARE-REPORT "Examples" in this document. it is possible that a word or string is wider than the horizontal space you have allotted.5 inch. In addition. The ORIENTATION parameter selects the proper fonts. If no DECLARE-LAYOUT is defined or if a DECLARE-REPORT does not reference a defined layout. the parameter interacts with PAPER-SIZE as follows: • When you do not specify ORIENTATION=LANDSCAPE or the PAPER-SIZE dimensions. You can override the DEFAULT layout attributes by defining a layout called DEFAULT in your program. Each printed segment of text is placed on the page using this grid. If you also specify ORIENTATION and the value differs from the PAPER-SIZE value.5 inch margins. then SQR creates a page with the dimensions set to 11 inch by 8.SQR FOR PEOPLESOFT LANGUAGE REFERENCE [LEFT-MARGIN=left_margin_num_lit[uom]] [TOP-MARGIN=top_margin_num_lit[uom]] [RIGHT-MARGIN=right_margin_num_lit[uom] |LINE-WIDTH=line_width_num_lit[uom] |MAX-COLUMNS=columns_int_lit] [BOTTOM-MARGIN=bottom_margin_num_lit[uom] |PAGE-DEPTH=page_depth_num_lit[uom] |MAX-LINES=lines_int_lit] [CHAR-WIDTH=char_width_num_lit[uom]] [LINE-HEIGHT=line_height_num_lit[uom]] END-DECLARE Description Defines the attributes for the layout of an output file. especially in words containing uppercase letters or bolded characters. This results in a page of 100 columns by 45 lines with 0. You can define as many layouts as are necessary for the requirements of the application. To account for this behavior. When you specify PAPER-SIZE=(paper_name) the page orientation is set according to the paper_name specified. The DECLARE-LAYOUT command describes the characteristics of a layout to be used for an output file. A layout can be shared by more than one report. • 2-70 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . you can either move the column position in the PRINT or POSITION statements or indicate a larger CHAR-WIDTH in the DECLARE-LAYOUT command. SQR calculates the number of columns per row by dividing the LINE-WIDTH by the CHAR-WIDTH and calculates the number of lines by dividing the PAGE-DEPTH by the LINE-HEIGHT. Because the characters in proportional fonts vary in width. then the ORIENTATION value overrides the PAPER-SIZE value. For an example of how DECLARE-LAYOUT relates to DECLARE-REPORT. uom Suffix Meaning Definition dp pt mm cm in decipoint point millimeter centimeter inch 0.25 in 7.5 in 8. Parameters Parameter layout_name Description A unique layout name to be used for referencing the layout and its attributes.5 in 8.12 in 9.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • When you specify PAPER-SIZE=(page_width.016 in Portrait Portrait Portrait Portrait Portrait Landscape Landscape Landscape Landscape PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-71 .875 in 4.66 in 9.125 in 3. The following table lists valid paper names.5 in 10. This name is associated with predefined dimensions.69 in 10.3937 inch 1.378 in 11 in 14 in 11.5 in 8.17 in 4.5 in 7. Name Width Depth Orientation Letter Legal A4 Executive B5 Com-10 Monarch DL C5 8. The following lists valid uom suffixes.03937 inch 0.001388 inch 0. page_depth) is specified then SQR does not swap the page width and page depth if ORIENTATION=LANDSCAPE.01388 inch 0.27 in 7.33 in 6. An optional suffix which denotes the unit of measure to apply to the preceding value.0000 inch Parameter paper_name Description An option of PAPER-SIZE. If you specify LINE-WIDTH or MAX-COLUMNS. If you specify BOTTOM-MARGIN or MAXLINES. Portrait pages are printed vertically. 8.5 in 0. LANDSCAPE YES PORTRAIT LEFTMARGIN TOP-MARGIN RIGHTMARGIN inches inches inches 0.5 in. If you specify RIGHTMARGIN or LINE-WIDTH. Amount of blank space to leave at the top of the page. Maximum number of columns in a line. Printing in landscape for the printer type HPLASERJET requires landscape fonts.5 in MAXCOLUMNS 75 BOTTOMMARGIN inches 0. you cannot use this parameter. Depth of the page. If you specify RIGHT-MARGIN or MAXCOLUMNS. Amount of blank space to leave at the right side of the page. Length of the line. If you specify PAGE-DEPTH or MAXLINES. Specifies whether formfeeds are to be written at the end of each page. you cannot use this parameter. 11 in Physical size of the page. you cannot use this parameter. When ORIENTATION= LANDSCAPE the default values are 11 in. Amount of blank space to leave at the bottom of the page. you cannot use this parameter. FORMFEED ORIENTATION YES. It may also be a predefined name.5 in PAGE-DEPTH inches 10 in 2-72 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Landscape pages are printed horizontally.5 in 0. The second parameter is the depth or length. NO PORTRAIT.) Note.5 in. Amount of blank space to leave at the left side of the page. The first parameter is the width of the page. you cannot use this parameter.5 in LINE-WIDTH inches 7. (See the Valid Paper Names table.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The following table describes the arguments of the DECLARE-LAYOUT command Argument Choice or Default uom Default Value Description PAPER-SIZE inches 8. HEIGHT points 12 pt CHARWIDTH points 7. LINE. 12) and (1.7mm right-margin=25. For the printer type LINEPRINTER. For the printer type LINEPRINTER. If LINE-HEIGHT is not specified.4mm bottom-margin=12.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Default uom Default Value Description MAX-LINES 60 Maximum number of lines printed on the page.7mm right-margin=25. this value is used only to calculate the TOP-MARGIN and BOTTOM-MARGIN (not in computing the position on the page). If you specify PAGE-DEPTH or BOTTOMMARGIN. 297mm) ! top- left-margin=12.4 mm end-declare ! ! ! ! ! ! ! ! Results in: paper-size=(210mm. it follows the value for POINT-SIZE. this value is used only to calculate the TOP-MARGIN and BOTTOM-MARGIN (for example. There are 72 points per inch. 13)). ! declare-layout my-layout paper-size=(a4) left-margin=12. Size of each SQR horizontal character column on the page (for example. metric). the distance between the locations (1. Size of each SQR line on the page. not in computing the position on the page). if specified.7 mm margin=12.7mm orientation=portrait columns=67 lines=64 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-73 . The default value of 12 points yields 6 lines per inch.2 pt Example The following example illustrates the ability to specify the ! parameters using a different measurement system (that is. you cannot use this parameter. 11in) ! top-margin=0.0in bottom-margin=0. The columns and rows are recalculated. 11) 11in) left-margin=1 right-margin=1 end-declare ! ! ! ! ! ! ! ! Results paper-size=(14in.5in ! left-margin=1.5in left-margin=1. All other values remain the same.5in. declare-layout default left-margin=1 right-margin=1 end-declare ! ! ! ! ! ! ! ! Results in: paper-size=(8. top-margin=0. ! declare-layout large-paper in: paper-size=(14.0in right-margin=1. The default page dimensions of (8.0in bottom-margin=0. declare-layout default orientation=landscape 8. 2-74 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .5in and 11in) are swapped.5in orientation=portrait columns=65 lines=60 The following example changes the orientation to landscape.5in orientation=portrait columns=120 lines=60 The following example retains the default page dimensions and changes the left and right margins to be 1 inch.0in right-margin=1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The following example changes the page dimensions and also changes the left and right margins to be 1 inch.5in) ! ! Results in: paper-size=(11in. declare-layout my_landscape in: orientation=landscape 8.0in left-margin=0.5in left-margin=0.125in. The default page dimensions of (8. Note that the orientation has also changed because this example is an envelope. top-margin=1.5in and 11in) are swapped.5in orientation=landscape columns=100 lines=45 The following example changes the orientation to landscape.5in left-margin=0.5in) end-declare ! ! ! ! Results in: ! paper- top-margin=0.5in right-margin=0.5in PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-75 .5in bottom-margin=0.5in right-margin=0. 9.5in right-margin=0.5in) top-margin=1 end-declare ! ! ! ! ! ! ! ! ! Results paper-size=(11in.5in orientation=landscape columns=100 lines=43 The following example illustrates how to specify the page dimensions using one of the predefined names. In addition the top margin is set to 1 inch.SQR FOR PEOPLESOFT LANGUAGE REFERENCE end-declare ! ! ! ! ! ! ! top-margin=0.5in bottom-margin=0. declare-layout envelope paper-size=(com-10) size=(4. If you need to change some of the arguments depending on the runtime environment. Each printer has a set of defaults as listed in the DECLARE-PRINTER Command Arguments table. and DEFAULT-PS for PostScript. The default printer attributes can be overridden by providing a DECLARE-PRINTER specification for each printer. Their names are: DEFAULT-LP for line printer.. 2-76 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .report_namei]. The DECLARE-PRINTER command overrides these defaults. If you do not provide a printer declaration. DEFAULTHP for HP LaserJet. A program can contain no more than one DECLARE-PRINTER command for each printer type for each report.)] [TYPE=printer_type_lit] [INIT-STRING=initialization_string_txt_lit] [RESET-STRING=reset_string_txt_lit] [COLOR=color_lit] [POINT-SIZE=point_size_num_lit] [FONT-TYPE=font_type_int_lit] [SYMBOL-SET=symbol_set_id_lit] [STARTUP-FILE=file_name_txt_lit] [PITCH=pitch_num_lit] [FONT=font_int_lit] [BEFORE-BOLD=before_bold_string_txt_lit] [AFTER-BOLD=after_bold_string_txt_lit] END-DECLARE Description Overrides the printer defaults for the specified printer type..5in orientation=landscape columns=85 lines=18 See Also The DECLARE-REPORT command. DEFAULT-HT for HTML. you can use the ALTER-PRINTER command in any part of the program except the PROGRAM and SETUP sections. the default specifications are used. DECLARE-PRINTER Syntax DECLARE-PRINTER printer_name [FOR-REPORTS=(report_name1[.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ! ! ! ! bottom-margin=0. Use the DECLARE-PRINTER command in the SETUP section to define the characteristics of the printer or printers to be used. The default is ALL reports. <27> is the ESC or escape character. HTML. For example.REPORTS ALL The name of the reports that use this printer definition. LINEPRINTER (LP) files generally consist of ASCII characters and can be viewed by a text editor. HP. Specify non-display characters by placing their decimal values inside angle brackets. Sends control or other characters to the printer at the beginning of the report. HPLASERJET (HP) files are binary files and cannot be edited or viewed. Argument Choice or Measure Default Description FOR.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The following table describes each of the arguments. POSTSCRIPT (PS) files consist of ASCII characters. HT LP INIT-STRING (none) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-77 . PS. you can ignore this argument. This parameter is designed primarily for the LINEPRINTER and has limited use with other printer types. POSTSCRIPT. HTML (HT) files consist of ASCII characters and can be viewed by a browser. This argument is required only for a program with multiple reports. LP. SQR creates output specific to each printer. but you need to know PostScript to understand what will be shown on the printer. and the default values. If you are writing a program that produces only a single report. HPLASERJET. the possible choices. TYPE LINEPRINTER. COLOR POINT-SIZE Yes. the default startup file is located in the directory pointed to by the environment variable SQRDIR. For example. For a complete list of the symbol sets. This argument is for HPLASERJET printers only. If you specify a fixed pitch font. Specify non-display characters by placing their decimal values inside angle brackets. see the HP LaserJet Technical Reference Manual. This argument applies only to HP LASERJET printers and needs to be specified only for font types not defined in the Fonts Available for HP LaserJet Printers in SQR table. FIXED Depends on the font SYMBOL.SET HP defined sets 0U STARTUP. <27> is the ESC or escape character. This argument does not apply to LINEPRINTER printers. Specifies whether this printer can print in color. No points No 12 FONT-TYPE PROPORTIONAL.STRING (none) Sends control or other characters to the printer at the end of the report. This argument applies only to HP LASERJET printers. you should also indicate the pitch. This argument is used to specify an alternate startup file. This is the beginning size of the selected font.STR PITCH characters/inch 10 2-78 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This argument applies only to POSTSCRIPT printers. Unless otherwise specified. This parameter is designed primarily for the LINEPRINTER and has limited use with other printer types.FILE filename POSTSC RI. The default value of "0U" is for the ASCII symbol set.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Description RESET. STR file.. If the string contains blank characters. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-79 . The BEFORE-BOLD and AFTER-BOLD arguments are for LINEPRINTER printers only.. such as ESC. For HP LASERJET printers. Read the POSTSCRI.').STR to add or delete fonts. so that you can use the same font number for reports to be printed on both types of printers.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Description FONT font_number 3 This is the font number of the typeface to use. You can modify the font list in POSTSCRI.STR file for instructions. this is the typeface value as defined by Hewlett-Packard. For a complete list of the typeface numbers. enclose it in single quote marks ('. enclose the decimal value inside angle brackets as follows: BEFORE-BOLD=<27>[r ! Turn on bold AFTER-BOLD=<27>[u ! Turn it off BEFORE-BOLD any string (none) These arguments work in conjunction with the BOLD argument of the PRINT command. The Fonts Available for HP LaserJet Printers in SQR table lists the fonts available in SQR internally. They specify the character string to turn bolding on and off. The Fonts Available for PostScript Printers table lists the fonts available in the SQR POSTSCRI. wherever possible. For POSTSCRIPT printers. SQR supplies a list of fonts and arbitrary font number assignments in the file POSTSCRI. see the HP LaserJet Technical Reference Manual. The font numbers are the same as those for HP LaserJet printers.STR. To specify non-printable characters. 2-80 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . available in a font cartridge. For fonts not listed in the Fonts Available for HP LaserJet Printers in SQR table. or the correct typeface cannot be selected by the printer. and point size—must be an internal font. The following table lists the fonts available in SQR for use with the FONT argument for HPLaserJet printer types. you must indicate the font style using the FONT-TYPE argument. or downloaded to the printer. typeface. The following table lists the fonts available in SQR for use with the FONT argument for PostScript printer types. Those for which bold face types are available are indicated by a "Y" in the Bold column. Value Typeface Style 0 1 2 3 4 5 6 8 11 17 18 19 20 21 22 23 24 Line printer Pica Elite Courier Helvetica Times Roman Letter Gothic Prestige Presentations Optima Garamondi Cooper Black Coronet Bold Broadway Bauer Bodini Black Condensed Century Schoolbook University Roman Fixed Fixed Fixed Fixed Proportional Proportional Fixed Fixed Fixed Proportional Proportional Proportional Proportional Proportional Proportional Proportional Proportional The font you choose—in orientation.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Description AFTER-BOLD any string (none) See BEFORE-BOLD. to send output to a Windows printer named NewPrinter. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-81 . you would use -PRINTER:WP:NewPrinter. For example. If your printer name has spaces. The {Printer Name} is the name assigned to your printer.STR file. enclose the entire argument in quotes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Value Typeface Bold 3 4 5 6 8 11 12 17 18 23 30 31 32 33 34 35 36 37 38 39 40 41 42 Courier Helvetica Times Roman Avant Garde Book Palatino Roman Symbol Zapf Dingbats Zapf Chancery Medium Italic Bookman Light New Century Schoolbook Roman Courier Oblique Helvetica Oblique Times Italic Avant Garde Demi Avant Garde Book Oblique Avant Garde Demi Oblique Palatino Oblique New Century Schoolbook Italic Helvetica Narrow Helvetica Narrow Oblique Bookman Demi Bookman Light Italic Bookman Demi Italic Y Y Y Y Y Y Y Y Y Y Y Y Other type faces can be added to the POSTSCRI. enter -PRINTER:WP:{Printer Name}. The Fonts Available for Windows Printers table lists the fonts available in SQR for Windows when printing on Windows printer drivers (using the -PRINTER:WP command-line flag). To specify a non-default Windows printer. When you use the -PRINTER:WP flag. your report is sent directly to the default Windows printer. INI file. See the [Fonts] section in the SQR. Parameters Parameter printer_name Description A unique name to be used for referencing a printer definition and its attributes. You can add more fonts by editing the appropriate [Fonts] section in the SQR. Fonts 6. The Symbol font uses the SYMBOL_CHARSET instead of the usual ANSI_CHARSET character set. Note. default values. and description of each of the arguments. 8. Value Windows Font/Name Style 3 300 4 400 5 500 6 8 800 11 Courier New Courier New Arial Arial Times New Roman Times New Roman AvantGarde Palatino Palatino Symbol Fixed Bold Proportional Bold Proportional Bold Proportional Proportional Bold Proportional Note. The advantage of using ATM fonts is the compatibility for PostScript printer fonts.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Fonts are specified in the FONT qualifier of the ALTER-PRINTER command by their number. and 800 are not supplied with Windows. The table lists the options. You can get these fonts by purchasing the ADOBE Type Manager (ATM).INI file for more information. Example declare-printer HP-definition type=HP font=4 ! for all reports ! Helvetica ! PC-850 Multilingual ! Default HP definition symbol-set=12U end-declare 2-82 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The DECLARE-PRINTER Command Arguments table describes the other arguments of the DECLARE-PRINTER command. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-83 .)]] [BEFORE-PAGE=procedure_name[(arg1[. DECLARE-PROCEDURE Syntax DECLARE-PROCEDURE [FOR-REPORTS=(report_name1[.. you can use the command as often as required to declare procedures required by all the reports.. the last one takes precedence. the default for each of the four procedure types is NONE..argi].)]] END-DECLARE Description Declares procedures that are triggered when a specified event occurs...SQR FOR PEOPLESOFT LANGUAGE REFERENCE declare-printer PS-Sales ! PS definition for-reports=(sales) type=PS font=5 end-declare ! Times-Roman ! for the Sales report See Also The ALTER-PRINTER and DECLARE-REPORT commands. If you issue multiple DECLARE-PROCEDURE commands.report_namei]. The DECLARE-PROCEDURE command can be used to define SQR procedures that are to be invoked before or after a report is printed or before the beginning or end of each page. ALL is assumed. Issue the DECLARE-PROCEDURE in the SETUP section. If no FOR-REPORTS is specified. that procedure is used unless NONE is specified.. In this way. To turn a procedure off. specify NONE in the USE-PROCEDURE statement. If a procedure is defined in one DECLARE-PROCEDURE for a report. For multiple reports...)] [BEFORE-REPORT=procedure_name[(arg1[.argi].)]] [AFTER-PAGE=procedure_name[(arg1[. you can use one command to declare common procedures for ALL reports and others to declare unique procedures for individual reports. Use the USE-PROCEDURE command to change the procedures to be used at runtime.. The referenced procedures can accept arguments.argi]..)]] [AFTER-REPORT=procedure_name[(arg1[. Initially.argi]. to set up page totals. 2-84 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or literal. Arguments can be any variable.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter FOR-REPORTS Description Specifies one or more reports that use the given procedures. Specifies a procedure to be executed at the beginning of every page. just before the first output command for the page. This argument is required only for a program with multiple reports. the procedure does not execute. for example. It can be used. for example. column. for example. It can be used. you can ignore this argument. to display page totals. It can be used. If you are writing a program that produces only a single report. It can be used to print totals or other closing summary information. to create a report heading. BEFORE-REPORT AFTER-REPORT BEFORE-PAGE AFTER-PAGE You can optionally specify arguments to be passed to any of the procedures. Specifies a procedure to be executed at the time of the execution of the first command which causes output to be generated (PRINT). Specifies a procedure to be executed just before each page is written to the file. Example declare-procedure ! These procedures will ! be used by all reports before-report=report_heading after-report=report_footing end-declare declare-procedure ! These procedures will ! be used by the customer ! report for-reports=(customer) before-page=page_setup after-page=page_totals end-declare See Also The USE-PROCEDURE command. Specifies a procedure to be executed just before the report file is closed at the end of the report. If no report was generated. Additional reports are generated with names conforming to the rules dictated by the SQR. Specifies the name of the Table of Contents for this report. the default layout is used. where program is the application name. When you are printing multiple reports. unless report names are specified using the -F command-line flag. Parameters Parameter report_name TOC Description Specifies the name of the report.INI OUTPUT-FILE-MODE setting. Specifies the name of the layout for this report. You must use this command when developing applications to produce more than one report. the first report declared is generated with the name of program. If none is specified. the first intermediate print file (SPF file) is generated with a name of program. Multiple reports can share the same layout and the same printer declarations or each report can use its own layout or printer definitions if the report has unique characteristics.spf and additional reports are generated with names conforming to the rules dictated by the SQR. You can use the DECLARE-REPORT command to declare one or more reports to be produced in the application.SQR FOR PEOPLESOFT LANGUAGE REFERENCE DECLARE-REPORT Syntax DECLARE-REPORT report_name [TOC=toc_name] [LAYOUT=layout_name] [PRINTER-TYPE=printer_type] END-DECLARE Description Defines reports and their attributes. When the -KEEP or -NOLIS flags are used.lis. LAYOUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-85 .INI OUTPUT-FILE-MODE setting. Issue the DECLARE-REPORT in the SETUP section. print customer detail. DECLARE-PRINTER. Valid values for PRINTER-TYPE are HT.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter PRINTER-TYPE Description Specifies the type of printer to be used for this report. DEFAULTLP is used.. HP. HPLASERJET.. HTML. DECLARE-LAYOUT... Example declare-layout customer_layout left-margin right-margin end-declare declare-layout summary_layout orientation=landscape end-declare declare-report customer_detail toc=detailed layout=customer_layout printer-type=postscript end-declare declare-report customer_summary layout=summary_layout printer-type=postscript end-declare . 2-86 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .print customer summary. use-report customer_summary . . . POSTSCRIPT... the default is the LINEPRINTER for this report.. use-report customer_detail . If no DECLARE-PRINTER is specified. See Also The USE-REPORT. and LINEPRINTER. LP. and DECLARE-TOC commands.. If none is specified. PS. )]] [AFTER-TOC=procedure_name[(arg1[..)] [DOT-LEADER=YES|NO] [INDENTATION=position_count_num_lit] [BEFORE-TOC=procedure_name[(arg1[. Specifies a procedure to be executed before generating the Table of Contents..)]] [AFTER-PAGE=procedure_name[(arg1[. the procedure does not execute.. Specifies a procedure to be executed after generating the Table of Contents. The default setting is 4...SQR FOR PEOPLESOFT LANGUAGE REFERENCE DECLARE-TOC Syntax DECLARE-TOC toc_name [FOR-REPORTS=(report_name1[.)]] END-DECLARE Description Defines the Table of Contents and its attributes. Parameters Parameter toc_name FOR-REPORTS Description Specifies the name of the Table of Contents. If no Table of Contents is generated..argi]. the procedure does not execute.. You can use DECLARE-TOC command to declare one or more Table of Contents for the application.report_namei].)]] [BEFORE-PAGE=procedure_name[(arg1[. Specifies the number of spaces by which each level is indented.argi]. Specifies a procedure to be executed at the start of every page.. The default setting is NO. Specifies one or more reports that uses this Table of Contents. DOT-LEADER INDENTATION BEFORE-TOC AFTER-TOC BEFORE-PAGE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-87 . Specifies whether a dot leader precedes the page number..)]] [ENTRY=procedure-name [(argi [. A Table of Contents can be shared between reports. Use DECLARE-TOC in the SETUP section.argi]. If no Table of Contents is generated..argi] ...argi]. These three SQRreserved variables are only valid within the scope of the ENTRY procedure. 2-88 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . See Also The BEGIN-FOOTING. the following SQR-reserved variables are populated with data about the TOC entry: #SQR-TOC-LEVEL Contains the level #SQR-TOC-TEXT Contains the text #SQR-TOC-PAGE Contains the page number. If the procedure is local. #_sqr-toc-page). but their contents are undefined. These are global variables. ENTRY Example begin-setup declare-toc common for-reports=(all) dot-leader=yes indentation=2 end-declare end-setup . BEGIN-HEADING. you must precede it with an underscore (for example. .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter AFTER-PAGE Description Specifies a procedure to be executed at the end of each page. They can be referenced outside the scope. toc-entry level=1 text=$Chapter toc-entry level=2 text=$Heading . . When this procedure is invoked.ENTRY commands. Specifies a procedure that is executed to process each Table of Contents entry (instead of SQR doing it for you). . and TOC. DECLARE-REPORT. Besides FLOAT. the command enables the default numeric type to be specified using the DEFAULT-NUMERIC setting as FLOAT. The placement of the command affects its scope. when it is placed in a local procedure. and the DEFAULTNUMERIC setting in the SQR. then the -DNT command-line flag takes precedence over the setting in the SQR... The DECLARE-VARIABLE command. With V30.. the DEFAULT-NUMERIC setting in the SQR. Alternately.. then all numeric literals are FLOAT (just as in pre-version 4.. or DECIMAL. using the -DNT command-line flag or the DEFAULT-NUMERIC setting in the [Default-Settings] section of the SQR. When dealing with money or where more precision is required. all variables are FLOAT. In addition to declaring variables.SQR FOR PEOPLESOFT LANGUAGE REFERENCE DECLARE-VARIABLE Syntax DECLARE-VARIABLE [DEFAULT-NUMERIC={DECIMAL[(prec_lit)]|FLOAT|INTEGER}] [DECIMAL[(prec_lit)]num_var[(prec_lit)][num_var [(prec_lit)]]. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-89 . it affects all variables in the entire program. or DECIMAL. that is. If the command has not been used. Finally. V30 is not a valid setting for the DEFAULT-NUMERIC setting in the DECLARE-VARIABLE command.. the -DNT command.] [TEXT string_var[string_var]. INTEGER. respectively.0 releases.INI file and -DNT command-line flag can be set to V30. If V30 is specified. the setting in the DECLARE-VARIABLE command takes precedence over all other settings.INI file is the same as specifying V30.. otherwise.INI file. If the command is in both places.. The DECLARE-VARIABLE command enables the user to determine the type of variables to use. Incidentally. the local declaration takes precedence over the SETUP declaration..INI file. the use or lack of a decimal point determines the type of the literal as either FLOAT or INTEGER. the program acts in the same manner as in pre-version 4. You can set the default numeric type externally. When used in the SETUP section.] END-DECLARE Description Enables the user to explicitly declare a variable type. you can use the DECIMAL qualifier. INTEGER.0 releases). This command can only appear in the SETUP section or as the first statement of a local procedure. not specifying DECLARE-VARIABLE command. and the DEFAULT-NUMERIC setting in the SQR.INI file affects the way numeric literals are typed.] [FLOAT num_var[num_var]. its effect is limited to the scope of the procedure.] [DATE date_var[date_var]. the -DNT command-line flag.] [INTEGER num_var[num_var]. However.line flag.. The precision is the total number of digits used to represent the number.9999999999999999999999999999999999999 E 4096 Specifies that the numeric variables that follow are used as double precision floating point.INI file entry has no DEFAULTNUMERIC entry. This qualifier overrides any setting from the command-lineflag -DNT or the DEFAULT. The range of decimal numbers is from -9. list variables should not be declared using this construct. Specifies that the date variables that follow can contain a date in the range of January1.NUMERIC entry in the [Default-Settings] section of the SQR. 9999 AD. The precision can be assigned to the group of variables or to each individual variable. Specifies that the string variables that follow are text variables. then the default numeric type is FLOAT.9999999999999999999999999999999999999 E 4096 to +9. In SQR for DDO.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note.INI file. Specifies that the numeric variables that follow are used as integers with a range of -2147483648 to +2147483647. This precision can range from 1 to 38. Unless explicitly declared otherwise. Parameters Parameter DEFAULT-NUMERIC Description Specifies the default type for numeric variables. The default value is 16. Specifies that the numeric variables that follow are decimal variables with a precision specified with prec_lit. DECIMAL FLOAT DATE INTEGER TEXT Example begin-setup declare-variable default-numeric=float decimal integer date #decimal(10) #counter $date 2-90 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . a numeric variable assumes the variable type.4713 BC to December 31. If -DNT was not specified on the command line and the SQR. The range and precision of these numbers are machine-dependent. begin-procedure sub1(:$dvar.1) 9. (+1. #uval) print $dvar (+1. let $date = strtodate('Jan 01 1995'. begin-procedure sub2 LOCAL declare-variable date $mydate end-declare let $mydate = dateadd($_date.1) position (+2.1) let #counter = 0 while #counter < 10 let #decimal = sqrt(#counter) add 1 to counter print #decimal end-while do sub1($date.1) position (+2. 10) do sub2 .'Mon DD YYYY') print $date (1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE end-declare end-setup . 5) print $mydate (+1. .999999999 See Also The -DNT command-line flag.INI File. Using the “PSSQR. $units. .1) end-procedure . 'year'. described in the Introduction.1) end-procedure .1) position (+2. . . $units.” [Default-Settings] Section PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-91 . 'day'. #uval) declare-variable date $dvar integer #uval end-declare let $dvar = dateadd($dvar. The value to be substituted. Parameters Parameter substitution_variable Description The variable to be used as the substitution variable. The #DEFINE command cannot be broken across program lines. ASK requests values for only those variables that have not had a value assigned. county. city. When the report runs. or any number or string that is used in several locations in the program.SQR FOR PEOPLESOFT LANGUAGE REFERENCE #DEFINE Syntax #DEFINE substitution_variable value Description Declares a value for a substitution variable within the body of the report (rather than using the ASK command). #DEFINE is useful for specifying constants such as column locations. printer fonts. which makes modifying programs much simpler. This is a method of gathering commonly used declarations into one place. co_name order_by 2-92 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and reusing them for more than one report.5 11 light LS^10027 LS^03112 1 27 54 state. The entire string is used as is. The substitution variable is used to substitute any command. ASK uses the previous value and the user is not prompted. argument. This enables you to predefine some variables and not others. and needs no enclosing quotes. or part of a SQL statement at compile time. All references to that variable change automatically. value Example The following code defines several constants: #define #define #define #define #define #define #define #define page_width page_depth bold col1 col2 col3 8. You can use #DEFINE commands inside an include file. If the ASK command is used to obtain the value of a substitution variable that has already been defined. you need only change your #DEFINE command. When the value of the number or string must be changed. The value in the #DEFINE command can have embedded spaces. DISPLAY Syntax DISPLAY {any_lit|_var|_col} [[:$]edit_mask|NUMBER|MONEY|DATE][NOLINE] Description Displays the specified column. {page_depth}) end-declare end-setup begin-heading 5 print 'Company Contacts' print 'Sort: {order_by}' (4. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-93 .{col1}) (0.1) center center ! space between col2 ! and col3 for both ! font changes and ! contact field.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The following excerpt from a report uses the preceding definitions: begin-setup declare-printer contacts type=hp paper-size=({page_width}. end-select end-procedure See Also The ASK command.1) (2.{col1}) (4. or literal. contact print '{light}' phone be enough next-listing from customers order by the {order_by} () () (0. ! Note: There must (1. variable.{col2}) (4.{col3}) ! Back to lightface.{col3}) print 'Company' print 'Contact' print 'Phone' end-heading begin-procedure main begin-select company print '{bold}' boldface.{col2}) ! Print contact in (1. use NOLINE on each display except the last. If you want to display more than one field on the same line. the format listed in the DATE Column Formats table is used. If this has not been set. use the SHOW command. the format specified by the SQR_DB_DATE_FORMAT setting is used. the date appears in the following manner: • For DATETIME columns and SQR DATE variables. If DATE-EDIT-MASK has not been specified. For DATE columns. the format listed in the TIME Column Formats table is used. The data is displayed to the current location on the screen. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. column. or variable using EDIT or DATE. For additional information regarding edit masks. If this has not been set. This option is not legal with date variables. • • When displaying a date in a string literal. SQR uses the first database-dependent format as listed in the Default Database Formats table. or a string literal. NUMBER MONEY DATE 2-94 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Causes the field to be edited before being displayed. or the database-independent format SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]. For TIME columns. the string uses the format specified by the SQR_DB_DATE_FORMAT setting. or variable. This option is not legal with numeric variables. Dates can be contained in a date variable or column. If this has not been set. Indicates that any_lit|_var|_col is to be formatted using the DATE-EDIT-MASK of the current locale. see the command "PRINT". one of the databasedependent formats as listed in the Default Database Formats table.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The DISPLAY command can display data to a terminal. This option is not legal with date variables. Indicates that any_lit|_var|_col is to be formatted using the MONEY-EDIT-MASK of the current locale. or date to be displayed. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. When a date variable or column is displayed without an edit mask. then the date is displayed using the default format for that database (see the Default Database Formats table). number. If you require more control over the display. column. Parameters Parameter any_lit|_var|_col edit_mask Description The text. Indicates that any_lit|_var|_col is to be formatted using the NUMBER-EDIT-MASK of the current locale. Example The following segments illustrate the various features of the DISPLAY command: ! ! Display a string using an edit mask ! display '123456789' xxx-xx-xxxx Produces the following output: 123-45-6789 ! ! Display a number using an edit mask ! display 1234567.78 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-95 .89 ! ! Display a number using the default edit mask (specified in SQR.89 999.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter NOLINE Description Suppresses the carriage return after the field is displayed.INI) ! display 123.78 number Produces the following output: 123.999.999.567.456.999.234.99 Produces the following output: 1.99' display 123456.780000 ! ! Display a number using the locale default numeric edit mask ! alter-locale number-edit-mask = '99.78 Produces the following output: 123.999. 78 in back taxes.78 ! ! Display a date column using the locale default date edit mask ! begin-select dcol from tables end-select alter-locale date-edit-mask = 'DD-Mon-YYYY' display &dcol date Produces the following output: 01-Jan-1999 ! ! Display two values on the same line ! display 'Hello' noline display ' World' Produces the following output: Hello World ! ! Display two values on the same line with editing of the values ! alter-locale money-edit-mask = '$$.$$9.78 money Produces the following output: $123.$$9. 2-96 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .$$$.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ! ! Display a number using the locale default money edit mask ! alter-locale money-edit-mask = '$$.99' let #taxes = 123456.456.78 display 'You owe ' noline display #taxes money noline display ' in back taxes.99' display 123456.456.$$$.' Produces the following output: You owe $123. The source is always first. For decimal variables. When dealing with money-related values (dollars and cents).5 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-97 . The EDIT parameter of the PRINT command for a description of the edit masks. If ON-ERROR is omitted and a division by zero is attempted. The LET command for information about copying. ROUND Example divide 37. These inaccuracies can appear due to the way different hardware and software implementations represent floating point numbers. For float variables. or converting fields. and small inaccuracies can appear when dividing many numbers in succession. The ALTER-LOCALE command for a description of the arguments NUMBER-EDIT-MASK. Rounds the result to the specified number of digits to the right of the decimal point. and DATE-EDIT-MASK.5 into #price ! #price / 37. Parameters Parameter src_num_lit|_var|_col dst_num_var ON-ERROR Description Divided into the contents of dst_num_var. Float variables are stored as double precision floating point numbers. SQR halts with an error message.SQR FOR PEOPLESOFT LANGUAGE REFERENCE See Also The SHOW command for information about screen control. DIVIDE Syntax DIVIDE {src_num_lit|_var|_col} INTO dst_num_var [ON-ERROR={HIGH|ZERO}][ROUND=nn] Description Divides one number into another. use decimal variables rather than float variables. Contains the result after execution. this value can be from 0 to 15. this value can be from 0 to the precision of the variable. editing. The source field is divided into the destination field and the result is placed in the destination. this argument is not appropriate. the destination always second. Sets the result to the specified number when a division by zero is attempted. For integer variables. MONEY-EDIT-MASK. The LET command for a discussion of complex arithmetic expressions. and literals can be passed to procedure string or date arguments. You can use arguments to send values to or receive values from a procedure." while zero is the "Lowest Value.)] Description Invokes the specified procedure. however. arg].SQR FOR PEOPLESOFT LANGUAGE REFERENCE divide divide &rate #j into #tot on-error=high on-error=zero into #subtot Note. Date variables can be passed to procedure date or string arguments. Arguments passed by a DO command to a procedure must match in number: • • • Database text columns. a date can be returned to a string variable and vice versa. Numeric variables (DECIMAL. numeric variables. When the procedure ends." See Also The ADD command. FLOAT) can be passed to procedure numeric arguments without regard to the argument type of the procedure. processing continues with the command following the DO command. numeric. DO Syntax DO procedure_name[(arg1[. and numeric literals can be passed to procedure numeric arguments. INTEGER.. depending on the procedure argument. High in the preceding example is the "Maximum Value. When a date is passed to a string. Database numeric columns. it must be a string. string variables. • When a field in a DO command receives a value back from a procedure (a colon indicates it is a back value—that is. a value that's being returned). SQR automatically converts the numeric values upon entering and leaving the procedure as required. or date variable. the date is converted to a string according to the following rules: 2-98 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .. #IFDEF. &co_name.) See Also The #IF. Arguments can be any type of variable or constant value. argi ] Description Specifies the name of the procedure to be executed. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. the format specified by the SQR_DB_DATE_FORMAT setting is used. If this has not been set. and #IFNDEF commands for a description of each compiler directive. If this has not been set. #IFDEF. and #IFNDEF compiler directives. Specifies the arguments to be passed to the procedure. (#ELSE is a compiler directive that works with the #IF. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-99 . Example do get_names do add_to_list ($name) do print_list ('A'. $name) See Also The BEGIN-PROCEDURE command for information about passing arguments. For DATE columns. the first database-dependent format as listed in the Default Database Formats table is used. For TIME columns the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. #IFDEF. #ELSE Syntax #ELSE Description Compiles the code following the #ELSE command when a preceding #IF. the format listed in the DATE Column Formats table is used.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • For DATETIME columns and SQR DATE variables. the format as listed in the TIME Column Formats table is used. • • Parameters Parameter procedure_name arg1 [. #total. If this has not been set. or #IFNDEF command is FALSE. Contains the result after execution.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ELSE Syntax ELSE Description ELSE is an optional command in an IF command. Only values <001> to <255> can be defined in the ENCODE command. See Also The IF command for a description and example. The ENCODE command can define nondisplay characters or escape sequences sent to an output device. These characters or sequences can perform complex output device manipulations. print $bold () code-printer=lp ! Code sequence to turn 2-100 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . use the Encode feature to create a string variable for it. Parameters Parameter src_code_string_lit Description Specifies a string of characters to be encoded and placed in dst_txt_var. dst_txt_var Example encode '<27>L11233' into $bold bold on. ENCODE Syntax ENCODE src_code_string_lit INTO dst_txt_var Description Assigns a non-display or display character to a string variable. The encode characters can be included in a report at the appropriate location using a PRINT or PRINT-DIRECT command. If your keyboard does not have the Euro symbol. The ENCODE command also displays characters not in the keyboard. The PRINT and PRINT-DIRECT commands. END-HEADING Syntax END-DECLARE END-DOCUMENT END-EVALUATE END-FOOTING END-HEADING Description Completes a section or paragraph.section command: BEGIN-DOCUMENT EVALUATE BEGIN-FOOTING BEGIN-HEADING Each command must begin on its own line. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-101 . The END-DECLARE command completes a paragraph started with: DECLARE-CHART DECLARE-IMAGE DECLARE-LAYOUT DECLARE-PRINTER DECLARE-PROCEDURE DECLARE-REPORT DECLARE-VARIABLE Other END-section commands complete the corresponding BEGIN. Example begin-footing print end-footing 2 (1) center 'Company Confidential' See Also The DECLARE-paragraph command.SQR FOR PEOPLESOFT LANGUAGE REFERENCE See Also The chr function described in the Miscellaneous Functions table under the LET command. END-EVALUATE. END-DECLARE. END-DOCUMENT. END-FOOTING. END-SETUP. END-PROCEDURE. and #IFNDEF commands for a description of each compiler directive.99 &cust_num See Also The #IF. (#END-IF is a compiler directive. #ENDIF Syntax #END-IF Description Ends an #IF. See Also The IF command for a description and example. ENDSQL. or #IFNDEF command. END-IF Syntax END-IF Ends an IF command. END-EXECUTE Syntax END-PROCEDURE END-PROGRAM END-SELECT END-SETUP END-SQL 2-102 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR FOR PEOPLESOFT LANGUAGE REFERENCE The BEGIN-section command. #END-IF. #IFDEF. END-WHILE. END-SELECT. END-PROGRAM. #IFDEF. Example #ifdef debuga show show #end-if 'DebugA: #j = ' 'Cust_num = ' #j edit 9999.) #ENDIF (without the dash) is a synonym for #END-IF. The WHILE command..SQR FOR PEOPLESOFT LANGUAGE REFERENCE END-WHILE Description Completes the corresponding section or paragraph.. Each END-section command completes the corresponding BEGIN. [BREAK]] [WHEN-OTHER SQR_Commands. [BREAK]] END-EVALUATE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-103 ..section command: BEGIN-PROCEDURE BEGIN-PROGRAM BEGIN-SELECT BEGIN-SETUP BEGIN-SQL WHILE Each command must begin on its own line... Example begin-program do main end-program See Also The BEGIN-section command. [BREAK] [WHEN comparison_operator {any_lit|_var|_col} SQR_Commands.. The general format of an EVALUATE command is the following: EVALUATE {any_lit|_var|_col} WHEN comparison_operator {any_lit|_var|_col} SQR_Commands. EVALUATE Syntax EVALUATE {any_lit|_var|_col} This command is equivalent to case/switch in C or Java. literal. SQR uses one of the database-dependent formats (see the Default Database Formats table). or date variable. If the expression is FALSE. EVALUATE commands can be nested. comparison_operator WHEN BREAK Causes an immediate exit of the EVALUATE command. If the expression is TRUE. a text. 2-104 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . not a byte by byte comparison as is done for strings). or the format as listed in the TIME Column Formats table. The EVALUATE command is useful for branching to different commands depending on the value of a specified variable or column. SQR processes the commands after the WHEN. If more than one WHEN expression appears directly before a set of commands. beginning from the first WHEN. Each WHEN must be on its own line. The string must be in the proper format as follows: • For DATETIME columns and SQR DATE variables the format specified by the SQR_DB_DATE_FORMAT setting. Use BREAK at the end of a set of commands. or the format listed in the DATE Column Formats table.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Determines the value of a column. For DATE columns. Evaluating a date variable or column with a string results in a date comparison (chronological. SQR uses the format specified by the SQR_DB_TIME_ONLY_FORMAT setting. • • Parameters Parameter any_lit|_var|_col Description Specifies a text or numeric column. causes the commands to execute. In short. SQR uses the format specified by the SQR_DB_DATE_ONLY_FORMAT setting. The evaluation argument is compared with the argument. if TRUE. or the database-independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'. numeric. or variable and takes action based on that value. See "comparison operators" in the Operators table. SQR processes the next WHEN expression. any one of them. For TIME columns. Specifies the evaluation expression. an evaluation argument. Any valid comparison operator. or a text or numeric literal to be used in the evaluation. .]] [INTO any_coldata_type[(length_int_lit)] [.)]] [@#status_var=]stored_procedure_name [[@param=]{any_col|_var|_lit}[.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter WHEN-OTHER Description Signifies the start of default commands to be processed if all other WHEN expressions are FALSE.. when > 'H' add 1 to #j when > 'W' add 2 to #j break when-other if isnull (&code) do null_code else move 0 to #j end-if break end-evaluate ! Unknown code...]][WITH RECOMPILE] PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-105 .. EXECUTE (SYBASE and MS-SQL Server) Syntax EXECUTE [-XC][ON-ERROR=procedure[(arg1[. ! Add 1 to #j and continue checking... Example evaluate &code when = 'A' move 1 to #j break when = 'B' when = 'C' move 2 to #j ! Will happen if &code is B or C.. break when > 'D' move 3 to #j ! Move 3 to #j and continue checking.argi].argi]. See Also The commands "IF" and "LET" for comparison operators.. WHEN-OTHER must appear after all other WHEN expressions.)]] [DO=procedure[(arg1[.. You can specify arguments to be passed to the ON-ERROR procedure. The stored procedure. This argument is required to share Sybase temporary tables. Arguments can be any variable. passing too few arguments) SQR halts. If no INTO argument is specified. with the exception of optional arguments and the INTO argument. Arguments can be any variable. column. Description Executes a stored procedure in Sybase/MS database. An INTO argument is specified. ON-ERROR DO Specifies an SQR procedure to execute for each row selected in the query. Declares an SQR procedure to execute if an error occurs. stored_procedure_name selects one or more rows. or literal. EXECUTE retrieves just the first row when the following instances are true: • • • The DO procedure is not specified. If the stored procedure specified in stored_procedure_name contains a SELECT query. For severe errors (for example. If ON-ERROR is omitted and an error occurs. Parameters Parameter -XC (SYBASE only) Description Specifies that the EXECUTE command shares the same connection as the DO=procedure it can invoke.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The syntax of this command generally follows that of the SYBASE Transact-SQL EXECUTE command. SQR halts with an error message. column. the EXECUTE command must specify an INTO argument to process the values from the query. The status is returned only after selected rows are retrieved. Processing continues until all rows have been retrieved. even if an error procedure is specified. or literal. @#status_variable stored_procedure_name 2-106 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This is useful for queries returning a single row. Names the stored procedure to execute. Returns the procedure status in the specified numeric variable. then the values from the query are ignored. You can specify arguments to be passed to the procedure. only the first query is described with the INTO argument. numeric. this is not required or recommended. Normally. Rows from subsequent queries are ignored. The parameter must be a string. The stored procedure selects data into five column variables. execute do=print_products PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-107 . The result from the stored procedure is stored in the variable #total. numeric. If you specify multiple output parameters. or date SQR variable. they must be listed in the same sequence as defined in the stored procedure. they must be in the same sequence as defined in the stored procedure.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter @param Description Names the parameter to pass to the stored procedure. Reporter' $State #Total Output The following example invokes the stored procedure get_products with two parameters. It can be a string. WITH RECOMPILE Causes the query to recompile each time it is executed rather than using the plan stored with the procedure. If used without names. The SQR procedure print_products is called for each row retrieved. Output parameters receive their values only after rows selected have been retrieved. Q. The return status from the stored procedure is placed in the variable #proc_return_status. or a string literal. execute get_total 'S. Parameters can be passed with or without names. Indicates where to store rows that are retrieved from the stored procedure's SELECT statement. any_lit|_var|_col OUT[PUT] INTO Example The following example invokes the stored procedure get_total with two parameters: a string literal and a string variable. You must specify the columns in the same sequence and match the data type used in the stored procedure's SELECT statement. or date variable. The INTO argument contains the names of the columns with data types and lengths (if needed). a numeric literal. a previously selected column. Specifies the value passed to the stored procedure. Indicates that the parameter receives a value from the stored procedure. If the stored procedure contains more than one SELECT query. INTO &prod_code &description &discount &restock &expire_date begin-procedure print_products print &prod_code print &description print &discount print &restock print &expire_date end-procedure (+1. Example begin-select cust_num.) edit 'Month dd.SQR FOR PEOPLESOFT LANGUAGE REFERENCE @#proc_return_status= get_products @prodcode=&code. yyyy' int. float. city. char (45).99 (+5) match Y 0 5 Yes N 0 5 No (+5.1) (+5.45) (+5) edit 99. char. contact. zip. 2-108 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . co_name. state. datetime @max=#maximum EXIT-SELECT Syntax EXIT-SELECT Description Exits a SELECT paragraph immediately. Use EXIT-SELECT when you need to end a query before all rows have been retrieved. EXIT-SELECT causes SQR to jump to the command immediately following the END-SELECT command. See Also The BEGIN-SELECT command. employees add &employees to #tot_emps if #tot_emps >= 5000 exit-select end-if do print_company from customers order by employees desc end-select ! Have reached required total emps. the string extracted from the source must be in one of the following formats: • • • The format specified by the SQR_DB_DATE_FORMAT setting One of the database-dependent formats (see the Default Database Formats table) The database-independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'. For DATE columns SQR uses the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. an offset of 1 begins one character beyond that. If this has not been set. Specifies a text or date variable. • • If the destination is a date variable. the format as listed in the TIME Column Formats table is used. and so on. the first databasedependent format as listed in the Default Database Formats table is used. If the source is a date variable or column.most character. If this has not been set. Parameters Parameter dst_txt_var | date_var Description Specifies a text or date variable into which the extracted string is placed. If this has not been set. Specifies starting location of the string to be extracted. { src_txt_lit|_var|_col } | { src_date_var | _col } start_num_lit|_var length_num_lit|_var PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-109 . it is converted to a string before the extraction according to the following rules: • For DATETIME columns and SQR DATE variables SQR specifies the SQR_DB_DATE_FORMAT setting. the format listed in the DATE Column Formats table is used. You must specify the starting location of the string as an offset from the beginning of the string and its length. or literal from which the string is to be extracted.SQR FOR PEOPLESOFT LANGUAGE REFERENCE EXTRACT Syntax EXTRACT {dst_txt_var|date_var} FROM {{src_txt_lit|_var|_col}|{src_date_var|_col}} {start_num_lit|_var}{length_num_lit|_var} Description Copies a portion of a string into a string variable. For TIME columns the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. An offset of zero (0) begins at the left. Specifies length of the string to be extracted. column. • 2-110 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . FIND returns -1 in dst_location_int_var. If the source or search object is a date variable or column. if the string is found. If the sequence is not found. The FIND command. If this has not been set. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. You must specify an offset from which to begin the search and supply a numeric variable for the return of the location. the first database-dependent format as listed in the Default Database Formats table is used. the format specified by the SQR_DB_DATE_FORMAT setting is used.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example extract extract code $state from $record 45 2 $foo from "SQR Rocks" 0 4 ! $foo='SQR' &phone from 0 3 &zip 5 4 #loc #rec_len from extract extract $zip_four $rec from $tape_block Note. PeopleSoft recommends that you do not use the EXTRACT command when processing strings. it is converted to a string before the search according to the following rules: • For DATETIME columns and SQR DATE variables. If this has not been set. FIND Syntax FIND {{obj_txt_lit|_var|_col}|{date_var|_col}} IN {{src_txt_var|_col}|{date_var|_col}} {start_int_lit|_var} dst_location_int_var Description Determines the location of a character sequence within a string. returns its location as an offset from the beginning of the specified string. the format listed in the DATE Column Formats table is used. See Also The substr function described in Miscellaneous Functions table under the LET command. For DATE columns. FIND searches the specified string for a character sequence and. . Parameters Parameter {obj_txt_lit|_var|_col}|{date_var|_col} Description Specifies a text variable. The EXTRACT command. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-111 . Specifies a text variable or column to be searched. or literal that is to be sought in src_txt_var|_col.comma not found. or numeric variable.FROM src_array_name(element) [field[(occurs)]].2' '. Description Retrieves data from an array and places it into a date....SQR FOR PEOPLESOFT LANGUAGE REFERENCE • For TIME columns.. If this has not been set. Specifies the starting location of the search. column. the format as listed in the TIME Column Formats table is used. Specifies the returned starting location of the leftmost character of the matching text in {src_txt_var|_col| date_var|_col }. See Also The instr function described in the Miscellaneous Functions table under the LET command. GET Syntax GET dst_any_var. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. {src_txt_var|_col}|{date_var|_col} start_int_lit|_var dst_location_int_var Example find find 'aw.' in in &code5 0 0 #loc &name #comma_loc if #comma_loc = -1 . string.... get #city_tot #county_tot from states(#j) cities counties The following example copies $code from the #j'th occurrence of the code field in the #n'th element of the codes array. $start_date. Numeric variables (decimal. get $name $start_date #salary from emps(#j) The following example copies #city_tot and #county_tot from the fields cities and counties in the #j'th element of the states array. If the destination is a date variable. If this has not been set.independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter dst_any_var Description A date. or one of the database-dependent formats (see the Default Database Formats table). SQR uses the first database-dependent format listed in the Default Database Formats table. and #salary from the first three fields in the #j'th element of the emps array. src_array_name(element) If the array's field names are listed. get $code from codes(#n) code(#j) See Also The PUT command for information about moving data into an array. If the array's field names are not listed. the string extracted from the source must be in the format specified by the SQR_DB_DATE_FORMAT setting. SQR takes the values from the fields and occurrences specified. Date variables are copied from char. or the database. String variables are copied from char. string. field[(occurs)] Example The following example copies $name. occurrence zero is used. float. If no field occurrence is stated. Array element and field occurrence numbers can be numeric literals (such as 123) or numeric variables (such as #j). text. 2-112 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . When a date field is copied to a string variable. or numeric variable (not database columns) can be destination variables. text. integer) are copied from number fields. SQR converts the date to a string in the format specified by the SQR_DB_DATE_FORMAT setting. the values are taken from consecutively defined fields in the array. or date fields. or date fields. If the requested color settings does not map to a defined name. You can use this format wherever you use a color name. The name 'default' is reserved and can be assigned a value. The GET-COLOR command is allowed wherever the PRINT command is allowed. The name 'none' is reserved and cannot be assigned a value. A name in the format (RGBredgreenblue) cannot be assigned a value. 0-9). the underscore (_) character. where each component is a three digit number. and the hyphen (-) character. The color name 'none' is returned if no color is associated with the specified area. {color_name_var} PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-113 . A color_name is composed of the alphanumeric characters (A-Z. then the name is returned as RGBredgreenblue.SQR FOR PEOPLESOFT LANGUAGE REFERENCE GET-COLOR Syntax GET-COLOR [PRINT-TEXT-FOREGROUND=({color_name_var |{rgb})] [PRINT-TEXT-BACKGROUND=({color_name_var |{rgb})] Description Retrieves the current colors. Parameters Parameter PRINT-TEXT. For example. Defines the color to print as a background behind the text.FOREGROUND PRINT-TEXT-BACKGROUND Description Defines the color in which the text prints. The name must start with an alpha (A-Z) character and it is case insensitive. 'Default' is used during execution when a referenced color is not defined in the runtime environment. RGB127133033. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter {rgb} Description red_lit | _var | _col.128) aqua=(0.0.0.0. In the BEGIN-SETUP section.255.255) gray=(128. The default colors implicitly installed with SQR include: black = (0.0.255) Example begin-setup declare-color-map light_blue = (193.255.0.0) navy=(0.0. 229) end-declare end-setup begin-program alter-color-map name = 'light_blue' value = (193.0) teal=(0.255.128) fuchsia=(255.255. green_lit | _var | _col.255) yellow=(255.192.0) maroon=(128. 233.0) purple=(128.0) green=(0. only literal values are allowed.128.0) blue=(0.128) silver=(192. blue_lit | _var | _col where each component is a value in the range of 000 to 255.255) lime=(0.128.0) white=(255.128. 230) print 'Yellow Submarine' () foreground = ('yellow') background = ('light_blue') get-color print-text-foreground = ($print-foreground) set-color print-text-foreground = ('purple') 2-114 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .128.0. 222.128) olive=(128.192) red=(255. Labels must end with a colon (:) and can appear anywhere within the same section or paragraph as the GOTO command. ALTER-COLOR_MAP. Parameters Parameter label Description Specifies a label within the same section or paragraph.. and SET-COLOR commands in this section. GRAPHIC VERT-LINE Syntax The GRAPHIC commands have the following syntax: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-115 . GOTO Syntax GOTO label Description Skips to the specified label. GRAPHIC HORZ-LINE.99 .0) edit 999.1) set-color print-text-foreground = ($print-foreground) end-program See Also The DECLARE-COLOR-MAP.SQR FOR PEOPLESOFT LANGUAGE REFERENCE print 'Barney' (+1.999. next: add 1 to #count from products end-select GRAPHIC BOX. Example begin-select price if &price < #old_price goto next end-if print &price (2.13.. {column_int_lit|_var}. width and depth rule_width 2-116 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .) The GRAPHIC command has the following variations: • • • BOX HORZ-LINE VERT-LINE Parameters The following sections describe the individual GRAPHIC commands: Parameter BOX Description BOX draws a box of any size at any location on the page. SQR changes the current print location to the starting location of the graphic. (This is different than the way the PRINT command works.SQR FOR PEOPLESOFT LANGUAGE REFERENCE GRAPHIC ({line_int_lit|_var}. depth is the vertical size in lines. or numeric variables. After GRAPHIC commands execute. The top left corner of the box is drawn at the line and column specified. Therefore. The top horizontal line is drawn just below the base of the line above the the starting point. Boxes can be drawn with any size rule and can be shaded or left empty.{column_int_lit|_var}. The bottom horizontal line is drawn just below the base of the ending line. (-). {length_int_lit|_var}) VERT-LINE [rule_width_int_lit|_var] Description Draws a box or line. {length_int_lit|_var}) HORZ-LINE [rule_width_int_lit|_var] GRAPHIC ({line_int_lit|_var}. as with regular print positions. a one-line deep box surrounds a single line. You can specify relative placement with (+). The bottom right corner is calculated using the width and depth. {width_int_lit|_var}) BOX {depth_int_lit|_var} [rule_width_int_lit|_var[shading_int_lit|_var]] GRAPHIC ({line_int_lit|_var}.{column_int_lit|_var}. The default rule width is 2 decipoints (there are 720 decipoints per inch). The width is the horizontal size in character columns. 66) box 58 20 around page graphic (30. To draw a vertical line next to a word printed on line 27. position the vertical line to begin on line 26. if a border is not desired.+2.4) vert-line 6 the paragraph ! Red line ! Draw See Also The ALTER-PRINTER and DECLARE-PRINTER commands for information about setting and changing the FONT.30) box 1 1 line ! Draw box ! Draw a 10! Draw 5 ! Draw box around The following example shows the GRAPHIC HORZ-LINE command: graphic (4. The default rule width is 2 decipoints.25.52. for the length specified. specifying the percentage of shading to apply. for a length of 1 line. VERT-LINE draws a vertical line from the location specified for the length (in lines) specified.66) box 5 0 8 line shaded box (without ! border) graphic (50.1.27.54) vert-line lines between columns graphic (1. and PITCH.10) box 10 characters-wide-by-10.8.62.characters-long box graphic (1. 1 is very light. Horizontal lines are drawn just below the base.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter shading Description A number between 1 and 100. Specify a rule-width of zero.1. and 100 is black.12) horz-line under final total ! Put line ! Put line The following example shows the GRAPHIC VERT-LINE command: graphic (1. Vertical lines are drawn just below the base line of the line position specified to just below the base line of the line reached by the length specified. FONT-TYPE. POINT-SIZE.66) horz-line 10 under page heading graphic (+1. HORZ-LINE rule_width VERT-LINE rule_width Example The following example shows the GRAPHIC BOX command: graphic (1. If no shading is specified. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-117 .1. The default rule width is 2 decipoints. the box is blank. HORZ-LINE draws a horizontal line from the location specified.54) vert-line graphic (3. Compiles the commands following the #ELSE directive when the #IF expression is FALSE.) SQR has five compiler directives that enable different pieces of SQR code to be compiled. string. depending on the existence or value of substitution variables (not program variables. The test is caseinsensitive. Substitution variables defined automatically for each -DEBUGxxx letter can also be used with the #IF. #ELSE #ELSE #ENDIF #IFDEF #ENDIF #IFDEF option #IFNDEF #IFNDEF option Parameters Parameter txt_lit | num_lit Description Any text or numeric literal. Compiles the commands following the #IFDEF directive if the substitution variable option is defined. (#IF is a compiler directive. #IFDEF. #IFDEF. The following table lists the compiler directives. depending on the -DEBUGxxx flag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE #IF Syntax #IF {txt_lit|num_lit}comparison_operator {txt_lit|num_lit} Description Indicates that the commands following are to be compiled when the expression is TRUE. or #IFNDEF directives cannot be broken across program lines. Ends the #IF directive. Only one simple expression is allowed per #IF command. or date). #IFDEF. 2-118 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Directive Example Description #IF #IF {option}='A' Compiles the commands following the #IF directive if the substitution variable option is equal to 'A'. #ENDIF can also be typed #END-IF (with a hyphen). You can nest #IF. such as. numeric. Compiles the command following the #IFNDEF directive if the substitution variable option is not defined. The #IF. or #IFNDEF directives to a maximum of 10 levels. They can turn entire sections of an SQR program on or off from the command line. and #IFNDEF directives. ...F. ! for B ! for F ! for M debug Cust_num = ' &cust_num edit 099999 show 'DEBUG: See Also The #DEBUG command for information about the -DEBUG command-line flag.code for F here #else #if {type} = 'B' .B)' end-setup begin-procedure Main #if {type} = 'M' ... PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-119 . F or B not selected. Report not created..code for M here #else #if {type} = 'F' .code for B here #else show 'M. Female or Both (M.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter comparison_operator Description Any of the comparison operators as follows: = != <> < > <= >= Equal Not Equal Not Equal Less than Greater than Less than or equal Greater than or equal Example begin-setup ask type 'Use Male.' stop #endif #endif #endif #ifdef #endif #ifndef debugB do test_procedure #endif ! DebugB turned on with -DEBUGB on ! SQR command line. The string must be in the proper format as follows: • For DATETIME columns and SQR DATE variables. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting. or the format listed in the DATE Column Formats table is used. Each IF command must have a matching END-IF. For TIME columns. results in a date comparison (chronological. 'M'. one of the database-dependent formats (see the Default Database Formats table). See the LET command for a description of logical expressions. 1) > 0 add 1 to #price_count if #price_count > 50 2-120 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Comparing a date variable or column with a string. the format specified by the SQR_DB_DATE_FORMAT setting.. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting. IF commands can be nested.. or the database-independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]' is used.. For DATE columns. The expression is evaluated as a logical TRUE or FALSE. or the format as listed in TIME Column Formats table is used. [ELSE SQR Commands..] END-IF Description Executes commands depending on the value of a condition. A value or expression that evaluates to nonzero is TRUE.SQR FOR PEOPLESOFT LANGUAGE REFERENCE IF Syntax IF logical_expression IF commands have the following structure: IF logical_expression SQR Commands. not a byte by byte comparison as is done for strings). • • Parameters Parameter logical_expression Description Any valid logical expression. Example if &price > &old_price and instr(&code. or by the -DEBUG flag on the SQR command line.' noline input $x 'Continue? (Y/N)' if upper($x) = 'N' stop end-if end-if else add 1 to #old_price_count end-if if #rows end-if if $date1 > 'Apr 21 1996 23:59' do past_due end-if ! Will be TRUE if #rows is non-zero. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-121 . The EVALUATE command. See Also The #IF command for a description of each compiler directive.SQR FOR PEOPLESOFT LANGUAGE REFERENCE show 'More than 50 prices found.) Parameters Parameter substitution_variable Description Is the variable to be used as the substitution variable. do print-it See Also The LET command for a description of logical expressions. (#IFDEF is a compiler directive. #IFDEF Syntax #IFDEF substitution_variable Description Indicates that the following commands are to be compiled when the substitution variable has been declared by an ASK or #DEFINE command. ) Parameters Parameter substitution_variable Description Is the variable to be used as the substitution variable. #INCLUDE Syntax #INCLUDE filename_lit Parameters Parameter filename_lit Description A file name that is valid for the platform on which this application is to be compiled. and page size declarations. 2-122 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This enables you to substitute all or part of the INCLUDE file name at runtime. You may want to keep commonly used routines in a single file and reference or "include" that file in programs that use the routine. INCLUDE files can be nested up to four levels. For example. or by the -DEBUG flag on the SQR command line.SQR FOR PEOPLESOFT LANGUAGE REFERENCE #IFNDEF Syntax #IFNDEF substitution_variable Description Indicates that the following commands are to be compiled when the substitution variable has not been declared by an ASK or #DEFINE command. You can reference the appropriate include file depending on which printer you want to use. (#IFNDEF is a compiler directive. See Also The #IF command for a description of each compiler directive. Description Includes an external source file into the SQR report specification. Variable substitution scanning takes place before the #INCLUDE command is processed. you might have a set of #DEFINE commands for different printers to control initialization. adding flexibility to controlling which file is included for the run. font changes. 'printer18. If a numeric variable is used.dat' for #include 'printer{num}. Datatype Description CHAR. preceding ! this #include statement. The datatypes supported are described in the following table. If TYPE=DATE is specified. The INPUT command is then re-executed. however.dat' #include 'XYZheader. this may cause the screen to flash instead). If the string entered is not the type specified. and DATE are invalid types. ! Include printer ! printer {num}.dat' definitions for ! Common procedure. the SQL is rejected and SQR halts. The types CHAR. Specifying TYPE causes data type checking to occur. This is the default datatype. a colon (:) and two spaces are added to the prompt. If the maximum length is exceeded. it is validated as a numeric variable.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example #include 'gethours. TEXT Any character. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-123 . TYPE=DATE is optional if input_var is a date variable. then input_var can be a date or text variable. the terminal beeps and an error message is displayed. In any case. ! Common report heading ! XYZ Company. which is passed ! on the command line: ! SQR REP1A SAM/JOE 18 ! where 18 is the arbitrary ! number assigned your printer ! definition file. Enter [$|#]var:.dat'. ! The report would contain the ! command: ASK num ! in the SETUP section. If an INSERT or UPDATE command references a variable whose length is greater than that defined in the database. Use MAXLEN to prevent the user from entering data that is too long. TEXT. INPUT Syntax INPUT input_var[MAXLEN=nn][prompt] [TYPE={CHAR|TEXT|NUMBER|INTEGER|DATE}] [STATUS=num_var][NOPROMPT][BATCH-MODE] [FORMAT={txt_lit|_var|_col}] Description Accepts data entered by the user at a terminal. the terminal beeps (on some systems. If prompt is omitted. SQR uses the default prompt. NNNNNN]] [AM|PM]] MM-DD-YYYY [BC|AD] [HH:MI[:SS[.DD. MAXLEN 2-124 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Too long (longer than MAXLEN or the input for an INTEGER variable is < -2147483648 or > +2147483647). No error message is displayed. Bad type (did not match the datatype of TYPE). numeric. Status Value Indicates 0 1 2 Successful. If FORMAT has not been set.999[E[+|]99] An integer in the format [+|-]99999 A date in one of the following formats: MM/DD/YYYY [BC|AD] [HH:MI[:SS[. FORMAT can only be used with dates. 3 By using NOPROMPT and STATUS with the SHOW command. Use the keyword DATE if the date must be in the format as specified with INPUT-DATE-EDITMASK setting for the current locale. you can write a sophisticated data entry routine. The command was ignored. A nonzero error code is stored in the indicated numeric variable if the length or datatype entered is incorrect. The following table lists the values of the INPUT command's status argument.YYYY [BC|AD] [HH:MI[:SS[. use a database-independent format for the data as listed in the Datatypes Supported by the INPUT CommandExamples table. Parameters Parameter input_var Description Specifies a text. No arguments remain on the command line.NNNNNN]] [AM|PM]] SYYYYMMDD[HH24[MI[SS[NNNNNN]]]] Specifying STATUS causes the INPUT command to complete regardless of what the user enters. or date variable for the input data.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Datatype Description NUMBER INTEGER DATE A floating point number in the format [+|-]9999.NNNNNN]] [AM|PM]] MM. It can be a date edit mask or the keyword DATE. Specifies the maximum length for the data. 20) != 'Enter Start Date: ' noprompt 0 clear-line type=date $start-date status=#istat #istat goto show (24. NOPROMPT BATCH-MODE FORMAT Example The following example shows several INPUT commands: input input input input input $state #age maxlen=2 'Please enter state abbreviation' type=integer type=date 'Enter lower age boundary' format='Mon dd yyyy' $start_date $date_in $date 'Enter starting date for report' format=date The following example shows another INPUT command: show clear-screen (5.1) 'Please enter date in format DD-MON-YY' beep try_again ! Clear error end-if show (24.32) reverse 'CUSTOMER SUMMARY' normal Try_again: show input if (12. If BATCH-MODE is specified and no more arguments are in the command line.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter prompt TYPE STATUS Description Specifies the prompt displayed to the user. The Date Edit Format Codes table lists date edit format codes. Specifies the datatype required for the input.1) clear-line message line. The following example illustrates the use of the BATCH-MODE option: begin-program while (1) input $A status=#stat batch-mode if #stat = 3 break else do procedure ($a) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-125 . Specifies the format for entering a date. a value of 3 is returned in the STATUS variable and the user is not prompted for input. Prevents the prompt from being displayed before the INPUT command is processed. Specifies a numeric variable for a return status code. Example begin-footing 1 page-number appear as last-page end-footing (1. Specifies a text string to be printed before the last page number. The INPUT-DATE-EDIT-MASK setting in the "SQR. BEGIN-HEADING. and BEGIN-FOOTING commands.37) 'Page ' () ' of ' '.INI" section. Specifies a text string to be printed after the last page number. as in "page n of m"." See Also The PAGE-NUMBER. The text strings specified in pre_txt_lit and post_txt_lit are printed immediately before and after the number.SQR FOR PEOPLESOFT LANGUAGE REFERENCE end-if end-while end-program See Also The ALTER-LOCALE command in this section. 2-126 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Parameters Parameter position pre_txt_lit post_txt_lit Description Specifies the position for printing the last page number.' ! Will ! "Page 12 of 25. Using LAST-PAGE causes SQR and SQRT to delay printing until the last page has been processed so that the number of the last page is known. LAST-PAGE Syntax LAST-PAGE position [pre_txt_lit[post_txt_lit]] Description Places the last page number on each page. Working from the inside out. SQR also provides a rich set of mathematical. operands of lower precision are converted to match the operand of higher precision. Consider the following example: let #answer = #float * #decimal / #integer Because the multiply and divide operators are equal in precedence. numeric. The number of significant digits is not lost when an integer is converted to float or decimal. The expression to evaluate. and functions. SQR now converts the #integer operand to a decimal type before performing the final divide. (#decimal)/#integer. (2) the operator. expression Operands Operands form the backbone of an SQR expression. SQR supports a standardized set of mathematical operators and logical comparison operators working within a carefully defined set of precedence rules. string. All combined. String. Valid expressions are formed as a combination of operands.SQR FOR PEOPLESOFT LANGUAGE REFERENCE LET Syntax LET dst_var=expression Description Assigns the value of an expression to a string. When finished with the expression evaluation. numeric and array field operands to form a valid expression. numeric. In a similar manner. operators. and file manipulation functions along with a number of special purpose utility functions. date. or date variable or array field to which the result of the expression is assigned. The number of significant digits is only sacrificed when the final result is converted to match the type of the #answer variable and this variable is less precise than the highest of the operands being evaluated. and array field operands can be used in an expression and embedded functions. As the expression is evaluated. Parameters Parameter dst_var Description A string. Converting operands of lower precision to operands of higher precision preserves the number of significant digits. the expression is evaluated as (#float * #decimal) / #integer. numeric. or date variable. the number of significant digits is preserved when floating point operands are converted to the decimal type. the #float variable is converted to a decimal type where a multiply is performed yielding the simplified expression. SQR performs a sequence of automatic operand conversions as it evaluates expressions that contain dissimilar operand types. SQR converts the result to match the type of the #answer variable. the SQR expression provides a powerful tool that can be tailored to suit any information processing need. date. You can combine string. In the PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-127 . Operands do not have to be the same type. The following detail outlines the specific behavior of each expression component: (1) the operand. and (3) the function. precision is not lost if the #answer is declared as a decimal type. Operators listed in the same row within the table have the same precedence (the operators *.. <=./. float. <>.total (#store_id. equal Logical NOT Logical AND Logical OR.. = not and or. followed by float and then decimal.b) for integers Plus. ^ *..processing when out of range.. 2) $first_name || ' ' || $last_name customer. 'MON DD YYYY') The following sections list operators and functions supported in expressions. less than. /. Operator Explanation || +. remainder: a % b = mod(a. integer) are supported for all operators. #qtr) = store. xor Comparison operators: greater than. % +. 'G') .% are equal in precedence). from left to right. not equal (!= or <>). - Concatenate two strings or dates Sign prefix (positive or negative) Exponent Multiply. <.total (#customer_id) + #invoice_total if not range(upper($code). XOR (exclusive OR) 2-128 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . minus Note: SQR distinguishes between a sign prefix and arithmetic operation by the context of the expression.total (#store_id. !=. 'A'.total (#customer_id) = customer. Operators The following table lists operators in descending order of precedence. >. Operators of the same precedence are processed in the sequence they appear in the expression. divide. SQR considers integer variables as the lowest in the precision hierarchy. Here are a few simple expression examples: let let let #discount $name = = round (&price * #rate / 100. Use parentheses to override the normal precedence rules. let store.SQR FOR PEOPLESOFT LANGUAGE REFERENCE example. All numeric types (decimal. >=. #qtr) + #invoice_total let $date1 = strtodate ('Apr 10 1996'. greater or equal to. less than or equal to. variable. Use parentheses to override the normal precedence rules. This function returns a float value. The value is always converted to float. column. Example: let #dabsvar = abs(#dvar) acos Returns the arccosine of num_value In the range of 0 to radians. dst_var = decimal. or third argument of a function. and miscellaneous functions. Example: let #facosvar = acos(#fvar) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-129 . integer). float. Arguments referenced as x. The value of num_value must be between -1 and 1. Function arguments are enclosed in parentheses and can be nested. The following table lists numeric functions. second. Otherwise. The following table annotates the functions that directly support the decimal type and which ones do not. or integer literal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Functions This section lists numeric. or integer literal. float. or expression. functions take a single argument or no arguments. but convert input decimal operands to the float type before the function is evaluated. variable. Syntax: dst_var = acos(num_value) num_value = decimal. or z indicate the first. float. This function returns a value of the same type as num_value. Syntax: dst_var = abs(num_value) num_value = decimal. or integer variable. The functions are listed in alphabetical order. float. All arguments are evaluated before a function is evaluated. y. or expression. file-related. float. Function abs Description Returns the absolute value of num_value. column. Not all functions support all numeric types (decimal. or integer variable. dst_var = decimal. Certain functions do not support the decimal type directly. column. dst_var = decimal. or integer variable. variable. The value of num_value must be between -1 and 1. dst_var = decimal. Example: let #fatanvar = atan(#fvar) ceil Returns a value representing the smallest integer that is greater than or equal to num_value. The value of num_value must be between -1 and 1. Example: let #fasinvar = asin(#fvar) atan Returns the arctangent of num_value in the range of . float. column. or expression. The value is always converted to float. variable. Syntax: dst_var = ceil(num_value) num_value = decimal./2 to /2 radians. This function returns a float value. or integer variable. or integer literal. This function returns a value of the same type as num_value. This function returns a float value. float. Syntax: dst_var = atan(num_value) num_value = decimal. Syntax: dst_var = asin(num_value) num_value = decimal. column. float. float. or integer literal. float. or integer variable. or integer literal. or expression./2 to /2 radians. The value is always converted to float. or expression. float. Example: let #fceilvar = ceil(#fvar) 2-130 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . variable. dst_var = decimal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function asin Description Returns the arcsine of num_value in the range of . or integer variable. Syntax: dst_var = cosh(num_value) num_value = decimal. dst_var = decimal. The value is always converted to float. float. Example: let #fcosvar = cos(#fvar) cosh Returns the hyperbolic cosine of num_value. Example: let #fcoshvar = cosh(#fvar) deg Returns a value expressed in degrees of num_value which is expressed in radians. or expression. column. float. dst_var = decimal. variable. The value is always converted to float. or integer literal. Example: let #fdegvar = deg(#fvar) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-131 . dst_var = decimal. This function returns a float value. or integer variable. Syntax: dst_var = deg(num_value) num_value = decimal. column. column. variable. variable. float. float. Syntax: dst_var = cos(num_value) num_value = decimal. or integer literal. This function returns a float value. This function returns a float value. or integer variable. or integer literal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function cos Description Returns the cosine of num_value. or expression. float. or expression. float. The value is always converted to float. float. Example: let #ffloorvar = floor(#fvar) 2-132 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Syntax: dst_var = floor(num_value) num_value = decimal. dst_var = decimal. dst_var = decimal. column. float. float. column. float. or integer variable. or integer variable. The value is always converted to float. or integer variable. or expression. or integer literal. This function returns a float value. Example: let #fe10var = e10(#fvar) exp Returns the value of e raised to num_value. This function returns a value of the same type as num_value. Syntax: dst_var = exp(num_value) num_value = decimal. This function returns a float value.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function e10 Description Returns the value of 10 raised to num_value. or integer literal. Syntax: dst_var = e10(num_value) num_value = decimal. Example: let #fexpvar = exp(#fvar) floor Returns a value representing the largest integer that is less than or equal to num_value. variable. column. or expression. The value is always converted to float. or expression. dst_var = decimal. or integer literal. float. variable. variable. float. #fyvar) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-133 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function log Description Returns the natural logarithm of num_value. column. or integer literal. column. The value is always converted to float. and the absolute value of f is less than the absolute value of y_value. variable. Syntax: dst_var = log10(num_value) num_value = decimal. Syntax: dst_var = mod(x_value. Example: let #fmodvar = mod(#fxvar. variable. or expression. Example: let #flogvar = log(#fvar) log10 Returns the base-10 logarithm of num_value. f has the same sign as x_value. dst_var = decimal. column. float. or integer literal. column. or integer variable. float. float. or integer variable. float. variable. or expression. of x_value/ y_value such that x_value = i * y_value + f. float. Syntax: dst_var = log(num_value) num_value = decimal. y_value) x_value = decimal. float. float. The value is always converted to float. where i is an integer. f. dst_var = decimal. or integer variable. or integer literal. The arguments are promoted to the type of the greatest precision and the function returns a value of that type. This function returns a float value. or integer literal. y_value = decimal. dst_var = decimal. Example: let #flog10var = log10(#fvar) mod Returns the fractional remainder. This function returns a float value. or expression. or expression. variable. float. The value is always converted to float. or expression. variable. float. This function returns a float value. float. The value is always converted to float. Syntax: dst_var = rad(num_value) num_value = decimal. y_value) x_value = decimal. column. variable. float. The value is always converted to float. float. place_value) num_value = decimal. variable. The value is always converted to float. #fyvar) rad Returns a value expressed in radians of num_value which is expressed in degrees. or integer variable. or integer literal. or expression. dst_var = decimal. or expression. or expression. float. or integer variable. float. place_value = decimal. column. or integer literal. or expression. variable. float. Example: let #frndvar = round(#fvar. column. column. or integer literal. or integer variable. or integer literal. dst_var = decimal. Syntax: dst_var = power(x_value.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function power Description Returns the value of x_value raised to the power of y_value. column. y_value = decimal. float. Example: let #fradvar = rad(#fvar) round Returns a value that is num_value rounded to place_value digits after the decimal separator. dst_var = decimal. or integer literal. or integer literal. Example: let #fpowervar = power(#fxvar. #fplace) (#x. #y) 2-134 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . variable. column. This function returns a float value. variable. or expression. Syntax: dst_var = round(num_value. The value is always converted to float. This function returns a value of the same type as num_value. place_value = decimal. or expression. This function returns a float value. The value is always converted to float. or integer literal. or +1 depending on the sign of num_value. Syntax: dst_var = sinh(num_value) num_value = decimal. dst_var = decimal. or integer variable. dst_var = decimal. float. or integer variable.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function sign Description Returns a -1. float. Example: let #fsinhvar = sinh(#fvar) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-135 . or integer variable. float. The value is always converted to float. This function returns a float value. or expression. or integer literal. 0. Example: let #fsinvar = sin(#fvar) sinh Returns the hyperbolic sine of num_value. column. or integer literal. or expression. float. This function returns a float value. variable. variable. float. variable. Syntax: dst_var = sin(num_value) num_value = decimal. float. dst_var = decimal. column. column. Syntax: dst_var = sign(num_value) num_value = decimal. Example: let #fsignvar = sign(#fvar) sin Returns the sine of num_value. or expression. The value is always converted to float. Example: let #ftanhvar = tanh(#fvar) 2-136 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or integer variable. The value is always converted to float. Syntax: dst_var = tanh(num_value) num_value = decimal. or integer variable. variable. float. float. column. Syntax: dst_var = sqrt(num_value) num_value = decimal. Example: let #ftanvar = tan(#fvar) tanh Returns the hyperbolic tangent of num_value. This function returns a float value. or integer literal. float. variable. dst_var = decimal. column. column. or integer literal. float. or integer variable. dst_var = decimal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function sqrt Description Returns the square root of num_value. The value is always converted to float. dst_var = decimal. or expression. This function returns a float value. or expression. or integer literal. Example: let #fsqrtvar = sqrt(#fvar) tan Returns the tangent of num_value. Syntax: dst_var = tan(num_value) num_value = decimal. float. float. This function returns a float value. variable. Syntax: stat_var = delete(filename) filename = text literal. #fplace) The transcendental functions sin. cos. use the rad or deg functions as follows: let #x = sin(rad(45)) let #y = deg(asin(#x)) ! Sine of 45 degrees. float. dst_var = decimal. or expression. passing a negative number to the sqrt function causes an error. For example. The function returns either a zero (0) to indicate success or the value returned from the operating system to indicate an error. and tanh take their arguments in radians. This function returns a value of the same type as num_value. float. The value is always converted to float. they return the system error code. SQR halts with an error message. ! Convert back to degrees. or expression. otherwise. column. or integer variable. tan. or integer literal. column. place_value = decimal. Function Description delete Deletes the file filename. variable. column. or integer literal. These functions return zero (0) if successful. Example: let #ftruncvar = trunc(#fvar. cosh.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Trunc Description Returns a value that is num_value truncated to place_value digits after the decimal separator. or integer variable. float. or expression. acos. sinh. The following table lists file-related functions. To convert from radians to degrees or degrees to radians. place_value) num_value = decimal. float. and atan return radian values. Example: let #fstatus = delete($filename) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-137 . stat_var = decimal. Syntax: dst_var = trunc(num_value. variable. variable. The functions asin. If arguments or intermediate results passed to a numeric function are invalid for that function. Use the cond function described in the Miscellaneous Functions table to prevent division by zero or other invalid function or operator argument values. exists.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Description exists Determines if the file. For TIME columns. • • On the other hand. column. These functions return a string value unless otherwise indicated. In these functions where a string argument is expected and a date variable. or expression is entered where a date argument is expected. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. except where noted in an individual function. If this has not been set. float. Example: let #fstatus = exists($filename) Rename Renames old_filename to new_filename. Example: let #fstatus = rename($old_filename. variable. If this has not been set. or expression is entered. new_filename = text literal. filename. the format listed in the DATE Column Formats table is used. or integer variable. variable. SQR converts the date to a string according to the following rules: • For DATETIME columns and SQR DATE variables. then the string must be in the format specified by the SQR_DB_DATE_FORMAT setting. Syntax: stat_var = exists(filename) filename = text literal. stat_var = decimal. the format specified by the SQR_DB_DATE_FORMAT setting is used. column. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. If this has not been set. variable. if a string variable. The function returns either a zero (0) to indicate success or the value returned from the operating system to indicate an error. or integer variable. or expression. the format as listed in the TIME Column Formats table is used. column. new_filename) old_filename = text literal. the first database-dependent format as listed in the Default Database Formats table is used. float. column. one of the database-dependent 2-138 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or expression. $new_filename) The following table lists miscellaneous functions. Syntax: stat_var = rename(old_filename. stat_var = decimal. or expression. The function returns either a zero (0) to indicate success or the value returned from the operating system to indicate an error. column. For DATE columns. or integer variable Example: let #fascii = asciic($filename) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-139 . variable. column. 'c') ascii Returns the ASCII value for the first character in str_value. field_name) array_name = text literal. or expression array_var = text variable Example: let #fstatus = printarray(array('products'. Syntax: array_var = array(array_name. Syntax: ascii_var = asciic(str_value) str_value = date or text literal. or the database-independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]' Function Explanation array Returns a pointer to the starting address of the specified array field. column. This function returns a float value. 10.SQR FOR PEOPLESOFT LANGUAGE REFERENCE formats listed in the Default Database Formats table. or expression field_name = text literal. float. variable. variable. 'name'). variable. column. The value returned from this function can only be used by a user-defined function. column. See the routine printarray in the file UFUNC. float. Syntax: ascii_var = ascii(str_value) str_value = date or text literal. or expression ascii_var = decimal. or integer variable Example: let #fascii = ascii($filename) asciic Returns the numeric value for the first character (rather than byte) of the specified string.C for complete instructions on how to use this function. 2. or expression ascii_var = decimal. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation chr Returns a string that is composed of a character with the ASCII value of num_value. The value is always converted to float. column. Example: let $svar = chr(#num) cond Returns y_value if the x_value is nonzero (0) otherwise returns z_value. column. otherwise. 1) 2-140 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . date and textual arguments are compatible. column. z_value) x_value = decimal. or expression. column. Syntax: dst_var = chr(num_value) num_value = decimal. a date is returned. or expression z_value = Any literal. the z_value must also be numeric. The value is always converted to float. If y-value is numeric. If either the y_value or z_value is a date variable. or expression dst_var = Any variable Example: let #avg = #total / cond(&rate != 0. y_value = Any literal. or integer literal. &rate. or expression. or integer literal. variable. column. or expression. variable. y_value. variable. The return value of the function depends on which value is returned. float. variable. Syntax: dst_var = cond(x_value. dst_var = text variable. float. date_var = date variable Example: let $date = dateadd($startdate. 'hour'. 7. 'week'. 'quarter'. float. 'hour'. 'month'. or integer literal. Syntax: dst_var = datenow() dst_var = date variable Example: let $date = datenow() PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-141 . units_value) date1_value = date variable or expression date2_value = date variable or expression units_value = text literal. Syntax: dst_var = datediff(date1_value. 'quarter'. column. Syntax: date_var = dateadd(date_value. and 'second' dst_var = decimal. quantity_value) date_value = date variable or expression units_value = text literal. Valid units are 'year'. and 'second' quantity_value = decimal. 'day'. or integer variable Example: let #diff = datediff($date1. 'minute'. column. 'month'. or expression. 'week'. 'hour') datenow Returns the current local date and time from the client machine. $date2. float. variable. variable. or expression. or expression. The result can be negative if the first date is earlier than the second date. date2_value. The value is always converted to float.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation dateadd Returns a date after adding (or subtracting) the specified units to the date_value. column. Valid units are 'year'. 'day'.5) datediff Returns the difference between the specified dates expressed in units_value. The function returns a float value. 'minute'. variable. 'day'. units_value. '(xxx) xxx-xxxxx') let $price = edit(#price. 'DD/MM/YYYY') getenv Returns the value of the specified environment variable. If this argument is not specified. variable.99') let $today = edit($date. DATE) edit Formats source_value according to edit_mask and returns a string containing the result. YYYY') let $localedate = datetostr($date. then the format specified by the SQR_DB_DATE_FORMAT setting is used. '999. The keyword DATE can be used to specify the DATE-EDIT-MASK setting from the current locale. variable. dst_var = text variable Example: let $formdate = datetostr($date. Syntax: dst_var = getenv(env_value) env_value = text literal. format_mask]) date_value = date variable or expression format_mask = text literal. column.dependent format listed in the Default Database Formats table is used. edit_mask) source_value = Any literal. or expression. 'Day Mon DD. variable. If the environment variable does not exist. column. or expression dst_var = text variable Example: let $phone = edit(&phone. If this has not been set. column. variable.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation datetostr Converts the date date_value to a string in the format format_mask. column. or expression edit_mask = text literal. then the first database. an empty string is returned. Syntax: dst_var = edit(source_value. Syntax: dst_var = datetostr(date_value [. or expression dst_var = text variable Example: let $myuser = getenv('USER') 2-142 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Syntax: dst_var = instr(source_value. The search begins at offset offset_value. column. column. 10) instrb Performs the same functionality as the instr function except that the starting point and returned value are expressed in bytes rather than in characters. column. variable. or integer literal. float. This function returns a float value. offset_value) source_value = date or text literal. or integer variable Example: let #offset = instrb(&description. Syntax: dst_var = instrb(source_value. or expression sub_value = text literal. variable. dst_var = decimal. or integer literal. or integer variable Example: let #offset = instr(&description. or expression offset_value = decimal. or expression offset_value = decimal. or expression. dst_var = decimal. 10) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-143 . variable. The value is always converted to integer. 'auto'. column. or expression sub_value = text literal. float. variable. sub_value. variable. variable. or expression.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation instr Returns the numeric position of sub_value in source_value or zero (0) if not found. float. offset_value) source_value = date or text literal. The value is always converted to integer. column. 'auto'. column. float. sub_value. Syntax: dst_var = isblank(source_value) source_value = date or text literal. column. variable. PeopleSoft recommends that you use either the lengthp or lengtht function instead of the length function. returns a value of zero (0). column. Syntax: dst_var = length(source_value) source_value = date or text literal. float. column. or expression dst_var = decimal. float. variable. otherwise. float. null string. or integer variable Example: let #length = length(&description) Note. or expression dst_var = decimal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation isblank Returns a value of one (1) if source_val is an empty string. otherwise. 2-144 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or integer variable Example: let #blank = isblank(&description) isnull Returns a value of one (1) if source_val is null. or composed entirely of whitespace characters. variable. Syntax: dst_var = isnull(source_value) source_value = date or text literal. or integer variable Example: let #null = isnull($date) length Returns the number of characters in source_value. returns a value of zero (0). or expression dst_var = decimal. PeopleSoft recommends that you use either the lengthp or lengtht function instead of the lengthb function. or expression. variable. column. lengthp Returns the length of a given string in print positions. 'Shift-JIS') PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-145 . variable. rather than in characters. float. or integer variable Example: let #printlen = lengthp(&string) lengtht Returns the length of a given string in bytes when converted (transformed) to a specified encoding. column. column. variable. variable. or integer variable Example: let #sjislen = lengtht($string. float. dst_var = decimal. Syntax: dst_var = lengtht(source_value. or expression dst_var = decimal. float. or expression encoding_value = text literal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation lengthb (Multi-byte versions of SQR only) Has the same functionality as the length function except that the return value is expressed in bytes. or integer variable Example: let #length = lengthb(&description) Note. Syntax: dst_var = lengthb(source_value) source_value = date or text literal. encoding_value) source_value = date or text literal. or expression dst_var = decimal. Syntax: dst_var = lengthp(source_value) source_value = date or text literal. column. 25. pad_value = text literal. column. Syntax: dst_var = lower(source_value) source_value = date or text literal. or expression dst_var = text variable Example: let $lpad = lpad($notice. column. column. The value is always converted to integer.') ltrim Trims characters in source_value from the left until a character is not in set_value and returns the result.') 2-146 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or expression dst_var = text variable Example: let $lower = lower(&description) lpad Pads the source_value on the left to a length of length_value using pad_value and returns the result.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation lower Converts the contents of source_value to lowercase and returns the result. pad_value) source_value = date or text literal. length_value. or integer literal. variable. column. column. variable. '. Syntax: dst_var = lpad(source_value. variable. Syntax: dst_var = ltrim(source_value. column. or expression set_value = text literal. or expression length_value = decimal. set_value) source_value = date or text literal. variable. variable. '. float. variable. or expression. or expression dst_var = text variable Example: let $ltrim = ltrim(&description. or expression dst_var = Any variable Example: let $city = nvl(&city. '-. or the format listed in the DATE Column Formats table is used. The return value of the function depends on which value is returned. In any case. y_value must also be numeric. y_value) x_value = Any literal. the format specified by the SQR_DB_DATE_FORMAT setting. column. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation nvl Returns y_value if the x_value is null otherwise returns x_value. Syntax: dst_var = nvl(x_value. For DATE columns. the x_value determines the type of expression returned. or expression y_value = Any literal. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting. For TIME columns.not city --') If x_value is a date and y_value is textual. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-147 . column. then y_value is validated according to the following rules: For DATETIME columns and SQR DATE variables. variable. or the database-independent format 'SYYYYMDD[HH24[MI[SS[NNNNNN]]]]' is used. or the format as listed in the TIME Column Formats table is used. If x_value is numeric. otherwise. variable. one of the database-dependent formats (see the Default Database Formats table). date and textual arguments are compatible. or expression z_value = Any literal. or the database-independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]' is used. or integer variable Example: let #inrange let #inrange $enddate) let #inrange Apr-97') let #inrange = range(&grade. or the format listed in the table DATE Column Formats is used. 'D') = range($date. variable. If the first argument is text or numeric. For TIME columns. one of the database-dependent formats (see the Default Database Formats table). or expression dst_var = decimal. the other arguments must be of the same type. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting. z_value) x_value = Any literal. column. variable.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation range Returns a value of one (1) if x_value is between y_value and z_value. Syntax: dst_var = range(x_value. the remaining arguments can be dates and/or text. variable. the format specified by the SQR_DB_DATE_FORMAT setting. For DATE columns. for example. 2-148 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . #low. y_value must represent a date that is earlier than that of z_value. = range($date. #high) If x_value is a date and y_value and/or z_value is textual. where x_value is a date and y_value and z_value are text arguments. otherwise returns a value of zero (0). float. then y_value and/or z_value is validated according to the following rules: For DATETIME columns and SQR DATE variables. $startdate. y_value. It is also possible to perform a date comparison on a mix of date and text arguments. 'A'. or the format as listed in table TIME Column Formats is used. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting. In a comparison of this sort. $startdate. column. '15= range(#price. or expression y_value = Any literal. column. If the first argument is a date. column. column. to_string) source_value = date or text literal. variable. variable. or expression dst_var = text variable Example: let $replaced = replace($paragraph. column. variable. '. pad_value) source_value = date or text literal. column. or integer literal. float. The value is always converted to integer. or expression from_string = text literal. variable. variable. 25. 'good'. or expression to_string = text literal. column.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation replace Inspects the contents of source_value and replaces all occurrences of from_string with to_string and returns the modified string. variable. Syntax: dst_var = replace(source_value. Syntax: dst_var = roman(source_value) source_value = text literal. variable. dst_var = text variable Example: let $roman = roman(#page-count) rpad Pads the source_value on the right to a length of length_value using pad_value and returns the result. or expression dst_var = text variable Example: let $rpad = rpad($notice. length_value. column. Syntax: dst_var = rpad(source_value. pad_value = text literal. 'excellent') roman Returns a string that is the character representation of source_value expressed in lowercase roman numerals. or expression. column. or expression length_value = decimal. from_string. or expression.') PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-149 . or expression set_value = text literal. or the database-independent format 'SYYYYMDD[HH24[MI[SS[NNNNNN]]]]'. Valid format codes are specified in the Date Edit Format Codes table.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation rtrim Trims characters in source_value from the right until a character is not in set_value and returns the result. '. column. column. YYYY') let $date = strtodate($str_date. The keyword DATE can be used to specify the DATE-EDIT-MASK setting from the current locale. then source_value must be in the format specified by the SQR_DB_DATE_FORMAT setting. If this argument is not specified. column. variable. 'Mon DD. or expression that describes the exact format of the source_value. set_value) source_value = date. or expression dst_var = text variable Example: let $rtrim = rtrim(&description. variable. dst_var = date variable Example: let $date = strtodate($str_date. variable. Syntax: dst_var = rtrim(source_value. format_mask]) source_value = text literal. DATE) 2-150 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or expression format_mask = text literal. column. one of the database-dependent formats (see the Default Database Formats table). Syntax: dst_var = strtodate(source_value [. variable.') strtodate Converts the string source_value in the format format_mask to a date type. or text literal. #len) Note. length_value = decimal. or expression.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation substr Extracts the specified portion source_value. PeopleSoft recommends that you use either the substrp or substrt function instead of the substrb function. float. Offset_value = decimal. or expression. column. offset_value. column. The extraction begins at offset_value (origin is 1) for a length of length_value characters. offset_value. Example: let $piece = substr(&record. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-151 . 10. The value is always converted to integer. variable. column. The value is always converted to integer. or expression. or integer literal. Syntax: dst_var = substr(source_value. variable. Example: let $piece = substrb(&record. The value is always converted to integer. or expression. float. column. PeopleSoft recommends that you use either the substrp or substrt function instead of the substr function. The value is always converted to integer. float. column. float. dst_var = text variable. length_value = decimal. variable. column. or expression. or expression. rather than in characters. #len) Note. or integer literal. length_value) source_value = date or text literal. or integer literal. or integer literal. 10. variable. variable. Syntax: dst_var = substrb(source_value. substrb Has the same functionality as the substr function except that the starting point and length are expressed in bytes. variable. dst_var = text variable. length_value) source_value = date or text literal. offset_value = decimal. 10. column. length_value. The value is always converted to integer. column. column. The value is always converted to integer. Syntax: dst_var = substrp(source_value. variable. length_value = decimal. column. variable. or integer literal. encoding_value = text literal. float. The value is always converted to integer. float. variable. length_value) source_value = date or text literal. dst_var = text variable. encoding_value) source_value = date or text literal. 'Shift-JIS') 2-152 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . column. or expression. variable. or integer literal. or expression. column. Syntax: dst_var = substrt(source_value. float. float. dst_var = decimal. or integer literal. or expression. variable. 1. or expression. Offset_value = decimal. Example: let $sub = substrp(&string. offset_value. variable. #printpos. or expression. offset_value. column. or expression. or integer variable. offset_value = decimal. The value is always converted to integer. #printlen) substrt Returns a substring of a given string starting at a specified byte and byte length in a given encoding.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation substrp Returns a substring of a given string starting at a specified print poition into the string and of a specified print length. or integer literal. variable. length_value = decimal. or expression. Example: let $sjisPrep = substrt(&string. float. float. roman characters. variable. variable. or expression dst_var = text variable Example: let $string = to_char(#number) to_multi_byte Converts the specified string as follows: Any occurrance of a double-byte character that also has a single-byte representation (numerals. Syntax: dst_var = to_number(source_value) source_value = decimal. and katakana) is converted. or integer literal. using maximum precision. variable. or expression dst_var = decimal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation to_char Converts source_value to a string. float. column. Syntax: dst_var = to_multi_byte (source_value) source_value = date or text literal. or expression Example: let $multi = to_multi_byte (&text) to_number Converts source_value to a number. float. column. punctuation. column. or integer variable Example: let #value = to_number($number) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-153 . This function returns a float value. or integer literal. Syntax: dst_var = to_char(source_value) source_value = decimal. column. roman characters. Syntax: dst_var = transform(source_value. column.'. EBCDIK290. variable.. variable. column. '. column.. transform_value) source_value = date or text literal. Syntax: dst_var = to_single_byte(source_value) source_value = date or text literal.999. Syntax: dst_var = translate(source_value. and EBCDIK1027. column. variable or expression transform_value = text literal. and katakana) is converted. or expression Example: let $single = to_single_byte (&text) translate Inspects the contents of source_value and converts characters that match those in from_set to the corresponding character in to_set and returns the translated string. or expression to_set = text literal.99'). variable. '. from_set. or expression dst_var = text variable Example: let $translated = translate(edit(&price. variable. or expression dst_var = text variable Example: let $hiragana = transform($string. any occurrance of a singlebyte character that also has a multi-byte representation (numerals. 'ToHiragana') 2-154 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This fnction also converts a sequence of kana characters followed by certain grammatical marks into a single-byte character that combines the two elements. For all other encodings. column.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation to_single_byte Converts the specified string as follows: For SJIS. the string is not modified. '999. variable.') transform Returns a Unicode string which is a specified transform of a given string. punctuation. to_set) source_value = date or text literal. or expression from_set = text literal. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Function Explanation unicode Returns a Unicode string from the string of hexadecimal values provided. Syntax: dst_var = upper(source_value) source_value = date or text literal. line_height.'') PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-155 . wrap_width. column.40. or integer variable Example: let #depth = wrapdepth(&description. column. Syntax: dst_var = wrapdepth(source_value. strip = text literal. column. float. float. column. or integer literal. or integer literal. or expression wrap_width = decimal. Syntax: dst_var = unicode(source_value) source_value = text literal. variable. or expression dst_var = text variable Example: let $upper = upper(&description) wrapdepth Returns the number of print lines required by source_value. column. See the PRINTWRAP command for detailed descriptions of the parameters to this function.'<13>'. variable. float. or expression line_height = decimal. variable or expression dst_var = text variable Example: let $uniStr = unicode('u+5e73 u+2294') upper Converts the contents of source_value to uppercase and returns the result. variable. on. column. column. or expression. or expression dst_var = decimal. variable. This function returns a float value. variable. strip) source_value = text literal. variable.1. or expression on = text literal. 0. (double *) Address for result numeric value. 0. 'n'.C is random. then the same sequence is used. to either char[ ] or double. When adding functions to UFUNC. The function name in UFUNC. The name of the function called from sqr is random.C." and the argument type is n for numeric. The following is a step-by-step example of how to add a user-defined function to SQR so that it can be invoked using the LET. The function accepts a parameter that is used as the seed to start a new sequence of numbers. The return type is n for numeric. function returns zero. 2-156 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Name Return_type Number of Arguments Arg_Types Function • "max". you can write your own functions in C. 'n'. you must relink SQR. If unchanged.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Writing Custom Functions In addition to using the preceding built-in functions. using the supplied source file UFUNC. IF. If the seed is zero. (char *) or (double *) Array of argument pointers. keep in mind the following considerations: • String functions require the following arguments: (int) Number of arguments. (char *) Address for result string.C file that was provided with SQR: • Add the prototype for the random function: static void random CC_ARGS((char *. Add the function name to the declaration list. The example adds the C function random. • Numeric functions require the following arguments: (int) Number of arguments. char *)). in bytes. "n". (char *) or (double *) Array of argument pointers. You can pass any number of arguments to your function and values can be returned by the function or passed back in variables. The number of arguments passed is "1. PVR max.C. (int) Maximum length of result string. "max". which returns a random number. "n". After editing and recompiling UFUNC. The characters "PVR" must be entered before the function name. add the following modifications to the UFUNC. If unchanged. function returns a NULL string. PVR max. or WHILE command. to either char[ ] or double. To add the random function to SQR. 0. 'n'. argv[]) CC_LARG(double *. 'n'. 0 }. "C". /* Last entry must be NULL -. • At the end the of UFUNC. *result = rand(). argv. 0. in your SQR program it can be referenced in either uppercase or lowercase.C and relink SQR. return. 4. "printarray". recompile UFUNC. the following is an example of a simple SQR program that uses the random function: begin-program do get-random-number do process-calculations end-program begin-procedure let #seed = 44 let #ran = random(#seed) end-procedure begin-procedure process-calculations . however.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Name Return_type Number of Arguments Arg_Types Function "split". 'n'. "random". '\0'. PVR split. . See the programmer's reference manual for details about your particular machine. add the following random routine. result)) CC_ARG(int.do not change */ "". argc) CC_ARG(double *. . "". PVR random. result) { if (*argv[0] != 0) srand(*argv[0]). "n". 1. } After these modifications. The routine name must be lowercase.C file. Finally. PVR printarray. /* The number arguments passed */ /* The argument list */ /* Where to store result */ static void random CC_ARGL((argc. "cnnc". PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-157 . and WHILE expressions when it compiles your code and saves the result in an internal format so that repetitive execution is at maximum speed.99') let summary.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example The following examples show some complex expressions: let #j = ((#a + #b) * #c) ^ 2 if #j > 2 and sqrt(#j) < 20 or #i + 2 > 17.#j+2)) != 'XXXX' and not isnull(&price) let #len = length(&fname || &initial || &lname) + 2 let $s = edit(&price * &rate.total(#j) > 1000000 let store. 'Day Month DD.)] [FROM-ROWSET=(m.m-.total(#j) = summary. IF.n..1. strtodate('1995'.'month'.total(#j) + (&price * &rate) if summary.4 while upper(substr(&descrip. #dept) = store. #dept) + #total let #diff = datediff(datenow(). '99999.'YYYY')..total (#store_id.-n. LOAD-LOOKUP Syntax In the SETUP section: LOAD-LOOKUP NAME=lookup_table_name TABLE=database_table_name KEY=key_column_name RETURN_VALUE=return_column_name [ROWS=initial_row_estimate_int_lit] [EXTENT=size_to_grow_by_int_lit] [WHERE=where_clause_txt_lit] [SORT=sort_mode] [QUIET] [SCHEMA=schema_name] [PROCEDURE=procedure_name] [COMMAND=command_string] [GETDATA=getdata_string] [PARAMETERS=(.50) let $date1 = datetostr(strtodate(&sale_date).total (#store_id.'day') let $newdate = dateadd(datenow().all)] [FROM-PARAMETER=rowset_name] In the body of the report: 2-158 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . YYYY') SQR analyzes LET. LOAD-LOOKUP retrieves two columns from the database. the KEY field and the RETURN_VALUE field. SQR lets the database sort the data. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-159 .n. a lookup table cannot be warranted.all)] [FROM-PARAMETER=rowset_name] Description Loads an internal table with columns from the database..)] [FROM-ROWSET=(m. if your report is small and the number of rows to be joined is small.SQR FOR PEOPLESOFT LANGUAGE REFERENCE LOAD-LOOKUP NAME=lookup_table_name TABLE=database_table_name KEY=key_column_name RETURN_VALUE=return_column_name [ROWS=initial_row_estimate_lit|_var|_col] [EXTENT=size_to_grow_by_lit|_var|_col] [WHERE=where_clause_txt_lit|_var|_col] [SORT=sort_mode] [QUIET] [SCHEMA=schema_name] [PROCEDURE=procedure_name] [COMMAND=command_string] [GETDATA=getdata_string] [PARAMETERS=(. because the entire table has to be loaded and sorted for each report run.-n. if the machine that SQR is running on is faster than the machine the database is running on. When you use the LOOKUP command SQR searches the array (with a "binary" search) to find the RETURN_VALUE corresponding to the KEY referenced in the lookup. Usually this type of lookup can be done with a database join. Enables a quick search using the LOOKUP command. Rows are ordered by KEY and stored in an array. EXTENT. The binary search is performed quickly regardless of how many rows are loaded. You could conceivably load an array with many thousands of rows.. This works fine if the database and SQR both use the same character set and collating sequence. The SORT argument enables you to specify the sorting method if this is not true. letting SQR perform the sort could decrease the execution time of the report. Use the LOAD-LOOKUP command in conjunction with one or more LOOKUP commands. Additionally. By default. but joins take substantially longer. LOAD-LOOKUP commands specified in the SETUP section are always loaded and cannot reference variables for the ROWS. and WHERE arguments. and in fact can be slower.m-. However. The only limit to the size of a lookup table is the amount of memory your computer has available. You can do this by concatenating columns. or numeric data types. The array name is referenced in the LOOKUP command. a value of 100 is used. SQR permits only integers 12 digits or less for the KEY column. The name of the column that is used as the key in the array that is used for looking up the information. there is no limit to the number of lookup tables that can be defined. This argument is optional. See the RETURN_VALUE argument. EXTENT WHERE 2-160 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . If specified. The WHERE clause is limited to 255 characters. next. The amount to increase the array when it becomes full. where the KEY and RETURN_VALUE columns or expressions are stored. a value of 25% of the ROWS value is used. If numeric. See your database manual for the correct syntax. the selection begins after the word WHERE. Keys can be character. Note. The name of the column (expression) that is returned for each corresponding key.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Except for the amount of available memory. The following example is for ORACLE. This argument is optional. RETURN_VALUE='name||''-''||country||''-''||popul ation' TABLE KEY RETURN_VALUE ROWS The initial size of the lookup table. Parameters Parameter NAME Description The name of the lookup table. A WHERE clause used to select a subset of all the rows in the table. This is not supported for DDO. You can combine several columns into an expression if you need several fields returned for each lookup. The name of the table in the database. and if not specified. date. Keys can be any database-supported expression. and if not specified. The warning message stating the number of duplicate keys found is also suppressed.' ! Lookup didn't find a match PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-161 . The DI method is applicable only to databases that provide this feature and have been installed in that manner. case-sensitive sort (not supported for DDO) DI—Database sorts data.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter SORT Description The sorting method to be used. Example The following command loads the array states with the columns abbr and name from the database table stateabbrs where country is "USA. when the command executes." load-lookup name=states rows=50 table=stateabbrs key=abbr return_value=name where=country='USA' The preceding array is used in the example for the LOOKUP command to retrieve the full text of a state name from the abbreviation. QUIET Suppresses the message Loading lookup array. The following values are permitted: DC—Database sorts data. case-sensitive sort SI—SQR sorts data. case-insensitive sort (not supported for DDO) SC—SQR sorts data. case-insensitive sort The default is SC or the method specified by the -LL command-line flag. The following example uses the LOOKUP command to validate data entered by a user using an INPUT command: get_state: input $state 'Enter state abbreviation' uppercase $state lookup states $state $name if $name = '' show 'No such state... if you want to print the entire state name rather than the abbreviation. 2-162 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . you could use LOAD-LOOKUP and then LOOKUP to do this.abbr and r. regions r' key=abbr return_value=name where='s. This table must be previously loaded with a LOAD. Speeds up processing for long reports.LOOKUP command. The two single quotes around USA and NE are translated to one single quote in the SQL statement.abbr = r. The following example uses joins in a LOAD-LOOKUP command by including two tables in TABLE and the join in WHERE: load-lookup name=states rows=50 sort=sc table='stateabbrs s. For example.location = ''ne''' LOOKUP Syntax LOOKUP lookup_table_name{key_any_lit|_var|_col} {ret_txt_var|_date_var} Description Searches a lookup table (an array) for a key value and returns the corresponding text string. Parameters Parameter lookup_table_name Description Specifies the lookup table. as shown in the following example: where='country=''USA'' and region = ''NE''' The entire WHERE clause is surrounded by quotes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE goto get_state end-if Surround any command argument with embedded spaces by single quotes. . if found...SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter key_any_lit | _var | _col ret_txt_var | _date_var Description The key used for the lookup. Example The following example works in conjunction with the example for the LOAD. LOWERCASE Syntax LOWERCASE txt_var Description Converts the contents of a text variable to lowercase.LOOKUP command: lookup states &state_abbr $state_name This example searches the states lookup table for a matching &state_abbr value. lowercase $answer See Also The lower function listed in the Miscellaneous Functions table. A string variable into which the corresponding value is returned. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-163 . a null is placed in $state_name.etc. See Also The LOAD-LOOKUP command. Example input $answer 'Type EXIT to stop' ! Allows user to enter ! upper or lowercase. it returns the corresponding state name in $state_name. If not found.. if $answer = 'exit' . Parameters Parameter txt_var Description Specifies a text variable to be converted to lowercase. When a date variable or column is moved to a string variable. Source and destination fields can be different types. you can reformat the field using the format_mask argument. • 2-164 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . If this has not been set. roman characters. For DATE columns. date and numeric variables are incompatible. text. the date is converted according to the following rules: • For DATETIME columns and SQR DATE variables. Optionally. numeric.SQR FOR PEOPLESOFT LANGUAGE REFERENCE MBTOSBS Syntax MBTOSBS {txt_var} Description Converts a double-byte string to its single-byte equivalent. the format listed in the DATE Column Formats table is used. punctuation. or date. MOVE is also useful for converting from one type to another. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. and katakana) is converted. Parameters Parameter txt_var Description Specifies the string to be converted. however. the format specified by the SQR_DB_DATE_FORMAT setting is used. the first databasedependent format as listed the Default Database Formats table is used. MOVE Syntax MOVE {src_any_lit|_var|_col} TO dst_any_var [[:$]format_mask|NUMBER|MONEY|DATE] Description Moves the source field to the destination field. See Also The TO_SINGLE_BYTE function of the LET command. This command converts the specified string as follows: Any occurrence of a double-byte character that also has a single-byte representation (numerals. If this has not been set. (See the command. the edit mask can be contained in a string variable. or a string literal. "PRINT". or literal. A date can be stored in a date variable or column.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • For TIME columns. Indicates that src_any_lit|_var|_col is to be formatted using the NUMBER-EDIT-MASK from the current locale. Finally. one of the databasedependent formats as listed in the Default Database Formats table. or variable. Note.) Indicates that src_any_lit|_var|_col is to be formatted using the MONEY-EDIT-MASK from the current locale. or variable. if a string literal. variable. column.) NUMBER MONEY DATE Example The following example illustrates the various features of the MOVE command: ! ! Convert a string in place ! move '123456789' to $ssn move $ssn to $ssn xxx-xx-xxxx show '$SSN = ' $ssn Produces the following output: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-165 . Parameters Parameter src_any_lit | _var | _col Description Specifies any source column. see the command. the source. "ALTER_LOCALE". the format as listed in the TIME Column Formats table is used. This option is not legal with date variables. When using a date format_mask or the keyword DATE with the MOVE command. This option is not legal with date variables. (See the command. must be in the format specified by the SQR_DB_DATE_FORMAT setting.) Indicates that src_any_lit|_var|_col is to be formatted using the DATE-EDIT-MASK from the current locale. dst_any_var format_mask Specifies a destination variable. Specifies an optional format mask. If this has not been set. For additional information regarding edit masks. (See the command "ALTER_LOCALE". or the database-independent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'. This option is not legal with numeric variables. ""ALTER_LOCALE". the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. as this example shows. column. 999.780000 ! ! Convert the number to a string using the locale default ! numeric edit mask ! alter-locale number-edit-mask = '99.89 to #value move #value to $value 999.78 to #defvar move #defvar to $defvar show '$DefVar = ' $defvar Produces the following output: $DefVar = 123.999. by default. ! If you require more or less precision.999. ouputs six digits of precision.SQR FOR PEOPLESOFT LANGUAGE REFERENCE $SSN = 123-45-6789 ! ! Convert a number to a string using an edit mask ! move 1234567.89 Produces the following output: $Counter = 000123 ! ! Convert a number to a string using the default edit mask ! ! SQR.234.999. ! move 123.99' move 123456.567.78 to #nvar move #nvar to $nvar number show '$NVar = ' $nvar 2-166 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .99 show '$Value = ' $value Produces the following output: $Value = ! ! Convert a number to a string using a variable edit mask ! move 123 to #counter move '099999' to $mask move #counter to $counter :$mask show '$Counter = ' $counter 1. specify an edit mask. $Date2 = 10/01/95 00:00 ! PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-167 .999.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Produces the following output: $NVar = ! ! Convert the money value to a string using the locale default ! money edit mask ! alter-locale money-edit-mask = '$9.456.456.78 Produces the following output: $MVar = $ ! ! Convert the date column to a string using the locale default ! date edit mask ! begin-select dcol from tables end-select alter-locale date-edit-mask = 'Mon-DD-YYYY' move &dcol to $dvar date show '$DVar = ' $dvar 123.99' move 123456.999.78 to #mvar move #mvar to $mvar money show '$MVar = ' $mvar 123.78 Produces the following output: $DVar = Jan-01-1999 ! ! Reset date to first day of the month ! ($date1 and $date2 have been defined as date variables) ! let $date1 = datenow() move $date1 to $date2 'MMYYYY' show '$Date2 = ' $date2 edit 'MM/DD/YY HH:MI' Produces the following output if the report was run in October of 1995. MONEY-EDIT-MASK.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ! Convert date to a string ! ($date1 has been defined as a date variable) ! move $date1 to $str_date 'DD-MON-YYYY' show '$Str_Date = ' $str_date Produces the following output. MULTIPLY Syntax MULTIPLY {src_num_lit|_var|_col} TIMES dst_num_var [ROUND=nn] Description Multiplies the first field by the second and places the result into the second field. 2-168 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The PRINT command regarding the default date-time components as a result of moving an incomplete date to a date variable. $Date1 = Nov 29 1995 00:00 See Also The LET command for information about copying. editing. The EDIT parameter of the PRINT command for a description of the edit masks. or converting fields. $Str_Date = 01-DEC-1995 ! ! Convert string (in partial format of SYYYYMMDDHHMISSNNN) to a ! date ! move '19951129' to $date1 show '$Date1 = ' $date1 edit 'Mon DD YYYY HH:MI' Produces the following output. The ALTER-LOCALE command for a description of the arguments NUMBER-EDIT-MASK. and DATE-EDIT-MASK. variable. For decimal variables. For integer variables. In reports where an overflow page is needed. The LET command for a discussion of complex arithmetic expressions.SQR FOR PEOPLESOFT LANGUAGE REFERENCE When dealing with money-related values (dollars and cents). Each NEW-PAGE occurrence adds a form feed character to the output file unless you specify FORMFEED=NO in the DECLARE-LAYOUT for this program in the SETUP section. this argument is not appropriate. NEW-PAGE Syntax NEW-PAGE [erase_from_line_num_lit|_var|_col] Description Writes the current page and begins a new one. After this action is performed. Float variables are stored as double precision floating point numbers. sometimes it is useful to retain information from the first page on succeeding pages. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-169 . Specifies a destination numeric variable. the value of #CURRENT-LINE is the same. Example multiply multiply &quantity 1. and small inaccuracies can appear when multiplying many numbers in succession. this command can optionally erase the old page starting at a specified line. or literal. The default action is to erase the entire page and reset #CURRENT-LINE to its initial value for the page. For float variables. the location on the page is unchanged—that is. use decimal variables rather than float variables. Rounds the result to the specified number of digits to the right of the decimal point. For line printers. These inaccuracies can appear due to the way different hardware and software implementations represent floating point numbers. this value can be from 0 to 15. Parameters Parameter src_num_lit | _var | _col dst_num_var ROUND Description Specifies a numeric source column. this value can be from 0 to the precision of the variable.5 times times #cost #result See Also The ADD command for more information. Example ! Write current page. It is possible that NEW-REPORT will not create a new file. or literal for line printers. use NEXT-LISTING instead. When used with multiple report declarations. This command is normally used with single reports only. variable. this command affects the current report only. Parameters Parameter {report_filename_txt_lit | _var | _col} Description Specifies a new file name. Note.lis' $next-file 2-170 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. A NEW-PAGE automatically occurs if page overflow is detected. then erase it ! beginning at line 5. if no data is selected and nothing is printed on the page. for example. Parameters Parameter erase_from_line_num_lit | _var | _col Description Specifies a numeric column. new-page 5 NEW-REPORT Syntax NEW-REPORT {report_filename_txt_lit|_var|_col} Description Closes the current report output file and opens a new one with the specified file name. Tabular reports do not require explicit NEW-PAGE commands. Example The following example shows the NEW-REPORT command: new-report new-report 'rep2a. SQR does not create a report output file until the first page is completed. The internal page counter is reset to 1 when NEW-REPORT is executed. The -F command-line flag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Assign the report file name within an SQR report by issuing the NEW-REPORT command before printing. GOTO-TOP ERASE-PAGE Example The following example prints columns across the page: columns 10 50 columns ! Define two PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-171 . the reserved variable $sqr-report is updated to reflect the new report name. This argument is useful when printing columns down the page.. Causes the current line in the next column to be num_lit|_var|_col. Parameters Parameter AT-END Description Takes effect if the current column is the last one defined when NEXT-COLUMN is invoked. See Also The DECLARE-REPORT and USE-REPORT commands. as shown in the following example: begin-report input . Specifies where to begin erasing the page when an AT-END=NEWPAGE occurs. $file 'Enter report file name' new-report $file After execution of this command. NEXT-COLUMN Syntax NEXT-COLUMN [AT-END={NEWLINE|NEWPAGE}] [GOTO-TOP={num_lit|_var|_col}] [ERASE-PAGE={num_lit|_var|_col}] Description Sets the current position on the page to the next column defined with the COLUMNS command.. You might even prompt for the file name to use. NEXT-LISTING is used in tabular reports.0) edit (xxx)bxxx-xxxx goto-top=1 at-end=newpage if #current-line >= #bottom_line next-column else position (+1.1) end-if from phonelist order by name end-select See Also The COLUMNS and USE-COLUMN commands. That is.+3.1. 5).SQR FOR PEOPLESOFT LANGUAGE REFERENCE begin-select name phone (0.20) (0. order by name end-select ! within two ! next-column Print names The following example prints columns down the page: columns 10 50 move 55 to #bottom_line begin-select name phone (0.+3. NEXT-LISTING Syntax NEXT-LISTING[NO-ADVANCE] [SKIPLINES={num_lit|_var|_col}] [NEED={num_lit|_var|_col}] Description Ends the current set of detail lines and begins another. if you then write PRINT (1. line 1 is reset one line below the deepest line previously printed in the page body. This command causes a new vertical offset in the page to begin. After NEXT-LISTING is executed. the string is printed on 2-172 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .0) edit (xxx)bxxx-xxxx at-end=newline ! across the page from phonelist columns.1.20) (0. 10. NEED=2 keeps 2 from customers order by cust_num ! line detail groups from end-select breaking across ! pages. then 1 is assumed. a new page is started. Note that the SQR reserved variable #currentline still reflects the actual line number within the page body.1) edit 099999 ! Each detail group prints ! starting ! ! city (.+2) moving line 1 down the next-listing skiplines=1 need=2 ! page. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-173 . The value of NEED must be an integer greater than 0. If it is less than 0.SQR FOR PEOPLESOFT LANGUAGE REFERENCE the next available line starting in column 5. The NEXT-LISTING command automatically issues a Use-Column 1 command if columns are active. then 0 is assumed. The value of SKIPLINES must be a nonnegative integer. SKIPLINES NEED Example begin-select cust_num (1. Causes the specified number of lines to be skipped before setting up the new offset.+3) on line 1 since name (2. ! Note.30) NEXT-LISTING keeps address (. You can use NEED to prevent a group of detail lines from being broken across two pages. If it is less than or equal to 0. The default increments the line position even when nothing was printed. Parameters Parameter NO-ADVANCE Description Suppresses any line movement when no printing has occurred since the previous NEXT-LISTING or NEW-PAGE. If this number of lines does not exist. Specifies the minimum number of lines needed to begin a new listing or set of detail lines. For existing files. this is the size of each record. a new file is created. When a file is opened in append mode. When a file is opened for reading.000. this is the size of each record without the line terminator. Specifies a number that identifies the file in the application. this is the maximum size for a record. You can use this file type when writing or reading binary data. The number can be any positive integer less than 64. For the VARY file type. the current file contents are preserved. File numbers can be numeric variables and literals. For the FIXED_NOLF file type. All data written is placed at the end of the file. {filenum_num_lit | _var | _col} FOR-READING FOR-WRITING FOR-APPEND RECORD FIXED 2-174 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This file type assumes that all records contained within the file are the same length. When a file is opened for writing. For the FIXED file type. All file commands use the file number to reference the file. The file name can be literal. it can be overwritten (this depends on the operating system). If a file of the same name already exists. Failure to do this can produce unpredictable results.SQR FOR PEOPLESOFT LANGUAGE REFERENCE OPEN Syntax OPEN {filename_lit|_var|_col} AS {filenum_num_lit|_var|_col} {FOR-READING|FOR-WRITING|FOR-APPEND} {RECORD=length_num_lit[:FIXED|:FIXED_NOLF|:VARY]} [STATUS=num_var] Parameters Parameter {filename_lit | _var | _col} Description Specifies the file name. Terminate each record by a line terminator (system dependent). variable. This makes it easy to prompt for a file name at runtime. or column. SQR does not allow for random access of information. SQR procures all data sequentially. SQR creates the file if one does not already exist. make sure the attributes used are the same as those used when the file was created. dat' open $filename open $filename open $filename if #filestat != 0 . This file type can be used when writing or reading binary data.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter FIXED_NOLF Description This file type specifies that all records contained within the file are the same length with no line terminators. A maximum of 256 files can be opened at one time. a failure on OPEN causes SQR to halt. Each record is terminated by a line terminator (system-dependent).. you can control what processing should occur when a file cannot be opened.. error processing . Only records containing display characters (no binary data) can be used safely. This is the default file type. SQR pads short records with blank characters to ensure each record is the same length. it remains open until explicitly closed by the CLOSE command. When reading records. When writing records. Example open 'stocks. When no ENCODING is specified on the OPEN command.. end-if as 5 as 2 as 6 for-reading record=100 for-writing record=70 record=80:fixed for-reading record=80:fixed_nolf for-reading record=132:vary status=#filestat as #j for-append Expanded OPEN Command Syntax An encoding directive added to the OPEN command allows differently encoded files to be managed in a single run of SQR..dat' as 1 open 'log. SQR uses the file input or output encoding specified in the INI file unless the file is UCS-2 encoded and auto-detection of UCS-2 files is enabled. any data beyond the maximum length specified is ignored. The complete syntax of the OPEN command is: OPEN {filename_lit | _var | _col} AS {filenum_num_lit | PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-175 . By using a STATUS variable. Without the STATUS argument. After a file is opened. VARY STATUS Description Opens an operating system file for reading or writing. This file type specifies that the records can be of varying length. Sets the numeric variable to zero if the OPEN succeeds and to -1 if it fails. The text specified in pre_txt_lit and post_txt_lit are printed immediately before and after the number. Specifies a text string to be printed after the page number. WRITE. Parameters Parameter position pre_txt_lit post_txt_lit Description Specifies the position of the page number. 2-176 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .37) () 'Page ' '. Specifies a text string to be printed before the page number." ' of ' See Also The LAST-PAGE command. See Also The READ.' ! Will ! "Page 12 of 25.SQR FOR PEOPLESOFT LANGUAGE REFERENCE _var | _col} { FOR-READING | FOR-WRITING | FOR-APPEND } { RECORD = length_num_lit[:FIXED | :FIXED_NOLF | :VARY]} [ STATUS = num_var ] [ ENCODING = { _var | _col | ASCII | ANSI | SJIS | JEUC | EBCDIC | EBCDIK290 | EBCDIK1027 | UCS-2 | UTF-8 | others… } The ENCODING directive is only allowed when converting to Unicode internally. and CLOSE commands for information about using files. PAGE-NUMBER Syntax PAGE-NUMBER position[pre_txt_lit[post_txt_lit]] Description Places the current page number on the page. Example begin-footing 1 page-number appear as last-page end-footing (1. 999..]] Description Sets the current position on a page.999 ! marker @total_location. When COLUMNS is used. column 5.25) ! Set current position to line 12.5) (+2. In this case. The columns defined are relative to the position of the document marker. The examples with the description of a DOCUMENT paragraph SQR for PeopleSoft Report Developer's Guide. position () @name_loc columns 1 30 ! ! Columns are defined at @name_loc and 29 characters to the right of @name_loc print name next-column print title () () See Also The COLUMNS command for more information.. Parameters Parameter @document_marker Description References a location defined in a DOCUMENT paragraph. “Creating Form Letters.SQR FOR PEOPLESOFT LANGUAGE REFERENCE POSITION Syntax POSITION position [@document_marker[COLUMNS{num_lit|_var|_col} [num_lit|_var|_col]. ! position () @total_location Set position to document print #total () edit 999. ! Set position 2 lines down. COLUMNS Example position position (12. the entire command cannot be broken across more than one program line.” PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-177 . the position used is the location of that marker in the text of the document. at 25th column. Defines columns beginning at the location of the document marker. position Specifies the position where the data is to be printed. When using EDIT or DATE with the PRINT command. Parameters Parameter {any_lit | _var | _col} Description Specifies the data to be printed. or variable. format_command[format_cmd_params] Format Commands The PRINT command has the following format commands: BACKGROUND MATCH BOLD BOX CENTER CODE-PRINTER DATE EDIT FILL FOREGROUND MONEY NOP NUMBER ON-BREAK SHADE UNDERLINE WRAP Some of these format commands can be used in combination with others and some are mutually exclusive. Note. An "X" indicates that they can be used together. or variable must be in an acceptable format. See the description for "EDIT" for further details. column. column. The following tables shows which can be used together. in a string literal.]… Description Puts data on the page at a specified position.. Dates can be contained in a date column or variable or. a date in a string literal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE PRINT Syntax PRINT {any_lit|_var|_col} position[format_command[format_cmd_params]. Specifies optional formatting commands and parameters. 2-178 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .. See the "Changing Fonts" in the SQR for PeopleSoft Developer's Guide. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. BOXD BOX CENTER CODEPRINTER EDIT NUMBER MONEY DATE FIXX BOXD BOX CENTER CODEPRINTE R EDIT NUMBE R MONEY DATE FIXX F/B MATCH NOP ONBREAK SHADE UNDERXINE WRAP X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X Table. SQR for DDO does not support printing of List variables. Part 1 F/B MATCH NOP ON-BREAK SHADE UNDERXINE WRAP BOXD BOX CENTER CODEPRINTER X X X X X X X X X X X X X X X X X X X X PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-179 . BOLD BOLD causes the string or number to print in bold type. 20) bold print 'Your account is in arrears' (1. The following sections describe these format commands. then BOLD has no effect. the appropriate boldface must be defined in the PostScript startup file. when the BEFORE-BOLD and AFTER-BOLD arguments on the DECLARE-PRINTER command are used. For PostScript printers. F/B stands for FOREGROUND/BACKGROUND. See the DECLARE-PRINTER Command Arguments table for information about which font can be bolded. For example: print &name (+1. In the previous tables. For line printers. If BEFORE-BOLD and AFTER-BOLD are not specified. the appropriate boldface font must be loaded in the printer.SQR FOR PEOPLESOFT LANGUAGE REFERENCE F/B MATCH NOP ON-BREAK SHADE UNDERXINE WRAP EDIT NUMBE R MONEY DATE FIXX F/B MATCH NOP ONBREAK SHADE UNDERXINE WRAP X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X Table. Part 2 Note. the specified strings are added before and after the data to be bolded.1) bold 2-180 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . POSTSCRI.STR. For HP LaserJet printers. Only strings can be printed using CODE-PRINTER.SQR FOR PEOPLESOFT LANGUAGE REFERENCE BOX BOX draws a one-line deep graphical box around the printed data. BOX and SHADE are not able to determine the correct length of the box because it varies with the width of the characters printed. BOX and SHADE work well with fixed-pitch fonts and with all PostScript fonts. CODE-PRINTER causes the string to be placed "behind" the page buffer. HP.. This option has no effect for line printers. CENTER CENTER centers the field on a line. For example: print 'Quarterly Sales' (1) center CODE-PRINTER CODE-PRINTER has the following syntax: CODE-PRINTER = printer_type Valid values for printer_type are HT. 20) box print 'Happy Birthday !!' (1. For example: encode '<27>[5U' into $big_font encode '<27>[6U' into $normal_font .. HPLASERJET. PS. +2) code-printer=lp print &phone () edit '(xxx) xxx-xxxx' print $normal_font () code-printer=lp PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-181 . CODE-PRINTER Adds nondisplay characters to the program for the purpose of sending a sequence to the printer. POSTSCRIPT. and LINEPRINTER. The report is ignored if printed to a different type. Because the report might be printed on different types of printers. rather than within it. For example: print &grand_total (+5. For HP LaserJet printers using proportional fonts. If necessary. you should specify for which type this data is to be used. print $big_font (0. you can send a different sequence to another type with a second PRINT statement.1) box Note. HTML. so alignment of printed data is not affected by the white space consumed by the nondisplay characters. LP. The position qualifier for column is ignored. DATE indicates that the field is to be formatted using the DATE-EDIT-MASK from the current locale. See the TIME Column Formats table for the format that is used. Character Description X B ~ (tilde) Use character in field.PRINTER argument are positioned using the regular line and column positioning. (See the command. Sequences printed with the CODE. the two CODE-PRINTER arguments put the $big_font and $normal_font sequences into the output.SQR FOR PEOPLESOFT LANGUAGE REFERENCE In the previous example.) If this entry is not set. However. The three types of edits are: • • • Text edit Numeric edit Date edit The following table lists the text edit format characters. 2-182 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Insert blank. Skip character in field. See the DATE Column Formats table for the format that is used. Column Type DATETIME Default Mask SQR_DB_DATE_FOR MAT If not set See the Default Database Formats table for the format that is used. the current print location after execution is the beginning location where the CODE-PRINTER string was placed. DATE You cannot use DATE with numeric columns or variables. DATE SQR_DB_DATE_ONL Y_FORMAT TIME SQR_DB_TIME_ONL Y_FORMAT EDIT EDIT has the following syntax: EDIT edit_format EDIT causes each field to be edited before it is printed. then the date is printed according to the following rules shown in the Date table. without overwriting any data in the page buffer. unlike the PRINT command. Multiple coded strings printed using the same line and column location appear in the output in the same sequence in which they were printed. "ALTER_LOCALE". Entered at the end of the mask. The "E" can be uppercase or lowercase. causes floating parentheses to display around the number if the number is negative. Dollar sign. The optional number indicates right justification within length indicated. Scientific format. Entered at the end of the mask. for languages such as Hebrew. Treated as a "9". Entered at the end of the mask. trim leading blanks (left justify the number). the field is converted to blanks.56). space fill to the left.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Character Description R[n] Reverse sequence of string. The number of 9s after the decimal point determines the number of significant digits displayed. but if a value is zero. causes "N/A" to display if the numeric column variable is null. Any other character (for example. The case of N/A follows that of the mask. Entered at the end of the mask. Entered at the end of the mask. punctuation) in a text edit mask is treated as a constant and is included in the edited field. The following table lists the numeric edit format characters. zero fill to the right of the decimal point. causes the comma and period characters to be transposed when the edit occurs. (Example: 1. This is to support monetary values where periods delimit thousands and commas delimit decimals. the display follows the case of the mask. causes angle brackets (< >) to display around the number if the number is negative. The characters 8. Implied decimal point. Character Description 8 9 0 $ B C Digit.234. and $ are illegal in a text edit mask because they are used to indicate that the mask is for a numeric edit. causes parentheses to display around the number if the number is negative. E V MI PR PS PF NA PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-183 . Digit. zero fill to the left. causes a minus to display at the right of the number. 9. Entered at the end of the mask. optionally floats to the right. V. 0. zero fill to the right of the decimal point. Digit. Mask Value Display 999.456.99 9.345 (216) 9910551 2-184 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .456789 0 123.34 123456 0 12345 2169910551 34.56 1234.56 $1.34 1.456.888.56 12.999 B9. The following table shows sample edit masks and resulting fields. causes blanks to display if the numeric column variable is null.789 1234 123 1234 -123 -1234 12345 -123 -123 -123 -123 (null) (null) 1234.888.99 $$9.456. Decimal point.56 $ 12.57 123.789 1.234.$$9.235e+05 (blank) 12.99 9.999 9.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Character Description NU .999.34 12.999V999 9 8. Comma.789 0 123. Characters other than those listed in the Numeric Edit Format Characters table are illegal for numeric edit masks and cause errors during processing. .999 (xxx)bxxx-xxxx 34.568 123.999.99 $$$.999.888 9.999.34 $12.234.999e B9. Entered at the end of the mask.234 123 01234 -123 **** **** 123< 123> ( 123) (123) n/a (blank) $1.999 09999 9999 9999 9999 9999mi 9999pr 999999ps 999999pf 9999na 9999nu $$9.99c $$9. 55. 2.999.999.4.1. On input.55. Day of year (1-366). for calculating the 4-digit year. Week of the month (1-5) where week 1 starts on the first day of the month and ends on the seventh.0) (16.99 ! Dollar-Symbol £ The following table lists the date edit format codes. Century. JAN-MAR=1).999. JAN=I).0) edit b99.55.0) edit (xxx)bxxx-xxxx ! (216) 397-0551 print #total (7.2.0) (5.55.0) edit £££9. the current century and/or decade are used. "S" prefixes BC dates with "-".235E+04 print #phone (16.0) print #total (7.345. Week of year (1-53) where week 1 starts on the first day of the year and continues to the seventh day of the year.60.99pr ! < 12. Roman numeral month (I-XII. 4 digit year.99 ! Blank if zero edit 099999 ! 001234 edit 9.3. Last 2 digits of year.345. or 1 digits of the year.55. YYYY SYYY Y RR CC or SCC BC AD Q RM WW W DDD PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-185 . See the Date Edit Format Code-RR table.67>(if ! neg) print #comm print &cnum print #cat (7. Character Description YYY YY Y Last 3.345.10.67 edit 999. for years in other centuries. Quarter of year (1. "S" prefixes BC dates with "-".67 edit $$$9. For example.999.999.999E ! 1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Mask Value Display xxx-xx-xxxx ~~xx~xx r10 123456789 ABCDEFG HIJ ABCDEFG 123-45-6789 CDFG GFEDCBA The following example shows some uses of edit masks: print #total (7. BC/AD indicator.0) print #total (7.0) edit $999.99 ! $ 12. a '9' using the 'Y' mask would result in 1999 as the year if the current year is in the 1990s.99 ! $12. 4713 BC. Meridian indicator. Hour of day (1-12). Minute (0-59). and <nichi> are the kanji strings for year. Name of day.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Character Description DD D DAY DY ER Day of month (1 . Used to concatenate different masks. Japanese Imperial Era. Name of month. EY J AM PM HH HH12 HH24 SSSSS N NN NNN NNNN NNNNN NNNNNN MONTH MON MM MI SS | Julian day. Returns the name of the of the Japanese Imperial Era in the appropriate kanji ('Heisei' is the current era). Numbers specified with 'J' must be integers. Hour of day (0-23). JAN=01). Day of week (1-7). Assumes 24 hour clock unless meridian indicator specified. Abbreviated name of day. Note: The common Japanese date format is: 'YYYY<nen>MM<gatsu>DD<nichi>' where <nen>. this much accuracy will not be attainable. Sunday is first day of week. Fractions of a second. however. Second (0-59). for most hardware and databases. 2-186 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . <gatsu>. Month (01-12. Precise to microseconds. Year of the Japanese Imperial Era. the number of days since Jan 1. Abbreviated name of month. and day respectively. Seconds past midnight (0-86399). Returns the current year within the Japanese Imperial Era. month.31). AM. 50 . a mask of "The cu\rre\nt \mo\nth is Month" results in the output string of "The current month is January". 1996 MARCH1996 09:35 09:35 AM PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-187 . Any other character (for example. MONTH. For example. All other masks are case-insensitive and can be entered in either uppercase or lowercase. See the command ALTER-LOCALE in the "SQR Samples" section for additional information. Without the backslashes the output string would be "The cu95e7t january is January". DY. Edit Mask Result dd/mm/yy DD-MONYYYY 'Month dd. DAY. National Language Support is provided for the following masks: MON. For example. SCC. If the edit mask contains spaces. BC. DY. and AD. Q. and WW. The masks MON. the mask Mon yields "Jan" and MON yields "JAN".99 All masks can be used by the strtodate function except for CC. and RM are case-sensitive and follow the case of the mask entered. PM. YYYY' MONTH-YYYY HH:MI 'HH:MI PM' 14/03/96 14-MAR1996 March 14. BC. The return date is in the current century. DAY. PM. punctuation) in a date edit mask is treated as a constant and is included in the edited field. AM. MONTH. The return date is in the century after the current one. A backslash forces the next character into the output from the mask. A vertical bar can be used as a delimiter between format codes. The return date is in the century before the current one. AD. W. In addition. if the month is January. it must be enclosed in single quotes ('). the edit masks produce the results in the following table. in most cases the bar is not necessary. however.49 The return date is in the current century. For example.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Last 2 digits of current year 2-digit year is 00 – 49 2-digit year is 50 – 99 00 . If the value of the date field being edited is "Mar 14 1996 9:35". the mask 'YYYY|MM|DD' is the same as 'YYYYMMDD'. When a date column or variable is printed without an edit mask. When a date with missing date and/or time components is displayed or printed. For example: move print show '$999. The default month is the current month. MOVE.000000: let $date1 = strtodate('13:21'.DD.14. 1996 13:21:00. the following assignment would produce an equivalent date-time of September 1. it must be in one of the following formats: • • • The format specified by the environment variable SQR_DB_DATE_FORMAT. 2-188 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .YYYY Mon DD|D|DDD 19960314 03. For example. the date is printed in the format specified by the environment variable SQR_DB_DATE_FORMAT or the corresponding setting in the SQR.99' #total #total edit to $mask :$mask (5. This applies to DISPLAY. DISPLAY.INI file.INI file. and with the edit function of the LET command. CONCAT. The default time is zero (00:00:00.000000). or variable is printed with an edit mask. The default day is one. the defaults are as follows: • • • • The default year is the current year. One of the database-dependent formats. 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'. 1996.1996 Mar 143073 In addition to being used with the EDIT argument.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Edit Mask Result YYYYMMDD MM.10) edit :$mask When a date that is stored in a string literal. The database-independent format. If this has not been set. column.999. as listed in the Default Database Formats table. and SHOW commands as well as PRINT. or the corresponding setting in the SQR. then the date is printed in the primary database format (the first entry) listed in the Default Database Formats table. assuming today is September 7. and SHOW commands. edit masks can also be used with the MOVE. You edit the field using the supplied mask before storing or displaying it.'HH:MI') Edit masks can be changed dynamically by storing them in a string variable and referencing the variable name preceded by a colon (:). NNN MM/DD/YYYY MM-DD-YYYY MM. Database Default Database Formats DB2 YYYY-MM-DDHH:MI:SS.NNN]][PM] YYYYMMDD [HH:MI[:SS[:NNN]]PM] YYYYMMDD [HH:MI[:SS[.SS.SS.NNNNNN YYYY-MM-DD YYYY-MM-DD HH:MI:SS.NNNNNN Informix Ingres ODBC Oracle Sybase SQLBase Database DATE Column Formats DB2 Informix ODBC YYYY-MM-DD MM/DD/YYYY DD-MON-YYYY Database TIME Column Formats DB2 ODBC HH24.YYYY DD-MON-YYYY HH:MI:SS MM/DD/YYYY HH:MI:SS MM-DD-YYYY HH:MI:SS MM-DD-YYYY DD-MON-YY MON DD YYYY HH:MIPM MON DD YYYY [HH:MI[:SS[:NNN]][PM] MON DD YYYY [HH:MI[:SS[.SS HH24:MI:SS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-189 .NNNNNN YYYY-MM-DD HH.NNN]]PM] YYYY-MM-DDHH.MI.MI.DD.SQR FOR PEOPLESOFT LANGUAGE REFERENCE The following table lists default date formats for each database.MI. { column_num_lit|_var|_col } MATCH compares a field to a list of key values and if a match is found. Use the color name "none" to turn off color for the specified area. (+1. and print_text. If the match_text contains white space. prints the corresponding string at the specified line and column.1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE FILL FILL fills the page with the specified character or string as indicated by the print position and length. but each must have its own line. If a match is not found. If you do not define the specified color name. column..40) FOREGROUND/BACKGROUND When you specify a color on the PRINT command its scope is that of the PRINT command. For example: print &type_buyer (20. Line and column positions for each matched string are treated as fixed or relative positions depending on the type of positioning used in the position qualifier for the PRINT command. Syntax PRINT {any_lit|_var|_col} [FOREGROUND =({color_name_lit|_var|_col}|{rgb})] [BACKGROUND =({color_name_lit|_var|_col}|{rgb})] MATCH MATCH has the following syntax: MATCH match_text { line_num_lit|_var|_col } print_text ..79) fill fill ! Fill line with *'s ! Fill with '-*' characters. then the setting for "default" is used.12) match A 20 12 Casual B 20 22 Impulsive C 21 12 Informed D 21 22 Choosey 2-190 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Any number of match text(s) can be tested. it must be enclosed in single quotes (').20. the unmatched field is printed at the position specified in the parentheses. The following example prints a line of stars and then a line of dashes followed by stars: print print '*' '-*' (1. ) This can only be used with a numeric column or variable.)]] [AFTER=procedure_name[(arg1[ .. (See the ALTER-LOCALE command. NOP NOP suppresses the print command.1) nop Hide the social security number. This argument is useful for temporarily preventing a field from printing.. causing "no operation" to be executed. (See the command.)]] [SAVE=txt_var] [LEVEL=nn] [SET=nn] ON-BREAK causes the specified action in a tabular report when the value of a field changes (a break occurs)..argi].) This argument can only be used with a numeric column or variable. ON-BREAK ON-BREAK has the following syntax: ON-BREAK [PRINT={ALWAYS|CHANGE|CHANGE/TOP-PAGE|NEVER}] [SKIPLINES={num_lit|_var|_col}] [PROCEDURE=procedure_name[(arg1[ . For example: print &ssn (1.. ! NUMBER NUMBER indicates that the column or variable is to be formatted using the NUMBER-EDIT-MASK from the current locale. MONEY MONEY indicates that the column or variable is to be formatted using the MONEY-EDITMASK from the current locale. you could use the following example: print $state (0.)]] [BEFORE=procedure_name[(arg1[ . for example. ON-BREAK has the following qualifiers: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-191 ..argi].. "ALTER_LOCALE".argi]. The default action prints the field only when its value changes (PRINT=CHANGE).SQR FOR PEOPLESOFT LANGUAGE REFERENCE To use relative line and fixed column positioning.25) match OH 0 25 Ohio MI 0 37 Michigan NY 0 25 'New York' The column positions are treated as fixed locations due to the fixed "25" position declared in parentheses. county. When a break occurs in the query. AFTER and BEFORE procedures—Specify procedures to invoke either after or before the value changes. CHANGE prints the value only when it changes. ALWAYS duplicates the break field for each detail group. AFTER procedures are processed in descending sequence from the highest level to the level of the current break field. This is the default. d. For example. If no rows are fetched. 2. and city is level 3 (the most minor). • • • SKIPLINES—Specifies how many lines to skip when the value changes. This qualifier cannot be used with either the AFTER or BEFORE qualifiers. CHANGE/TOP-PAGE prints the value both when it changes and at the top of each new page. and city might have three break levels: state is level 1 (the most major). LEVEL—Specifies the level of the break for reports containing multiple breaks. other breaks with equal or higher level numbers are cleared. neither procedure is executed. b. PROCEDURE procedure—Specifies the procedure to be invoked when the value changes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • PRINT—Specifies when the break field is printed. SET—Assigns a number to the set of leveled breaks in reports with more than one set of independent breaks. 2-192 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The level number also affects the sequence in which AFTER and BEFORE procedures are processed. Any breaks with the same or higher level numbers are cleared so they do not break on the next value. NEVER suppresses printing. SAVE variables are set with the new value. The AFTER and BEFORE can be used only within a SELECT paragraph. the following happens: a. Any BEFORE procedures are processed in ascending LEVEL sequence before the first row of the query is retrieved. c. The sequence of events is shown here: SAVE—Indicates a string variable where the previous value of a break field is stored. a report sorted by state. BEFORE procedures are processed in ascending sequence from the current level to the highest level break. • Following is the sequence of events for a query containing ON-BREAK fields: 1. When a break occurs. For example: begin-select state city .1.14) on-break level=2 before=bef-cnty after=cnty-tot Now when state breaks. After the query finishes (at END-SELECT) any AFTER procedures are processed in descending level sequence. end-select (+1. after all of the AFTER breaks and in sequence from lower to higher level numbers. the city-tot procedure is executed. end-select (+1. f.+2. the current line position is advanced. first the city-tot procedure is executed. g. When state breaks. Cnty-tot 3. If any BEFORE breaks were indicated. 3.+2. The value is printed (unless PRINT=NEVER was specified).+2. the sequence of procedures executed is as follows: 1.1.tot (. they would also be processed automatically.14) on-break level=3 before=bef-city after=city-tot county (. When county breaks.SQR FOR PEOPLESOFT LANGUAGE REFERENCE e. If SKIPLINES was specified. the procedure is invoked.+2.. the city-tot.2) (. For example: begin-select state city .14) The breaks are processed as follows: • • • When city breaks. Bef-state PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-193 . and state-tot procedures are processed in that sequence... City-tot 2. State-tot 4. then the county-tot procedure is executed.14) on-break level=1 on-break level=2 on-break level=3 after=state-tot after=county-tot after=city-tot skiplines=2 skiplines=1 county (..2) on-break level=1 before=bef-state after=state. county-tot. If a PROCEDURE has been declared. 2) on-break set=1 after=state-tot level=1 SET=1 associates this leveled break with other breaks having the same set number.state The SET qualifier enables you to have sub-reports with leveled breaks. Cnty-tot 3. 2-194 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Bef-city Upon entering the query at BEGIN-SELECT. SHADE Draws a one-line deep. shaded graphical box around the printed data. City-tot 2. 40) shade shade Note. BOX and SHADE are not able to determine the correct length of the box because it varies with the width of the characters printed. the three BEFORE procedures are executed in sequence: 1. By separating the ON-BREAKs into sets. Bef-state 2. Bef-cnty 3.1. Bef-cnty 6.SQR FOR PEOPLESOFT LANGUAGE REFERENCE 5. at END-SELECT. print 'Company Confidential' (1. For HP LaserJet printers using proportional fonts. State-tot The SAVE qualifier saves the previous break value in the specified string variable for use in an AFTER procedure. begin-select state (+1.1) print &state (+2. For line printers this argument has no effect. Bef-city After the last row is retrieved.1) on-break after=state-tot save=$old. the three AFTER procedures are executed in sequence: 1. You may want to print the previous break field with a summary line: print &state (+1. the associated leveled breaks in each set do not interfere with each other. BOX and SHADE work well with fixed pitch fonts and with all PostScript fonts. 30) (1. To continue printing on the same line. you must use a fixed line number for the next field. When a string ends on the last position of a line. an implicit line feed causes the new current position to be the first character of the following line. In the SETUP section. which emulates underlining.+2. use the DECLARE-LAYOUT command to make the page width one character wider than the right edge of the wrapped text to avoid generating an implicit line feed. Note.20.0) wrap 50 3 ! Paragraph is 50 ! characters wide. print print print ¬e1 ¬e2 ¬e3 (1.1) underline WRAP WRAP wraps text at word spaces.30) wrap wrap wrap 30 30 30 4 4 4 In this example. For example: print &name (+1. note2. ! with a maximum ! depth of 3 lines. the current position is one character to the right of the last character in the column.20.WRAP has the following syntax: WRAP {line_length_lit|_var|_col} {max_lines_lit|_var|_col}[KEEP-TOP] [STRIP=strip_chars][ON=break_chars][R] [LINE-HEIGHT={line_height_lit|_var|_col}] line_length_lit|_var|_col Specifies the maximum paragraph width in characters. and note3.+2. The current print position after a wrap occurs at the bottom right edge of the wrapped paragraph. For line printers. UNDERLINE causes backspace and underscore characters to be output.SQR FOR PEOPLESOFT LANGUAGE REFERENCE UNDERLINE UNDERLINE prints the specified data with underlined characters.30) (1. 45) underline print 'Your account is in arrears' (1. the line position is 1 for each of the three wrapped fields: note1. For example: print &comment (48. After a string wraps. Additional text is moved to a new line. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-195 . If the ON character is not found within the width specified for the paragraph.45) wrap #wrap_width #msg_wid 6 #msg_lines KEEP-TOP retains the current line position except if a page break occurs.30) wrap 6 30 keep-top (0.10) wrap 50 22 strip=/\^@<13> on=<10> 2-196 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .10.Usually. However. In the following example. the line length and maximum lines are indicated with numeric literals. to print a long data type that contains embedded carriage returns. This is useful when you want to change the width or depth of a wrapped paragraph during report processing.SQR FOR PEOPLESOFT LANGUAGE REFERENCE max_lines_lit|_var|_col Specifies the maximum paragraph depth in lines. and which characters force a wrap to occur.+3.20) wrap 42 30 on=<13> The paragraph wraps at each carriage return. The default action is to set the next print position at the bottom of the wrapped data. the column &resolution prints on the same line as the first line of the column &instructions: print &phone print &instructions print &resolution (+1. in which case.10) edit '(xxx) xxx-xxxx' (+1. For example: print print $comments $message (1.30) wrap (5. the wrap occurs at a word space. line 1 is used as the current line position. rather than at the usual word boundaries. Characters in the ON string argument cause a wrap at each ON character found. The numeric variable can optionally be preceded by a colon (:). Both arguments accept regular characters and nondisplay characters whose ASCII values are surrounded by angled brackets. The following example converts the STRIP characters to spaces before wrapping on either a line feed <10> or a space (the default): print &description (20. • • Characters in the STRIP string argument are converted to spaces before the wrap occurs. The ON character is not printed. WRAP can also reference numeric variables or columns. the setup would be: print &long_field (5. For example. <nn>.25) The STRIP and ON arguments affect which characters are to be converted before wrapping. print &comment (2. The following example prints the comment column with one blank line between each printed line for a maximum of four printed lines: print &comment (1. the entire paragraph is right-justified within the length indicated. editing. PRINT-BAR-CODE Syntax PRINT-BAR-CODE position {TYPE={bar_code_type_num_lit|_var|_col}} {HEIGHT={bar_code_height_num_lit|_var|_col}} {TEXT={bar_code_txt_lit|_var|_col}} [CAPTION={bar_code_caption_txt_lit|_var|_col}] [CHECKSUM={checksum_lit}] Description PRINT-BAR-CODE prints industry standard bar codes. in 30 character field. or converting fields.1) wrap 40 4 line-height = 2 ! Double space text See Also The LET command for information about copying. MONEY-EDIT-MASK. By default a value of 1 (single space) is assumed. The ALTER-LOCALE command for a description of the arguments NUMBER-EDIT-MASK. In addition. An R after the length and max_lines arguments causes the field to be reversed before the wrap takes place.SQR FOR PEOPLESOFT LANGUAGE REFERENCE WRAP can also be used to print reversed characters. ! Reverse wrap. and DATE-EDIT-MASK. The DISPLAY and SHOW commands.50) wrap 50 7 r LINE-HEIGHT specifies the number of lines to skip between each line of the wrapped data. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-197 . SQR supports the bar code types listed in the following table.35) wrap 30 5 r print $notes (1. for support of languages such as Hebrew. x. 9. 14. p. the current position is returned to this location. X. X. X. the next listing line is the next line below the bottom of the bar code. or 16 11. Document markers are not allowed. or 11 1 to 30 1 to 30 1 to 30 19 1 to 30 9 9 9 9 9. or 12 1 to 30 1 to 30 2 to 30 1 to 30 1 to 30 5. 9. p 9. (This is different than the way the PRINT command works.Numbers (0-9) X. 13. c 9 9. p 9.Upper Case Letters (A-Z) x. p 9 9 y y y y y y y y Parameters Parameter position Description Specifies the position of the upper left corner.Control Characters 2-198 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . x. x. Types are shown in the Bar Code Types table. however. 13. or 17 7.Lower Case Letters (a-z) p. c 9 9 9 9. X. After execution.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Ty pe Description Text Length Text Type1 CHECKSUM RECOGNIZED 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 UPC-A UPC-E EAN/JAN-13 EAN/JAN-8 3 of 9 (Code 39) Extended 3 of 9 Interleaved 2 of 5 Code 128 Codabar Zip+4 Postnet MSI Plessey Code 93 Extended 93 UCC-128 HIBC 11. TYPE 1 Text Type characters: 9. p. X. See the POSITION command for examples of relative positioning.Punctuation c.) Specifies the type of bar code to be printed. or 16 12. Position parameters can be relative. CAPTION is not valid for Zip+4 Postnet. The number and type of text characters permitted or required depends on the bar code type. Specifies optional text to be printed under the bar code in the current font.1 and 2 inches. SQR attempts to center the caption under the bar code. Example This example shows how to use the PRINT-BAR-CODE command to create a UPC-A barcode as shown in the following illustration: begin-program print 'Sample UPC-A Barcode' (1. the bar code extends above the position specified.1) print-bar-code (3. The code prints to the nearest one-tenth of an inch. Specifies the text to be encoded and printed. Note. for proportional fonts this may vary slightly.2 and 2. The height must be between 0.2.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter HEIGHT Description Specifies the height of the bar code in inches. See the Bar Code Types table for specifications. where NO is the default. If it is less than 0.3 text='01234567890' caption='0 12345 67890' end-program ! UPC-A Sample UPC-A Bar Code PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-199 . Some barcode types ignore the CHECKSUM qualifier. TEXT CAPTION CHECKSUM Specifies an optional check sum to be computed and printed within the bar code. it is ignored.1) type=1 height=0.0 for Zip+4 Postnet. Valid values are YES and NO. If specified. however. See the Bar Code Types table for those barcode types for which CHECKSUM is relevant. The height should be between 0. For Zip+4 Postnet. the height of the bar code is fixed. See your bar code documentation for the proper formatting of certain bar codes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE This example shows how to use the PRINT-BAR-CODE command to create a ZIP+4 Postnet code as shown in the following illustration: begin-program print 'Sample Zip+4 Postnet' (1. SQR does not check bar code syntax. PRINT-CHART Syntax PRINT-CHART[chart_name]position DATA-ARRAY-ROW-COUNT={x_num_lit|_var|_col} DATA-ARRAY-COLUMN-COUNT={x_num_lit|_var|_col} DATA-ARRAY=array_name [DATA-LABELS=data_labels_lit | _var | _col] [COLOR-PALETTE=color_palette_lit | _var | _col]] [ITEM-COLOR=(Chart_item_keyword..1) print 'AnyTown.1) Sample Zip+4 Postnet Bar Code Note.1) print 'John Q.)}}] [CHART-SIZE=(chart_width_num_lit|_var.g.2 text='12345678934' end-program (7.1) print '1234 Main Street' (4. USA 12345-6789' (5. chart_depth_num_lit|_var)] [TITLE={title_txt_lit|_var|_col}] [SUB-TITLE={subtitle_txt_lit|_var|_col}] [FILL={fill_lit|txt_var|_col}] [3D-EFFECTS={3d_effects_lit|txt_var|_col}] [BORDER={border_lit|txt_var|_col}] [POINT-MARKERS={point_markers_lit|txt_var|_col}] 2-200 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .1) print-bar-code type=10 height=0.b))] [DATA-ARRAY-COLUMN-LABELS={NONE|array_name| {({txt_lit|_var}[. txt_lit |var | (r. Public' (3..{txt_lit|_var}]. Only PostScript printers or HP printers that support HPGL (generally.PRESENTATION={legend_presentation_lit|txt_var|_col}] [PIE-SEGMENT-QUANTITY-DISPLAY= {pie_segment_quantity_display_lit|txt_var|_col}] [PIE-SEGMENT-PERCENT. The PRINT-CHART command directs SQR to output a chart according to the named chart. this is HPLaserJet 3 and higher) render chart output. if any.DISPLAY={pie_segment_percent_display_lit |txt_var|_col}] [PIE-SEGMENT-EXPLODE={pie_segment_explode_lit |txt_var|_col}] [X-AXIS-LABEL={x_axis_label_txt_lit|_var|_col}] [X-AXIS-MIN-VALUE={x_axis_min_value_lit|_num_lit|_var |_col}] [X-AXIS-MAX-VALUE={x_axis_max_value_lit|_num_lit|_var |_col}] [X-AXIS-SCALE={x_axis_scale_lit|txt_var|_col}] [X-AXIS-MAJOR-TICK-MARKS={x_axis_major_tick_marks_lit |txt_var|_col}] [X-AXIS-MINOR-TICK-MARKS={x_axis_minor_tick_marks_lit |txt_var|_col}] [X-AXIS-MAJOR-INCREMENT={x_axis_major_increment_lit |_num_lit|_var|_col}] [X-AXIS-MINOR-INCREMENT={x_axis_minor_increment_lit |_num_lit|_var|_col}] X-AXIS-TICK-MARK-PLACEMENT= {x_axis_tick_mark_placement_lit|txt_var|_col}] [X-AXIS-GRID={x_axis_grid_lit|txt_var|_col}] [Y-AXIS-LABEL={y_axis_label_lit|txt_var|_col}] [Y-AXIS-MIN-VALUE={y_axis_min_value_lit|_num_lit |_var|_col}] [Y-AXIS-MAX-VALUE={y_axis_max_value_lit|_num_lit |_var|_col}] [Y-AXIS-SCALE={y_axis_scale_lit|txt_var|_col}] [Y-AXIS-MAJOR-TICK-MARKS={y_axis_major_tick_marks_lit |txt_var|_col}] [Y-AXIS-MINOR-TICK-MARKS={y_axis_minor_tick_marks_lit |txt_var|_col}] [Y-AXIS-MAJOR-INCREMENT={y_axis_major_increment_lit |_num_lit|_var|_col}] [Y-AXIS-MINOR-INCREMENT={y_axis_minor_increment_lit |_num_lit|_var|_col}] [Y-AXIS-TICK-MARK-PLACEMENT= {y_axis_tick_mark_placement_lit|txt_var|_col}] [Y-AXIS-GRID={y_axis_grid_lit|txt_var|_col}] Note. if any. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-201 . Description Prints a chart. If you do not define CHART-SIZE with this command. you must define it with DECLARE-CHART. and the overridden attributes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE [TYPE={chart_type_lit|txt_var|_col}] [LEGEND={legend_lit|txt_var|_col}] [LEGEND-TITLE={legend_title_txt_lit|_var|_col}] [LEGEND-PLACEMENT={legend_placement_lit|txt_var|_col}] [LEGEND. DATA-ARRAY-ROW-COUNT. As mentioned previously. Histograms show the character value on the y-axis. All the attributes defined for DECLARE-CHART are valid for the PRINT-CHART command. leaving one or more lines of meaningless data across your report. If the first field in the array designated by DATA-ARRAY is of type CHAR. If a PIE chart contains many small slices. See the Chart Array Field Types (fewer than four fields) table for details. PRINT-CHART has five additional parameters. Note. Only PostScript printers or HP printers that support Hewlett Packard's HPGL (generally. Note. beginning with 1. and DATA-ARRAY-COLUMN-LABELS. The data that supports the chart is defined in the additional attributes: DATA-ARRAY. do not be alarmed if the chart does not fit exactly inside the box you have specified. For example. Note. PRINT-CHART can be used without referencing a named chart if all required attributes for the DECLARE-CHART are supplied in addition to all its required parameters. then the chart is printed with first value. If the first field is not of type CHAR. Manipulation of chart attribute values has no effect on the appearance of the chart after the PRINT.CHART command has been executed.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. each chart type meets a specific organizational requirement. the chart is centered within the specified region. In cases where the display area is not well suited to the chart display. XY-Scatter charts do not use the character value and none is needed in the array. PRINT-CHART expects the DATA-ARRAY to be organized in a particular way. The position of the chart is described using the first parameter. 'Encouraging Results'. Note. DATA-ARRAY-COLUMN-COUNT. Pie charts show the character value in the legend area. The PRINT-CHART command directs SQR to display the chart on the current page using the attribute values at the moment the command is executed. The Chart Array Field Types (fewer than four fields) table describes these requirements. If you attempt to print a chart to a LASERJET printer that does not support HPGL. and the dimensions are scaled to accommodate the region. Note. this is HP LaserJet model 3 and higher) render chart output. PRINTCHART fills the area defined by CHART-SIZE as much as possible while maintaining an aesthetically pleasing ratio of height to width. if you execute a PRINT-CHART with TITLE=$ttl and $ttl='Encouraging Results'. then the value on the x-axis is the contents of that column. It means that SQR has accommodated the shape of the region to provide the best looking chart possible. Note. Note. the HPGL command output will likely become part of your output. then the value of the x-axis is the row number of the array designated by DATA-ARRAY. Therefore. and then change the value of $ttl to 'Discouraging Results' immediately afterward. the user must set the PIE-SEGMENT-QUANTITY-DISPLAY and/or PIE-SEGMENT-PERCENT-DISPLAY arguments to NO to prevent the values from one slice overwriting the values of another slice. 2-202 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Chart commands used to send output to a line printer are ignored. . the names associated with each segment LINE BAR STACKED-BAR 100%-BAR OVERLAPPED-BAR HISTOGRAM AREA STACKED-ARE A 100%-AREA XY-SCATTER-PLOT Type=char X-Axis values Type=num The value associated with each pie segment (Optional) Type=char Pie segment explode flag setting.. 'Y' or 'N' (Optional) Type=num Series 2 Y-Axis values (Optional) Type=num Series 3… Y-Axis values Type=num Series 1 Y-Axis values Type=num Series 1 X-Axis values Type=char X-Axis values Type=num Series 1 Y-Axis values Type=num Series 1 Y-Axis offset (Optional) Type=num Series 2 X-Axis values Type=num Series 1 Y-Axis duration (Optional) Type=num Series 2 . PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-203 . This name is not necessary if you specify the CHART-SIZE and all other pertinent attributes in the PRINT-CHART command.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Chart Type Field 0 Field 1 Field 2 Field 3 PIE Type=char Pie segment labels. Y-Axis values (Optional) Type=Num Series 2 . Y-Axis offset FLOATING-BAR Chart Type Field 0 Field 1 Field 2 Field 3 Field 4 HIGH-LOWCL OSE Type=char X-Axis values Type=num High value Type=num Low value Type=num Closing value (Optional) Type=num Opening value Parameters Parameter chart_name Description Specifies the name of the chart from the DECLARE-CHART command... the next listing line is the next line below the bottom of the chart area.) Specifies the name of the array containing the data to be plotted. Document markers are not allowed. If the DATAARRAY has a greater number of rows. only DATA-ARRAYCOLUMN-COUNT is included in the chart. however. DATA-ARRAY DATA-ARRAY-ROW-COUNT DATA-ARRAY-COLUMN-COUNT DATA-ARRAY-COLUMN-LABELS For definitions of the other arguments.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter position Description (row. Specifies labels for each Y-Axis value of the data set (fields) in DATA-ARRAY. the current position is returned to this location. Specifies the number of rows or sets of data to be used from the DATA-ARRAY. 2-204 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This must be the name of an array defined with CREATE-ARRAY. Specifies the number of columns to be used from the DATA-ARRAY. These labels are displayed in the legend box. See the Chart Array Field Types (fewer than four fields) table for applicable fields for each type of chart.COUNT is included in the chart. If the DATA-ARRAY has a greater number of columns. (This is different than the way the PRINT command works. Column labels are ignored for pie charts. column) Specifies the position of the upper left corner. See the POSITION command for examples of relative positioning. Position parameters can be relative. only DATA-ARRAY-ROW. see the DECLARE-CHART Command Arguments table. After execution. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example Line 100% Area Chart Overlapped-Bar Histogram Chart PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-205 . SQR FOR PEOPLESOFT LANGUAGE REFERENCE Area Stack ed-Area Floating Bar Bar Chart 2-206 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . . 28) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-207 . create-array name=unit_sales size=12 field=product:char field=units:number field=explode:char . . print-chart (15. a pie chart is printed without explicit reference to a chart declared with DECLARE-CHART.SQR FOR PEOPLESOFT LANGUAGE REFERENCE XY Scatter High-Low-Close In this example. 20) title sub-title chart-size type data-array data-array-column-count data-array-row-count 3d-effects fill = yes = color = 7 = pie = unit_sales = 3 = 'Green City Store Sales' = '(Second Quarter)' = (50. All necessary arguments must be supplied in PRINT-CHART. . . printed text is followed by a carriage return and line feed character. Because this text is often printer-dependent and because the report can be printed on different types of printers that require different control characters. Parameters Parameter NOLF Description Specifies that no carriage return and line feed is to be printed. One approach is to use PRINT. such as initializing a page with graphics or other special sequences.. Description Writes directly to the print output file without using the SQR page buffer. When using PRINT-DIRECT in conjunction with PRINT commands. PRINT-DIRECT can be used for special applications that cannot be accomplished directly with PRINT commands.DIRECT commands inside a BEFORE-PAGE or AFTER-PAGE procedure (declared with the DECLARE-PROCEDURE command).SQR FOR PEOPLESOFT LANGUAGE REFERENCE See Also The DECLARE-CHART command. By default. If no PRINTER qualifier is specified. be aware that the SQR page buffer is copied to the output file only when each page is full or when a NEW-PAGE command is issued. the command applies to all printer types. you can use the PRINTER qualifier to specify the printer type. 2-208 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . so they are coordinated with the information coming out of the page buffer. PRINT-DIRECT Syntax PRINT-DIRECT [NOLF] [PRINTER={LINEPRINTER|POSTSCRIPT|HPLASERJET|HTML|LP|PS|HP|HT}] {txt_lit|_var|_col}. Description Prints an image. The image file pointed to can be any file of the proper format. PRINT-IMAGE may be used without referencing a named image if all required attributes for the DECLARE-IMAGE are supplied in addition to all its required parameters.height_num_lit |_var|_col)] [SOURCE={file_name_txt_lit|_var|_col}] Note.) position PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-209 . If TYPE. The text to be printed. column) Specifies the position of the upper left corner. Position parameters can be relative. {txt_lit | _var | _col} Example print-direct print-direct printer=ps nolf '%%Page: ' reset $page-number printer=lp PRINT-IMAGE Syntax PRINT-IMAGE[image_name]position [TYPE={image_type_lit|_var|_col}] [IMAGE-SIZE=(width_num_lit|_var|_col. (row.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter PRINTER Description Specifies the type of printer to which this text applies. Document markers are not allowed. the current position is returned to this location. Parameters Parameter image_name Description Specifies the name of an image specified by a DECLARE-IMAGE. however. IMAGE-SIZE. the next listing line below the bottom of the image area. (This is different from the way the PRINT command works. After execution. See the POSITION command for examples of relative positioning. they must be defined in DECLARE-IMAGE. and SOURCE are not defined in PRINT-IMAGE. The PRINT-IMAGE command can be placed in any section of a report with the exception of the SETUP section. . JPEG-FILE.. 25) type=bmp-file source='m:\logos\gustavs. 20) print-image type source image-size (50. Specifies the name of a file containing the image. 3) For Windows: print-image company-logo (+21. IMAGE-SIZE SOURCE Example For PostScript: print-image office-signature (50. or BMPFILE (for Windows).eps' = (10.. HPGL-FILE.50) See Also The DECLARE-IMAGE command. GIF-FILE. PUT Syntax PUT {src_any_lit|_var|_col}. 2-210 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 20) = eps-file = 'sherman. Specifies the width and height of the image. Types can be EPS-FILE. INTO dst_array_name(element)[field[(occurs)]].SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter TYPE Description Specifies the image type..bmp' image-size=(75. in the occurrence specified of that field. data is copied into occurrence zero of each field of the element specified in the array. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-211 . data is placed into consecutive fields in the order they were defined in the CREATE-ARRAY command. If this has not been set. field [ ( occurs ) ] Array element and field occurrence numbers can be numeric literals (123) or numeric variables (#j). • • When a string variable. Columns retrieved from the database and SQR variables or literals can be moved into an array. For DATE columns. the format listed in the DATE Column Formats table is used. If array fields are not listed. the first databasedependent format as listed the Default Database Formats table is used. or the databaseindependent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]]'. The array must have been created previously using the CREATE-ARRAY command. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. the format specified by the SQR_DB_DATE_FORMAT setting is used.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Moves data into an array. Considerations using PUT When a date variable or column is moved into a text or char array field. or literal is moved to a date array field. the string must be in the format specified by the SQR_DB_DATE_FORMAT setting. If no occurrence is specified. For TIME columns the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. If this has not been set. the format as listed in the TIME Column Formats table is used. the date is converted to a string according to the following rules: • For DATETIME columns and SQR DATE variables. one of the databasedependent formats as listed in the DATE Column Formats table is used. dst_array_name(element) If array fields are listed. column. data is placed into each field in the sequence it is listed. occurrence zero is used. If this has not been set. and $code are placed into the first four fields defined in the names array. it must be in the format specified by the SQR_DB_DATE_FORMAT setting.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter src_any_var Description The source variable or literal to be moved into the array. put #j2 #j3 #j4 into totals(#j) tot(0) tot(1) tot(2) The following command copies #count into the #j2'th occurrence of the count field in the #j'th element of the states array. When reading a date into a date variable. and database columns can be put into number (decimal. put #count into states(#j) count(#j2) READ Syntax READ {filenum_lit|_var|_col} INTO {any_var:length_int_lit}. char. #j3.. Numeric variables. the four variables &name. Example In the following example. text. put &name #count $date1 $code into names(#j) The following command places #j2. If the field was written as a date variable. one of the database-dependent formats as listed in the DATE Column Formats table is used. integer) fields. Date variables can be put into date.. After being transferred. String variables. trailing blanks in the variable are omitted. or date fields.[STATUS=status_num_var] Description Reads the next record of a file into the specified variables. The data is put into the #j'th element of the array. $date1. then it may be read into a date variable or text variable. Text and binary data is parsed according to the following criteria: • Text data is any string of characters. #count. • 2-212 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . literals. literals. and #j4 into the zero through 2nd occurrences of the tot field in the #j'th element of the totals array. and database columns can be put into char. or the databaseindependent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]'. float. or text fields. The length of the variable name indicates how many characters to place into the variable. Note that the bytes making up the binary number must be in the standard sequence expected by your operating system. Specifies one or more variables into which data from the record read are to be put. otherwise. length_int_lit specifies the length of each field of data. If you use binary numbers. 2. Your program should check this variable after each READ command. which is then converted to a date using the strtodate function. it is set to 0 (zero). . the file is not portable across platforms. otherwise. SQR returns 0 if the read is successful. it returns the value of errno. declare-variable date $date1 $date2 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-213 . One is loaded into a date variable. They must be read into numeric variables. Specifies an optional variable into which a read status is returned. To maintain the decimal portion of the number convert the number to a string variable. If STATUS is specified. Only the integer portion of the number is represented with binary numbers. the other is loaded into a string variable. • • • The total length indicated for the variables must be less than or equal to the length of the record being read. If there are no more records to read. This is because different hardware represents binary numbers differently. any_var :length_int_lit STATUS Example The following example shows several READ commands: read read read 1 3 into into $name:30 $type:2 $addr:30 #amount:2 $city:20 #rate:1 $state:2 $code:5 $zip:5 $date:11 #j into #sequence:2 $name:20 $title:15 The following example shows a READ command that reads two dates. or 4 bytes in length. .SQR FOR PEOPLESOFT LANGUAGE REFERENCE • Binary numbers. may be 1. . Parameters Parameter filenum_lit|_var | _col Description Specifies the number assigned in the OPEN command to the file to be read. which is system-dependent. the #end-file reserved variable is set to 1. When reading binary data the file must be opened with the FIXED or FIXED-NOLF qualifier. $location) end-sql add 1 to #inserts if #inserts >= 100 begin-sql end transaction. . and WRITE commands for information about files. CLOSE. read 4 into $date1:18 $text1:18 let $date2 = strtodate($text1. below. begin transaction end-sql move 0 to #inserts end-if end-while begin-sql end transaction end-sql ! End of file reached. $parent. See Also The OPEN. exited by BREAK. . location) values ($company.'SYYYYMMDDHHMISSNNN') or let $date2 = strtodate($text1) The following example shows a READ command with an INSERT loop: begin-sql begin transaction end-sql while read 1 10 ! Infinite loop. 2-214 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . parent. into $company:40 $parent:30 $location:50 if #end-file break end-if begin-sql insert into comps (name.SQR FOR PEOPLESOFT LANGUAGE REFERENCE text $text end-declare . ROLLBACK is useful in testing or in certain error conditions. Ingres. ROLLBACK is an SQR command and should not be used inside an SQL paragraph. roman characters and katakana) is converted. This command also converts a sequence of a kana character followed by certain grammatical marks into a single multi-byte character. See the COMMIT command for an example of ROLLBACK. ORACLE. ODBC. punctuation.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ROLLBACK Syntax ROLLBACK Description An automatic rollback is performed whenever SQR ends due to program errors. use BEGIN TRANSACTION and ROLLBACK TRANSACTION within SQL paragraphs as in the following example. Example if #error-status = 1 rollback stop end-if See Also The COMMIT command. (Microsoft SQL Server is accessible only with SQR Server for ODBC. This command converts the specified string as follows: Any occurrance of a single-byte character that also has a multi-byte representation (numerals. which combines the two elements. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-215 . The ROLLBACK command can be used with DB2. Informix. SBTOMBS Syntax SBTOMBS { txt_var } Description Converts a single-byte character into a multi-byte equivalent. Note.) For SYBASE and Microsoft SQL Server. and SQLBase. This argument is optional and can be used multiple times. column. See Also The TO_MULTI_BYTE function of the LET command. all subsequent commands for the current report are constrained by the designated sids until the report ends or another SECURITY command executes.. sid APPEND REMOVE MODE mode Example Begin-Report 2-216 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Can be any string literal.. SECURITY Syntax SECURITY [SET=(sid [. The SECURITY command can be repeated as many times as desired for the current report. Parameters Parameter SET Description Sets the list of security IDs for subsequent commands.sid]. column.. You can use the SECURITY command wherever you use the PRINT command. This argument is optional and can only be used once. Appends the specified security IDS to the current list.)] [APPEND=(sid [.)] [MODE=mode] Description Enables you to mark sections of a report for security purposes.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter txt_var Description Specifies the string to be converted.sid].sid].)] [REMOVE=(sid [.. Used to turn on (reactivate) or turn off (suspend) the security feature for the current report. This argument is optional and can be used multiple times.. The value is not case-sensitive and can be either ON or OFF. This argument is optional and can only be used once. Removes the specified security IDS from the current list. or variable. The previous list of security IDs is replaced by the specified security IDs. After the SECURITY command is executed. Can be any string literal. or variable. The value is case-sensitive.. The SET-COLOR command is allowed wherever the PRINT command is allowed. . End-report ! Only VPs.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Security Set=('Directors'.FOREGROUND=({color_name_lit|_var|_col|{rgb})] [PRINT-TEXT.BACKGROUND=({color_name_lit|_var|_col|{rgb})] Description Defines default colors. . Security Append=('Engineers') . . 'Vice-Presidents') . this . Security Remove=('Directors') . . PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-217 . . . .' Use the color name 'none' to turn off color for the specified area. and Engineers can see ! Only VPs and Managers can see this ! Anybody can see this ! Only VPS can see this ! Only Directors and VPS can see this SET-COLOR Syntax SET-COLOR [PRINT-TEXT. SQR uses the settings for the color name 'default. . Security Mode='On' Append=('Managers') .FOREGROUND PRINT-TEXT-BACKGROUND Description Defines the color in which the text is printed. Defines the color to print as a background behind the text. Security Mode='Off' . If the specified color name is not defined. Parameters Parameter PRINT-TEXT. Managers. . and the hyphen (-) character. The name 'none' is reserved and cannot be assigned a value. 0-9).255.0) maroon=(128. The name 'default' is reserved and may be assigned a value. 'Default' is used during execution when a referenced color is not defined in the runtime environment.0.128) aqua=(0.128.0. The default colors implicitly installed with SQR include: black = (0.0.0.128.0) green=(0. red_lit | _var | _col. blue_lit | _var | _col where each component is a value in the range of 000 to 255.0) navy=(0.255) gray=(128.0. It is caseinsensitive. the underscore (_) character.128) silver=(192.255) lime=(0.0) purple=(128. 229) end-declare end-setup 2-218 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . In the BEGINSETUP section.128. only literal values are allowed.255.0. A name in the format (RGBredgreenblue) cannot be assigned a value. green_lit | _var | _col.255) yellow=(255.0) white=(255.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter {color_name_lit | _var | _col} Description A color_name is composed of the alphanumeric characters (A-Z.128) olive=(128.192) red=(255.128) fuchsia=(255.192.255) {rgb} Example begin-setup declare-color-map light_blue = (193.0) teal=(0.255. 222.128.0. It must start with an alpha (A-Z) character.255.0) blue=(0. hierarchy.Q1. 233. hierarchy. SET-GENERATIONS Syntax SET-GENERATIONS=(dimension.1 ) SET-LEVELS Syntax Set-levels=(dimension.' This would increase the result set to a list of beers and wines.SQR FOR PEOPLESOFT LANGUAGE REFERENCE begin-program alter-color-map name = 'light_blue' value = (193. level.alcoholic beverages. 230) print 'Yellow Submarine' () foreground = ('yellow') background = ('light_blue') get-color print-text-foreground = ($print-foreground) set-color print-text-foreground = ('purple') print 'Barney' (+1. (Returns all 'Year' members (Generation Level 1) under the time hierarchy of '1997. dimension. dimension. This reduces result set to '1997'.1) set-color print-text-foreground = ($print-foreground) end-program See Also The DECLARE-COLOR-MAP. dimension.…. Returns the set of members in the dimension 'product' that are at the 5th generation in the dimension's hierarchy. and GET-COLOR commands in this section.…) Description Specifies dimension hierarchy for the previously declared dimension. ALTER-COLOR-MAP. level. hierarchy.2'.5. (Returns all 'Brand Name' members (Generation Level 5) under the product hierarchy of 'all products.) Returns the set of members in the dimension 'time' that are at the 1st generation deep into the dimension.'time'.drink.….…) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-219 .beer and wine.) Example set-generations=('product'. at a specific level of 'alcoholic beverages'. at the specific level of '2'.beer and wine. hierarchy. dimension. at the specific level of 'Q1'. In addition.'1997.drink.alcoholic beverages.drink. Returns the set of members in the dimension 'product' at the specific hierarchy of 'all products'. hierarchy. Example set-members=('product'. Description Displays one or more variables or literals on the screen.' Example set-levels=('product'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Extends the dimension hierarchy for the previously declared dimension.2 ) SET-MEMBERS Syntax set-members=(dimension. cursor control is supported for ANSI terminals.. level.drink.beer and wine'. returns all members for generation levels 5 through 7 under the product hierarchy of all products.Q1.…. at a specific level of 'beer and wine'. Set-levels used with only the previous 'set-members'.2' ) SHOW Syntax SHOW[cursor_position] [CLEAR-SCREEN|CS|CLEAR-LINE|CL][any_lit|_var|_col] [EDITedit_mask|NUMBER|MONEY|DATE][BOLD][BLINK] [UNDERLINE][REVERSE][NORMAL][BEEP][NOLINE].'all products.alcoholic beverages. 2-220 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL ..beer and wine'.'time'.alcoholic beverages. returns all members under the product hierarchy and the next two generations (Product SubCategory and Brand Name) for the product hierarchy of all products. Returns the set of members in the dimension 'time' at the specific hierarchy of '1997'. at a specific level of 'drink'. or hierarchy whose name is specified by a string.…) Description Returns the set of members in a dimension. Set-levels used with the previous 'set-members' and 'set-generations'. or BEEP is used. Instead. add (+1. If the line was advanced. one of the database-dependent formats as listed in the Default Database Formats table. Screen locations can be indicated by either fixed or relative positions in the format (A. the first database-dependent format as listed in the Default Database Formats table is used. the date is displayed according to the following rules: • For DATETIME columns and SQR DATE variables. For TIME columns. and display characteristics. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-221 . CLEAR-SCREEN. For DATE columns. • • When displaying a date in a string literal. If this has not been set. column. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. the format specified by the SQR_DB_DATE_FORMAT setting is used. the string must be in the format specified by the SQR_DB_DATE_FORMAT setting.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Any number of variables and screen positions can be used in a single command.). the format as listed in the TIME Column Formats table is used. Parameters Parameter cursor_position Description Specifies the position on the screen to begin the display. without an edit mask. where A is the line and B is the column on the screen. column. Also. is not supported. the format listed in the Default Database Formats table is used. Relative positions depend on where the previous SHOW command ended. The SHOW command does not advance to the next line if a cursor location (. or a string literal. Scrolling off the screen using relative positioning. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. CLEAR-LINE. the screen cursor is usually immediately to the right of the previously displayed value and one line down.. or variable. you cannot mix SHOW and DISPLAY commands while referencing relative cursor positions. line blanking. Each one is processed in sequence. When displaying a date variable or column. Only ANSI terminals are supported for cursor control. use a SHOW command without any cursor position when you want to scroll. If this has not been set.B). for example (+1.) To add a line advance. or variable using EDIT or DATE. (A SHOW command without any of these arguments automatically advances the line. If this has not been set. A and/or B can also be numeric variables. screen blanking. Fixed or relative cursor positioning can be used only within the boundaries of the terminal screen. or the databaseindependent format 'SYYYYMMDD[HH24[MI[SS[NNNNNN]]]].1).1) to the end of the line or use an extra empty SHOW command.. Dates can be contained in a date variable or column. Inhibits a line advance. enclose it in single quotes.) This option is not legal for date variables. Changes the display of characters on terminals that support those characteristics. BLINK. If the mask contains spaces.1). see the PRINT command. UNDERLINE. and REVERSE NORMAL BEEP NOLINE Example The following program segments illustrate the various features of the SHOW command: ! ! Show a string using an edit mask ! 2-222 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Indicates that any_lit|_var|_col is to be formatted using the DATE-EDIT-MASK from the current locale.) This option is not legal for date variables. Indicates that any_lit|_var|_col is to be formatted using the NUMBER-EDIT. {CLEAR-LINE | CL} {any_lit | _var | _col} EDIT NUMBER MONEY DATE BOLD. Clears a line from the current cursor position to the end of the line. Turns off all special display characteristics set with BOLD. Specifies the information to be displayed. Indicates that any_lit|_var|_col is to be formatted using the MONEY-EDIT. use NORMAL. (See the ALTER-LOCALE command.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter {CLEAR-SCREEN | CS} Description Clears the screen and sets the cursor position to (1. If DATE-EDIT-MASK has not been specified.) This option is not legal for numeric variables. (See the ALTER-LOCALE command. Causes the terminal to beep. BLINK.MASK from the current locale. Some terminals support two or more characteristics at the same time for the same text. and REVERSE. then the date is displayed using the default format for that database (see the Default Database Formats table). Shows variables under an edit mask. UNDERLINE.MASK from the current locale. (See the ALTER-LOCALE command. To turn all special display characteristics off. For additional information regarding edit masks. 456.999.99' show 123456.780000 ! ! Show a number using the locale default numeric edit mask ! alter-locale number-edit-mask = '99.78 money Produces the following output: $123.456.567.$$$.78 number Produces the following output: 123.89 edit 999.999.SQR FOR PEOPLESOFT LANGUAGE REFERENCE let $ssn = '123456789' show $ssn edit xxx-xx-xxxx Produces the following output: 123-45-6789 ! ! Show a number using an edit mask ! show 1234567.999.$$8.234.99' show 123456.78 Produces the following output: 123.99 Produces the following output: 1.999.78 ! PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-223 .89 ! ! Show a number using the default edit mask ! show 123.78 ! ! Show a number using the locale default money edit mask ! alter-locale money-edit-mask = '$$. screen blanking.78 show 'You owe ' #taxes money ' in back taxes. begin-program ! ! Produces a menu for the user to select from ! show clear-screen (3. Quarterly Details of Accounts' '4.78 in back taxes.30) (+2.456.' Produces the following output: You owe $123. Quarterly Summary' 2-224 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Only terminals that support the ANSI escape characters can use the cursor control.10) bold 'Accounting Reports for XYZ Company' normal '1.10) (+1.10) (+1.10) (+1. The following program illustrates the usage of additional options of the SHOW command.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ! Show a date column using the locale default date edit mask ! begin-select dcol from tables end-select alter-locale date-edit-mask = 'DD-Mon-YYYY' show &dcol date Produces the following output: 01-Jan-1999 ! ! Show two values on the same line ! show 'Hello' ' World' Produces the following output: Hello World ! ! Show two values on the same line with editing of the values ! let #taxes = 123456. Monthly Summary' '3. Monthly Details of Accounts' '2. line blanking and display attributes. and DATE-EDIT-MASK. All report page buffers are flushed. if they contain data. instead of ending with an error message.99 See Also The LET command for information about copying.1) clear-line 'Error in SQL. no headers or footers are printed and the AFTER-PAGE and AFTER-REPORT procedures are not executed.1) 'The price is ' #price edit 999. MONEY-EDIT-MASK.SQR FOR PEOPLESOFT LANGUAGE REFERENCE ! ! Show a line of text and numerics combined ! show (+2.99 ' ! ! Put an error message on a particular line ! show (24. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-225 . The ALTER-LOCALE command for a description of the arguments NUMBER-EDIT-MASK. The DISPLAY command. however. Parameters Parameter QUIET Description Causes the report to complete with the "SQR: End Of Run" message. STOP Syntax STOP [QUIET] Description The STOP command halts SQR and executes a ROLLBACK command (not in SYBASE. or converting fields.' beep Total = ' #total edit 99999. The EDIT parameter of the PRINT command for a description of the edit masks. Microsoft SQL Server. or Informix). end-program Please try again. editing. STOP is useful in testing. . 2-226 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. or literals into a single text variable. Parameters Parameter {src_any_lit|_var|_col} Description Specifies one or more fields to be concatenated. The destination string must not be included in the list of source strings. separated by the delim_txt_lit|_var|_col character or characters. If this has not been set. For DATE columns. Each member of the list separated by the specified delimiter string. the first database-dependent format as listed in the Default Database Formats table is used. If the source is a date variable or column. the format as listed in the TIME Column Formats table is used. the format specified by the SQR_DB_DATE_FORMAT setting is used.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example if #error-status = 1 rollback stop else commit stop quiet end-if STRING Syntax STRING {src_any_lit|_var|_col}. the format listed in the Default Database Formats table is used.BY {delim_txt_lit|_var|_col} INTO dst_txt_var Description Concatenates a list of variables.. For TIME columns the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. If this has not been set. columns. it is converted to a string according to the following rules: For DATETIME columns and SQR DATE variables. and placed into the dst_txt_var variable. If this has not been set. NY - ! Use null delimiter. The "||" concatenation operator in the Operators table under the LET command. use decimal variables rather than float variables. SUBTRACT Syntax SUBTRACT {src_num_lit|_var|_col} FROM dst_num_var[ROUND=nn] Description SUBTRACT subtracts the first value from the second and moves the result into the second field. Specifies the destination field for the concatenated result. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-227 . and small inaccuracies can appear when subtracting many numbers in succession. dst_txt_var Example string 11287 string &cust_num &entry-date &total by '.12-MAR-89.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter {delim_txt_lit|_var|_col} Description Specifies one or more characters to be used as separator characters between the source fields. Float variables are stored as double precision floating point numbers. Contains the result after execution. $codes123 AGL ! Result: See Also The UNSTRING command for additional information.New York .' into $cust-data ! Result: string &code1 &code2 &code3 by '' into 100014.' into $show-info ! Result: Sam Mann . These inaccuracies can appear due to the way floating point numbers are represented by different hardware and software implementations.127 &name &city &state &zip by ' . When dealing with money-related values (dollars and cents). Parameters Parameter {src_num_lit | _var | _col} dst_num_var Description Is subtracted from the contents of dst_num_var. For integer variables. 2-228 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .1 subtract &discount from #price ! #price . The LET command for information about complex arithmetic expressions. For decimal variables.&discount See Also The ADD command for more information.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter ROUND Description Rounds the result to the specified number of digits to the right of the decimal point. this value can be from 0 to the precision of the variable. Example subtract 1 from #total ! #total . TOC-ENTRY Syntax TOC-ENTRY TEXT={src_txt_lit|_var|_col} [LEVEL={level_num_lit|_var|_col}] Description Enter the text in the Table of Contents at the desired level. For float variables this value can be from 0 to 15. If this argument is not specified. the value of the previous level is used. this argument is not appropriate. LEVEL Example toc-entry text = &heading toc-entry text = &caption level=2 See Also The DECLARE-TOC command. Parameters Parameter TEXT Description Specifies the text to be placed in the Table of Contents. Specifies the level at which to place the text. Delim_txt_lit|_var|_col Specifies one or more characters to be used to delimit the fields within {src_txt_lit|_var|_col}|{src_date_var|_col} Specifies one or more destination fields to receive the results. the extra destination strings are each set to an empty string.' into $name $city $state $zip PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-229 . Description Copies portions of a string into one or more text variables. the format listed in the Default Database Formats table is used. If more substrings are found in the source string than in the destination strings. the format as listed in the TIME Column Formats table is used. If this has not been set. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used.. it is converted to a string according to the following rules: • For DATETIME columns and SQR DATE variables. If this has not been set. If the source is a date variable or column. For TIME columns. • • Parameters Parameter {src_txt_lit|_var|_col}|{ src_date_var|_col} Description Specifies the source field to be parsed. Each substring is located using the specified delimiter. the first database-dependent format as listed in the Default Database Formats table is used.SQR FOR PEOPLESOFT LANGUAGE REFERENCE UNSTRING Syntax UNSTRING {{src_txt_lit|_var|_col}|{src_date_var|_col}} BY {delim_txt_lit|_var|_col} INTO dst_txt_var. If more destination strings than substrings are found in the source strings. If this has not been set. For DATE columns.. the extra substrings are not processed. It is up to the programmer to ensure that enough destination strings are specified. The source string must not be included in the list of destination strings. Dst_txt_var Example unstring $show-info by ' . the format specified by the SQR_DB_DATE_FORMAT setting is used. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. When used. (SYBASE and Microsoft SQL Server only) Use USE in the SETUP section only. rather than the default database associated with your username. USE Syntax USE database Description Uses the named database. Parameters Parameter txt_var Description Specifies the field to be converted to uppercase. uppercase $state See Also The upper function in the Miscellaneous Functions table under the LET command. before any queries are defined. Example input $state 'Enter state abbreviation' ! Force uppercase. it must appear at the top of your report. 2-230 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .' into $cust_num $entry-date $total See Also The STRING and EXTRACT commands.SQR FOR PEOPLESOFT LANGUAGE REFERENCE unstring $cust-data by '. The substr and instr functions in the Miscellaneous Functions table under the LET command. UPPERCASE Syntax UPPERCASE txt_var Description Converts a string variable to uppercase. the column_number_int_lit|_var|_col can be 1 to 5. however.customers You cannot issue the SYBASE or Microsoft SQL Server USE command from within an SQL paragraph. use a column number of 0 (zero). Example begin-setup use pubs end-setup See Also The -DB command-line flag. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-231 . if five columns are defined. The column must be previously defined with the COLUMNS command. To stop printing within columns.sqr. For example: from sqdb. Printing returns to normal. the columns remain defined for subsequent NEXT-COLUMN or USE-COLUMN commands.” USE-COLUMN Syntax USE-COLUMN {column_number_int_lit|_var|_col} Description Sets the current column.SQR FOR PEOPLESOFT LANGUAGE REFERENCE To reference more than one database in a program. For example. Parameters Parameter database Description Specifies the name of the database to use. described in “Invoking SQR Execute. specify secondary databases explicitly. Parameters Parameter {column_number_int_lit|_var|_col} Description Specifies the number of the defined column (not the location on the page). .argi].)]] [BEFORE-PAGE=procedure_name[(arg1[. and USE-REPORT commands. the USE-PRINTER-TYPE command is ignored.. Example use-report customer_orders use-printer-type PostScript print (1. Parameters Parameter printer-type Description Specifies the printer type to be used for the current report.999 ! End of column printing.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example use-column print use-column 3 () 0 ! Print total in 3rd column.report_namei].. If output has already been written to the report file..argi]. #total USE-PRINTER-TYPE Syntax USE-PRINTER-TYPE printer-type Description Sets the printer type to be used for the current report. USE-PROCEDURE Syntax USE-PROCEDURE [FOR-REPORTS=(report_name1[. The USE-PRINTER-TYPE command must appear before the first output is written to that report..argi]. See DECLARE-PRINTER for valid types... 999..argi]. 1) 'Customer Name: ' print () $customer_name See Also The DECLARE-PRINTER..)]] [AFTER-REPORT=procedure_name[(arg1[.)] [BEFORE-REPORT=procedure_name[(arg1[. The USE-PRINTER-TYPE command sets or alters the printer type to be used for the current report.. DECLARE-REPORT.)]] [AFTER-PAGE=procedure_name[(arg1[.)]] 2-232 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Specifies a procedure to execute at the time of execution of the first command. to display page totals. ALL is assumed. If you issue multiple USE-PROCEDURE commands. You can use the command as often as required to change to the necessary procedures required by the reports. If a procedure is defined in one DECLARE-PROCEDURE for a report. the default for each of the four procedure types is NONE. You can also specify arguments to be passed to the procedure. If no FOR-REPORTS is specified. because that causes the BEFORE-REPORT procedure to be executed.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Changes the procedure usage. The referenced procedures can accept arguments. to create a report heading. It can be used. Parameters Parameter FOR-REPORTS Description Specifies the reports that are to use these procedures. BEFORE-REPORT AFTER-REPORT BEFORE-PAGE AFTER-PAGE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-233 . each remains in effect for that report until altered by another USE-PROCEDURE command for that report. you can use one to change common procedures for ALL reports and others to change unique procedures for individual reports. In this way. column. Specifies a procedure to execute just before the report file is closed at the end of the report. This argument can be used. which causes output to be generated. for example. This argument is required only for a program with multiple reports. This argument can be used to print totals or other closing summary information. to set up page totals. just before the first output command for the page. You can change the BEFORE-REPORT only before the first output is written to that report. USE-PROCEDURE is a runtime command. Arguments can be any variable. the procedure does not execute. If no report was generated. Initially. or literal. that procedure is used unless NONE is specified. for example. You can use the command. The USE-PROCEDURE must be issued in the PROGRAM or PROCEDURE sections of an SQR program. If you are writing a program that produces a single report. its compile-time equivalent is DECLARE-PROCEDURE. for example. Specifies a procedure to execute just before each page is written to the file. you can ignore this argument. Specifies a procedure to execute at the beginning of every page. USE-REPORT Syntax USE-REPORT {report_name_lit|_var|_col} Description For programs with multiple reports. You must specify the report name and report characteristics in a DECLARE.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Example use-procedure for-reports=(all) before-report=report_heading after-report=report_footing use-procedure for-reports=(customer) before-page=page_setup after-page=page_totals use-procedure for-reports=(summary) after-report=none ! The after-report ! procedure will be ! disabled for the ! summary report ! These procedures will ! be used by the customer ! report ! These procedures will ! be used by all reports See Also The DECLARE-PROCEDURE command.REPORT paragraph and in the associated DECLARE-LAYOUT and DECLARE. An application can contain several USE.REPORT statements to control several reports.PRINTER paragraphs. enables the user to switch between reports. 2-234 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The USE-REPORT command specifies to which report files the subsequent report output is to be written. An expression returning 0 (zero) is considered FALSE. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-235 . DECLARE-LAYOUT. END-WHILE Description Begins a WHILE .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter {report_name_lit|_var|_col} Description Specifies the report to become the "current" report. END-WHILE loop. an expression returning nonzero is TRUE. All subsequent PRINT and PRINTDIRECT statements are written to this report until the next USE... The WHILE loop continues until the condition being tested is FALSE. and USE-PRINTER-TYPE commands. SQR continues with the command immediately following END-WHILE.REPORT is encountered. [BREAK] SQR_commands. WHILE commands can be nested to any level and can include or be included within IF and EVALUATE commands... WHILE Syntax WHILE logical_expression The general format of a WHILE command is as follows: WHILE logical_expression SQR_commands. DECLARE-PRINTER. Example use-report customer_orders use-printer-type PostScript print (1.. BREAK causes an immediate exit of the WHILE loop.. 1) 'Customer Name: ' print () $customer_name See Also The DECLARE-REPORT. for example when using flags: move 1 to #have_data . as shown in the following example: while #count < 100 and (not #end-file or isnull(&state)) ..SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter logical_expression Description A valid logical expression. if ... You can use single numeric variables in your expression to make your program more readable...... Example The following example shows an IF nested within a WHILE: while #count < 50 do get_statistics if #stat_count = 100 break end-if add 1 to #count end-while ! Exit WHILE loop. end-while The following example sets up an infinite loop: while 1 .... break end-if end-while ! Exit loop Any complex expression can be used in the WHILE command. See the LET command for a description of logical expressions.processing.processing.. 2-236 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . end-while See Also The LET command for a description of expressions... while #have_data . Only 1. which is system-dependent. The total length of the variables and literals being written must not be greater (but can be less) than the record length specified when the file was opened. the current length of the variable is used.SQR FOR PEOPLESOFT LANGUAGE REFERENCE WRITE Syntax WRITE {filenum_lit|_var|_col} FROM {{{txt_lit|_var|_col}|{date_var|_col}|num_col} [:len_int_lit]}|{num_lit|_var:len_int_lit}}. the format as listed in the TIME Column Formats table is used. the length argument is required. columns. The file must already be opened for writing. When writing a date variable or column. it returns the value of errno. For TIME columns. or 4 byte binary integers are written. otherwise. specify a length for each variable written to the file. If you need a fixedlength record. the format listed in the DATE Column Formats table is used. If this has not been set. If length is specified. If length is not specified (for string variables or database columns).. or literals. the format specified by the SQR_DB_TIME_ONLY_FORMAT setting is used. the date is converted to a string according to the following rules: • For DATETIME columns and SQR DATE variables. you can first convert floating point numbers to strings and then write the string. If this has not been set. However. • • Text literals take the length of the literal. Records are not padded. the format specified by the SQR_DB_DATE_FORMAT setting is used. but are written with the total length of all variables in the WRITE command. SQR returns 0 if the write is successful. [STATUS=status_num_var] Description Writes a record to a file from data stored in variables. the variable is either truncated at that length or padded with spaces to that length. The file is not portable across platforms because binary numbers are represented differently.NOLF qualifiers. When writing numeric variables. If STATUS is specified.. Files opened for writing are treated as having variable-length records. For DATE columns. When writing binary data the file must be open using the FIXED or FIXED. the format specified by the SQR_DB_DATE_ONLY_FORMAT setting is used. 2. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR COMMAND REFERENCE 2-237 . the first databasedependent format as listed in the Default Database Formats table is used. If this has not been set. Floating point values are not supported directly in the WRITE command. Specifies an optional variable into which a write status is returned. {{txt_lit|_var|_col}|{date_var|_col}|num_c ol} [:len_int_lit]}|{num_lit|_var:len_int_lit} STATUS Example write write write move write 5 17 #j2 from from from $name:20 $company #rate:2 $city:15 ' .' $state ' ' $zip #quantity:1 ! Convert floating point to ! string. and READ commands.' $state:2 ' . Specifies one or more variables to be written. CLOSE.99 See Also The OPEN. len_int_lit specifies the length of each field of data. 2-238 SQR COMMAND REFERENCE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameters Parameter filenum_lit|_var |_col Description Specifies the number assigned in the OPEN command to the file to be written. 1 from $tot ! Put the current date and time ! into DATE variable write 3 from $date1:20 let $date1 = datenow() $city #amount:4 #total to $tot 99999. intranet. HTML General Purpose Procedures The following table lists the HTML general purpose procedures. Adding HTML procedures to the SQR program enhances the appearance of the HTML output. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-1 . You can publish the output on an internet. or extranet website.CHAPTER 3 Generating HTML Output This section describes the procedures that enable SQR for PeopleSoft to generate HTML output. An SQR program without HTML procedures has limited HTML capabilities. This chapter describes the following HTML procedures: • • • • • • General purpose Headings Highlighting Hypertext links Lists Tables See Also SQR for PeopleSoft Developer’s Guide. “Working With HTML” for details on using these procedures. string attributes) count = the number of HTML <BR> tags that are inserted. attributes = the HTML attributes that are incorporated inside the HTML <BR> tag. Syntax: html_center() attributes = the HTML attributes that are incorporated inside the HTML <CENTER> tag. Example: Centering text using the <CENTER> tag: do html_center(‘’) print ‘Here is some text’ () do html_center_end html_center_ end Marks the end of text previously specified to be centered. Example: Producing a horizontal divider: print 'Here is some text' () do html_hr('') print 'And some more text' () 3-2 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Syntax: html_br(number count. Example: Producing a line break: print 'Here is some text' () do html_br(3. Syntax: html_center_end html_hr Produces a horizontal divider between sections of text using the HTML <HR> tag.'') print 'Here is some three lines down' () html_center Marks the start of text to be centered on the HTML document using the HTML <CENTER> tag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_br Produces the specified number of line breaks in a paragraph using the HTML<BR> tag. Syntax: html_hr(string attributes) attributes = the HTML attributes that are incorporated inside the HTML <HR> tag. You can also accomplish this using the SQR print statement with CENTER specified in the code. The paragraph continues onto the next line. the procedure html_img enables you to specify the full set of available HTML attributes. the HTML procedures are not turned on.gif) height = height of the image in pixels. the appearance of the web page must be formatted using the various HTML procedures. (Ex: width=400) Example: Producing an image: do html_img('src="/images/stop. (Ex: height=200) width = width of the image in pixels. Call this procedure at the start of an SQR program.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_img Inserts an image using the HTML <IMG> tag. Syntax: html_nobr Example: Preventing line wrapping: do html_nobr('') print 'Here's long text that should not wrap' () do html_nobr_end html_nobr_end Marks the end of text that cannot be wrapped using the HTML </NOBR> tag. Syntax: html_nobr_end html_on Turns on the HTML procedures. otherwise. however.gif"') html_nobr Marks the start of text that cannot be wrapped using the HTML <NOBR> tag. Syntax: html_on Example: Turning on the HTML procedures: do html_on PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-3 . (Ex: src=/images/abc. Some common attributes: src = URL of the image to be inserted. This can also be done using the command PRINT-IMAGE. Syntax: html_img(string attributes) attributes = the HTML attributes that are incorporated inside the HTML <IMG> tag. After the HTML procedures are turned on. then another paragraph with normal text: do html_p('ALIGN=RIGHT') print 'Right aligned text' (1. Syntax: html_p_end html_set_body_attribute s Specifies the attributes that are incorporated into the HTML <BODY> tag. Some common attributes: background = Specifies the image to display is the background of the web page. The end of a paragraph is typically implied and not needed.1) html_p_end Marks the end of a paragraph using the HTML </P> tag. Syntax: html_set_body_attributes(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <BODY> tag.gif"') 3-4 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_p Marks the start of a new paragraph using the HTML <P> tag. (Ex: background=/images/logo.gif) bgcolor=#rrggbb Specifies the background color of the Web page. (Ex: bgcolor=#80FFF) Example: Using BACKGROUND attribute to display image marble. however. This must be called at the start of the SQR program.gif in the background of the web page: do html_set_body_attributes('BACKGROUND="/images/x.1) do html_p_end print 'Normal text' (+1. we recommend that you specify it for completeness. Syntax: html_p(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <P> tag. Some common attributes: align = left|right|center Specifies the alignment of the paragraph Example: Displaying one paragraph with right-aligned text. Example: Displaying the title My Report for the Web page: do html_set_head_tags('<TITLE>My Report</TITLE>') HTML Heading Procedures The following table lists the HTML heading procedures. Syntax: html_set_head_tags(string attributes) attributes = defines the HTML attributes that are incorporated between the <HEAD> and </HEAD> HTML tags. Procedure Description html_h1 Marks the start of heading level one text using the HTML <H1> tag. Syntax: html_h1_end PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-5 . This must be called at the start of the SQR program. Text under this heading is displayed more prominently than that of heading level two.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_set_head_tags Specifies the tags that are incorporated between the <HEAD> and </HEAD> HTML tags. Syntax: html_h1(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <H1> tag. One common tag to set is <TITLE>. Example: Displaying text as a heading level one: do html_h1('') print 'This is a heading' () do html_h1_end html_h1_end Marks the end of heading level one text using the HTML </H1> tag. By default tThese are empty by default. which specifies the title to display for the Web web page. html_h4_end Marks the end of heading level four text using the HTML </H4> tag. Syntax: html_h2(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <H2> tag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_h2 Marks the start of heading level two text using the HTML <H2> tag. Syntax: html_h2_end html_h3 Marks the start of heading level three text using the HTML <H3> tag. Syntax: html_h3(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <H3> tag. Example: Displaying text as a heading level two: do html_h2('') print 'This is a heading' () do html_h2_end html_h2_end Marks the end of heading level two text using the HTML </H2> tag. Note. Text under this heading displays less prominently than that of heading level three and more prominently than that of heading level five. Syntax: html_h4(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <H4> tag. Text under this heading displays less prominently than that of heading level two and more prominently than that of heading level four. html_h3_end Marks the end of heading level three text using the HTML </H3> tag. Text under this heading is displayed less prominently than that of heading level one and more prominently than that of heading level three. Syntax: html_h3_end html_h4 Marks the start of heading level four text using the HTML <H4> tag. Syntax: html_h4_end 3-6 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This heading level is the default value. Syntax: html_h6(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <H6> tag. Text under this heading displays less prominently than that of heading level four and more prominently than that of heading level six. Text under this heading displays less prominently than that of heading level five and more prominently than that of heading level seven. Procedure Description html_blink Marks the start of blinking style text using the HTML <BLINK> tag. Syntax: html_h5_end html_h6 Marks the start of heading level six text using the HTML <H6> tag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_h5 Marks the start of heading level five text using the HTML <H5> tag. Syntax: html_h5(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <H5> tag. html_h6_end Marks the end of heading level six text using the HTML </H6> tag. Syntax: html_blink(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <BLINK> tag. Example: Displaying text with the address style: do html_blink('') print 'This is blinking' () do html_blink_end html_blink_end Marks the end of blinking style using the HTML </BLINK> tag. html_h5_end Marks the end of heading level five text using the HTML </H5> tag. Syntax: html_h6_end HTML Highlighting Procedures The following table lists the HTML highlighting procedures. Syntax: html_blink_end PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-7 . SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_cite Marks the start of citation style text using the HTML <CITE> tag. Syntax: html_cite_end html_code Marks the start of code style text using the HTML <CODE> tag. Example: Displaying text with the keyboard style: do html_kbd('') print 'Here is keyboard' () do html_kbd_end html_kbd_end Marks the end of keyboard style text using the HTML </KBD> tag. Example: Displaying text with the code style: do html_code('') print 'Here is code' () do html_code_end html_code_end Marks the end of code style text using the HTML </CODE> tag. Syntax: html_kbd_end 3-8 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Syntax: html_code_end html_kbd Marks the start of keyboard input style text using the HTML <KBD> tag. Syntax: html_cite(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <CITE> tag. Syntax: html_code(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <CODE> tag. Example: Displaying text with the citation style: do html_cite('') print 'This is a citation' () do html_cite_end html_cite_end Marks the end of citation style text using the HTML </CITE> tag. Syntax: html_kbd(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <KBD> tag. Syntax: html_sub_end PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-9 . Example: Displaying text with the sample style: do html_samp('') print 'Here is sample' () do html_samp_end html_samp_end Marks the end of sample style text using the HTML </SAMP> tag. Example: Displaying text with the subscript style: print 'Here is' () do html_sub('') print 'subscript text' () do html_sub_end html_sub_end Marks the end of subscript style text using the HTML </SUB> tag. Syntax: html_samp_end html_strike Marks the start of strike-through style text using the HTML <STRIKE> tag. Syntax: html_strike(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <STRIKE> tag. Syntax: html_samp(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <SAMP> tag. Syntax: html_sub(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <SUB> tag. Syntax: html_strike_end html_sub Marks the start of subscript style text using the HTML <SUB> tag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_samp Marks the start of sample style text using the HTML <SAMP> tag. Example: Displaying text with the strike-through style: do html_strike('') print 'Here is strike-through' () do html_strike_end html_strike_end Marks the end of strike-through style text using the HTML </STRIKE> tag. Syntax: html_sup_end HTML Hypertext Link Procedures The following table lists the HTML hypertext link procedures.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_sup Marks the start of superscript style text using the HTML <SUP> tag. 3-10 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Syntax: html_sup(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <SUP> tag. Example: Displaying text with the superscript style: print 'Here is' () do html_sup('') print 'superscript text' () do html_sup_end html_sup_end Marks the end of superscript style text using the HTML </SUP> tag. (Ex: name = an anchor to which a hypertext link can point.html. The first hypertext link points to the HTML document otherdoc. At a minimum. the web browser switches to the specified HTML document. Syntax: html_a_end HTML List Procedures The following table lists the HTML list procedures.html) where the hypertext link points to. When the user clicks the area with the hypertext link. do html_a('NAME=TOP') do html_a_end print 'At the top of document' () do html_br(20. The second hypertext link points to the anchor named TOP.html') print 'Goto other document' () do html_a_end do html_p('') do html_a('HREF=#TOP') print 'Goto top of document' () do html_a_end html_a_end Marks the end of a hypertext link using the HTML </A> tag. the HREF attribute should be defined. Some common attributes: href = href=home.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_a Marks the start of a hypertext link using the HTML <A> tag. The anchor is positioned at the top of the document. (Ex: name=marker1) Example: Creating an anchor with two hypertext links. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-11 . which specifies the URL of an HTML document. Syntax: html_a(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <A> tag. '') do html_a('HREF=otherdoc. Syntax: html_dir_end 3-12 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . we recommend that you specify it for completeness. The end of a definition in a definition list is typically implied and not needed. Syntax: html_dd_end html_dir Marks the start of a directory list using the HTML <DIR> tag. however. html_dd_end Marks the end of a definition in a definition list using the HTML </DD> tag. Syntax: html_dd(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <DD> tag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_dd Marks the start of a definition in a definition list using the HTML <DD> tag. Example: Displaying an ordered list with three items: do html_dir('') do html_li('') print 'First item' () do html_li('') print 'Second item' () do html_li('') print 'Last item' () do html_dir_end html_dir_end Marks the end of a directory using the HTML </DIR> tag. Syntax: html_dir(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <DIR> tag. Syntax: html_dl(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <DL> tag. Syntax: html_li(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <LI> tag. Syntax: html_dt(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <DT> tag. Use the procedure html_dt to display a term.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_dl Marks the start of a definition list using the HTML <DL> tag. A definition list displays a list of terms and definitions.' () do html_dt('') print 'A Rose' () do html_dd('') print 'A very passionate flower.' () do html_dl_end html_dl_end Marks the end of a definition list using the HTML </DL> tag. html_dt_end Marks the end of a term in a definition list using the HTML </DT> tag. Syntax: html_dt_end html_li Marks the start of a list item using the HTML <LI> tag. Use the procedure html_dd to display a definition. The term displays above and to the left of the definition. Syntax: html_dl_end html_dt Marks the start of a term in a definition list using the HTML <DT> tag. Example: Displaying a definition list with two terms and definitions: do html_dl('') do html_dt('') print 'A Daisy' () do html_dd('') print 'A sweet and innocent flower. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-13 . Example: Displaying an ordered list with three items: do html_menu('') do html_li('') print 'First item' () do html_li('') print 'Second item' () do html_li('') print 'Last item' () do html_menu_end html_menu_end Marks the end of a menu using the HTML </MENU> tag. Use the procedure html_li to identify each item in the list. however. The end of a list item is typically implied and not needed. we recommend that you specify it for completeness. Syntax: html_li_end html_menu Marks the start of a menu using the HTML <MENU> tag. Syntax: html_menu_end 3-14 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Syntax: html_menu(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <MENU> tag.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_li_end Marks the end of a list item using the HTML </LI> tag. Each item in the list typically displays indented to the right with a number to the left.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_ol Marks the start of an ordered list using the HTML <OL> tag. Syntax: html_ol_end PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-15 . Syntax: html_ol(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <OL> tag. Example: Displaying an ordered list with three items: do html_ol('') do html_li('') print 'First item' () do html_li('') print 'Second item' () do html_li('') print 'Last item' () do html_ol_end html_ol_end Marks the end of an ordered list using the HTML </OL> tag. Use the procedure html_li to identify each item in the list. Syntax: html_ul_end HTML Table Procedures The following table lists the HTML table procedures. Use the procedure html_li to identify each item in the list. Procedure Description html_caption Marks the start of a table caption using the HTML <CAPTION> tag. however.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_ul Marks the start of an unordered list using the HTML <UL> tag. Syntax: html_caption_end 3-16 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Each item in the list typically is displayed indented to the right with a bullet to the left. Syntax: html_caption(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <CAPTION> tag. html_caption_end Marks the end of a table caption using the HTML </CAPTION> tag. The end of a table caption is typically implied and not needed. we recommend that specify it for completeness. Syntax: html_ul(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <UL> tag. Example: Displaying an ordered list with three items: do html_ul('') do html_li('') print 'First item' () do html_li('') print 'Second item' () do html_li('') print 'Last item' () do html_ul_end html_ul_end Marks the end of an unordered list using the HTML </UL> tag. Syntax: html_table(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <TABLE> tag. width cols COLS=4) = Specifies the width of the entire table in pixels. html_td_end.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_table Marks the start of a table using the HTML <TABLE> tag. (Ex: Example: Displaying database records in a tabular format. = Specifies the number of columns in the table. html_tr_end. Some common attributes: border = Specifies that a border is displayed around each cell of the table. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-17 . The procedures html_caption_end. however. and html_th_end are used for completeness. they are typically implied and not needed. Syntax: html_table_end 3-18 GENERATING HTML OUTPUT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .10.6) edit 099999 do html_td_end do html_td('') name (1.1) do html_th_end do html_th('') print 'Name" (.25) do html_td_end do html_tr_end next-listing skiplines=1 need=1 from customers end-select ! end the table do html_table_end html_table_end Marks the end of a table using the HTML </TABLE> tag.10) do html_th_end do html_tr_end ! display each record begin-select do html_tr('') do html_td('') cust_num (1.1.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_table (Continued) ! start the table & display the column headings do html_table('border') do html_caption('') print 'Customer Records' (1.1) do html_caption_end do html_tr('') do html_th('') print 'Cust No' (+1. we recommend that you specify it for completeness. Syntax: html_th(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <TH> tag. however. Syntax: html_th_end html_tr Marks the start of a new row in a table using the HTML <TR> tag. we recommend that you specify it for completeness. html_tr_end Marks the end of a list item using the HTML </TR> tag. it is a good idea to specify it for completeness.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Procedure Description html_td Marks the start of a new column in a table row using the HTML <TD> tag. The end of a column in a table is typically implied and not needed. This specifies that the text that follows is displayed as the header of the column. Syntax: html_tr(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <TR> tag. Syntax: html_tr_end PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GENERATING HTML OUTPUT 3-19 . This specifies that the text that follows is displayed in the column. however. The end of a column is typically implied and not needed. Syntax: html_td(string attributes) attributes = defines the HTML attributes that are incorporated inside the HTML <TD> tag. html_td_end Marks the end of a column in a table using the HTML </TD> tag. html_th_end Marks the end of a column header in a table using the HTML </TH> tag. The end of a column header is typically implied and not needed. Syntax: html_td_end html_th Marks the start of a new column header in a table row using the HTML <TH> tag. however. . Flag Description -A Appends the output to an existing output file of the same name. -BURST:P and -BURST:S require -PRINTER:EH or -PRINTER:HT. connectivity.. enter the following command. {l} is the number of logical report pages that each . The setting BURST:P is equivalent to -BURST:P0. The table in the “SQR Command-Line Arguments” section describes program. invoke SQRWT rather than SQRT.. {n}-{m}. If the file does not exist.. Running SQR Execute To begin running SQR Execute. Specifies the type of bursting to be performed. In -BURST:P[ {l} . The Page range selection feature of -BURST:P requires -PRINTER:HT. SQR Execute is a runtime program that enables you to run a previously compiled SQR program.1. (Microsoft Windows) Specifies that the Cancel dialog box appears while the program is running so you can easily terminate the program execution. -BURST:T requires -PRINTER:HT -C -BURST:{xx} PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INVOKING SQR EXECUTE 4-1 .) SQRT [program][connectivity][flags... and @file. args. -BURST:S generates the report output according to the symbolic Table of Contents entries set in the program with the TOC.] SQR Execute Flags The following table describes flags. {l} is the level at which to burst upon. The setting -BURST:S is equivalent to -BURST:S1 -BURST:P generates the report output by report page numbers. -BURST:T generates the Table of Contents file only. or {n}-.ENTRY command's "level" argument.CHAPTER 4 Invoking SQR Execute This chapter describes how to invoke SQR Execute. but want to create only a single output file.when using -PRINTER:HT or BURST:P1 when using -PRINTER:EH.][args.][@file. -{m}.. (If you are running under Microsoft Windows. Note. {s} [. In -BURST:S[ {l} ]. it creates a new one. {s}] …] ] . This is useful when you want to run the same report more than once.htm file contains and {s} is the page selection: {n}. no file is created. Switches between HTML 3.csv file from the report data. -DBdatabase -E[file] EH_APPLETS:dir -EH_BQD -EH_BQD:file EH_BROWSER:x x Generates a {report}. SQR generates HTML designed for Netscape.0 and HTML 3. Sets the language used for the HTML navigation bar. German. When set to ALL.pdf in the navigation bar. SQR generates HTML suitable for all browsers. or to the default file program. You can specify English. If no number is entered after -D. Associates the CSV icon with the specified file. Associates a PDF icon with {report}. (Non-Microsoft Windows) Causes SQR to display the report output on the terminal at the same time it is being written to the output file. otherwise. and generates HTML designed for that browser. If the program is producing more than one report.bqd in the navigation bar. When set to BASIC.2. or Spanish. Note. When set to FALSE. When set to TRUE. SQR does not display any output. nn is the maximum number of lines to display before pausing. Generates a {report}. -EH_CSV -EH_CSV:file -EH_CSVONLY EH_FULLHTML: xx -EH_Icons:dir EH_LANGUAGE: xx -EH_PDF -EH_Scale:{nn} 4-2 INVOKING SQR EXECUTE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .bqd file from the report data. When set to NETSCAPE. Portuguese. the display scrolls continuously. overriding any USE command in the SQR program. The default directory for theses applets is IMAGES. The printer type must be LP. SQR generates HTML 3. (SYBASE) Causes the SQR program to use the specified database. The following 13 flags are applicable only when either the -PRINTER:EH or -PRINTER:EP flag is specified. Directs error messages to the named file. the display is for the first report only. Associates the BQD icon with the specified file. Also associates a BQD icon with {report}. Sets the scaling factor from 50 to 200. French. Creates a CSV file.err. When set to IE. Specifies the directory location of the Enhanced HTML applets.0 Specifies the directory in which the HTML should find the referenced icons. If no errors occur. Specifies the target browser.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -CB -Dnn (Windows) Forces the communication box. SQR generates HTML 3. but does not create an HTML file.2. invokes a browser-specific file. SQR generates HTML designed for Internet Explorer. SQR auto-determines which browser is being used. "afopen" function. If the new name does not specify a directory. The output file is not created until data is actually printed on the page. To change the name of the output file. (MVS) -GPRINT=YES causes SQR's report output file to have ANSI control characters written to the first column of each record of the file. the file is created in the current directory. the file is created in the current library. The default action places the program. specify -F without an argument. Displays the copyright banner on the console. no output file is created. specify -F with the new name. You can specify up to 10 sets of attributes. AS400) Suppresses printer control characters from column 1. If no data is printed. OpenVMS) Specifies the file attributes to use when the report output file is created. xx EH -Gfile_attributes -GPRINT=YES | NO -ID -KEEP -NOLIS -O[file] -P -PB -PRINTER:xx PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INVOKING SQR EXECUTE 4-3 . separated by commas (. for a complete description of all the valid keywords and values. the sqr.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -F[library| file(member)] (AS400) Overrides the default output file name library/lis(program). The default action places the LIS in a source file called LIS in the same library as the member {program}.lis. Prevents the creation of LIS files. Instead. Directs log messages to the specified file or to programt. creates an SPF file for each report that your program generates. (MVS. for a complete description of all the valid keywords and values. specify -F with the new name. (Informix) Causes column data to retain trailing blanks. In addition to LIS files. Specify the file name and directory for different operating systems as follows: Operating System VMS UNIX MVS -Gfile_mode (VM) Specifies the file mode to use when the report output file is created. To specify an alternate filename: -FSQRDIR/LIS(file) -F[file | directory] Overrides the default output file name. To use the current directory. specify -F without an argument. If no data is printed. (VMS. See the VAX C Library manual. To use the current library.log if no file is specified. "creat" function. By default.log file is used in the current working directory. SPF files are created. program. The output file is not created until data is actually printed on the page.sqr file. To change the name of the output file. If the new name does not specify a library. See the VM C Library manual. no output file is created. Causes printer type xx to be used when creating output files.lis in the same directory as the program.). SQR stops after the specified number of pages defined for the first report have been printed.2 HTML tags. End of Run" message.. Type HT produces version 2. The {Printer Name} is the name assigned to your printer. Type EH produces reports in which content is fully formatted with version 3. and PS produce files with the . -Tnn -T{B} 4-4 INVOKING SQR EXECUTE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . enclose the entire argument in quotes. number of times each was compiled and executed.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description EP HP HT LP PD PS WP Types LP.PRINTER:WP:NewPrinter. Types EH and HT produce . (MVS/DB2. Status includes the text of each SQL statement. For example. ODBC) Trims trailing blanks from database character columns. SQR ignores All ORDER BY clauses in SELECT statements to save time during testing. -TBZ or -TZB prevents both. On Microsoft Windows systems. (Microsoft Windows) Do not use the communication box. If the program is producing more than one report. use . -TBZ or -TZB is legal. to send output to a Microsoft Windows printer named NewPrinter.htm file output. use -KEEP. and the total number of rows selected. (SYBASE CT-Lib. -TZ trims trailing zeros from the decimal portion of numeric columns. -S Requests that the status of all cursors be displayed at the end of the report run..0 HTML files with the report content inside of <PRE></PRE> tags. -Vserver -XB -XCB (SYBASE) Uses the named server. Specifies that you want to test your report for nn pages. If you also want to create an . enter PRINTER:WP:{Printer Name}. the WP extension sends the output to the default Microsoft Windows printer.lis extension. HP. -T{B|Z|BZ|ZB} (MVS/DB2) -TB prevents SQR from removing trailing blanks from database character columns.0 or 3. To specify a non-default Microsoft Windows printer. (Non-Microsoft Windows) Suppresses the SQR banner and the "SQR. (AS400/DB2) -TB trims trailing blanks from database character columns.If your printer name has spaces. -TZ prevents SQR from removing trailing zeros from the decimal portion of numeric columns. DB2/400) Prevents SQR from removing trailing blanks from database character columns.SPF file. This flag implicitly invokes the -KEEP flag to create program.INI.properties file on an NT system: c:\peoplesoft\properties\registry. (SYBASE DBLib) Prevents SQR from creating temporary stored procedures. Programs run in this mode cannot contain any SQL statements. See “BEGIN-SELECT” for more information.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -XL Prevents SQR from logging on to the database. only the first report file is passed to the Viewer.spf file. See the -E flag for more information. You still must supply at least an empty slash (/) on the command line as a placeholder for the connectivity information. Sets the full path and name of an alternate registry.” Understanding the SQR Command Line. Invokes the SPF Viewer after generating program.properties file. Prevents SQR from creating the navigation bar in. sqrerr.properties file lists Data Sources that SQR Server can access. -XL enables you to run SQR without accessing the database. See information about your particular operating system and database to determine which files you need.PRINTER:HT is also specified.lis file at the end of a line. Error messages are only sent to an . PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INVOKING SQR EXECUTE 4-5 . Specifies the full path and name of the SQR error message file. SQR.spf. -XNAV -XP -XTB -XTOC -ZIF{file} -ZIV -ZMF{file} -ZRF{file} See Also “Understanding SQR for PeopleSoft. This occurs when only a single .dat. Prevents SQR from generating the Table of Contents for the report. For example: sqr myprog / -xl Some database files must be available for SQR to run whether SQR logs onto the database.properties The registry.HTM files generated from a single report always contain the navigation bar. SQR ignores this flag when either -PRINTER:EH or .err file. -XMB (Microsoft Windows) Disables the error message display so that a program can be run without interruption by error message boxes. Multiple .HTM files generated with PRINTER:HT. Sets the full path and name of the SQR initialization file. The following is a common default path to the registry.HTM file is produced. Preserves the trailing blanks in an . In case of multiple output files. . Generate output in Microsoft Windows. enter the following command.] The following table describes spf-file (SPF file) and flags.CHAPTER 5 Using SQR Print This chapter describes SQR Print and discusses how to: • • • Generate output from the command line.. SQR Print converts portable printer-independent files (SPF) into printer-specific files. You can override this name with the -F command line flag. but with the LIS extension. SQR Print writes an LIS file with the same name as the SPF file. SQR offers several options: • • • • • • Line Printer HP LaserJet PostScript HTML Enhanced HTML ADOBE PDF PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING SQR PRINT 5-1 . The -PRINTER command line flag specifies printer type.. SQR and SQRT create SPF files when you use the -KEEP and -NOLIS command line flags. Use SQR print command-line flags. Understanding SQR Print SQR Print enables you to create printer-specific reports for any of the file types supported by SQR. invoke SQRWP rather than SQRP. (If you are in Microsoft Windows. Generating Output from the Command Line To begin running SQR Print.) SQRP [spf-file] [flags. 5-2 USING SQR PRINT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . {l} is the number of logical report pages that each . {s} [. -BURST:P and -BURST:S require -PRINTER:EH or -PRINTER:HT. The setting -BURST:S is equivalent to -BURST:S1. the display is for the first report only. If no number is entered after -D. -BURST:{xx} -Dnn (Non-Microsoft Windows) Displays the report output on the terminal at the same time it is being written to the output file. no file is created. or {n}-. In -BURST:P[ {l} . Note. {l} is the level at which to burst upon.bqd file from the report data. If the file does not exist. but want to create only a single output file.bqd in the navigation bar. Generates a {report}. The default directory for theses applets is IMAGES. SQR Print ignores graphic elements such as lines. The setting -BURST:P is equivalent to -BURST:P0. -BURST:S generates the report output according to the symbolic Table of Contents entries set in the program with the TOC-ENTRY command's "level" argument. Directs error messages to the named file.1. This is useful when you want to run the same report more than once. This following 12 flags are applicable only when either the – PRINTER:EH or –PRINTER:EP flag is specified. and charts and prints only text.HTM file contains and {s} is the page selection: {n}. If the program is producing more than one report. Specifies the type of bursting to be performed. Also associates a BQD icon with {report}. {n}-{m}. -BURST:T generates the Table of Contents file only. Associates the BQD icon with the specified file. or to the default file program. The printer type must be LP or the display is ignored. -{m}. {s}] …] ] . nn is the maximum number of lines to display before pausing. Flag Description -A Appends the output to an existing output file of the same name. -BURST:P generates the report output by report page numbers. the display scrolls continuously. In -BURST:S[ {l} ]. -BURST:T requires -PRINTER:HT.when using -PRINTER:HT or BURST:P1 when using -PRINTER:EH. boxes. -E[file] -EH_APPLETS: dir -EH_BQD -EH_BQD:file Specifies the directory location of the Enhanced HTML applets. The Page range selection feature of -BURST:P requires -PRINTER:HT. it creates a new one. If no errors occur. SQR Print Command-Line Flags The following table describes the command-line flags of SQR Print.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • Enhanced HTML & ADOBE PDF If your report contains graphics and you select Line Printer.err. Note. 0 and HTML 3. When set to IE.2. Sets the scaling factor from 50 to 200. To use the current directory. To change the name of the output file. SQR generates HTML 3. Sets the language used for the HTML navigation bar. When set to ALL. program.lis.0 Specifies the directory in which the HTML should find the referenced icons. When set to TRUE. SQR generates HTML designed for Internet Explorer. sqr file. To specify an alternate filename: -FSQRDIR/LIS(file) -EH_CSV -EH_CSV:file -EH_CSVONLY -EH_FULLHTM L:xx -EH_Icons:dir -EH_LANGUA GE:xx -EH_PDF -EH_Scale:{nn} -F[library| file(member)] -F[file | directory] Overrides the default output file name. Specify the file name and directory for different operating systems according to the following: Operating System VMS UNIX MVS -Gfile_mode (VM) Specifies the file mode to use when the report output file is created. German. no output file is created. no output file is created. If the new name does not specify a directory. specify -F with the new name. Portuguese.csv file from the report data. French. If the new name does not specify a library. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING SQR PRINT 5-3 . "afopen" function. SQR generates HTML suitable for all browsers. If no data is printed. SQR generates HTML designed for Netscape. SQR auto-determines which browser is being used.pdf in the navigation bar. SQR generates HTML 3. invokes a browser-specific file. The output file is not created until data is actually printed on the page. See the VM C Library manual. Generates a {report}. specify -F without an argument. To change the name of the output file. specify -F with the new name. Creates a CSV file but does not create an HTML file. Associates the CSV icon with the specified file. Switches between HTML 3.2.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -EH_BROWSER :xx Specifies the target browser. (AS400) Overrides the default output file name library/lis(program). the file is created in the current directory. The default action places the program. You can specify English. The default action places the lis in a source file called lis in the same library as the member {program}. To use the current library. Associates a PDF icon with {report}. If no data is printed. When set to BASIC. or Spanish. the file is created in the current library. and generates HTML designed for that browser. When set to FALSE.lis in the same directory as the program. When set to NETSCAPE. for a complete description of all the valid keywords and values. specify -F without an argument. The output file is not created until data is actually printed on the page. Multiple HTM files generated from a single report will always contain the navigation bar. enclose the entire argument in quotes. Sets the full path and name of an alternate registry.properties file on an NT system: c:\peoplesoft\properties\registry. for a complete description of all the valid keywords and values. Displays the copyright banner on the console.log file is used in the current working directory. Specifies the full path and name of the SQR error message file. Directs log messages to the specified file or to programt. sqrerr. (MVS. The following is a common default path to the registry. Prevents SQR from generating the Table of Contents for the report. SQR. By default.INI.SPF file.properties file lists Data Sources that SQR Server can access. See the VAX C Library manual. you would use PRINTER:WP:NewPrinter. If you want to create an . and PS produce files with the .properties The registry. separated by commas (.log if no file is specified.dat.htm file output. AS400) Suppresses printer control characters from column 1.).SQR FOR PEOPLESOFT LANGUAGE REFERENCE Flag Description -Gfile_attributes (VMS. -XTB -XTOC -ZIF{file} -ZMF{file} -ZRF{file} 5-4 USING SQR PRINT PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . to send output to a Microsoft Windows printer named NewPrinter.. xx EH EP HP HT LP PD Types LP.If your printer name has spaces.. Sets the full path and name of the SQR initialization file. You can specify up to 10 sets of attributes. "creat" function. This occurs when only a single HTM file is produced. On Microsoft Windows systems.LIS extension. -ID -O[file] -P -PRINTER:xx -XB -XNAV (Non-Microsoft Windows) Suppresses the SQR banner and the "SQR. the WP extension sends the output to the default Microsoft Windows printer. the sqr. To specify a nondefault Microsoft Windows printer. This flag is ignored when either -PRINTER:EH or -PRINTER:HT is also specified. End of Run" message. enter -PRINTER:WP:{Printer Name}. Prevents SQR from creating the 'Navigation Bar' in HTM files generated with PRINTER:HT. Types EH and HT produce . The {Printer Name} is the name assigned to your printer.properties file. use -KEEP. Preserves the trailing blanks in a LIS file at the end of a line. Causes SQR to use printer type xx when creating output files. For example. OpenVMS) Specifies the file attributes to use when the report output file is created. HP. you can also select a Windows printer. 2. 5. Click OK. 3. The Print dialog box appears. In addition to the previously mentioned SQR Print output options. To generate output in Microsoft Windows: 1. select Print. Under Generate output for. select the option next to the type of output you want.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Generating Output in Microsoft Windows If you are a Microsoft Windows user. the graphical user interface of SQR Print enables you to generate ouput from the Print dialog box. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING SQR PRINT 5-5 . 4. Select the Print to file check box. Specify a file path. This spools your SQR output to your default Microsoft Windows printer or print server. From the File menu. . PeopleSoft recommends that you phase these commands out of your code as soon as it is feasible to do so. SQR may not support these commands in future releases. they do not interact well with the current SQR lexicon. If you still have older SQR commands in your program code. Understanding Older SQR Commands PeopleSoft recommends that you avoid incorporating these commands in your SQR code. Even though these commands are technically supported in this release. refer to this chapter as you replace them with their updated alternatives. Old Commands Use Instead BEGIN-REPORT (ENDREPORT) DATE-TIME DECLARE PRINTER DECLARE PROCEDURE DOLLAR-SYMBOL GRAPHIC FONT MONEY-SYMBOL NO-FORMFEED PAGE-SIZE PRINTER-DEINIT PRINTER-INIT PRINT…CODE BEGIN-PROGRAM (END-PROGRAM) datenow function DECLARE-PRINTER DECLARE-PROCEDURE ALTER-LOCALE ALTER-PRINTER ALTER-LOCALE DECLARE-LAYOUT DECLARE-LAYOUT DECLARE-PRINTER DECLARE-PRINTER PRINT…CODE-PRINTER PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-1 .CHAPTER 6 Avoiding Older SQR Commands This chapter provides a list of the current set of older SQR commands and provides detailed information concerning each. Incorporating these commands into your SQR code can cause unpredictable results. DECLARE-PRINTER and DECLARE-PROCEDURE. use BEGINPROGRAM. Description Begins a report. After processing the commands in the SETUP section. do not contain hyphens. PeopleSoft recommends that you no longer use this command. BEGIN-REPORT Syntax BEGIN-REPORT Note. To use the newer SQR functionality. PeopleSoft recommends that you no longer use this command. DECLARE PRINTER and DECLARE PROCEDURE. The new commands. This command may be discontinued in a future release. Example begin-report do startup do main do finish end-report DATE-TIME Syntax DATE-TIME position [date_format[col_var]] Note. SQR starts program execution at the BEGIN-REPORT section.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. though you can also use other commands. To use the newer SQR functionality. contain hyphens. Older SQR Command Details The following sections discuss each of the older SQR commands. Two older commands. This is the only required section in an SQR program. use the datenow function in the LET command. This command may be discontinued in a future release. 6-2 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The PROGRAM section typically contains a list of DO commands. If col_var is specified. that format is always used in either of these cases.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Retrieves the current date and/or time from the local machine (or from the database for Oracle and some DB2 platforms) and places it in the output file at the specified position or into a column variable.NNNNNN YYYY-MM-DD HH:MI YYYY-MM-DD HH:MI:SS.1) The second format retrieves the date-time into a column variable. The following table provides the default date-time formats for SQR-supported databases. the date is retrieved only at program start and the same date and/or time is printed each time. Parameters Parameter position date_format Description Specifies the position for printing the date. as follows: date-time () '' &date1 For those databases with only one default format. If a date_format is not specified. See the table showing miscellaneous functions under the “LET” command for information about the valid edit mask format codes. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-3 . then the date is returned in the default format for that database. as in the following example: date-time (+1. Database Default Date-Time Format DB2 YYYY-MM-DD-HH:MI YYYY-MM-DDHH:MI:SS.NNN DD-Mon-YYYY HH:MI PM DD-MON-YYYY HH:MI Informix Oracle SYBASE For some databases. Otherwise. there are two default formats. The first format prints the date-time. A string literal containing the date format mask. a date_format must be supplied and the current date and time is retrieved each time this command is executed. Generally.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Parameter col_var Description Places the retrieved date-time into a column variable rather than in the output file. you should use it in the SETUP section. YYYY' HH:MI date-time (+1. use DECLARE-LAYOUT and DECLARE-PRINTER.70) 'MON DD YYYY HH24:MI' &datetime date-time (#i. #j) 'YYYY-MM-DD' &date1 See the $current-date reserved and datenow function described in the table showing miscellaneous functions under the “LET” command. To use the newer SQR functionality. if you do not 6-4 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .50) date-time () MM/DD/YY &time date-time (1. DECLARE PRINTER Syntax DECLARE PRINTER [TYPE=printer_type_lit] [ORIENTATION=orientation_lit] [LEFT-MARGIN=left_margin_num_lit] [TOP-MARGIN=top_margin_num_lit] [LINE-SIZE=line_size_num_lit] [CHAR-SIZE=char_size_num_lit] [LINES-INCH=lines_inch_int_lit] [CHARS-INCH=chars_inch_num_lit] [POINT-SIZE=point_size_num_lit] [FONT-TYPE=font_type_txt_lit] [SYMBOL-SET=symbol_set_id_lit] [STARTUP-FILE=file_name_txt_lit] [FONT=font_int_lit] [BEFORE-BOLD=before_bold_string_txt_lit] [AFTER-BOLD=after_bold_string_txt_lit] Note. Example date-time (1. You can use the DECLARE PRINTER command in either the SETUP section or in the body of the report.1) 'Day Mon DD. This command may be discontinued in a future release. See Also ALTER-LOCALE command. However. Description Specifies the printer type and sets printer characteristics. PeopleSoft recommends that you no longer use this command. LINEPRINTER files generally consist of ASCII characters and can be viewed by a text editor. POSTSCRIPT. HPLASERJET LINEPRINTER SQR creates output specific to each printer. POSTSCRIPT files consist of ASCII characters. you could put several DECLARE PRINTER commands in the body of the report and execute the one you need. upon execution of the first PRINT command. Because the characters in proportional fonts vary in width. and thereafter have no effect even if changed: LINE-SIZE CHAR-SIZE LINES-INCH CHARS-INCH ORIENTATION SQR maps its line and column positions on the page by using a grid determined by the LINE-SIZE and CHAR-SIZE (or LINES-INCH and CHARS-INCH) arguments. Parameters The following table describes the arguments for the DECLARE PRINTER command. especially in words containing uppercase letters. it is possible that a word or string is wider than the horizontal space you have allotted.SQR FOR PEOPLESOFT LANGUAGE REFERENCE know what type of printer you will be using until the report is run. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-5 . To account for this behavior. but you need to know PostScript to understand what will be shown on the printer. Argument Choice or Measure Default Value Description TYPE LINEPRINTER. Each printed piece of text is placed on the page using this grid. or if you need to change some of the arguments depending on user selection. The following arguments take effect only once. you can either move the column position in the PRINT statement or indicate a larger CHAR-SIZE in the DECLARE PRINTER command. HP LaserJet files are binary files and cannot be edited or viewed. LINE-SIZE points 12 This argument does not apply to LINEPRINTER printers. LANDSCAPE PORTRAIT Portrait pages are printed vertically. TOP. If LINE-SIZE is not specified.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Value Description ORIENTATION PORTRAIT. LEFT. This is the size of each SQR line on the page.5 This argument does not apply to LINEPRINTER printers. Landscape pages are printed horizontally. There are 72 points per inch. Printing in landscape on HP LaserJet printers requires landscape fonts. if specified. it follows the value for POINT-SIZE.MARGIN inches 0. 6-6 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The default value of 12 points yields 6 lines per inch.5 This argument does not apply to LINEPRINTER printers. This is the amount of blank space to leave at the left side of the page.MARGIN inches 0. This is the amount of blank space to leave at the top of the page. 13)). This is the beginning size of the selected font. LINES. The default value of 7.SIZE points 12 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-7 . which yields 16.INCH characters 10 POINT. This is an alternate way of indicating the width of each SQR character column.12) and (1.6.SIZE points 7. rather than in points for the LINE-SIZE. This argument does not apply to LINEPRINTER printers. If CHAR-SIZE is not specified and the POINT-SIZE is less than 8.6 characters per inch.2 yields 10 characters per inch. rather than points for CHAR-SIZE.32. the distance between the locations (1.INCH lines 6 CHARS.2 This argument does not apply to LINEPRINTER printers.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Value Description CHAR. in characters per inch. This is the size of each SQR horizontal character column on the page (for example. This argument does not apply to LINEPRINTER printers. This is an alternate way of indicating the line size. This argument does not apply to LINEPRINTER printers. CHAR-SIZE is set to 4. in lines per inch. FIXED Depends on the font This argument applies only to HP LaserJet printers and must be specified only for font types not defined in the table showing the fonts available for HP LaserJet printers in SQR in the previous “DECLAREPRINTER” section. This argument applies only to HP LaserJet printers. SYMBOL. This argument applies only to PostScript printers. Unless otherwise specified. the default startup file is located in the directory specified by the environment variable SQRDIR. The default value of "0U" is for the ASCII symbol set.SET HP defined sets 0U STARTUP. STR 6-8 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Use this to specify an alternate startup file. For a complete list of the symbol sets.FILE filename POSTSCRI.TYPE PROPORTIONAL. see the HP LaserJet Technical Reference Manual.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Value Description FONT. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-9 . SQR supplies a list of fonts and arbitrary font number assignments in the file POSTSCRI. so that you can use the same font number for reports to be printed on both types of printers. For HP LaserJet printers. The font numbers are the same as those for HP LaserJet printers. For a complete list of the typeface numbers. See also the table that lists the fonts available in the SQR POSTSCRI. You can modify the font list in POSTSCRI. see the HP LaserJet Technical Reference Manual.STR to add or delete fonts. For PostScript printers. See the table that lists the fonts available for HP LaserJet printers that are available in SQR internally in the previous “DECLAREPRINTER” section.STR file also in the previous “DECLAREPRINTER” section.STR file for instructions. wherever possible.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Value Description FONT font_number 3 This is the font number of the typeface to use.STR. Read the POSTSCRI. this is the typeface value as defined by HewlettPackard. typeface. For fonts not listed in the table that lists the fonts available for HP LaserJet printers that are available in SQR internally in the previous “DECLARE-PRINTER” section. To specify nonprintable characters. AFTER. enclose the decimal value inside angle brackets as follows: BEFOREBOLD=<27>[r ! Turn on bold AFTERBOLD=<27>[u ! Turn it off These arguments work in conjunction with the BOLD argument of the PRINT command. If the string contains blank characters. or the correct typeface cannot be selected by the printer. DECLARE PROCEDURE Syntax DECLARE PROCEDURE [BEFORE-REPORT=procedure_name] [AFTER-REPORT=procedure_name] [BEFORE-PAGE=procedure_name] [AFTER-PAGE=procedure_name] 6-10 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . See BEFORE-BOLD.BOLD any string (none) The font you choose—in orientation. and point size—must be an internal font. you must indicate the font style using the FONT-TYPE argument.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Argument Choice or Measure Default Value Description BEFORE. such as ESC. enclose it in single quote marks (').BOLD arguments are for LINEPRINTER printers only. They specify the character string to turn bolding on and off. available in a font cartridge. or downloaded to the printer.BOLD any string (none) The BEFORE-BOLD and AFTER. In this way. Use this to set up page totals. Specifies a procedure to execute just before each page is written to the file. To use the newer SQR functionality. If you issue multiple DECLARE PROCEDURE commands. The referenced procedures do not take any arguments. Specifies a procedure to execute just before the report file is closed at the end of the report. This command may be discontinued in a future release. If no report was generated. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-11 . Parameters BEFORE-REPORT AFTER-REPORT Specifies a procedure to execute at the time of the first PRINT command. however. they may be LOCAL. for example. that is. for example. To use the newer SQR functionality. Specifies a procedure to execute at the beginning of every page. use DECLARE-PROCEDURE. use ALTER-LOCALE. just before the first PRINT command for the page. DECLARE PROCEDURE can be issued either in the SETUP section or in the body of the report. PeopleSoft recommends that you no longer use this command. they cannot PRINT into the header and/or footer areas. the last one takes precedence. PeopleSoft recommends that you no longer use this command. In addition. for example. Description Defines specific event procedures. You can use the command as often as you like. Use this to display page totals. BEFORE-PAGE AFTER-PAGE Example declare procedure before-page=page_setup after-page=page_totals DOLLAR-SYMBOL Syntax DOLLAR-SYMBOL new_symbol Note. Use this to print totals or other closing summary information. they can only PRINT into the body of the report.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. you can turn procedures on and off while the report is executing. This command may be discontinued in a future release. the procedure does not execute. Use this to create a report heading. The MONEY-SYMBOL command has the same effect as these options of the ALTERLOCALE command: MONEY-SIGN and MONEY-SIGN-LOCATION=LEFT. Type Character Numbers Alphabetical 0. Note. 8. The DOLLAR-SYMBOL provides a way to change that symbol for both the edit mask and for printing. . Use DOLLAR-SYMBOL and MONEY-SYMBOL together to configure your SQR programs and the reports they produce. If you want to change the symbol that prints on the report. The dollar sign ($) is the default currency symbol for coding edit masks in the program that prints on report listings. + ! * _ ` < 6-12 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . use MONEY-SYMBOL in the PROCEDURE section. This command is used only in the SETUP section. The following table lists the characters that DOLLAR-SYMBOL cannot take. 9 b e n r v B E N R V Symbols .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Redefines the currency symbol within numeric edit masks. POINT-SIZE.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Type Character > ( ) Parameters Parameter new_symbol Description Specifies a new. GRAPHIC FONT Syntax GRAPHIC () FONT { font_number_int_lit|_var } [point_size_int_lit|_var[{1|0} [pitch_int_lit|_var]]] Note.999. print #amount () edit £££.. single character to be used in edit masks instead of the dollar sign ($). To use the newer SQR functionality.999. use ALTER-PRINTER and DECLARE-PRINTER to set the FONT. This command may be discontinued in a future release.99 . end-procedure ! Define £ as the currency symbol In the previous example.99 See Also See the ALTER-LOCALE command for a description of other locale-specific parameters. PeopleSoft recommends that you no longer use this command.. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-13 . the following error message appears: Bad numeric 'edit' format: $$$. and PITCH.. Example The following example indicates how to use the DOLLAR-SYMBOL command: begin-setup dollar-symbol £ end-setup begin-procedure .. if you used the dollar sign in the edit mask after defining the dollar symbol as £. FONT-TYPE. FONT-TYPE. use the ALTERLOCALE command. This command may be discontinued in a future release. If the specified font is fixed pitch. POINT-SIZE. If the point_size is omitted. the size from the most recent DECLARE-PRINTER or GRAPHIC FONT command is used. The default is proportional.STR file. MONEY-SYMBOL Syntax MONEY-SYMBOL new_symbol Note. 6-14 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . the font must be defined in the POSTSCRI. PeopleSoft recommends that you no longer use this command. the specified font must be installed in the printer. and 0 indicates a fixed pitch font. For PostScript printers. you should also indicate the pitch in characters per inch. To use the newer SQR functionality. 12 points.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Changes a font.5 points 12 0 10! Letter Gothic. (See the table that lists the fonts available for HP LaserJet printers that are available in SQR internally under the DECLARE-PRINTER command.) 1 indicates a proportional font. and PITCH. It is needed only if you are using a font that SQR does recognize.5! Century Schoolbook. This argument is for HP LaserJet printers only. ! fixed. Parameters Parameter font_number Description For HP LaserJet printers. point_size {1|0} pitch Example The following example indicates the GRAPHIC FONT command: graphic () font graphic () font 23 6 8. 8. 10 characters per inch graphic () font :#font_number :#point_size See Also ALTER-PRINTER and DECLARE-PRINTER for information about setting and changing the FONT. 56 ...56 .999.99 ! Prints as: $1.. See the table under the DOLLAR-SYMBOL command for characters that cannot be used with MONEY-SYMBOL. If you want to change the symbol that prints on the report.99 ! Prints as: . money-symbol print #Amount () Edit £££..99 ! Prints as: £1. Parameters Parameter new_symbol Description Specifies a new.. money-symbol $ print #Amount () Edit £££.56 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-15 . When the MONEY-SYMBOL is set.999.234.. Note. single character to replace the dollar sign ($) or DOLLAR-SYMBOL character on the printed report..234. The MONEY-SYMBOL command has the same effect as these options of the ALTERLOCALE command: MONEY-SIGN and MONEY-SIGN-LOCATION=LEFT.. Example The following example indicates how to use the DOLLAR-SYMBOL and MONEY-SYMBOL commands: begin-setup dollar-symbol £! Define £ as the ! currency symbol end-setup begin-procedure! If #Amount=1234.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description Redefines the currency symbol to be printed.999. that value is used until the next MONEY-SYMBOL command executes. end-procedure 1.234. use the MONEY-SYMBOL in the programs PROCEDURE sections. surround its decimal value with angle brackets (<>). Use DOLLAR-SYMBOL and MONEY-SYMBOL together to configure your SQR application programs and the reports they produce.56 . money-symbol £ print #Amount () Edit £££. To indicate a non-edit character. To use the newer SQR functionality. flat file output. for example. PeopleSoft recommends that you no longer use this command. Do not write form feed control characters directly into the output file between pages.SQR FOR PEOPLESOFT LANGUAGE REFERENCE See Also DOLLAR-SYMBOL and ALTER-LOCALE commands. PeopleSoft recommends that you no longer use this command. Example begin-setup no-formfeed end-setup See Also See the FORMFEED qualifier in DECLARE-LAYOUT. It is used only in the SETUP section. use the MAX-LINES and MAX-COLUMNS parameters of the DECLARE-LAYOUT command. NO-FORMFEED Syntax NO-FORMFEED Note. Description Sets the page size. This command may be discontinued in a future release. use the FORMFEED parameter of the DECLARE-LAYOUT command. 6-16 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . To use the newer SQR functionality. Description Prevents form feed characters from being written to the output file. This command may be discontinued in a future release. PAGE-SIZE Syntax PAGE-SIZE page_depth_num_lit page_width_num_lit Note. NO-FORMFEED is useful for certain types of reports. SQR FOR PEOPLESOFT LANGUAGE REFERENCE If you are printing multiple reports. A 3 inch by 5 inch sales lead card might have a size of 18 by 50. The size of the internal page buffer used to store a complete page in memory can be determined by multiplying the page depth by the width in the PAGE-SIZE command. Example begin-setup page-size end-setup 57 132! 57 lines long by 132 columns wide See Also See the PAPER-SIZE parameter of the DECLARE-LAYOUT command.000 characters wide. . SQR stores one complete page in a buffer before writing the page to the output file when you issue a NEW-PAGE command or when a page overflow occurs. Each time a NEW-PAGE occurs. An average report printed on 8 1/2 by 11 inch paper might have a page size of 60 lines by 80 columns. . Having a wider page than necessary does not waste any file space because SQR trims trailing blanks on each line before writing the report file. the current position becomes the first position of the next line. On other computers. CODE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-17 . For line printers. Use the NO-FORMFEED command in the SETUP section to suppress form feed characters between pages. This can cause confusion when using relative line positioning with the NEXT-LISTING command. the default of 62 lines by 132 columns is used. you must use the PAPER-SIZE parameter of the DECLARE-LAYOUT command. You could define a page to be 1 line deep and 4. When the last column position on a line is printed. the page buffer is limited only by the amount of memory available. This command is used in the SETUP section only. This could be used for writing large flat files. perhaps for copying to magnetic tape. Specify the page_depth in lines and the page_width in columns. Use a page width at least one character larger than the right-most position that will be written. one record would be written. If the page size is not specified. This prevents unwanted wrapping when printing. For PCs. PRINT …CODE Syntax PRINT . the page buffer is limited to 64K bytes. if none is specified. It has limited functionality with HP LaserJet and PostScript printers. Parameters Parameter CODE Description CODE is a qualifier that may be discontinued in a future release.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Description If you use CODE. PeopleSoft recommends that you no longer use this command. To take advantage of newer SQR functionality. See the chr function in the table listing miscellaneous functions under the LET command section. <27> is the ESC or escape character. For example. use the RESET-STRING parameter of the DECLARE-PRINTER command. the sequence is assumed to be for the printer type specified in the DECLARE-REPORT or default printer. PRINTER-DEINIT Syntax PRINTER-DEINIT initialization_string Note. Use CODE-PRINTER instead. PRINTER-INIT Syntax PRINTER-INIT initialization_string 6-18 AVOIDING OLDER SQR COMMANDS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Specify nondisplay characters by placing their decimal values inside angled brackets. The PRINTER-DEINIT command is used only in the SETUP section and is designed for use with Line-Printer style output. This command may be discontinued in a future release. Example begin-setup printer-deinit<27>[7J! Reset the printer end-setup See Also See the ENCODE command for another method of printing nondisplay characters. Description Sends control or other characters to the printer at the end of a report. Description Sends control or other characters to the printer at the beginning of a report. Example begin-setup printer-init<27>[7J! Set the printer end-setup See Also See the ENCODE command for another method of printing non-display characters. Specify non-display characters by placing their decimal values inside angled brackets. PeopleSoft recommends that you no longer use this command. It has limited functionality with HP LaserJet and PostScript printers. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL AVOIDING OLDER SQR COMMANDS 6-19 . For example. use the INIT-STRING parameter of the DECLARE-PRINTER command. The PRINTER-INIT command is used only in the SETUP section and is designed for use with Line-Printer output. This command may be discontinued in a future release. To use the newer SQR functionality.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Note. See the chr function in the table listing miscellaneous functions under the LET command section. <27> is the ESC or escape character. . DAT _______.SQR BAR100.SQR COMP_PLN.SQR COMP_FOR.SQR CALENDAR. and write a form letter using a DOCUMENT paragraph (Oracle) Creates stored functions and procedures for Oracle Version 7 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING SQR SAMPLE PROGRAMS 7-1 .SQR BARCODE.SQR COMP_P_G. Understanding SQR Samples SQR samples is a library of SQR programs you can use to customize and experiment with.SQR CRUPSAL.SQR AREA100. medium.SQR programs SQR startup files to run small. These programs are stored in the SQR Server directory called SAMPLE on your installation media.SQR COMP_F_G.MEM APPEND. SQR Sample Programs The following table lists the sample SQR programs and provides a brief description of each.SQR APTDIARY.SQR Data files used by the LOADALL. enter data in the database. Name Description _______. text wrapping Demonstrates a 100% area chart Demonstrates a 100% bar chart Demonstrates printing a bar code Demonstrates nondatabase formatting Prints a graph of the forecasted and actual sales for a given employee Prints a graph of the forecasted and actual sales for month or quarter Prints a graph of the planned and actual sales for a given employee Prints a graph of the planned and actual sales for month or quarter Uses SQR to input data from user.CHAPTER 7 Using SQR Sample Programs This chapter describes the SQR Samples library of programs. You can modify these programs to create configured SQRs. Each program comprises a report specification and a sample of the output. and large SQR programs Demonstrates the append and fixed-nolf commands Demonstrates columns.SQR COVLET02. SQR FOR_EMP.SQR FOR_CUST.SQR FOR_REG.SQR CUSTOMR3.DAT DROPALL.SQR CUST_SUM. NEXT-LISTING command Demonstrates the use of the ON-BREAK argument to the PRINT command Demonstrates the use of the INPUT command to change report output Demonstrates the use of arrays Demonstrates dynamic queries to enable user to qualify a report as it runs Prints a group of information about each customer in the customer table Demonstrates the flat file output for magnetic tape or other postprocessing Needed for append.SQR Prints a list of all of the customers bursted by page Demonstrates printing mailing labels within columns Demonstrates multiple detail lines.SQR DYNAMCOL. the second to import that table.SQR EMP_COMM.SQR CUSTOMER.SQR ENVELOPE.SQR 7-2 USING SQR SAMPLE PROGRAMS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR EXPORT. dynamic tables and variables passed to ON-ERROR procedure Prints a list of all of the employees bursted by page Calculates each employee's commission based on sales List all employee quotas for a given month or quarter Demonstrates use of printing envelope with proper bar code Creates two SQR reports: one to export a database table.DAT DATAB.SQR CUSTTAPE.sqr Needed for append.SQR CUSTOMR4.SQR CUSTLBLS.SQR EMP. with trailing blanks removed.sqr Drops all the SQR sample tables created by the LOADALL program (SYBASE) Deletes leftover temporary stored procedures belonging to the user Demonstrates use of dynamic columns.SQR FLOATBAR.SQR FOR_PROD.SQR DATAA.SQ R EMP_P_Q. Data from the table is stored in an external operating system file in compressed format.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Name Description CUST.SQR CUSTOMR5.SQR DROPPROC.SQR CUSTOMR2. Creates an SQR report to extract a database table and place it into a flat file Demonstrates a floating bar chart Sales forecast for given customer grouped by month or quarter Sales forecast for given employee grouped by month or quarter Sales forecast for given product grouped by month or quarter Sales forecast for given region grouped by month or quarter FLATFILE. SQR ORD_PROD.SQR MAKEDATA. display those rows.SQR PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING SQR SAMPLE PROGRAMS 7-3 .SQR INQUIRY. then repeat.SQR ORD_REGG.SQR LOADALL.SQR PLN_GEN.SQR HILO.SQR MITI1. and printing envelopes Creates and loads sample tables used in the above SQR programs Creates a data file with fixed length and NOLF attributes Helps you create SQR reports more quickly Needed for sqrlogo.SQR MAKEREPT. Demonstrates multiple reports.SQ R ORD_SUM.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Name Description FOR_SUM.EPS MULTIPLE. The resulting SQR program prompts you to qualify rows to be selected. and page footings Sales plan for given employee grouped by month or quarter Sales plan grouped by month or quarter Sales plan for given region grouped by month or quarter List of products and their prices and a graph of orders of products Demonstrates DOCUMENT paragraphs INVOICE. page headings.SQR ORDERS.SQR ORD_S_Q.SQ R ORD_M_Q.sqr Demonstrates creating multiple reports Demonstrates nesting of procedures Lists all the orders and the orderlines associated with them List all orders for a given month and group them by employee number List all orders for a given month or quarter List all orders for a given product Creates a report of all orders from a given region grouped by month or grouped by quarter Displays an order's summary by month Prints a graph of the percent of orders for each region (in a year) and four graphs of the percent of orders for each region (one for each quarter of that year) Demonstrates an overlapped bar chart Demonstrates printing within columns.SQR FORMLETR.SQR HISTGRAM.SQR PLN_REG.SQR PHONELST.SQR OVERBAR. printing invoices.SQR PLN_EMP.SQR Creates a table of projected product sales with links to more information Demonstrates form letters using a DOCUMENT paragraph Demonstrates a high-low-close chart Demonstrates a histogram chart Creates an SQR program to display rows at your terminal selected from a database table you specify.SQR ORD_MONG.SQR PRODUCT.SQR SALELEAD.SQR NESTREPT. SQR UPDATE.SQR SCATTER.SQR SQRLASER.SQR SQR3DBAR.SQR TABREP. A sample report that demonstrates use of stored functions and procedures in Oracle 7 UPDSAL.SQR SQRPIE.SQR SQRLOGO.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Name Description SALES. The created program uses the SHOW command to simulate a menu interface.SQR SHOWPROC.SQR STCKAREA.SQR SQRLINE.SQR 7-4 USING SQR SAMPLE PROGRAMS PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR Demonstrates charting from stored data and printing several charts on one page Demonstrates a scatter chart (SYBASE) Shows any leftover temporary stored procedures belonging to the user Demonstrates a stacked area chart Demonstrates a 3D bar chart Demonstrates graphic and file I/O commands Demonstrates a line chart Demonstrates printing images Demonstrates a pie chart Creates a tabular SQR report for a table you select Generates an SQR program that enables you to query and update database tables. This file is located in the SQR directory under the PS_Home directory. 3. The directory in which the executable image resides. For Microsoft Windows Platforms Only: SQR looks for the initialization file in the following locations in order: 1.INI installation process.INI.CHAPTER 8 Using the PSSQR. Fonts section. PDF fonts section. This file contains settings and parameters that SQR uses during the compile and execution phases. This chapter provides an overview of the PSSQR.INI The installation process installs a default initialization file called PSSQR. The file name specified by the -ZIF{file} command-line flag. 2.INI file is the initialization file for SQR for PeopleSoft. Environment section. Installation of PSSQR. The Windows system directory. Locale section. Colors section. HTML images section.INI File The PSSQR. Default settings. For All Other Platforms: SQR looks for the initialization file in the following locations in order: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR. Processing-limits section.INI file and discusses the following topics: • • • • • • • • • PSSQR.INI FILE 8-1 . . them when the entry is processed. [Another_Section_Name] Entry = Value . 2. must be the first character of the line and therefore cannot be [Default-Settings] Section This section defines the various SQR default actions. the space characters you must surround the value with either SQR will remove The semicolon . [Section_Name] Entry = Value . To preserve . single (') or double (") quote characters. . 8-2 USING THE PSSQR. . Leading and trailing space characters are ignored.SQR FOR PEOPLESOFT LANGUAGE REFERENCE 1. The format of the file is as follows: . Comments are lines which start with a semicolon.INI. The file name specified by the -ZIF{file} command-line flag. SQRDIR is no longer kept in PSSQR.INI file. . You can make changes or additions to the PSSQR. . The directory specified using the SQRDIR environment variable. . The current working directory. . . SQR automatically sets up SQRDIR.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 3. part of another line. SQR allows character to equal either character or date columns. If this has not been set. AllowDateAsChar=True.INI FILE 8-3 . the first databasedependent format as listed in the table showing default database formats in the “Edit” section under the PRINT command. SQR uses the format specified by the SQR_DB_DATE_FORMAT setting. By default. For TIME columns. Begin-Select [$Col1] &col1=Text [$Col2] &col2=Date [$Col3] &col3=Number from MyTable End-Select OUTPUT-FILE-MODE LONG | SHORT Specifies the filename convention used for HTML output. SQR creates the string according to the following rules: For DATETIME columns. date equals date. SQR uses the format specified by the SQR_DB_TIME_ONLY_FORMAT setting. When a date column is “type cast” to be a character. SQR produces an error when a dynamic column specification does not match the database definition of the column. This allows $Col1 to be either date or text. SHORT specifies DOS style (8. If this has not been set. If this has not been set. character equals character. the format listed in the table showing default database formats in the “Edit” section under the PRINT command. That is. and numeric equals numeric. the format as listed the table showing the TIME column formats in the “Edit” section under the PRINT command. The default is LONG. (Ignored on 16-bit platforms) The Declare-TOC command and -Burst force OutputFile-Mode = LONG.3). SQR uses the format specified by the SQR_DB_DATE_ONLY_FORMAT setting.3) and LONG specifies UNIX style (non 8. For DATE columns. When this value is set to TRUE.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry AllowDateAsChar={TRUE|FALSE } Value Description TRUE | FALSE The default setting is FALSE. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR. In the following example. LIS SPF file = {Output}.LIS for first. and {Program}. Windows NT.Gxx for all reports bb ranges from 00 to 99 and represents the report number. DOS.HTM. SQR-generated filenames are limited to a DOS 8. SQR and SQRT: {Program} is the name of the SQR/SQT file without the extension For Output-File-Mode = SHORT.Snn for multi-reports PDF file = {Program}.HTM.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .3 format Output file = {Program}. and {Program}. and {Program}.htm bb ranges from 01 to ZHJOZI and represents the bursted page group number. {Output}_nav. and VMS. {Output}_toc. 8-4 USING THE PSSQR.SPF PDF file = {Output}. {Output}_bb. For Output-File-Mode = LONG. and {Program}.SFP for first. {Output}={Program} of first report and {Program}_nn for multi-reports.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry Value Description The following represent the file formats for UNIX. zz ranges from 00 to ZHJOZI and represent the graphic number.HTM for “frame. nn ranges from 01 to 99 and represents the report number. SQR-generated filenames are not constrained to a DOS 8.Pnn for multi-reports HTM file = {Program}. nn ranges from 01 to 99 and represents the report number.Lnn for multi-reports SFP file = {Program}. {Output}_frm. Output file = {Output}. xx ranges from 00 to ZZ and represents the graphic number.PDF GIF file = {Output}_zz.Hbb for report bodies GIF file={Program}.PDF for first.SPF HTM files = {Output}.3 format.HTM.HTM. the DECLARE-VARIABLE command overrides this setting.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry Value Description SQRP: {Filename} is the name of the SPF file without the extension For Output-File-Mode = SHORT. Similarly.HTM and {Filename}.Gxx PDF file = {Filename}. The value of SYSTEM is used to reference the default locale. The default value is FALSE. Specifies the default numeric type for variables.INI FILE 8-5 .SPF HTM files = {Filename}. DEFAULT-NUMERIC OutputFormFeedWithDashD= {TRUE|FALSE} PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR. {Filename}_nav.INI file or the name SYSTEM. the -Dnn command line flag outputs the Form-Feed character that denotes a page break.LIS GIF file = {Filename}. See the “ALTER-LOCALE” command section for a complete description.PDF GIF file = {Filename}_zz.H00 xx ranges from 00 to ZZ and represents the graphic number. {Filename}_bb.3 format. LOCALE Name of a locale defined in the SQR. Output file = {Filename}. When set to TRUE. {Filename}_frm. zz ranges from 00 to ZHJOZI and represents the graphic number.LIS PDF file = {Filename}.HTM.PDF HTM file = . The command line flag -DNT overrides this setting. See the DECLARE-VARIABLE command for complete details on the meaning of the values.HTM. For Output-File-Mode = LONG.HTM. Output file = {Filename}. INTEGER | FLOAT | DECIMAL[(p)] | V30 TRUE | FALSE Specifies the initial locale that SQR loads when the program starts to execute. {Filename}_toc.htm bb ranges from 01 to ZHJOZI and represents the bursted page group number. SQR-generated filenames are not limited to a DOS 8. SQR-generated filenames are limited to a DOS 8.HTM.3 format. SQR treats the YY date edit mask as though it is an RR edit mask. If the -Mfile command line flag is used.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Use the setting V30 to process numbers in the same manner as in prior releases (before V4. Specifically. Maximum length. Maximum number of column forward references. When set to TRUE.0). Maximum number of dynamic SQL arguments. UseY2kCenturyAlgorithm={TRU E |FALSE} TRUE | FALSE Note. When set to TRUE. Entry BREAKS Default Value Maximum Value Entry Size Description 100 64K-1 4 Number of BREAK arguments allowed per EVALUATE or IF command. then the Processing-Limits section of the file is not processed. of temporary string storage used during LET operations.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry OutputTwoDigitYearWarningMs g ={TRUE|FALSE Value Description TRUE | FALSE The default value is TRUE. The default value is FALSE. including integer literals. which has a direct impact on the memory requirements. See the RR edit mask. The entries are the same as those used in the file specified with the -Mfile command line flag. Processing-Limits Section The Processing-Limits section is used to define the sizes and limitations of some of the internal structures used by SQR. SQR generates a warning message (sent to the warning file) when a YY or RR date edit mask is encountered during a program run. all numeric variables and literals are declared as FLOAT. DYNAMICARGS 70 32K-1 14 EXPRESSIONSPACE 8192 64K-1 1 FORWARDREFS 200 32K-1 8 8-6 USING THE PSSQR. in bytes. This affects only SQR code that is processed. Maximum number of program lines (SQR commands).5.30)". "(10. ONBREAKS 30 64K-1 8 POSITIONS 1800 64K-1 14 PROGLINEPARS 18000 64K-1 2 PROGLINES 5000 32K-1 8 QUERIES 60 32K-1 60 QUERYARGS 240 64K-1 6 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR. Maximum number of BEGIN-SQL and BEGIN-SELECT paragraphs.INI FILE 8-7 . This size is used as a close approximation. Maximum number of ON-BREAK LEVEL=values per SET. The number of arguments required is one more than the number used in your report file. This value is generally 3 or 4 times the value set for PROGLINES. Maximum number of arguments for all program lines.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry LONGSPACE Default Value Maximum Value Entry Size Description 32K-2 32K-2 1 Maximum buffer size to transfer text and image data in bytes. Maximum number of placement parameters. Maximum number of arguments (bind variables) for all SQL or SELECT statements. This is database dependent and can vary. On Microsoft Windows systems. however. limits are lower for PCs. however. The other 8-8 USING THE PSSQR. Maximum size of string space for program line arguments. and DSQUERY (Sybase only). This might be advantageous. SQRFLAGS. STRINGSPACE 15000 64K-1 1 SUBVARS 100 32K-1 8 VARIABLES 1500 64K-1 18 WHENS 70 64K-1 4 The maximum value refers to the number of entries allowed as shown in the previous table. where memory is limited.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . for certain applications running in the PC environment. An environment variable can be defined in multiple environment sections. In any case. Maximum number of variables (string. SQR indicates the limit if you exceed it.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry SQLSIZE Default Value Maximum Value Entry Size Description 4000 64K-1 1 Maximum length of an SQL statement in characters. for example. SQRDIR is required and is automatically defined in the appropriate database-specific environment section during the SQR installation. In addition to increasing the sizes you may also lower them to decrease the amount of memory used. [Environment: environment] Sections The [ Environment:{ Common | DB2 | Informix | Ingres | ODBC | Oracle | RDB | Redbrick | SQLBase | Sybase | DDO} ] sections define environment variables to be used by SQR. Maximum number of WHEN arguments allowed per EVALUATE command. and database columns. decimal). The environment variables that can be set are SQRDIR. integer. float. Add 4 to the entry size for Informix and Ingres. in bytes. a definition in a database-specific environment section takes precedence over an assignment in the [Environment:Common] section. Maximum number of run-time substitution variables. literal values. support files> SQR_DDO_JRE_CLASSn=<optional. or underscore). SQRFLAGS specifies the default command-line flags for all invocations of SQR. additional entries to the classpath> SQR_DDO_JRE_PATH=<classpath information for the local JRE> Each of these entries is automatically entered upon product installation (NT only).dll= c:\sqrexts\sqrext2. These additional variables are available to augment the normal 512-character line limit for entries in the sqr.DLL (Oracle supplied) Additional DDO variables are: • • • SQR_DDO_JRE_CLASS=<classpath for DDO drivers.dll= Any new extension DLLs containing new user functions must be listed in the [SQR Extension] section in SQR. OCIW32.DLL in the same directory. [Locale:locale-name] Section The [LOCALE:locale-name] section specifies the default settings for the locale identified by locale-name (which can consist of A-Z.DLL (Oracle supplied) ORANT71.DLL are being loaded.DLL and SQRWT. the [SQR Extension] section defines DLLs containing new user functions (ufunc) and user calls (ucall). it searches for the Oracle DLL as follows: • • • The file described by the value of ORACLE_DLL entry in the [Environment:Oracle] section of the SQR. When SQR attempts to access an Oracle database. they look for SQREXT. A locale can be referenced or PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR. Depending on your application. the settings for these locales may have to be altered or new locales may have to be added. See the SQR for PeopleSoft Developer's Guide.INI file. DSQUERY identifies the default SYBASE server to use. “Interoperability”. On Microsoft Windows systems only. hyphen. When SQRW.INI FILE 8-9 . For Windows/Oracle. 'Ufunc' and 'ucall' now reside inside SQREXT.INI such as: [SQR Extension] c:\sqrexts\sqrext1. SQR uses dynamic binding of Oracle routines.SQR FOR PEOPLESOFT LANGUAGE REFERENCE environment variables are optional.dll= c:\sqrexts\sqrext3. 0-9.INI file. You can specify additional classpath entries using up to nine SQR_DDO_JRE_CLASSn variables. where n is a number from 1-9.INI.DLL and/or other DLLs. and for any DLLs specified in the [SQR Extension] section in SQR.ini file. A number of locales are predefined in the SQR. EDIT. Specifies the characters to replace 'AM'. UPPER and LOWER forces the output to either all uppercase or lowercase. Specifies the characters to replace 'PM'. Use the ALTER-LOCALE command to change the SYSTEM locale settings at runtime. Valid values are UPPER. Use EDIT to follow the case as specified with the format code in the edit mask. MONEY-EDIT-MASK DATE-EDIT-MASK INPUT-DATE-EDIT-MASK MONEY-SIGN MONEY-SIGN-LOCATION THOUSAND-SEPARATOR DECIMAL-SEPARATOR DATE-SEPARATOR TIME-SEPARATOR EDIT-OPTION-NA EDIT-OPTION-AM EDIT-OPTION-PM EDIT-OPTION-AD EDIT-OPTION-BC DAY-OF-WEEK-CASE 8-10 USING THE PSSQR. MOVE. The default numeric edit mask format when the keyword MONEY accompanies the DISPLAY. The default date edit mask format when the keyword DATE accompanies the DISPLAY. or the LET datetostr() or strtodate() functions. The entries for a locale section are described in the following table. Note. PRINT. Specifies the characters to replace the '$' edit character.SQR FOR PEOPLESOFT LANGUAGE REFERENCE altered at runtime using the ALTER-LOCALE command. Specifies the character to replace the ':' character. Specifies the character to replace the '.' edit character. Use NO-CHANGE to ignore the case of the format code and output the day of week as explicitly listed in the DAY-OF-WEEK-FULL or DAY-OF-WEEK-SHORT entries. MOVE. are ignored. or SHOW command. or SHOW command. The default date format to use with the INPUT command when TYPE=DATE is specified with the command or the input variable is a DATE variable. Specifies the character to replace the '.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . ignoring the case of the format code in the edit mask. Specifies the characters to replace 'AD'. Specifies the characters to replace 'BC'. if set. or SHOW command. Specifies the character to replace the '/' character. but is commented out. Specifies the MONEY-SIGN characters location. The settings for the SYSTEM locale. Specifies the characters to replace the 'na' option. and NOCHANGE. PRINT. Entry NUMBER-EDIT-MASK Description The default numeric edit mask format when the keyword NUMBER accompanies the DISPLAY.' edit character. Valid values are LEFT and RIGHT. Specifies how the case for the DAY-OF-WEEK-FULL or DAY-OFWEEK-SHORT entries are affected when used with the format codes 'DAY' or 'DY'. PRINT. LOWER. MOVE. The SYSTEM locale is provided for your reference. Use NOCHANGE to ignore the case of the format code and output the month as explicitly listed in the MONTHS-FULL or MONTHS-SHORT entries. Specifies how the case for the MONTHS-FULL or MONTHS-SHORT entries is affected when used with the format codes 'MONTH' or 'MON'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry DAY-OF-WEEK-FULL Description Specifies the full names for the days of the week. Specifies the full names for the months of the year. and NO-CHANGE. Valid values are UPPER. All seven days must be specified. SQR considers the first day of the week to be Sunday. All 12 months must be specified. UPPER and LOWER force the output to either all uppercase or lowercase. See the DECLARE. SQR considers the first month of the year to be January. Specifies the abbreviated names for the months of the year. All 12 abbreviations must be specified.INI FILE 8-11 . SQR considers the first day of the week to be Sunday. Use EDIT to follow the case as specified with the format code in the edit mask. This section does not apply to PostScript or HP LaserJet printer types. All seven abbreviations must be specified.SS HH24:MI:SS [Fonts] Section The [Fonts] section lists the fonts available to SQR when printing on Microsoft Windows printer devices (using the -PRINTER:WP command-line flag). SQR considers the first month of the year to be January. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR. EDIT.PRINTER command for a listing of available fonts for these alternate printer types. LOWER.MI. ignoring the case of the format code in the edit mask. Specifies the abbreviated names for the days of the week. DAY-OF-WEEK-SHORT MONTHS-CASE MONTHS-FULL MONTHS-SHORT Database DATE Column Formats DB2 INFORMIX ODBC YYYY-MM-DD MM/DD/YYYY DD-MON-YYYY Database TIME Column Formats DB2 ODBC HH24. Specifying Character Sets in Windows If you are a Microsoft Windows user. EASTEUROPE. all of which are associated with a font number. AUTO automatically determines the default character set of the Microsoft Windows installation and uses the default set when generating reports.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . SHIFTJIS. Syntax: CharacterSet=DEFAULT|AUTO|character_set Arguments: DEFAULT reflects current SQR functionality. ARABIC. RUSSIAN. commands such as ALTER-PRINTER and DECLARE-PRINTER. CHINESEBIG5. MAC. can reference a particular font style. you can use the CharacterSet entry either to determine the Microsoft Windows default character set or to specify a character set. a font style (fixed or proportional). Proportional is assumed if the second parameter starts with a "P". HANGUL. HEBREW.fixed. Also. there are a number of predefined font entries. BALTIC. You can add entries by using the font numbers 900 through 999. For example: 4=Arial. This enables you to print any standard character set to a Windows printer (. TURKISH. GREEK. [HTML-Images] Section The [HTML-Images] section defines the parameters that SQR uses when generating HTML report output files. character_set specifies one of these keywords: ANSI. JOHAB. Using the font number. GB2312. VIETNAMESE. Each entry consists of a font name.PRINTER:WP) or to view an SPF file displaying the appropriate character set.bold Note.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Adding [Fonts] entries Within the [Fonts] section. bold is assumed if a third parameter is supplied. SYMBOL. 8-12 USING THE PSSQR. and a bold indicator. OEM. THAI.proportional or 300=Courier New. gif LAST-PAGE HEIGHT.INI FILE 8-13 .60. WIDTH.prevpg.gif NEXT-PAGE HEIGHT. Fonts specified are case sensitive.gif Specifies the NAME of the graphic image file that accesses the first page of the report. Background image of navigation bar. WIDTH.60.60. Specifies the NAME of the graphic image file that accesses the previous page of the report. [PDF Fonts] Section The [PDF Fonts] section lists the available fonts for SQR when printing using the PRINTER:PD command-line flag. PREV-PAGE HEIGHT.60. The HEIGHT and WIDTH are values specified in pixels. Specifies the NAME of the graphic image file used as the background image for the report. The HEIGHT and WIDTH are values specified in pixels Specifies the NAME of the graphic image file that accesses the last page of the report. SQR does not perform any validation of the graphic image filenames provided. WIDTH. WIDTH. The HEIGHT and WIDTH are values specified in pixels. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR.firstpg. Specifies the NAME of the graphic image file that accesses the next page of the report. NAME 60.gif WALLPAPE R NAME Navbar Back ground NAME Note. NAME 60.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Entry Value DefaultValue Description FIRST-PAGE HEIGHT. NAME 60.lastpg. The HEIGHT and WIDTH are values specified in pixels.nextpg. NAME 60. The user is responsible for ensuring that the graphic image files are in a location that the browser can access. When set to FALSE. [Colors] Section The [Colors] section defines the default colors that you can use in your SQRs.INI FILE PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . When set to NETSCAPE.0 is generated. Enter the default colors in the format of: [Colors] color_name = ({rgb]) color_name = ({rgb]) . color_name = ({rgb]) The default colors implicitly installed are: 8-14 USING THE PSSQR. The default action is to generate HTML suitable for ALL browsers. the generated HTML auto-determines which browser is being used and invoke the proper browserspecific file. the generated HTML is designed for Netscape. Sets the language used for the HTML navigation bar. When set to TRUE. . HTML 3. . Entry Value Description Browser={ALL|IE|NETS CAPE} ALL|IE|NETSCAPE When set to ALL. Language= {English|French| German| Portuguese|Spanish} FullHTML={TRUE | FALSE} English|French| German| Portuguese|Spanish TRUE | FALSE The default setting is English. HTML 3. When set to IE.2 is generated. The default setting is FALSE. the generated HTML is designed for Internet Explorer.SQR FOR PEOPLESOFT LANGUAGE REFERENCE [Enhanced-HTML] Section The [Enhanced-HTML] section is used to define various default actions that SQR will take when generating HTML output utilizing the -EH command line flag. 0.0.128.0.0) white=(255.0) purple=(128.0.SQR FOR PEOPLESOFT LANGUAGE REFERENCE • • • • • • • • • • • • • • • • black = (0.255) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL USING THE PSSQR.0) navy=(0.0) maroon=(128.128) fuchsia=(255.128.255) gray=(128.255) yellow=(255.128) silver=(192.0) green=(0.255) lime=(0.192) red=(255.255.128) olive=(128.128.192.0.128) aqua=(0.255.128.0.INI FILE 8-15 .255.0) teal=(0.0.255.0) blue=(0. . From the -S command line flag. SQR cannot provide information about the cursor due to errors in the program. From the -S command line flag. Enter `01`02 NOPROMPT used . The SQR program did not contain any commands that required a database cursor. Type the value to be assigned to the specified variable. `01 = First character of the variable name `02 = Rest of the variable name No cursors defined. Unnumbered Messages This table lists all unnumbered SQR for PeopleSoft messages. `01 = Name of the substitution variable Enter this run's parameters: Enter the values for the parameters defined in the program.CHAPTER 9 Understanding SQR Messages This chapter provides all the messages produced by SQR for PeopleSoft. Descriptions of these replacement markers are listed with the message. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-1 . Not processed due to report errors. Enter the value to be assigned to the specified substitution variable. (PC) Use the -Mfile to reduce some of the different memory requirements. It contains two tables listing all: • • Unnumbered messages Numbered messages Two digits ('nn) appear as replacement markers in the messages. This occurs when a call to the C routine 'malloc()' fails. Remove unneeded TSRs. (Unix) Increase the size of the system swap file. (VAX) Increase the amount of memory allowed for that user. The messages contain the proper value when they appear on the screen. Error Description Out of memory.Enter value below Enter `01 (Windows) This message appears when an INPUT command is defined with the NOPROMPT argument. `01 = Image name (for example.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Description Error on line `01: `02 SQR detected an error while processing the report file. Correct the error and rerun. Correct the errors and rerun. (Oracle) Title for the dialog box that informs the user that SQR could not load the Oracle DLL. Informational message. Enter the name of the report (.sqt) to run. the password is not be echoed. X to exit run: Error at: `01 Loading Oracle DLL Failed!!! Errors were found in the program file. `01 = Source line number `02 = Source line Warning in include file "`01" on line `02: `03 SQR detected a nonfatal error while processing the report file. `01 = Name of the include file `02 = Source line number `03 = Source line Type RETURN for more. Text message Text message 9-2 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Informational message that is used in conjunction with the -D command line flag.sqr or . (All but Ingres) Enter the name of the database. Correct the error and rerun. `01: End of Run.. Enter the password. Enter the user name to log onto the database. C to continue w/o display.. Errors were found during the program run. SQR) Enter report name: Enter database name: Enter database[/username]: Enter Username: Enter Password: Customer ID: Press Enter to close. `01 = Source line number `02 = Source line Error in include file "`01" on line `02: `03 SQR detected an error while processing the report file. `01 = Name of the include file `02 = Source line number `03 = Source line Warning on line `01: `02 SQR detected a nonfatal error while processing the report file. For security reasons. Correct the errors and rerun. contact technical support. Error Number Error Message Suggestion/Interpretation 000001 Error while opening the message file: '`01' (`02): `03 Try reloading the sqrerr. `01 = Name of the error message file `02 = System error code `03 = System error message 000002 Error while reading the message file.dat file from the release media. (Windows) A title for the error message dialog box.dat file from the release media. This lets the user quit the program run by clicking the Cancel button. Text for HTML driver Text for HTML driver Text for HTML driver Text for HTML driver Text for HTML driver Text for HTML driver Numbered Messages This table lists numbered messages. If the error persists. (Windows) This is the body of the -C cancel dialog box. `01 = Name of the error message file `02 = System error code `03 = System error message Try reloading the sqrerr. If the error persists. contact technical support. *** Internal Coding Error *** SQL DataServer Message Operating-System error DB-Library error `01 is running. `01 = Image name (for example. SQR) Informational message. (`01): `02 000003 Error while closing the message file. contact technical support.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Description `01: Program Aborting. (Windows) A title for the error message dialog box. (Windows) A title for the error message dialog box. Table of Contents Previous Next First Page Last Page PAGE Informational message. (`01): `02 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-3 .dat file from the release media. If the error persists. `01 = Name of the error message file `02 = System error code `03 = System error message Try reloading the sqrerr. Click the Cancel button to interrupt it. An invalid code was passed to the error message handler. `01 = Unsupported version read from the header 000005 Corrupt message file: Invalid header information. contact technical support. `01 = Invalid code Try reloading the sqrerr. `01 = Invalid type `02 = Internal error code The type error code is not correct. If the error persists. (1) Make sure SQRDIR points to the correct directory. If the error persists. If the error persists. 000006 000007 Cannot handle message file version `01. If the error persists.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000004 Error while seeking the message file. then contact technical support. If the error persists. then contact technical support. If the error persists. then contact technical support. 000013 Cannot point to message `01.dat file from the release media. `01 = Error code The error handler cannot position to the desired error code.dat file from the release media.dat file from the release media. If the error persists. then contact technical support. The header contains an invalid entry count. (`01): `02 Try reloading the sqrerr. Corrupt message file: Invalid count (Got `01. (1) Make sure SQRDIR points to the correct directory.dat file from the release media. Should be `02).dat file from the release media. contact technical support. then contact technical support. If the error persists. Try reloading the sqrerr.dat file from the release media. `01 = Name of the error message file `02 = System error code `03 = System error message Try reloading the sqrerr. (2) Try reloading the sqrerr. Try reloading the sqrerr. `01 = The value read from the header `02 = What the value should be This release of SQR does not support the header version.dat file from the release media. `01 = Error code 000011 Unknown conversion type (`01) for code `02. Try reloading the files from the release media. 000010 Invalid SEMCode encountered: `01. (2) Try reloading the sqrerr. 9-4 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 000012 Message `01 must be either Preload or BuiltIn. then contact technical support. Try reloading the files from the release media. Try reloading the sqrerr. Record the steps leading up to the error and contact technical support. The initialization file specified by the -ZIF command line flag cannot be accessed. 000015 000016 `01() called to process (`02) and the message file is not open. (Windows) This is the result of a memory overwrite. `01 = Environment variable name The meta escape character defined in the header does not match what the error message handler expects. The Meta ESC characters do not match (Got '`01'. If the error persists. then contact technical support. (Windows) This is the result of a memory overwrite. 000019 000020 GLOBAL header has an invalid size. Record the steps leading up to the error. If the error persists. 000028 Cannot access the initialization file: `01 (`02): `03 000202 DPUT: Bad field number. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-5 . Define the named environment variable and restart SQR. If the error persists. 000018 Allocation header does not point to a valid heap. `01 = What was found in the header `02 = What was expected to be found The specified error routine was called but the error message file was not open.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000014 The required environment variable `01 has not been defined. Record the steps leading up to the error and contact technical support. then contact technical support. `01 = Name of the routine `02 = Error code Try reloading the sqrerr.dat file from the release media. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. `01 = Error code (Windows) This is the result of a memory overwrite. (Windows) This is the result of a memory overwrite. 000017 Message `01 must be ReportParameters or CopyrightNotice.dat file from the release media. `01 = Name of the file `02 = System error code `03 = System error message This is an internal error that should never occur during normal operations. 000021 Cannot free GLOBAL allocation. Should be '`02'). and contact technical support. then contact technical support. Allocation header has an invalid size. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. 000211 SGOTO: Bad label: from parameters.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000203 DARRAY: Unknown command number. 000204 `01: Cannot find `02 command. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 000210 SGOTO: Could not find beginning of section or paragraph. 9-6 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 000205 DDO: DO arguments do not match procedure's. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. `01 = Name of the routine `02 = Name of the command This is an internal error that should never occur during normal operations. 000209 SGOTO: Bad goto function parameters. 000208 SGOTO: Bad command numbers. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. 000212 COMPAR: Unknown relational (numeric) operator. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. 000206 SDO: Bad params for DO command. 000207 SDO: Bad params for BEGIN-PROCEDURE command. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 000222 GLET: Unknown operator in expression. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. `01 = Name of the routine `02 = name of the variable This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-7 . Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 000215 `01: Bad length case for numeric `02. 000218 GDOC: Unknown document type. 000219 GLET: Bad operator. This is an internal error that should never occur during normal operations. `01 = Number of the argument This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000213 COMPAR: Unknown relational (string) operator. This is an internal error that should never occur during normal operations. 000216 GARRAY: Unknown command number. 000221 GLET: Unknown operator type. 000217 GCMDS: No Gfunc found. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 000214 DONBRK: Unknown case for putlin. 000220 GLET: Stack incorrect for expression arg `01. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. `01 = Internal command format string This is an internal error that should never occur during normal operations. TCOL or NCOL type. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 000224 GPARS: Bad parameter format: `01 =`02= 000225 GPARS: No end of required word in parfmt: `01 000226 GPARS: Bad parfmt entry: `01 000227 GPARS: Bad parameter string. Record the steps leading up to the error and contact technical support. `01 = Internal command format string This is an internal error that should never occur during normal operations. `01 = Internal command format string `02 = Bad format field found This is an internal error that should never occur during normal operations. `01 = Internal command format string This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations.8. Record the steps leading up to the error and contact technical support.9 allowed for repeats: `01 000230 GPARS: Missing required x: `01 000231 GPARS: Bad type in 'ckvrpr()'. 000228 GPARS: Repeat count bad: `01 000229 GPARS: Only a. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 9-8 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000223 GPARS: Column not SCOL. `01 = Internal command format string This is an internal error that should never occur during normal operations.b. This is an internal error that should never occur during normal operations. `01 = Internal command format string This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. `01 = Invalid element number This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 000238 PGMPARS: '`01' passed invalid parameter number: `02. This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations. 000242 RDPGM: Bad match adding internal variable: `01 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-9 . This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. `01 = Maximum internal command number supported. 000235 PGMPARS: 'addvar()' passed maxlen but not column. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. 000239 PGMPARS: 'fxclrf()' encountered bad column reference type: `01. `01 = Internal variable type code This is an internal error that should never occur during normal operations.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000232 GPROC: No Gfunc found. 000241 RDPGM: Command array size exceeded (change COMDMAX to at least `01). Record the steps leading up to the error and contact technical support. 000234 GSHOW: Unknown SHOW option. 000240 PLCMNT: 'getplc()' passed invalid element number: `01. `01 = Routine name `02 = Invalid parameter number This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. `01 = Internal variable name 000233 GRDWRT: Unknown command number. Ingres) This is an internal error that should never occur during normal operations. (Oracle) This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. in Run Time. (DB2. This is an internal error that should never occur during normal operations. Ingres) This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 000248 SIFWHL: Command number incorrect. Record the steps leading up to the error and contact technical support. Informix. 000245 SETSQL: Could not find variable '`01'. Record the steps leading up to the error and contact technical support. Informix. (DB2. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 000254 SETSQL: Could not find variable entry in list. `01 = Name of the SQR routine This is an internal error that should never occur during normal operations. 000251 DBFFIX: DBDATLEN returned out of range status. 000256 DBFETCH: Unknown variable dbtype encountered: `01 (`02) 9-10 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. `01 = Variable name `02 = Unknown database type 000244 Function `01 not included in run-time package. 000249 SPINIT: Bad parameters. This is an internal error that should never occur during normal operations. `01 = Variable name This is an internal error that should never occur during normal operations. This is an internal error that should never occur during normal operations.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000243 RDPGM: No cmdget function found for BEGIN_S. 000255 DBDESC: SQLD not = number of select columns. 000252 DPRPST: Error converting Sybase type for EXECUTE. `01 = Unknown SPF code This is an internal error that should never occur during normal operations.SELECT command. Record the steps leading up to the error and contact technical support.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 000257 WRITE_SPF: Unknown code encountered: `01 This is an internal error that should never occur during normal operations. `01 = Index into nvars table This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. (`02): `03 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-11 . 001201 Cannot open the argument file: '`01'. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. Record the steps leading up to the error and contact technical support. 000262 MODIFYVAR: Incompatible variable types (`01) and (`02). use -Mfile to increase QUERYARGS. &Col) allowed in the context of a BEGIN-SQL or BEGIN. #Var. 000261 MODIFYVAR: Attempt to change variable which is not xVAR (`01). Depends on the system error message. 001100 Out of query arguments. `01 = Name of the routine `02 = Name of the table This is an internal error that should never occur during normal operations. `01 = Name of the routine `02 = Name of the variable This is an internal error that should never occur during normal operations. `01 = Name of the file `02 = System error code `03 = System error message 000258 `01: Cannot find LOAD-LOOKUP table: `02 000259 PGMPARS: '`01' called with wrong variable '`02' 000260 SQTMGT: Could not find 'vars' entry with 'nvars' index of '`01'. `01 = Variable type (from) `02 = Variable type (to) This is the total number of variable references ($Var. `01 = name of the variable This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Invalid -MFile entry: '`01'. Edit the source code and use different variable names. 001211 The value for '`01' (`02) is not an integer number. `01 = Entry name `02 = Specified value `03 = Maximum value Value must be a integer value. 001203 Cannot open the . 001205 001206 001207 001209 001210 The maximum value for '`01' (`02) is `03. `01 = Name of the file `02 = System error code `03 = System error message Correct the -Mfile entry. Edit the source code and use different variable names.MFile: '`01'. Cannot close the .MFile. `01 = System error code `02 = System error message Value out of range. 9-12 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . `01 = Entry name `02 = Specified value `03 = Minimum value Value out of range. `01 = Keyword in question `02 = Maximum value allowed Correct the -Mfile entry. `01 = Entry name `02 = Specified value (All but Ingres) SQR reserves the variable names that start with "@__p" for internal use. `01 = Keyword in question `02 = Minimum value allowed Correct the -Mfile entry. (`01): `02 The minimum value for '`01' (`02) is `03. forward references to &column names are not permitted. (Ingres) SQR reserves the variable name "?" for internal use. (`02): `03 001204 Minimum value for '`01' in the -MFile is `02. Maximum value for '`01' in the -Mfile is `02. `01 = The line from the -Mfile Depends on the system error message. (`01): `02 Depends on the system error message. `01 = System error code `02 = System error message Depends on the system error message. 001300 Bind list does not match query (do not use '?' character). Move the BEGIN-SQL paragraph after the &column definition. 001301 Forward references not permitted in select list bind variables. Bind list does not match query (do not use '@__p' string). Within the body of BEGIN-SQL paragraphs.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001202 Cannot close the argument file. The actual error text from the server follows this message. Oracle. 001308 `01: Could not bind column `02. &columns. 001309 The type for '&`01' (`02) does not match the type from the database (`03). Ingres. Bind value too large (IMAGE. Correct the SQL statement. Contact technical support with the version of the database you are connected to. 001306 001307 CMPSQL: DBDEFN failed. (ODBC. (ODBC. expressions and 'where' clause for syntax. Oracle. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. SQLBase) This is an internal error that should never occur during normal operations. Modify your SQL statement to use other columns to perform the same selection logic. Informix. TEXT not allowed). 001401 001402 Optional qualifier is ROUND=n (0`01). PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-13 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001302 SQL buffer too small. The database server has determined that the SQL statement is in error. Optional qualifiers for DIVIDE are ON. `01 = Name of the column/expression pseudonym `02 = User specified type `03 = Database type Only #numeric variables. The SQL statement exceeds the size of the internal SQL buffer. use -Mfile to increase SQLSIZE. Record the steps leading up to the error and contact technical support. Informix. Correct the syntax. `01 = Name of the SQR routine `02 = Name of the column Correct the source code. Record the steps leading up to the error and contact technical support. 001400 Only numerics allowed for arithmetic.ERROR={HIGH|ZER O} and ROUND=n. `01 = Maximum value for ROUND= Correct the syntax. The database server has determined that the SQL statement is in error. The actual error text from the server follows this message. and literals are permitted in the arithmetic commands. `01 = Datatype in question IMAGE and TEXT data types cannot be used as bind variables. Correct the SQL statement. 001303 Error in SQL (perhaps missing &name after expression): 001304 Check SELECT columns. SQLBase) This is an internal error that should never occur during normal operations. 001305 CMPSQL: Unknown data type in database: `01. Correct the source code. Ingres. Correct the syntax. `01 = Element number passed `02 = Name of the array `03 = Name of the field `04 = Program line number The ARRAY-DIVIDE command has attempted division by zero. 001502 WARNING: Attempting division by zero on line `01. `01 = Name of the current report `02 = Erase-Page value `03 = Page width 001501 Field element out of range (`01) for array '`02'.. Array field '`02' unchanged. Report '`01': GOTO.TOP=`02 must be between 0 and the page depth (`03). 001500 Correct the source logic. 001702 001703 Report '`01': ERASE. Array element out of range (`01) for array '`02' on line `03. 001700 Report '`01': Columns must be between 1 and the page width (`02). `01 = Name of the current report `02 = Page width The value specified on the GOTO-TOP argument of the NEXT-COLUMN command was either less than 1 or greater than the page depth. WARNING: The ROUND or TRUNC qualifier is greater than the number's precision. `01 = Element number passed `02 = Name of the array `03 = Program line number Correct the source logic. The specified value is wider than the width of the page. on line `04. 001601 'FILL' not appropriate for numeric data. Correct the source line. Run continuing.. Use the ON-ERROR = HIGH | ZERO option to prevent this error from halting the program. The division has been ignored. and then print the string variable. `01 = Name of the current report `02 = Goto-Top value `03 = Page width The line number specified on the ERASEPAGE argument of the NEXT-COLUMN command is greater than the page depth. Correct the syntax. field '`03'. `01 = Program line number `02 = Name of field The FILL argument to the PRINT command may be used only for text fields. the result field is unchanged. Correct the source line. Add logic to account for this possibility. Bad number of digits to ROUND or TRUNC (0-15). Correct the source line. Move the #numeric variable to a $string variable.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001403 001404 001405 Attempting division by zero.PAGE=`02 must be between 0 and the page depth (`03). 9-14 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Elsewhere. SQR ends the program run since it cannot continue.argi]. Reduce the complexity of the program.. Perhaps username/password incorrect.)] ] Cannot use CONNECT while SQL statements are active. `01 = Name of the current report `02 = Column number Correct the syntax.table. 001801 Correct the program logic to ensure that all BEGIN-SELECT paragraphs have completed before executing the CONNECT command.SQL paragraphs are active at the same time. Use another connection number. Logoff failed prior to CONNECT. not in BEGIN-SQL. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-15 . Program too large. `01 = Name of the current report `02 = Name of the section The column number specified with the USECOLUMN command is greater than the highest column defined in the COLUMNS command. 001806 The number of SQL statements has been exceeded. The specified connectivity information is incorrect or there might have been a network failure. Use -Mfile to increase QUERIES. 001802 001803 CONNECT failed. 001804 001805 Sybase extensions SET and SETUSER not permitted in SQR. Correct the source. Use the ON-ERROR flag to trap any errors during the program run. The database server returned an error while trying to log off from the database. USE allowed once in SETUP section only..[user]. otherwise SQR ends the program run.. 001705 001800 Format for CONNECT: username/password [ON-ERROR=procedure[(arg1[. Correct the source line. `01 = Connection number Too many BEGIN-SELECT and BEGIN. Correct the source line. 001808 Cannot find inactive database cursor. The -Cnn value specified is being used by another BEGIN-SELECT paragraph that is currently selecting data. Remove SET and SETUSER from the source. Out of query space. 001807 The requested database connection (`01) is already active.. Report '`01': Column number `02 is not defined. Use the -Mfile flag on the command line specify a file that contains an entry that increases a greater value than is currently defined.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001704 Report '`01': The NEXT-COLUMN command is not legal in the `02 section with the qualifier ATEND=NEWPAGE. specify db. Bad date mask starting at: '`01'. Seconds past midnight must be between 0 and 86399. Correct the date. Seconds must be between 0 and 59. 001810 Database rollback failed. Correct the date. ODBC. (SQLBase) This is an error that should never occur during normal operations. `01 = Date part. Correct the date. Oracle. Bad input data (`01) for edit mask: '`02'. SQLBase) This is an error that should never occur during normal operations. Correct the edit mask. 001811 Cannot open database cursor. SQLBase) This is an error that should never occur during normal operations. Format code cannot appear in date input format: '`01'. Format code must be SYYYY when specifying signed year. 001915 001916 001917 001918 001919 001920 001921 001922 001923 001924 001925 9-16 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . HPIW) This is an error that should never occur during normal operations. Record the steps leading up to the error and contact your system administrator. '`01' is not a valid date part. Oracle. `01 = Improper format characters. Ingres. Correct the input. Correct the edit mask. Minutes must be between 0 and 59. Month must be between 1 and 12. Cannot open database cursor. (DB2. Correct the date.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001809 Database commit failed. Invalid day of week. Record the steps leading up to the error and contact your system administrator. Oracle. `01 = Data being converted `02 = Edit mask Correct the date. Correct the date. ODBC. Ingres. Year must be between -4713 and 9999 inclusive. (DB2. Correct the edit mask. Ambiguous date-time. Correct the date. `01 = Improper format characters. Correct the date part. 001901 001913 001914 Variable for date-time must begin with '&'. Year cannot be zero. ODBC. (Ingres. `01 = SQL statement Correct the syntax. Record the steps leading up to the error and contact your system administrator. Correct the date. Record the steps leading up to the error and contact your system administrator. there is a problem with the database server. A fatal error relating to the SQL statement used to retrieve the date-time was encountered. Correct the format mask. (DB2) Possibly the format mask needs to be corrected. otherwise. (Table syssql. (Oracle) Possibly the format mask needs to be corrected.) Bad SQL for default date-time. `01 = Name of the month. Hour must be between 1 and 12. Correct the date. HH12 requires meridian indicator. there is a problem with the database server. Record the steps leading up to the error and contact your system administrator. A fatal error relating to the SQL statement used to retrieve the date-time was encountered.systables required for syntax. Correct the date. A fatal error relating to the SQL statement used to retrieve the date-time was encountered. The format mask must be a literal when the date-time is not loaded into a variable. (Table DUAL required for syntax. (Table DUAL required for syntax. Date-time format too long. Record the steps leading up to the error and contact your system administrator. The month (`01) is not valid for the current locale or database. 001940 Error fetching row. otherwise. Correct the format mask. Record the steps leading up to the error and contact your system administrator. Correct the date. Bad date-time format. Correct the date. Day of year must be between 1 and 365 (366 for leap year). there is a problem with the database server. Correct the edit mask. The format mask must be a literal when the date-time is not loaded into a variable. Correct the date.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001926 001927 001928 001929 001930 001931 001932 001933 001934 Day must be between 1 and `01. Hour must be between 0 to 23. 001935 001936 001937 001937 001938 Cannot recompile sql. (SQLBase) Possibly the format mask needs to be corrected. HH24 precludes the use of meridian indicator. Correct the edit mask. 001939 Problem executing cursor.) Bad SQL for default date-time. Date string too long.) Correct the date. Bad SQL for default date-time. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-17 . otherwise. Correct the format mask. at a minimum. `01 = The invalid date.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001941 Cannot redefine variable addresses. the time is optional. the date must be specified. Record the steps leading up to the error and contact your system administrator.NNNNN N]] [AM | PM]] MM.NNNNN N]] [AM | PM]] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] 001943 001944 The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: DD-MON-YY SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: Mon DD YYYY [HH:MI[:SS[.DD. The date '`01' is not in one of the accepted formats listed below: MM/DD/YYYY [BC | AD] [HH:MI[:SS[. `01 = The invalid date. 001944 (Sybase) The date was not in one of the expected formats for this database. 001942 The date '`01' is not in the format SYYYYMMDD[HH24[MI[SS[N NNNNN]]]].NNNNN N]] [AM | PM]] MM-DD-YYYY [BC | AD] [HH:MI[:SS[. `01 = The invalid date.NNN]][ AM | PM]] Mon DD YYYY [HH:MI[:SS[:NNN]][ AM | PM]] YYYYMMDD [HH:MI[:SS[. The date specified with the INPUT command was not in one the default formats. When specifying an SQR date. `01 = The invalid date.NNN]][ AM | PM]] YYYYMMDD [HH:MI[:SS[:NNN]][ AM | PM]] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] (Oracle) The date was not in one of the expected formats for this database. 9-18 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Please reenter the date in a valid format.YYYY [BC | AD] [HH:MI[:SS[. A fatal error relating to the SQL statement used to retrieve the date-time was encountered. NNN]][ AM | PM]] Mon DD YYYY [HH:MI[:SS[:NNN]][ AM | PM]] YYYYMMDD [HH:MI[:SS[. (DB2) The date was not in one of the expected formats for this database.SS[. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-19 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 001944 The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: Mon DD YYYY [HH:MI[:SS[.MI. 001944 (Red Brick) The date was not in one of the expected formats for this database.NNN NNN]] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: YYYY-MM-DD HH:MI:SS. (Informix) The date was not in one of the expected formats for this database.MM.NNN]][ AM | PM]] YYYYMMDD [HH:MI[:SS[:NNN]][ AM | PM]] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: YYYY-MM-DD [HH24:MI[:SS[.NNN SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: YYYY-MM-DD[HH.YYYY SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] (ODBC) The date was not in one of the expected formats for this database. `01 = The invalid date.NNNNNN ]] MM/DD/YYYY DD. `01 = The invalid date. `01 = The invalid date. `01 = The invalid date. YYYY[ HH[:MI[:SS[:NNNNN N]]]][AM |PM] YYYY-MM-DD[ HH[:MI[:SS[:NNNNN N]]]][AM |PM] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below: DD-MON-YYYY[ HH:MI[:SS]] MM/DD/YYYY[ HH:MI[:SS]] MM-DD-YYYY[ HH:MI[:SS]] YYYY."): DD-MON-YY[YY][ HH[:MI[:SS[:NNNNN N]]]][AM |PM] MM-DD-YY[YY][ HH[:MI[:SS[:NNNNN N]]]][AM |PM] DD.MM. `01 = The invalid date. Correct the syntax. Reduce the length of the edit mask. Could not find procedure: '`01'.only' and 'time-only' dates). Give the procedure a unique name. DateDiff of 'date. (Ingres) The date was not in one of the expected formats for this database. DO argument must be $string or #number to accept returned value. Correct the source line. SQR does not support dates before the one specified in the message. (SQLBase) The date was not in one of the expected formats for this database. `01 = Procedure name Check for a misspelled procedure name. 001946 002000 002001 002002 Procedure name used more than once: '`01'. Edit string too long.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation The date '`01' is not in the format specified by SQR_DB_DATE_FO RMAT or in one of the accepted formats listed below (Times can also use ". 002003 002100 9-20 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . `01 = The invalid date.MM.DD[ HH:MI[:SS]] YYYY_MM_DD[ HH:MI[:SS]] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] 001945 SQR does not support dates before '`01'. The date variables are incompatible with each other. `01 = Procedure name The argument lists for the DO and BEGINPROCEDURE commands must match in both type and count. `01 = Smallest date The SQR function references two date variables which cannot logically be used together (for example. The edit mask must be less than 255 characters. DO arguments do not match procedure's. 002103 DOLLAR-SYMBOL must be a single alphanumeric character or its decimal value enclosed in brackets: <nnn>.) Cannot find a matching label for GOTO command. contact your system administrator. Correct the syntax. Remove the EXIT-SELECT command. See the PRINT command for the valid numeric edit mask characters. Correct the syntax.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 002101 Bad numeric 'edit' format: `01 The numeric edit mask contains an invalid character. `01 = Invalid character Correct the syntax.do not know which one to GOTO. (Labels must be in same section or paragraph as GOTO. 002107 002200 Correct the syntax. DOLLAR-SYMBOL cannot be any of the following characters: `01 MONEY-SYMBOL must be a single alphanumeric character or its decimal value enclosed in brackets: <nnn>. 002401 002500 002501 002502 002503 002506 The C routine "fgets()" returned an error and SQR ends the program run. Unknown INPUT datatype: type={char|number|integer|date} INPUT STATUS= must reference #variable. The error could be related to a network or server problem. `01 = Maximum length of an ENCODE string supported by this version of SQR The database command to cancel the query returned an error. Duplicate label's . 002104 002106 Correct the syntax. Correct the syntax. Break up the ENCODE command. Labels must be unique within the section or paragraph where they are defined. The response to the INPUT statement was too long. If the error persists. Maximum `01 characters. Unknown qualifier for INPUT. Too long. 002300 002301 002400 EXIT-SELECT valid only within SELECT paragraph. `01 = List of invalid characters Correct the syntax. Re-enter the data. MONEY-SYMBOL cannot be any of the following characters: `01 ENCODE string too large. Error getting INPUT. Give each label a unique name. `01 = Maximum characters allowed PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-21 . EXIT-SELECT failed. Try running the SQR program again. Check the source code. maximum is `01. 002508 002510 002511 002512 002513 002514 002515 The specified command required user interaction.NNNNN N]] [AM | PM]] SYYYYMMDD[HH24[MI[SS[N NNNNN]]]] `01 required user interaction but user interaction was disabled by the -XI command line flag. Enter a date in one of the following formats: MM/DD/YYYY [HH:MI[:SS[. Re-enter the data. `01 = Load lookup table name Correct the syntax. but user interaction was disabled by the XI command line flag. Enter a date in one of the specified formats. Re-enter the data. The format mask cannot be stored in a date variable. LOAD-LOOKUP `01= cannot reference a variable in the Setup section. Correct the syntax. Bad value for `01= in LOADLOOKUP. Invalid integer was entered for an INPUT request. Format for integer: [+|]999999 A format mask can only be specified when TYPE=DATE is used. Values are from -2147483648 to 2147483647. Invalid number was entered for an INPUT request. `01 = Name of the command Add a LOAD-LOOKUP command.NNNNN N]] [AM | PM]] MM-DD-YYYY [HH:MI[:SS[. LOAD-LOOKUP table '`01' has not been defined.YYYY [HH:MI[:SS[. Missing value for `01= in LOADLOOKUP. 002600 002601 002602 002603 002604 9-22 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Re-enter the data. The date cannot be blank.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 002507 Incorrect. Valid range is -2147483648 to 2147483647. `01 = Name of the parameter Either move the LOAD-LOOKUP command from the Setup section or remove the variable reference.99[E99] Incorrect. Format for floating point number: [+|-]99. Correct the syntax. The number was too large to be stored as an integer. `01 = Name of the parameter Give each LOAD-LOOKUP array a unique name. LOAD-LOOKUP names must be unique. `01 = Name of missing required parameter Correct the syntax. Correct the syntax.NNNNN N]] [AM | PM]] MM. Number too large for INTEGER. The input variable type does not match the TYPE qualifier.DD. `01 = Number of duplicate keys `02 = Name of the load lookup table Correct the source line. Numeric lookup keys must be <= `01 digits. LOAD-LOOKUP `01= must reference a string variable or literal. `01 = maximum length supported The database server returned an error while fetching the data. `01 = Name of the parameter 002606 Could not set up cursor for LOADLOOKUP table '`01'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 002605 Cannot compile SQL for LOADLOOKUP table '`01'. `01 = Columns name `02 = Return code `03 = Load lookup table name This message can be inhibited by using the QUIET argument on the LOAD-LOOKUP command. Field return code for `01 = `02 Bad return code after fetch in LOADLOOKUP table '`03'. `01 = Name of the load lookup table `02 = Number of rows loaded This message can be inhibited by using the QUIET argument on the LOAD-LOOKUP command..LOOKUP table '`01'. 002616 002617 LOAD-LOOKUP `01= must reference a numeric variable or literal. Also check the WHERE= clause for errors. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-23 . 002612 002613 Loading '`01' lookup table . Check the column and table names. `01 = Load lookup table name (SQLBase) The database server returned an error while fetching the data. Also check the WHERE= clause for errors. `01 = Name of the parameter Correct the source line. 002609 002610 002611 Integers only allowed in numeric lookup keys. `01 = Load lookup table name The database server returned an error while trying to compile the SQL statement needed to set up the LOAD-LOOKUP command. 002607 Problem executing the cursor for LOAD. 002615 Warning: `01 duplicate keys found in '`02' lookup table. The database server returned an error while trying to compile the SQL statement needed to process the LOAD-LOOKUP command. Correct the source line.. `01 = Load lookup table name The database server returned an error while trying to execute the SQL statement needed to process the LOAD-LOOKUP command. `01 = Load lookup table name Correct the source line. Check the column and table names. Bad return fetching row from database in LOAD-LOOKUP table '`01'. 002801 002802 002803 SET= and LEVEL= must be >= zero when indicated. SAVE= must be a $string variable. `01 command not allowed with -XL option in effect. 002805 002806 002900 002901 002902 ON-BREAK with BEFORE or AFTER must be inside Select. `01 = Name of the parameter `02 = Name of the undefined variable Reduce the ROWS= value. 002804 SET= must be same for all ONBREAKs in Select.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 002618 LOAD-LOOKUP `01= variable '`02' has not been defined. Cannot use old style PROCEDURE= with BEFORE= or AFTER=. Correct the syntax. use -Mfile to increase ONBREAKS. Out of ON-BREAKS. and then print the $string variable. Correct the source line. Correct the source line. LOAD-LOOKUP cannot support `01 rows. Correct the syntax. The ON-BREAK argument to the PRINT command may be used only for text fields. STATUS variable for `01 must be #Numeric. `01 = ROWS= value `02 = Maximum value allowed Either use the #IF command to conditionally compile the program when -XL is being used or do not execute this SQR report with the -XL option. Correct the syntax. Move the #numeric variable to a $string variable. 002619 002620 002700 002800 Line to stop erasing for 'NEW-PAGE' is larger than the page depth. 'ON-BREAK' not appropriate for numeric data. `01 = SQR command affected Correct the syntax. OPEN missing required qualifiers: RECORD={rec_len} FORREADING|FOR. Correct the source line.WRITING|FORAPPEND 9-24 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Record :types are FIXED. All the ON-BREAKS in a query must belong to the same SET. Correct the source line. Correct the syntax. `01 = SQR command Correct the source line. Use SET= to differentiate between ON-BREAKs in different queries. maximum is `02. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. VARY or FIXED_NOLF (default is VARY). (`02): `03 Specified file number not opened for writing. `01 = File number `02 = System error code `03 = System error message This message may indicate system problems. `01 = Maximum number of open external files supported by this version of SQR Check your program logic.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 002903 Too many external files opened. `01 = Filename `02 = File number `03 = System error code `04 = System error message SQR quits. Correct the syntax. (`02): `03 002907 Problem closing user file(s) at the end of run. 003000 003100 Cannot find document marker referenced in POSITION command.. SQR quits. Defines the specified @ marker in a BEGINDOCUMENT paragraph.. (`02): `03 003101 003200 Files must be opened for reading in order to use the READ command with them. 002908 While not an error. Warning: Cannot CLOSE file `01 -file not opened. maximum is `01. Line `01: Error writing the file. 002904 002905 File number already opened. Correct the program logic. Only 'COLUMNS nn. PAGE-NUMBER strings too long. Correct the program logic. `01 = Program line number `02 = System error code `03 = System error message Files must be opened for writing in order to use the WRITE command with them. `01 = File number The pre-and post-PAGE-NUMBER strings must be less than 74 characters.(`03): `04 002906 Cannot close file `01. Reduce the number of open external files needed by the program. this message indicates a problem with your SQR code.. Correct the source line. `01 = Program line number `02 = System error code `03 = System error message 003201 003202 003203 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-25 . Line `01: Error reading the file.' allowed after document marker in POSITION command. Cannot open file '`01' AS `02. Check for a misspelled @ marker name. Specified file number not opened for reading. Correct the syntax. or column. The total of the lengths indicated in the command must be less than the RECORD= argument used on the OPEN command. length of 18 is assumed. Bad :length for READ or WRITE command. Reduce the number of characters specified. 2 or 4 bytes. Correct the syntax. Correct the syntax. Missing required :length in READ command. #Numeric variables and literals must have :length of 1.255). `01 = Maximum number of characters supported by this version of SQR The number inside the angled brackets must be a valid ASCII number (1 . Correct the syntax. By default. Reduce the number of characters specified. and then print the $string variable. thus prohibiting the transfer of numeric binary data. Wrap not appropriate for numeric data. Move the #numeric variable to a $string variable first. variable. Correct the syntax. `01 = Maximum number of characters supported by this version of SQR. 003206 003207 003208 003209 003210 003211 003212 Command not complete. 003403 9-26 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The WRAP argument to the PRINT command may be used only for text fields. :Length not allowed for $date variables. 003213 003300 003301 003400 Correct the syntax. Program stopped by user request.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003204 Length of variables exceeds record length. all files are opened in VARY (variable length) mode. Correct the syntax. #Numeric variables and literals on CDC may only have :length of 1 or 3 bytes. 003402 Max `01 chars/line for WRAP with ON= or STRIP= Bad <number> in WRAP qualifier. 003205 Numeric binary transfer allowed with FIXED or FIXED_NOLF records only. Correct the source line. Unknown qualifier for STOP. File number must be a numeric literal. 003401 Max `01 chars/line for reverse WRAP. Correct the syntax. Check for a typographical error or recalculate the RECORD= value. Informational message. Add the:FIXED or FIXED_NOLF option to the RECORD= argument on the appropriate OPEN command. Correct the syntax. $String or #numeric variables required for READ. Correct the source line. Break up the literal into smaller pieces and combine using the LET command. Check against the CREATE-ARRAY command. GET or ARRAY. Array specified not defined with CREATE-ARRAY. `01 = Qualifier name `02 = Value encountered `03 = Relation to zero (<. Correct the source line. The "occurs" number for an array field is missing a right parenthesis. Use the CREATE-ARRAY command to define each array before referencing that array in other commands. 003405 The value for '`01' (`02) must be `03 0. Bad element reference for array (#variable|123). Literal strings can be up to 256 characters long. Correct the source line. #. 003500 003501 PUT. Correct the program logic. 003502 Literal too long. A leading "<" in the ON= or STRIP= qualifier indicates that a numeric value is following. The value specified for the specified qualifier is invalid. Did not find end of literal. Cannot find 'array_name (#element)'.=. `01 = Undefined field name The ARRAY command must not have more variables listed to the left of the array name than there are matching fields defined for the array. 003506 003507 003508 Did not find ending ')' for field. Correct the source line.ARRAY command.>=. Check program logic to make sure that the element number was not inadvertently changed. Check for a misspelled field name against the CREATE-ARRAY command.>) Correct the syntax. 003503 003504 003505 Unknown variable type. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-27 . Variable names must begin with $. '(#Element)' variable not found for array.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003404 Missing '>' in WRAP qualifier. Each GET or PUT command must indicate the element or row number to access in the array. The element number was not specified. or &. which must be ended by a closing ">". The element number is larger than the number of rows defined in the CREATE. The ending quote character (') was not found at the end of the literal.<=. Add the ending quote character. Correct the source line. 003509 Field not defined in array: `01 003510 More variables than fields specified in array command. Required word missing. Check for a misspelled array name.xxxx command incomplete. Check against the CREATE-ARRAY command. Missing ':type' in CREATE-ARRAY FIELD= `01 Duplicate FIELD name: `01 Optional :nn for FIELD must be between 1 and 64K. The ARRAY-ADD. PUT and GET variables must match array field types. CREATE-ARRAY FIELDS :type must be one of the following: `01 003520 003521 003522 003523 9-28 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 003514 003515 More fields than variables found in array command. `01 = The name of the field Correct the source line. 003517 003518 003519 Missing '=specifier' in qualifier: `01 Duplicate array name: `01 Too many fields defined. Check the CREATEARRAY command. Correct the source line. Reduce the number of arrays needed by the program. 003512 Only numeric variables and fields allowed with array arithmetic commands. 003516 Too many arrays defined. Correct the syntax. `01 = The name of the field Change the name of one of the fields. 01 = Name of missing required parameter Change the name of the array. and ARRAY-DIVIDE commands may have only numeric variables or literals as the source fields. 003513 GET can only be used with $string or #numeric variables. CHAR fields can be stored into/from strings. Check against the CREATE-ARRAY command. You can move array fields only into $string variables or #numeric variables. `01 = Maximum number of fields allowed per array Correct the syntax. The ARRAY command must not have more variables listed to the left of the array name than there are matching fields defined for the array. ARRAY-SUBTRACT. The ARRAY command must not have more variables listed to the left of the array name than there are matching fields defined for the array. maximum is `01. `01 = Maximum number of arrays supported by this version of SQR Correct the syntax. maximum is `01. `01 = Array name in question Reduce the number of fields. When moving data into or out of arrays. the source or destination variables must match the array fields in type. NUMBER fields into/from numeric variables.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003511 More variables in command than fields in array. ARRAY-MULTIPLY. Move the string data into a #numeric variable and then reference the #numeric variable. possibly extra characters after the final right parentheses. Out of substitution or #DEFINE variables. Missing FIELD= statements in CREATE. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. Did not find end of paragraph: `01 003603 003605 003700 The C routine "fgets()" returned an error and SQR ends the program run. Correct the syntax. Extra argument found. On PC-based systems. `01 = Offending command name The BEGIN-paragraph command is not allowed here. Reduce the number of entries. 003701 003702 003703 Invalid command. Check your SQR code for a misplaced paragraph. Correct the syntax. The array as specified would exceed this limit. Missing Comma.ARRAY. The DO or BEGIN-PROCEDURE command has an error in its argument list. use -Mfile to increase SUBVARS. Correct the syntax. Correct the syntax. Missing the END-paragraph command to match the specified paragraph. 01 = Name of the field Correct the syntax. Correct the syntax. Correct the syntax. WARNING: Substitution variables do not vary when saved with run-time. Correct the syntax. Bad Argument List. No substitution variable entered. Missing procedure name. Correct the syntax. Informational message. Missing 'ask' variable name. Correct the source line. Array dimensioned too large for PC in CREATE-ARRAY. Command not allowed in this section: `01 Paragraph not allowed inside procedure.ARRAY.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003525 003526 003527 003528 Missing NAME= in CREATEARRAY. 003704 003705 003706 003707 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-29 . `01 = BEGIN-paragraph in question Check for a misspelled command. Correct the source file. 003529 003600 003601 Missing or invalid initialization value for field `01. the maximum allocation that can be made is 65520 characters. Missing or incorrect SIZE= in CREATE. Did not find end of paragraph: `01 (No 'from. you could count the rows manually and use the EXIT-SELECT command to break out of the SELECT loop. Correct the source line.. 003710 An argument in a DO or BEGIN-PROCEDURE command is incorrect. 9-30 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . You are trying to select the same &column name more than once.Len)". Columns retrieved from the database are assigned names by prepending an "&" to the beginning of the name. `01 paragraph not allowed with -XL option in effect. Check for a misspelled variable type. Correct the SQL statement. `01 = Name of the BEGIN-paragraph The -Cnn value must be a non-zero value. Missing ).PROCEDURE parameters. Maximum is 32767'. Unknown argument type. Correct the source code. `01 = BEGIN-command in question The database server has determined that the SQL statement is in error. 003714 003715 003716 Bad database connection number. If your program logic requires that you stop processing after more than 32767 rows have been retrieved. Remove the extra characters after the dash.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003708 Empty Argument. The actual error text from the server follows this message. 003717 003718 Extra characters after expression continuation. Either use the #IF command to conditionally compile the program when -XL is being used or do not execute this SQR report with the -XL option. Correct the syntax. 003711 003712 003713 Indicate :$string or :#number returned values in BEGIN. Correct the syntax. 003719 Columns names and expressions must be unique or be given unique pseudonyms (&name). Correct the syntax.PROCEDURE only. Correct the source line.Col. An expression in a SELECT list must end with either a &column variable or a position parameter "(Row. Correct the source line. Change the assigned &column name by using an alias after the name.. possibly two commas in a row inside the parentheses. 003709 Only $string and #number variables allowed for BEGIN. 003720 Bad number specified for 'LOOPS=' on 'BEGIN-SELECT. Did not find end of expression.) Error in SQL statement. The DO or BEGIN-PROCEDURE command has an error in its argument list.' clause found. argi]. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [. (Oracle) Correct the syntax. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[..argi]. (SQLBase) Correct the syntax.argi].)]] [-DB=database] Bad param found on 'BEGIN-SELECT' line..argi]. 003721 (DB2) Correct the syntax.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003721 Bad param found on 'BEGIN-SELECT' line.. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [.)]] Bad param found on 'BEGIN-SELECT' line...argi].)]] [-DB=database] Bad param found on 'BEGIN-SELECT' line... Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[.)]] [-NR] [-DB=database] [-SORT=nn] [LOCK=ll] [-INMSG=nn] [-OUTMSG=nn] (HPIW) Correct the syntax.Bnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[. 003721 (Informix) Correct the syntax.)]] Bad param found on 'BEGIN-SELECT' line. 003721 (ODBC) Correct the syntax...argi]. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[.)]] Bad param found on 'BEGIN-SELECT' line. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[.. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-31 .. 003721 (Ingres) Correct the syntax. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[..Bnn] [LOOPS=nn] [ON-ERROR=procedure[(arg1[..)]] Bad param found on 'BEGIN-SELECT' line.argi].. 003725 Bad return fetching row from database. Try running the SQR program again. The error could be related to a network or server problem. Look closely at any $string variable references. SQL expression not ended. Correct the source line.. The database command to cancel the query returned an error. The database returned an error status for the last row that was fetched. An expression in a SELECT list must end with either a &column variable or a position parameter "(Row.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation Bad param found on 'BEGIN-SELECT' line. Correct the source line. perhaps missing &name.)]] Bad param found on 'BEGIN-SELECT' line.Col. Correct the source line. Look closely at any $string variable references. 003727 003728 SQL expression not ended.Len)". To embed a quote within a literal use two single quotes in sequence (''). perhaps parentheses not balanced. (Red Brick) Correct the syntax.XP] [LOOPS=nnn] [ON-ERROR=procedure[(arg1[. An error occurred while trying to compile the SQL statement.. 003726 Literal in SQL expression missing closing quote. make sure that the length of the first expression will be adequate for all rows selected. If the error persists..argi]. An error occurred while trying to execute the SQL statement. Correct the SQL statement or use the ON-ERROR= option to trap the error during the program run. If selecting expressions. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [. 003723 Problem executing cursor. An expression in a SELECT list must end with either a &column variable or a position parameter "(Row. Format is: BEGIN-SELECT [DISTINCT] [-Cnn] [LOOPS=nnn] [ON-ERROR=procedure[(arg1[. commonly due to the buffer not being large enough. (Sybase) Correct the syntax. Correct the SQL statement or use the ON-ERROR= option to trap the error during the program run.argi].)]] [-DB=database] 003722 Could not set up cursor.Col.Len)". contact your system administrator. Literals must be surrounded by single quotes ('). 9-32 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .. 003724 Could not exit query loop. ERROR=procedure[(arg1[. 03732 Correct the syntax.. 003730 (Informix) Correct the syntax.)]] [-DB=] Incorrect arguments for BEGIN-SQL: [-Cnn] [ON.ERROR=procedure(arg1[.)]] Incorrect arguments for BEGIN-SQL: [-Cnn] [ON.. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-33 ..argi].)]] Incorrect arguments for BEGIN-SQL: [-Cnn] [ON. Correct the source line. 003730 (Ingres) Correct the syntax. An expression in a SELECT list must end with either a &column variable or a position parameter "(Row.argi]..argi].)]] Incorrect arguments for BEGIN-SQL: [-Cnn] [ON.ERROR=procedure[(arg1[..ERROR=procedure[(arg1[. ON-ERROR= for 'BEGIN-SQL' in SETUP section must be STOP..argi]. Correct the source file.)]] Incorrect arguments for BEGIN-SQL: [-Cnn] [-NR] [ON....argi].argi].. (Red Brick) Correct the syntax.Col. 003730 Incorrect arguments for BEGIN-SQL: [-Cnn] [ON.. WARN or SKIP. 003731 003732 Did not find 'END..ERROR=procedure[(arg1[.)]] [-DB=] 003730 (DB2) Correct the syntax. (HPIW) Correct the syntax.SQL' after 'BEGINSQL'.argi].Len)".ERROR=procedure[(arg1[. (Sybase) Correct the syntax. 003730 (ODBC) Correct the syntax.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003729 SQL expression is missing &name or has unbalanced parentheses...argi].ERROR=procedure(arg1[.argi].ERROR=procedure[(arg1[. (SQLBase) Correct the syntax.)]] [-DB=] [-SORT=nn] [-LOCK=ll] [INMSG=nn] [-OUTMSG=nn] Incorrect arguments for BEGIN-SQL: [-Cnn] [-XP] [ON....)]] [-DB=] Incorrect arguments for BEGIN-SQL: [-Cnn] [ON.)]] Incorrect arguments for BEGIN-SQL: [-Cnn] [-NR] [ON.ERROR=procedure[(arg1[.. (Oracle) Correct the syntax. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003733 Could not create procedure for SQL. (Sybase) SQR could not create a stored procedure for the SQL statement. The most likely cause for failure is that the user name you are using to run the report under does not have the proper privileges. Either grant the user CREATE PROCEDURE privilege or use the XP command line option to inhibit SQR from creating temporary stored procedures for SQL statements. Correct the SQL statement or use the ONERROR= option to trap the error during the program run. An error occurred while trying to compile the SQL statement. Correct the SQL statement or use the ON-ERROR= option to trap the error during the program run. (Informix, Ingres, ODBC, Oracle, SQLBase, HPIW) Correct the source code. (Oracle, Sybase) The -B flag specifies an illegal value. Correct the source code. Informational message. Correct the syntax. Correct the syntax. `01 = Missing character Correct the syntax. Correct the syntax. Correct the syntax. `01 = Leading character `02 = Trailing character Add &name=type to all expressions and nondynamic columns. 003734 Could not compile SQL. 003735 Could not execute SQL. 003736 Please use BEGIN- SELECT - ENDSELECT section for SELECT statements. Bad fetch buffer count. Report interrupted by request. Dynamic column must be $string variable. Dynamic column missing '`01'. Dynamic columns must have a &pseudonym. &pseudonym =type must be 'char', 'number', or 'date'. Only a variable name may be between the '`01' and '`02' characters. When dynamic columns are used all non-dynamic columns and expressions must be defined with &name=type. When the table name is dynamic each column and expression must be defined with &name=type. 003737 003738 003741 003742 003743 003744 003745 003746 003747 Add &name=type to all expressions and nondynamic columns. 9-34 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003800 Too many document paragraphs; maximum is `01. There are too many BEGIN-DOCUMENT paragraphs. Reduce the number of DOCUMENT paragraphs needed by the program. `01 = Maximum number supported by this version of SQR There are too many BEGIN-DOCUMENT paragraphs. Reduce the number of DOCUMENT paragraphs needed by the program. `01 = Maximum number supported by this version of SQR Give the document marker a unique name. The BEGIN-DOCUMENT paragraph must end with END-DOCUMENT. Correct the source code. Correct the syntax. The -Cnn value must be a nonzero value. Correct the source line. Correct the source line. Correct the source line. `01 = The parameter in question Variable names must begin with $, #, or &. Correct the source line. Correct the syntax. Correct the syntax. Correct the syntax. Check for a misspelled data type. If the data type is correct, then contact customer technical support so SQR can be updated. The &column name assigned to the column must be unique throughout the report. Give the column a unique name. Correct the source line. Correct the source line. Correct the syntax. 003801 Too many document markers; maximum is `01. 003802 003803 Duplicate document marker. Did not find 'END- DOCUMENT' after 'BEGIN-DOCUMENT'. EXECUTE command is incomplete. Bad -Cnn connection number for EXECUTE. @#Return_status must be #numeric (missing #). Missing '=' after `01. Unknown variable type. OUT[PUT] variables for EXECUTE may only be $variable or #variable. The only EXECUTE option is WITH RECOMPILE. You must EXECUTE ... INTO &columns. Unknown datatype for EXECUTE...INTO &columns. EXECUTE...INTO &columns must be unique. Missing (length) for datatype in EXECUTE. Datatype should not have (length) in EXECUTE. DO= in EXECUTE requires INTO... variables. 003900 003901 003902 003903 003904 003905 003906 003907 003908 003909 003910 003911 003912 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-35 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 003913 Could not EXECUTE stored procedure. Bad return fetching row from database. Record the database error message displayed with this message. If needed, contact your system administrator. Record the database error message displayed with this message. If needed, contact your system administrator. The database server returned an error while trying to compile the SQL statement needed to set up the EXECUTE command. (Ingres) Correct the syntax. (Ingres) Correct the syntax. The LET command is not properly formatted. Correct the source line. The expression is either too long or is too deeply nested. Break the expression into smaller expressions. A left or right parenthesis is missing. Correct the source line. Break the expression into smaller expressions. `01 = Maximum number supported by this version of SQR The expression is invalid. Correct the source line. An argument is missing after a comma in the expression. Correct the source line. The concatenation operator is ||. Correct the source line. The expression contains too many forward references. Break the expression into smaller expressions. `01 = Maximum number supported by this version of SQR The specified function is not an SQR built-in function nor does it exist in the user-modifiable file UFUNC.C. Check for a misspelled function name. `01 = Function name All functions in an expression must be followed by their arguments enclosed in parentheses. Correct the source line. 003914 003915 Could not set up EXECUTE cursor. 003916 003917 004000 004001 Missing '(' before EXECUTE params. Missing EXECUTE params. Result #variable or $variable or '=' missing in expression. Expression too complex. 004002 004003 Parentheses unbalanced in expression. Too many variables; maximum is `01. 004004 004005 004006 004007 Empty expression. Extra comma in expression. Unknown operator '`01'. Do you mean `02 ? Too many &column forward references in expression; maximum is `01. 004008 Unknown function or variable in expression: `01 004009 Function '`01' missing parentheses. 9-36 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004010 Empty parentheses or expression. A pair of parentheses were found with nothing inside them. Remove the () in question from the source line. Look at the file UFUNC.C to determine the correct number and type of arguments required for the specified function. `01 = User function name Correct the syntax of the function. Functions are described under the LET command. `01 = SQR function name Correct the source line. Correct the syntax of the function. Functions are described under the LET command. `01 = Operator Correct the syntax of the function. Functions are described under the LET command. `01 = SQR function name Correct the syntax of the function. Functions are described under the LET command. `01 = SQR function name Look at the file UFUNC.C to determine the correct number and type of arguments required for the specified function. `01 = User function name Look at the file UFUNC.C to determine the correct number and type of arguments required for the specified function. `01 = User function name Look at the file UFUNC.C to determine the correct number and type of arguments required for the specified function. `01 = User function name Look at the file UFUNC.C to determine the correct number and type of arguments required for the specified function. `01 = User function name The UFUNC.C file has a bad definition for the specified function. Correct the UFUNC.C program file; recompile UFUNC.C; and recreate the SQR executable. `01 = User function name 004011 User function '`01' has incorrect number of arguments. 004012 Function '`01' has incorrect number of arguments. Missing operator in expression. Operator '`01' missing argument. 004013 004014 004015 Function '`01' missing argument. 004016 Function or operator '`01' missing arguments. User function '`01' requires character argument. 004017 004018 User function '`01' requires numeric argument. 004019 User function '`01' requires $string variable. 004020 User function '`01' requires #numeric variable. 004021 User function '`01' has incorrect argument type list. Must be of: c,n,C,N PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-37 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004022 User function '`01' missing arguments. Look at the file UFUNC.C to determine the correct number and type of arguments required for the specified function. `01 = User function name The UFUNC.C file has a bad definition for the specified function. Correct the UFUNC.C program file; recompile UFUNC.C; and recreate the SQR executable. `01 = User function name #numeric variables cannot be NULL. Correct the source line. #numeric variables cannot be NULL. Correct the source line. Correct the source line. `01 = Function or operator Correct the source line. `01 = Function or operator The expression used must evaluate a statement that will be TRUE or FALSE. Correct the source line. The expression tried to divide a number by zero. Use the COND() function to check if the divisor is zero; then divide by something else (for example, 1). An attempt was made to divide a number using the " %" operator. Use the COND() function to check if the divisor is zero; then divide by something else (for example, 1). The "%" operator works with integers only. Correct the program logic. `01 = Maximum value allowed SQR detected an error while processing a user defined function. If you are running an .sqt file, it probably needs to be recompiled because the user function has changed its definition. If you are running an .sqr file, then you need to correct the UFUNC.C program file; recompile UFUNC.C, and recreate the SQR executable. SQR detected an error while processing a user defined function. Correct the UFUNC.C program file recompile UFUNC.C and recreate the SQR executable. 004023 User function '`01' has incorrect return type. Must be c or n. 004024 004025 004026 004027 004028 'isnull' requires a &column, $string or $date argument. 'nvl' requires a &column, $string or $date as its first argument. Function or operator '`01' requires character argument. Function or operator '`01' requires numeric argument. IF or WHILE expression must return logical result. Attempting division by zero in expression. 004029 004030 Attempting division by zero with '%'. 004031 The number used with '%' (`01) is out of range. User function has unknown return type -- expecting n or c -- need to recompile Run-Time file? 004032 004033 In user function use C type with allocated string to change $variable. 9-38 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004034 004035 004036 Could not find array '`01' in ARRAY function. Could not find array field '`01' in ARRAY function. Math error in expression (usually overor under-flow). Check for a misspelled array name. `01 = Array name Check for a misspelled array field name. `01 = Array field name Most of the SQR mathematical built-in functions have a corresponding C library routine. One returned an error. Break the expression into discrete expressions in order to identify the function that caused the error. Record the steps leading up to the error and contact technical support. The expression requires more temporary string storage than is currently allocated. Use the Mfile flag on the command line to specify a file that contains an entry that increases by a greater value than is currently defined. Warning message. `01 = Expression in question Define the array using the CREATE- ARRAY command. `01 = Array name Correct the source code. `01 = Field name `02 = Array name Correct the source code. `01 = Array name Correct the source code. `01 = Array name. Correct the source code. `01 = Array name Correct the source code. Correct the source code. `01 = Field name Correct the source line. `01 = Function or operator You must precede PRINT command arguments (WRAP, ON-BREAK.) with an explicit PRINT command when outside of a BEGIN-SELECT paragraph. Correct the source line. 004037 004038 Error executing expression. Out of space while processing expression; Use -Mfile to increase EXPRESSIONSPACE. 004039 004040 '`01' assumed to be a variable name, not an expression. The array '`01' has not been defined. 004041 The field '`01' is not valid for array '`02'. The array reference '`01' has an incorrect number of parameters specified. The array reference '`01' requires numeric parameters for the element and occurs arguments. Function or operator '`01' requires date argument. Incompatible types between expression and variable. The field '`01' is must be 'char' or 'float'. Function or operator '`01' must be a string or date argument. Use 'print' command to format data outside SELECT query. 004042 004043 004045 004046 004047 004048 004100 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-39 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004101 004102 Cannot find required parameter. Bad number found. Correct the syntax. A command expecting a numeric literal or :#numeric variable reference found an illegal number definition or a reference to a string variable or column. Correct the source line. Correct the syntax. The position qualifier "(Row,Col,Len)" was not found. Check for a missing parentheses. The "Row", "Column" or "Length" fields are invalid or ill-formed. Correct the source line. An SQR command used as a qualifier for a primary command (for example, PRINT) is incorrect. Correct the source line. The PRINT command may have format command qualifiers such as WRAP, CENTER, or FILL. Other qualifier commands are not permitted. Correct the source line. Correct the source line. Correct the syntax. Expressions selected in a BEGIN-SELECT paragraph should be given an &Name or be followed by a print position "(Row,Col,Len)". Correct the source line. Correct the syntax. Correct the syntax. `01 = What was expected Correct the syntax. `01 = What was expected `02 = What was encountered Correct the syntax. Correct the syntax. `01 = Duplicated parameter Correct the syntax. `01 = Parameter name Correct the syntax. `01 = Qualifier name 004103 004104 004105 004106 Cannot find required numeric parameter. Cannot find placement parameters. Placement parameter incorrect. Invalid second function on line. 004107 Second function must be FORMAT type. 004108 004109 004110 004111 Missing operator =, <, >, ... Invalid operator. Missing variable. Please give this expression a &pseudonym. 004112 004113 004114 Wrong variable type. Command incomplete, expected '`01'. Expecting '`01', found '`02'. 004115 004116 004117 004118 Unknown command or extra parameters found (missing quotes?). Duplicate references to parameter '`01'. Unexpected equal sign found with '`01'. Qualifier '`01' cannot be used with the following qualifiers: 9-40 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004119 004120 004200 Expecting numeric column, found string column. Date variables (`01) cannot be used with this command. Page width and depth must be > 0 and < 32767. Page buffer must be < 65536 on PC SQR. Cannot generate line printer output for this report because position qualifier(s) may be out of range. If you are running this report, specify PRINTER:{HP,EH,HT ,PS,WP} for graphical printer output. Missing end of placement (...) in SHOW. Bad (...) location in SHOW. Missing literal or variable name to EDIT in SHOW. Missing edit mask in SHOW. Only string variable allowed for dynamic edit mask. Unknown option for SHOW. Program too large; use -Mfile to increase PROGLINES. Correct the syntax. Correct the syntax. `01 = Parameter name The values specified with the PAGE-SIZE command are out of specified range. Specify legal values. The maximum allocation on a PC is 65536. The Page-Depth * Page-Width cannot exceed this value. Reduce the Page-Depth or Page-Width. The report output cannot be generated for a Line Printer. If your report was designed for a graphics printer, specify PRINTER:{HP,EH,HT,PS,WP} for graphical printer output. The placement parameter is ill-formed. Correct the source line. Screen positions must be valid numbers. Correct the source line. The literal or variable name must immediately precede the EDIT, NUMBER, MONEY, or DATE keywords. The word EDIT must be followed by a valid edit mask. Correct the source line. Dynamic edit masks may only be stored in $Variables. Correct the line. Correct the syntax. The SQR program contains too many SQR command lines. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. The SQR program contains too many SQR command line parameters. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. The space allocated to hold the static string variables ('...') has been used. Use the - Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. 004201 004202 004300 004301 004302 004303 004304 004305 004400 004401 Out of param storage; use -Mfile to increase PROGLINEPARS. 004402 Out of string storage; use -Mfile to increase STRINGSPACE. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-41 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004403 Out of variables; use - Mfile to increase VARIABLES. There are too many variables (string, numeric), literals and database columns. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. A forward referenced variable is a variable that is referenced before it is defined. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. Use a different value. `01 = Internal number References were made to column variables (&var) that were not defined in the program. The list of variable names follows this message. A print position is the "(Row,Col,Len)" parameter. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. The use of "-#Variable" is not legal here. Negate the #Variable value and use "+#Variable". Correct the source line as indicated. 004405 Out of forward &column or $variable references; use -Mfile to increase FORWARDREFS. 004406 004407 Number `01 not allowed. Referenced variables not defined: 004500 Out of Print positions; use -Mfile to increase POSITIONS. 004501 Use '+' and negate variable for reverse relative placement. Fixed line placement #variable must be > 0. Use relative positioning, (+#line,10,0). Fixed column placement #variable must be > 0. Use relative positioning, (5,+#col,0). Length placement #variable must be >= 0. CODE not appropriate for numeric data. 004503 004504 Correct the source line as indicated. 004505 004600 The length field cannot be a negative value. Correct the source line. The CODE qualifier to the PRINT command may only be used for text fields. Move the “#Variable” to a “$Variable” first and then print the “$Variable”. Correct the syntax. 004601 Unknown option for GRAPHIC command: BOX, HORZ-LINE, VERTLINE or FONT GRAPHIC BOX out of bounds. Row: `01, Column: `02, Width: `03, Depth: `04 004602 SQR ends the program run. `01 = Row `02 = Column `03 = Width `04 = Depth 9-42 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004603 GRAPHIC VERT- LINE out of bounds. Row: `01, Column: `02, Length: `03 GRAPHIC HORZ- LINE out of bounds. Row: `01, Column: `02, Length: `03 Cannot open the program file: '`01' (`02): `03 SQR ends the program run. `01 = Row `02 = Column `03 = Length SQR ends the program run. `01 = Row `02 = Column `03 = Length Depends on the system error message. `01 = Name of the program file `02 = System error code `03 = System error message The connectivity information is either incorrect or the database server is unavailable. Check the connectivity information and the server availability. All commands must be within BEGIN-... ENDstatements. Correct the source code. Depends on the system error message. `01 = System error code `02 = System error message Missing an #ENDIF to complete conditional compilation. Correct the source code. Break the program line into smaller lines. `01 = Maximum line length supported by this version of SQR The substitution variable value would cause this line to exceed the maximum line size. Break the program line into smaller lines. `01 = Name of the substitution variable `02 = Maximum line length supported by this version of SQR An empty value was found for the substitution variable. Check for a misspelled name. `01 = Name of the substitution variable Missing an #IF or #IFDEF or #IFNDEF to begin conditional compilation. Correct the source code. Missing an #IF or #IFDEF or #IFNDEF to begin conditional compilation. Correct the source code. 004604 004700 004701 Cannot logon to the database. 004702 004703 Line found outside paragraph. Cannot close the program file. (`01): `02 #ENDIF not found for #IF. Program line too long; maximum is `01. Substitution variable {`01} would cause this line to exceed the maximum line length of `02 characters. 004704 004705 004706 004707 No value found for substitution variable: {`01} #ELSE without preceding #IF. 004708 004709 #ENDIF without preceding #IF. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-43 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004710 #IF's nested too deeply; maximum is `01. #INCLUDE files nested too deeply; maximum is `01. Reduce the number of nested #IF directives. `01 = The maximum depth supported by this version of SQR Reduce the number of nested #INCLUDE directives. `01 = The maximum depth supported by this version of SQR The combined -I directory name with the #INCLUDE file name exceeds the maximum length permitted for a complete pathname. Check the spelling of both the -I command flag and the #INCLUDE filename. `01 = Include file name `02 = System error code `03 = System error message `01 = Include file name `02 = System error code `03 = System error message This section is required for all reports. Correct the source code. `01 = Output file name `02 = System error code `03 = System error message The database server returned an error while trying to log off from the database. SQR ends the program run. SQR ends the program run. `01 = Run-Time file name `02 = System error code `03 = System error message SQR ends the program run. `01 = System error code `02 = System error message SQR ends the program run. `01 = System error code `02 = System error message The runtime file was created by a earlier version of SQR and is incompatible with the current version. Recreate the .sqt (runtime) file. Do not use the -XL option. 004711 004712 Include file name too long; Modify -I flag. 004713 Cannot open the #INCLUDE file: '`01' (`02): `03 Cannot close the #INCLUDE file: '`01' (`02): `03 'BEGIN-REPORT' command not found in program. Cannot open the report output file: '`01' (`02): `03 Cannot logoff the database. 004714 004716 004717 004719 004720 Cannot open the run- time file: '`01'. (`02): `03 004721 Cannot close the run- time file. (`01): `02 Error reading the run- time file. (`01): `02 Run time file must be recreated for this version of SQR. The -XL option cannot be specified with this run-time file because access to the database is required. 004722 004723 004724 9-44 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004725 Cannot open cursor. The database server returned an error indicating that a new database cursor or logon could not be completed. See the error message from the database server. (Sybase) SQR could not create a stored procedure for the SQL statement. The most likely cause for failure is that the user name you are running the report under does not have the proper privileges. Either grant the user CREATE PROCEDURE privilege or use the XP command line option to inhibit SQR from creating temporary stored procedures for SQL statements. `01 = System error code `02 = System error message (MVS) Use the proper format to specify the name of the .sqt file. 004726 Cannot create procedure for SQL statement. 004727 004728 Error writing the run- time file. (`01): `02 You must specify a Partitioned Data Set name and member to build a .sqt(member) run-time file. Could not create the run-time file. Cannot find inactive database cursor. Program too large. Run-time saved in file: `01 Cannot select user. 004729 (DB2, Oracle) The program has too many concurrent database cursors. Reduce the complexity of the program. Informational message. `01 = Name of the .sqt file created (Ingres) SQR could not select the default user name from the database. Contact your system administrator. SQR ends loading the runtime file. `01 = Variable type SQR ends loading the runtime file. SQR ends loading the runtime file. `01 = Database name from runtime file `02 = SQR image name `03 = Database that SQR is built for Correct the source code. Correct the source code. Correct the syntax. Correct the syntax. 004730 004734 004735 004736 004737 Unknown variable type encountered in run-time file: `01 Unexpected End-Of- File while processing the run-time file. Cannot load the run- time file because it was built for the `01database and `02 is built for the `03 database. 'END-REPORT' not paired with 'BEGIN- REPORT'. 'END-PROGRAM' not paired with 'BEGIN- PROGRAM'. #INCLUDE filename must be enclosed in quotation marks. #INCLUDE command format is: #Include 'filename'. 004738 004739 004743 004744 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-45 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 004745 Array field (`01.`02) specification exceeds the PC 64K limit. Layout '`01' specifications exceeds the PC 64K limit. The SQT file is corrupted and cannot be processed. The user function '`01' needs to be defined as entry `02 in the user function table. It requires a definition of: Return Type = '`03' Arg Count = `04 Arg Types = "`05" Reduce the size of the field requirements. `01 = Array name `02 = Field name The layout is too large for the PC version of SQR to handle. `01 = Layout name SQR ends loading the runtime file. The SQT file requires that the specified user function be defined. `01 = User function name `02 = Entry in the user function table `03 = Return type `04 = Argument count `05 = Argument types An attempt was made to move too much data into an SQR string variable. `01 = Number of characters to be moved `02 = Variable name `03 = Maximum characters allowed Correct the syntax. 004746 004747 004748 004749 An attempt was made to move `01 characters into '`02'. The maximum allowed is `03 characters. 004802 PRINTER TYPE must be HTML, HPLASERJET, POSTSCRIPT, or LINEPRINTER. Both BEFORE-BOLD and AFTERBOLD must be specified. Unknown DECLARE qualifier. Out of dynamic SQL arguments [$...]; use -Mfile to increase DYNAMICARGS. 004805 004807 004900 Correct the syntax. Correct the syntax. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. Correct the source code. `01 = Variable name Reduce the size of the heading or increase the page depth. Reduce the size of the footing or increase the page depth. The BEGIN-HEADING procedure either caused an overflow of the current page or it issued a command that caused a page eject to occur. Check any procedure invoked by the BEGIN-HEADING section to ensure that the commands do not overflow the page or cause a page eject. 004901 Date variables (`01) cannot be used in BEGIN-SQL or BEGIN-SELECT paragraphs. Report '`01' heading section size exceeds the page depth. Report '`01' footing location must be less than the page depth. Check 'BEGIN- HEADING' commands: Discovered 2nd page- initialization while heading in progress. 005000 005001 005002 9-46 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL Use -Mfile to increase BREAKS. Report '`01' has overlapping heading and footing sections. 'EVALUATE' commands nested too deeply. perhaps number of footing lines is too small. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-47 . `01 = Report name `02 = Duplicated section name Correct the source code. Out of Break commands. This is the number of BREAK commands allowed per EVALUATE command. Correct the source code. You cannot define more than one default '`01' section. Correct the source code. Attempt to execute the `01 command while processing the `02 section. `01 = Report name Correct the source code. Only one 'ELSE' allowed per 'IF'.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005003 Check 'BEGIN-FOOTING' commands. `01 = Table of Contents name `02 = Duplicated section name Reduce the nested commands.write while footing in progress. The BEGIN-FOOTING procedure either caused an overflow of the current page or it issued a command that caused a page eject to occur. 005004 005005 Report '`01' already has been assigned a `02 section. maximum is `01. Change the SQR program logic to prevent the command from executing while the specified section is active. Rewrite the source code to use nested IF statements. Discovered 2nd page. Single 'ELSE' found inside 'WHILE' or 'EVALUATE' statement. TOC '`01' already has been assigned a `02 section. 'ELSE' found without matching 'IF'. 'BREAK' found outside 'WHILE' or 'EVALUATE' statement. 005006 005007 005008 005100 005101 005102 005103 005104 005105 005106 005107 END-WHILE found without matching 'WHILE'. 'IF' or 'EVALUATE' command not completed before 'END. Correct the source code. Check any procedure invoked by the BEGINFOOTING section to ensure that the commands do not overflow the page or cause a page eject. ELSE can be used only within the context of an IF command. ELSE can be used only within the context of an IF command. Correct the syntax. `01 = Maximum depth allowed by this version of SQR The BREAK command is valid only in the context of a WHILE or EVALUATE statement. `01 = Duplicated section name Correct the source code. 'WHILE'. 'IF'. Use the Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. Correct the source code. `01 = Command name `02 = Section name Correct the source code.WHILE'. 005110 EVALUATE statements nested too deep. maximum is `01.OTHER' allowed per 'EVALUATE'. Correct the source code. Correct the source code. You are missing a closing END-WHILE or END-EVALUATE command before END. Correct the syntax. 'IF' or 'WHILE' command not completed before 'END. Each inner statement must be complete before a closing statement is ended. Correct the syntax. Only one 'WHEN.EVALUATE'. These commands must be contained within a single section or paragraph. numeric or date).IF. Correct the syntax. Correct the source code.OTHER' command. Correct the syntax. Reduce the number of nested statements. Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. 'When-other' found outside 'Evaluate' statement. Each EVALUATE command must have a matching END-EVALUATE command. Out of When commands. 'WHILE' or 'EVALUATE' command not completed before 'END-IF'. Correct the source line. 'IF' or 'WHILE' not ended before 'WHEN.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005108 005109 Found 'END-IF' without matching 'IF'. 'WHEN' found outside 'EVALUATE' clause. Correct the source code. Correct the source code. Incorrect types for comparison. 'WHEN-OTHER' must be after all 'WHEN's. 005116 005117 005118 005119 005120 005121 005122 9-48 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 'IF'. 'IF' or 'WHILE' not completed before 'WHEN' statement. Use -Mfile to increase WHENS. Each IF command must have a matching ENDIF command. `01 = Maximum depth supported by this version of SQR WHEN may be used only in the context of an EVALUATE clause. Correct the syntax. Found 'END-EVALUATE' without matching 'EVALUATE'. Correct the source code. and EVALUATE statements can be nested. Correct the syntax. No 'WHEN's found inside 'EVALUATE' statement. but they cannot cross each other's boundaries. WHILE. Both must be of the same type (string. 'EVALUATE' and 'WHILE' statements cannot cross sections or paragraphs. 005111 005112 005113 005114 005115 WHEN can be used only in the context of an EVALUATE statement. IF. `01 = Qualifier name Correct the source line. variable. `01 = Qualifier name Correct the source line..SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005200 Did not find '>' after <. Required argument '`01' was not specified. or column. Valid qualifiers are: Qualifier '`01' requires a numeric literal. which must be ended by a right angled bracket ">". `01 = Qualifier name Correct the source line. Missing comma in list.. Correct the syntax. `01 = Maximum number of characters supported by this version of SQR Correct the syntax. Qualifier '`01' references a numeric variable that has not been defined..).. Qualifier '`01' has already been specified. `01 = Qualifier name Correct the source line. Qualifier '`01' requires a string literal. `01 = Qualifier name Correct the source line. Incorrect value for qualifier '`01'.>.. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-49 . Numbers in angled brackets <> must be between 1 and 255. Valid values are: Invalid qualifier '`01'. Qualifier '`01' requires a integer value. Qualifier '`01' requires a list of values: (val [.. use a PRINT-DIRECT command in a BEGIN-REPORT or END-REPORT procedure... or column. 005300 005301 005302 005303 005304 005305 005306 005307 005308 005309 005310 005311 005312 005313 Did not find '=' after qualifier: `01 Qualifier '`01' requires a numeric value. `01 = Qualifier name Correct the source line.val].. <. maximum is `01 characters. If this is not possible.. Bad ascii number in <. `01 = Qualifier name Correct the syntax. Correct the source line. Numbers in angled brackets <> must be between 1 and 255. `01 = Qualifier name Correct the syntax. Qualifier '`01' requires a string literal.> string is too long. Reduce the length of the string. variable.>. `01 = Qualifier name Correct the source line. `01 = Qualifier name Correct the source line. List not terminated. `01 = Qualifier name Correct the source line. Correct the source line.. Correct the source line. Correct the source line. A leading left angled bracket "<" indicates that you are beginning an ASCII value. `01 = Qualifier name 005201 005202 005203 Bad ascii character in <. String cannot be placed on page: `01 -. Valid suffixes are: dp pt mm cm in Second page write attempted while writing current page. Program stopped by user request. `01 = Unknown database datatype 005400 005402 005403 005404 Error writing the output file. (Sybase) The DB-Library routine dbsetopt() returned an error.`04) Correct the source line. (Sybase) The DB-Library routine dbclropt() returned an error. `01 = Stored procedure name (Sybase) Use another database column. This should never happen. 005503 005504 Cannot use `01 datatype as bind variable. `01 = Qualifier name Correct the source line. This should never happen.`03. 9-50 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . AFTERPAGE procedures. (`02. Contact technical support. `01 = Qualifier name Check any procedure invoked by the BEFOREPAGE or AFTER-PAGE procedures to ensure that the commands do not overflow the page or cause a page eject.PAGE. Contact technical support. Ensure the values are within the page limits.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005314 005315 005316 Invalid character in variable name '`01'. Qualifier '`01' uses an invalid Unit-OfMeasure suffix. This should never happen. (Sybase) See the database server error message that was also output. (Sybase) Please contact technical support. Cannot set parse_only option. 005502 Cannot drop SQR generated stored procedure: `01.placement specified is out of range. Unknown datatype for bind variable: `01 Cannot create stored procedure. Check BEFORE. (`01): `02 Cannot open the Postscript startup file: `01 (`02): `03 SQR trial copy exiting after `01 pages. 005405 005406 005408 005500 005501 Cannot reset parse_only option. `01 = Text value `02 = Row `03 = Column `04 = Length `01 = System error code `02 = System error message `01 = Name of the file `02 = System error code `03 = System error message `01 = Number of pages. Qualifier '`01' references a string variable that has not been defined. `01 = Invalid character Correct the source line. `01 = The database datatype. Contact technical support. `01 = Number of pages Informational message. Exiting after requested number of test pages (`01). See the error message from the database. Contact technical support.. SQLNSI: Cannot get number of select items. Missing default database name for USE. Missing default database name for USE. 005506 SQR's EXECUTE command not available for this version of Sybase. (Sybase) The size of the SQL text needed to create the stored procedure is too large for SQR to process. Error converting OUTPUT Sybase type for EXECUTE. (ODBC) Could not connect to the specified datasource. (Sybase) Correct the syntax. Missing default database name for USE. Place the SETUP section at the beginning of the SQR report.. (Sybase) A DB-Library routine returned an unexpected error.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005505 SQL too large to create stored procedure. (Sybase) Only one USE command is allowed in a report. (Sybase) Check the definition for the stored procedure you are referencing. (SQLBase) SQR could not determine the number of columns in the Select list from the SQLBase database. (Red Brick) Could not connect to the specified datasource. (Sybase) Some early versions of Sybase SQL Server or Microsoft SQL Server do not support Remote Procedure Calls (RPCs). Update your database server. 005508 005509 005510 005511 005512 005512 005513 You may only specify 'USE db' once. (Sybase) Check the definition for the stored procedure you are referencing. `01 = Variable name (SQLBase) SQR could not get the position of the error in the SQL statement from the SQLBase database. Contact technical support. 005514 005515 005516 005517 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-51 . Contact technical support. Add the -XP option to the BEGINSQL or BEGIN-SELECT command. (Sybase) Check the definition for the stored procedure you are referencing. Number of OUTPUT parameters from EXECUTE is incorrect. SQLBase) Check for a misspelling. (ODBC. Contact technical support.INTO &columns does not match the procedure. Undefined variable referenced in -DB flag: `01 SQLEPO: Cannot get error position in SQL. The number of EXECUTE. Incorrect number of INTO &columns defined in EXECUTE. DBLON: 'sqlini() failed. (Sybase) The DB-Library routine dbconvert() failed to convert the data from the stored procedure. 005507 Could not add param to remote procedure call. (SQLBase) SQR could not initialize the database interface. before any SQL statements are executed. Try running the SQR program again. If the error persists. The error could be related to a network or server problem. The database command to close the database cursor returned an error. The error could be related to a network or server problem. Database commit failed.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005518 005519 Could not connect to database specified in . (SQLBase) SQR could not read the long datatype column from the SQLBase database. (SQLBase) Use the -Mfile flag on the command line to specify a file containing an entry that increases the currently defined value. (SQLBase) SQR could not read the long datatype column from the SQLBase database. HPIW SQL `01 error `02 in cursor `03: `04 005528 005528 DB2 SQL `01 error `02 in cursor `03: 005528 INFORMIX SQL `01 error `02 (ISAM: `03) in cursor `04: `05 9-52 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Try running the SQR program again. Contact your system administrator. If the error persists. (SQLBase) SQR could not get the error message from the SQLBase database. contact your system administrator. 005525 `01 Could not get database error message. `01 = Reason for failure (HPIW) `01 = Routine name `02 = Error code `03 = SQR cursor number `04 = Error message from database (DB2) `01 = Routine name `02 = Error code `03 = SQR cursor number (Informix) `01 = Routine name `02 = Error code `03 = ISAM code `04 = SQR cursor number `05 = Error message from database 005520 SQLRLO: Error reading Long datatype.DB variable: '`01'. SQLROW: Cannot get number of rows. Warning: LONG datatype truncated. (SQLBase) Correct database name. use -Mfile to increase LONGSPACE. The database command to perform a commit returned an error. SQLELO: Error reading Long datatype. `01 = Database name (SQLBase) SQR could not determine the number of rows from the SQLBase database. Contact technical support. Contact your system administrator. 005521 005522 005523 005524 Cannot close database cursor. contact your system administrator. Empty error message returned from system for error number: `01. Use the DBLibrary version of SQR to connect to a preSystem 10 server. 005528 ODBC SQL `01 error `02 in cursor `03: `04 ORACLE `01 error `02 in cursor `03: `04 SQLBase `01 error `02 in cursor `03: `04 Sybase `01 error in cursor `02: `03 Red Brick `01 error `02 in cursor `03: `04 005532 005533 System 10 files are missing. (Sybase) The CT-Library version of SQR can only connect to a System 10 server. `01 = Maximum number of characters supported by this version of SQR (DB2) `01 = Error message number (DB2) `01 = Error message number (Sybase) The select statement contains a COMPUTE clause that is not supported. Invalid SELECT statement. 005536 005537 005538 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-53 . maximum `01 characters. 005534 SQL too long for PREPARE/DECLARE. Unknown error message number: `01.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005528 INGRES SQL `01 error `02 in cursor `03: `04 (Ingres) `01 = Routine name `02 = Error code `03 = SQR cursor number `04 = Error message from database (ODBC) `01 = Routine name `02 = Error code `03 = SQR cursor number `04 = Error message from database (Oracle) `01 = Routine name `02 = Error code `03 = SQR cursor number `04 = Error message from database (SQLBase) `01 = Routine name `02 = Error code `03 = SQR cursor number `04 = Error message from database (Sybase) `01 = Routine name `02 = SQR cursor number `03 = Error message from database (Red Brick) `01 = Routine name `02 = Error code `03 = SQR cursor number `04 = Error message from database (Sybase) Contact your system administrator. COMPUTE clauses are not supported. (DB2) The SQL statement is too large. Not a System 10 SQL Server. `01 = Maximum number supported by this version of SQR. (ODBC) Could not connect to the specified datasource.C routine. 005541 005543 Bind variables are not supported. Error opening the -E error file: '`01' (`02): `03 9-54 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . If that DLL could not be loaded.INI file. (Oracle) SQR was unable to load the Oracle DLL.dll 005600 GETWRD: Word too long. This error can only occur if a User Function from either UFUNC. then SQR attempts to load 'orant71.C or UCALL. Reduce the length of the log file name. (HPIW) Bind variables are not supported. `01 = Name of the file `02 = System error code `03 = System error message 005540 Not connected to a database. such as ORACLE_DLL=orant 71. Commands that access the database can no longer be used.C or UCALL. Cannot call SQR recursively. maximum is `01. Specify the Oracle DLL name in the SQR. To pass more than this number of arguments. `01 = Name of the file `02 = System error code `03 = System error message The name of the program file was not found on the command line. database access is not allowed. The SQR program is no longer connected to a database. Do not call sqr() from a UFUNC. 005704 005705 005707 Program file name specified is too long.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005539 Could not connect to datasource specified in -db variable: '`01'. 005700 005701 Too many SQR command line arguments. use a @file argument file containing one argument per line. Could not connect to datasource specified in -db variable: '`01'. SQR looks first for “ociw32.dll'.C calls the sqr() routine. This situation can occur if the CONNECT fails and the ON-ERROR option was used. Reduce the length of the "word". Reduce the length of the program file name. (Red Brick) Could not connect to the specified datasource. The program name must be the first parameter on the command line.INI file in [Environment:Oracle] section for ORACLE_DLL entry. By default. `01 = Maximum size of a "word" supported by this version of SQR SQR cannot be called recursively. Error opening the SQR log file: '`01' (`02): `03 Missing program name. maximum is `01 005702 005703 Log file name specified is too long.dll” or the DLL specified by the ORACLE_DLL entry in the [Environment:Oracle] section of the SQR. 5. Record the steps leading up to the error and contact your system administrator. `01 = System status (VAX) This is an error that should never occur during normal operations. `01 = Name of the environment variable The length of the directory path plus the length of the file name to be opened is too long for SQR to handle. Record the steps leading up to the error and contact your system administrator. 005714 -G attribute too long. PATH or \SQR.formed. the environment variable SQRDIR must be defined. Correct the syntax. status = `01 005719 Cannot close channel to TT. `01 = System status (VAX) This is an error that should never occur during normal operations. (VAX) The command line option is ill. Record the steps leading up to the error and contact your system administrator. (VAX) The command line option is ill. Correct the syntax. status = `01 005718 Cannot read from TT. Correct the syntax. `01 = Maximum number of arguments supported by this version of SQR (VAX) The command line option is ill. `01 = System status 005709 `01 environment variable is not defined. `01 = File name As of version 2. maximum is `01.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005708 Cannot find `01 in SQRDIR. 005710 005711 005712 005713 Bad number in -T test flag. -G option requires arguments.formed. The specified file cannot be located in any of the directories pointed to by the mentioned environment variables or default directories. `01 = Environment variable name The number specified must be > zero. Make sure the "file" is present in one of the locations searched. `01 = Unknown command line flag (VAX) This is an error that should never occur during normal operations. maximum is `01. 005716 005717 Unknown flag on command line: `01 Cannot open channel to TT. `01 = Maximum number of each attribute supported by this version of SQR Correct the syntax. Too many arguments to -G option.formed. `01 path too long. status = `01 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-55 . Correct the value. Reduce the length of the directory path. `01 = Maximum number allowed 005721 Error with 'ioctl()'. Record the steps leading up to the error and contact your system administrator. PS. UNIX) This is an error that should never occur during normal operations. Database name needs to be included with . HT. Record the steps leading up to the error and contact your system administrator. Sybase) The number specified must be > zero. Database name needs to be included with . `01 = System error code `02 = System error message (DG. (Red Brick) Could not connect to the specified datasource. UNIX) This is an error that should never occur during normal operations. (Sybase) Supply the database name. Cannot use both -U and db/user. maximum is `01. UNIX) This is an error that should never occur during normal operations. `01 = System error code `02 = System error message (Oracle. (`01): `02 005723 Error closing tty. The report name must be the first command line argument. Record the steps leading up to the error and contact your system administrator. Unknown printer type specified with PRINTER: switch. WP is valid only with PC/Windows. Reduce the number of -F switches. (Ingres) Supply the role information. (Ingres) Correct the command line. LP. `01 = System error code `02 = System error message (DG.DB switch. `01 = System error code `02 = System error message (DG. No program name given.DB switch. Correct the value. or WP. Database name needs to be included with . (`01): `02 (DG. (ODBC) Could not connect to the specified datasource. 005739 Too many -F switches.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005720 Error opening tty. (`01): `02 005722 Error reading tty. UNIX) This is an error that should never occur during normal operations. Record the steps leading up to the error and contact your system administrator.DB switch. (`01): `02 005724 005734 005735 005736 005737 005738 005738 Bad number in -B flag. 9-56 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The printer type can be EH. HP. -P requires an argument: role_id/role_password. The -Burst switch is not properly formatted.Printer:EH switch to be specified. Older SPF files do not contain the proper information that permits bursting. -DNT:Decimal precision (`01) is out of range (`02 .`04). `01 = Command line option 005745 The specified default numeric type '`01 = `02' is invalid. The “Burst” command line flag cannot be specified when the -NOLIS command line flag is also specified.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005740 -F and outfile name are required with DDN or DD style SQR {program} name. Attempting to use SQR {program} file for outfile. The “Burst” command line flag is applicable only when HTML code is produced.INI file entry. The “Burst” command line flag was specified with a set of page ranges that prevented any output to be created. `01 = Entry `02 = Value Correct the SQR. 005746 005747 The following error(s) occurred while processing the [`01] section from the SQR. Unknown numeric type specified with DNT: switch.1 and above.INI file. (MVS) Correct the JCL stream. Bad number in -`01 005750 005751 005752 005753 005754 005900 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-57 . The decimal precision '`01 = `02' is out of range (`03 . The -Burst switch caused no output to be generated.INI file entry. The -Burst switch requires either the Printer:HT or .Burst:T switches can only be used against an SPF file which was generated with SQR v4. The -Burst:S and . Change the page ranges. (Windows) Specify a valid number. (Windows) `01 = System error code Correct the command line. 005741 005742 005743 005744 (MVS) Correct the JCL stream. You must specify either the -PRINTER:HT or PRINTER:EH switch. error code = `01. The -Burst switch cannot be used with the -NOLIS switch. `01 = Name of the section The “Burst” command line flag is not properly formatted. `01 = Entry `02 = Value `03 = Minimum allowed `04 = Maximum allowed See the error message(s) that follow. Attempt to invoke viewer (using WinExec) failed. `01 = Specified precision `02 = Minimum allowed `03 = Maximum allowed Correct the SQR. Correct the command line.`03).1 and above. The “Burst” command line flag can only be specified when processing a SPF file that was generated by SQR v4. `01 = System error code `02 = System error message (Windows) Re-enter with a valid file name. Try to recreate the . `01 = Maximum number supported by this version of SQR. permissions). 9-58 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .File while processing the printer file.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 005901 005902 005903 Bad filename in -`01 Bad directory in -`01 Cannot access the @ parameter file (`01): `02 (Windows) Specify a valid file name.spf file. `01 = System error code `02 = System error message (Windows) To pass more than this number of arguments. maximum is `01. `01 = Command line option (Windows) Specify a valid directory path. Record the steps leading up to the error and contact your system administrator. (`01): `02 006002 Cannot open the printer file: `01 (`02): `03 006003 Unexpected End-Of. Record the steps leading up to the error and contact your system administrator. `01 = System error code `02 = System error message This is an error that can occur during normal operations due to the system environment (for example. (`01): `02 006001 Error reading the printer file. file locking. permissions). file locking. file locking. contact technical support. 005905 Cannot open the report file (`01): `02 005906 006000 Invalid filename entered. If the error persists. (Windows) Depends on the system error message. This is an error that can occur during normal operations due to the system environment (for example. `01 = Command line option (Windows) Depends on the system error message. `01 = System error code `02 = System error message This is an error that can occur during normal operations due to the system environment (for example. Error writing the printer file. use a @file argument file containing one argument per line. `01 = Name of the file `02 = System error code `03 = System error message Possibly the file is corrupted. 005904 The argument list is too long. permissions). Record the steps leading up to the error and contact your system administrator. 006108 006120 Correct the source code. Chart module is not initialized. Number of chart data. Record the steps leading up to the error and contact technical support. `01 = Chart name Correct the source code. `01 = Message code This is an internal error that should never occur during normal operations. The 3rd column in the data array must be a character column to specify USE3RD. Record the steps leading up to the error and contact technical support. Too many pie segments (`01).SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006004 Encountered unknown SPF code (`01) while reading the printer file. Invalid chart size or placement.DATA-COLUMN. Unknown chart (`01). INTERNAL: Bad chart index from stack (`01). 006103 006104 006105 006106 006107 XY charts may have only numeric columns. This is an internal error that should never occur during normal operations. If the error persists. Max is `02.array columns specified (`01) exceeds the number of array columns (`02). 006100 006101 006102 Duplicate chart (`01). Correct the syntax. `01 = Number of data-array rows `02 = Number of array rows Correct the source code. contact technical support. Possibly the file is corrupted. `01 = Chart name Chart could not be found.spf file. `01 = Number of data-array columns `02 = Number of array columns Correct the source code. Try to recreate the . `01 = Unknown SPF code Each chart must be given a unique name. 006122 INTERNAL: Unsupported Grafsman chart type (`01). Number of chart data. `01 = Number of segments `02 = Maximum allowed segments This is an error that should never occur during normal operations. `01 = Chart index This is an internal error that should never occur during normal operations. `01 = Chart type 006121 INTERNAL: Unknown SQRBGInterface message (`01). Record the steps leading up to the error and contact technical support.array rows specified (`01) exceeds the number of array rows (`02). PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-59 . Record the steps leading up to the error and contact technical support. Correct the syntax. `01 = Qualifier name 006124 INTERNAL: Unsupported tick-mark placement (`01). Duplicate image (`01). `01 = Placement value This is an error that should never occur during normal operations. `04) 006128 006140 006141 006142 Check coordinate values. `01 = Return code `02 = Message code Correct the source code. Correct the syntax. 006127 Cannot fit Chart/Image into the current page. `01 = Setting value This is an internal error that should never occur during normal operations. `01 = Image name Image name could not be found. SQR ends the program run. 006126 Unrecognized return code (`01) from Grafsman command message (`02). 9-60 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 006150 006200 006201 006202 006203 This report has already been defined. Record the steps leading up to the error and contact technical support. This is an internal error that should never occur during normal operations. Unknown image (`01). Each layout must be given a unique name. This printer has already been defined.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006123 INTERNAL: Unsupported pie-explode setting (`01). Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. `01 = Image name Each report must be given a unique name. The values for '01' must be > 0. `02) Size: (`03. Position: (`01. 006125 Grafsman interface message (`01) not supported. `01 = Row `02 = Column `03 = Width `04 = Depth Correct the syntax. Images must be given unique names. `01 = Image name `01 = Name of the file `02 = System error code `03 = System error message This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Each printer must be given a unique name. Record the steps leading up to the error and contact technical support. Cannot open image file (`01). `01 = Message code This is an error that should never occur during normal operations. This layout has already been defined. (`02): `03 INTERNAL: Bad image index from stack (`01). Qualifier '01' is not applicable with a 'default' printer. No printer name was specified.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006204 Qualifiers '01' and '02' are mutually exclusive. No report name was specified. Correct the syntax. Correct the syntax. Correct the syntax. `01 = Qualifier name Correct the syntax. Correct the syntax. or column. `01 = Report name Correct the syntax. 'ALL' must be specified by itself. Referenced layouts not defined: Referenced reports not defined: Referenced printers not defined: The following SQR commands (listed below) cannot be used when any of the following NEW SQR commands are also used in the same report: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-61 .<=. The value for '01' must be ‘02 0. Correct the syntax. `01 = Report name A list of undefined layouts follows this message. Correct the syntax. Correct the syntax. No layout name was specified. `01 = Qualifier name `02 = Printer type Correct the syntax. The report name can be a string literal. A list of undefined printers follows this message. 006205 006206 006207 006208 006209 006210 006211 006212 006213 006214 006215 006216 006217 006218 006219 006220 006221 Report '01' does not exist. `01 = Qualifier name `02 = Qualifier name Correct the syntax. The name cannot be 'ALL'.=. Qualifier '01' is not allowed with a '02' printer. Correct the syntax. `01 = Qualifier name `02 = Relation to zero (<. The list must contain report names or ALL. A list of undefined reports follows this message.>=. The name can only contain characters [0-9 A-Z _ -]. `01 = Report name `02 = Printer type Correct the syntax. Report '01' is referenced by multiple '`02' printers.>) Correct the syntax. variable. Correct the syntax. Parameter (`01) is required. A list of valid printer types follows this message. `01 command not allowed while generating the Table of Contents. A: Line = `01. `01 = SQR command `02 = Procedure name Correct the syntax. Level = `05. `01 = A: Line number `02 = A: Level value `03 = A: Text value `04 = B: Line number `05 = B: Level value `06 = B: Text value Correct the syntax. A list of undefined Table of Contents follows this message. `01 = Specified LEVEL= value `02 = Current INDENTATION= value The specified command cannot be used while the Table of Contents is being generated. The TOC (Table Of Contents) entry cannot be positioned given the LEVEL (`01) and INDENTATION (`02) values. The list must contain TOC (Table of Contents) names or ALL. Text = '`06' Correct the syntax. Invalid option (`02) for parameter (`01). `01 = Parameter name `02 = Option Correct the syntax. `01 = SQR command Correct the program logic to eliminate the conflict between the two TOC (Table of Contents) entries. The TOC (Table of Contents) entry "A" cannot be processed because the existing entry "B" is positioned below it. but has not been specified. Each Table of Contents must be given a unique name. A list of valid predefined paper-size names follows this message. Correct the syntax. Incorrect value for 'paper-size'. Correct the syntax. 006303 9-62 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Level = `02. The Table of Contents entry will not fit given the specified level and current indentation values. `01 = Parameter name Correct the syntax. Valid values are: Attempt to execute the `01 command while processing the `02 procedure. Value not valid for parameter (`01). Incorrect value for printer type. Specify the actual dimensions or one of the following names: Referenced TOC (Table Of Contents) not defined: This TOC (Table Of Contents) has already been defined. `01 = Parameter name Correct the syntax. Text = '`03' B: Line = `04. SQR ends the program run. `01 = Parameter name 006227 006228 006229 006230 006231 006232 006233 006300 006301 006302 Unknown parameter (`01).SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006224 006225 006226 No printer type was specified. Parameter (`01) does not support &columns. `01 = Parameter name Correct the syntax. Parameter (`01) requires valid numeric value. Parameter (`01) requires equal sign. Record the steps leading up to the error and contact technical support. `01 = Parameter name Correct the syntax. Conversion [ (`01) to (`02) ] is not supported. `01 = Parameter name Correct the syntax. `01 = Parameter name Correct the syntax. `01 = Parameter name Correct the syntax. Parameter (`01) does not accept 'AUTOSCALE' in this context. Parameter (`01) requires proper object name. Parameter (`01) requires integer value. Perhaps quote or $ is missing. `01 = Parameter name This is an internal error that should never occur during normal operations. `01 = Parameter name Correct the syntax. `01 = Parameter name Correct the syntax. Correct the syntax. `01 = Parameter name Correct the syntax. Parameter (`01) requires valid string. `01 = From type `02 = To type 006315 006316 006317 006318 006320 006350 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-63 . `01 = Parameter name Correct the syntax. `01 = Parameter name Correct the syntax. Parameter (`01) does not support relative values. `01 = Parameter name Correct the syntax. Parameter (`01) requires literal.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006304 006305 006306 006307 006308 006309 006310 006311 006312 006313 006314 Parameter (`01) already specified. Missing part of specification for parameter (`01). `01 = Parameter name Correct the syntax. Parameter (`01) does not support type supplied. `01 = Parameter name Correct the syntax. `01 = Parameter name Correct the syntax. `01 = Parameter name Correct the syntax. Parameter (`01) does not accept 'NONE' in this context. Parameter (`01) has improper value list. Parameter (`01) has an unquoted string. Parameter (`01) requires array name. `01 = Data type This is an internal error that should never occur during normal operations. `01 = Option/request code `02 = Function name This is an internal error that should never occur during normal operations. `01 = Parameter name `02 = Data type This is an internal error that should never occur during normal operations. `01 = String to decode This is an internal error that should never occur during normal operations. 006360 INTERNAL: Unknown program state (`01). `01 = Parameter name `02 = Value This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. (`01). Record the steps leading up to the error and contact technical support.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006352 INTERNAL: Unsupported option/request (`01) in (`02). 006355 INTERNAL: Unable to retrieve parameter value. Record the steps leading up to the error and contact technical support. `01 = Data location `02 = Data type This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. `01 = State 006354 INTERNAL: Unknown data type. (`01). `01 = Parameter name This is an internal error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 006357 INTERNAL: Data location (`02) not valid for data type (`01). 006359 INTERNAL: Cannot set bit value (`02) for parameter (`01). Record the steps leading up to the error and contact technical support. 9-64 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 006358 INTERNAL: Cannot decode string (`01) to index. This is an internal error that should never occur during normal operations. 006356 INTERNAL: Data type (`02) not valid for parameter (`01). Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006400 Unsupported background color. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 006408 Unsupported font style. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. 006410 Unsupported horizontal text justification value. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Unsupported font path. 006405 X size out of range. 006404 Y position out of range. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 006409 Unsupported font color. 006406 Y size out of range. 006407 Unsupported font. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-65 . 006401 Unsupported border color. 006402 Border width out of range. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. 006411 006412 006413 Unsupported font rotation. Unsupported vertical text justification value. 006403 X position out of range. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 006416 Unsupported chart type. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 9-66 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Unsupported axis (not X or Y). This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. 006423 Unsupported dataset type. 006424 Unsupported dataset color. 006427 Unsupported dataset marker. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. 006415 Text line id# out of range. 006422 Dataset id# out of range. 006419 006420 006421 Unsupported axis label data type. 006418 Unsupported chart orientation (not H or V). Record the steps leading up to the error and contact technical support. Unsupported perspective (not 2D or 3D). This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006414 Font size out of range. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 006426 Unsupported dataset fill pattern. 006425 Unsupported dataset line style. Record the steps leading up to the error and contact technical support. 006417 Unsupported chart sub-type. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Unsupported pie. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. 006437 Unsupported pie-chart fill direction. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. 006438 006439 006440 006441 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-67 .segment border color. This is an error that should never occur during normal operations. Pie-chart radius out of range. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support.segment explode setting. Record the steps leading up to the error and contact technical support. Unsupported pie. Record the steps leading up to the error and contact technical support. 006432 006433 Unsupported pie. This is an error that should never occur during normal operations. Unsupported pie.segment label position. Record the steps leading up to the error and contact technical support. 006434 006435 006436 Pie-chart starting angle out of range. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Unsupported pie. Record the steps leading up to the error and contact technical support.segment quantity display position. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Command only valid for charts of type 'pie'. This is an error that should never occur during normal operations.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006428 Chart type does not support Y-axis datasets. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support.segment color. Unsupported legend style.segment per-cent display position. Pie-chart segment id# is out of range. 006429 006430 Unsupported pie.segment pattern. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. 006431 Unsupported pie. Must be clockwise or counterclockwise. 006452 Beginning of tickmarks is after end. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. 006445 Number of datasets specified does not match data. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006442 Unsupported legend horizontal position. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 9-68 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. 006451 Unsupported axis max scaling. 006454 Unsupported grid type. This is an error that should never occur during normal operations. 006453 Unsupported tickmark type. This is an error that should never occur during normal operations. 006448 006449 006450 Unsupported axis max scaling. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. 006443 006444 Text charts do not support legend. This is an error that should never occur during normal operations. 006455 Unsupported grid color. Unsupported axis label position. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. Pie and text charts do not support axis control. Unsupported axis min scaling. This is an error that should never occur during normal operations. 006446 006447 Unsupported axis type (not LINEAR or LOG). Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Unsupported legend vertical position. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. The bar code could not be positioned on the page. `01 = BCL error code Correct the source code. This is an error that should never occur during normal operations. Correct the source code.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006456 Grid line width out of range. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. 006460 Unable to open chart output destination. Correct the source code. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. A function called from the shared library specified in the grafcap file could not be found. This is an error that should never occur during normal operations. 006464 006500 006501 006502 006503 Invalid bar code type (`01): Valid values are from 1 to 15. `01 = Bar code text Correct the source code. 006504 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-69 . 006458 Unsupported grafcap device. 006461 006462 Improper parameters passed to gscale. The length of the bar code text ‘01' must be between 1 and 30 characters. The length of the caption text '01' must be between 1 and 30 characters. Height: `03 Unknown BCL error (`01) encountered. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. This is an error that should never occur during normal operations. This is an error that should never occur during normal operations. `01 = Row `02 = Column `03 = Height This is an error that should never occur during normal operations. Row: `01. Column: `02. 006463 The shared library specified in the grafcap file could not be found. This is an error that should never occur during normal operations. Record the steps leading up to the error and contact technical support. `01 = Caption text 006457 Unable to open grafcap file. Internal error during ggDraw. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. `01 = Bar code type. This is an error that should never occur during normal operations. 006459 Error in grafcap entry specification. Record the steps leading up to the error and contact technical support. Record the steps leading up to the error and contact technical support. Invalid pass: Valid values are from 1 to 6. The bar code text '01' is not valid for the type of bar code (`02) selected. Record the steps leading up to the error and contact your system administrator. Record the steps leading up to the error and contact technical support. 006511 006512 006601 006602 Failed to start printing the document. Record the steps leading up to the error and contact technical support. (Windows) This is an error that can occur due to lack of system resources. This is an error that should never occur during normal operations.1 to 2.0 inches. Cannot allocate the device context for the default printer. `01 = Height Correct the source code. `01 = Bar code text `02 = Bar code type This is an error that should never occur during normal operations. Correct the source code. Record the steps leading up to the error and contact your system administrator. Invalid checksum: Valid values are from 0 to 2. Internal error: Could not generate the bar code. 006605 End document failed. Correct the source code. Invalid offset: Valid values are from 0 to 250. 9-70 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur due to lack of system resources or a problem with the printer.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006505 006506 006507 006508 006509 006510 Invalid printer type (`01): Valid values are from 0 to 13. 006604 New-page (end) failed on page `01. `01 = Printer type Correct the source code. Record the steps leading up to the error and contact your system administrator. Internal error: Bar code buffer required too large (>32K). Invalid height (`01): Valid values are from 0. Record the steps leading up to the error and contact your system administrator. `01 = Page number (Windows) This is an error that can occur due to lack of system resources or a problem with the printer. (Windows) This is an error that can occur due to lack of system resources or a problem with the printer. Correct the source code. Correct the source code. 006603 New-page (start) failed on page `01. `01 = Page number (Windows) This is an error that can occur due to lack of system resources or a problem with the printer. Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur due to lack of system resources. Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur due to lack of system resources. `01 = Name of the file `02 = System error code `03 = System error message (Windows) Specify a valid bitmap file.INI. Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur during normal operations due to the system environment (file locking. Failed to create a brush for shading. `01 = Name of the file 006607 006608 Failed to select font `01. 006610 Failed to create a pen that was required to draw a box. Failed to create the palette for image (`01). Record the steps leading up to the error and contact your system administrator. Record the steps leading up to the error and contact your system administrator. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-71 . 006611 Failed to create a pen that was required to draw a horizontal line. 006609 Failed to modify font `01. `01 = Name of the file (Windows) This is an error that can occur due to lack of system resources or an invalid bitmap.INI file. `01 = Font name (Windows) This is an error that can occur due to lack of system resources. Record the steps leading up to the error and contact your system administrator. permissions). Record the steps leading up to the error and contact your system administrator.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006606 Error reading font information from the [Fonts] section in SQR. (Windows) This is an error that can occur due to lack of system resources. `01 = Font name (Windows) This is an error that can occur due to lack of system resources. Record the steps leading up to the error and contact your system administrator. 006613 Failed to open the image bitmap file (`01). (`02): `03 006614 006615 The file (`01) does not contain a valid bitmap. (Windows) Correct the [Fonts] section in the SQR. 006612 Failed to create a pen that was required to draw a vertical line. (Windows) This is an error that can occur due to lack of system resources. Using the default font. (Windows) This is an error that can occur due to lack of system resources. Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur due to lack of system resources. `01 = Name of the file (Windows) This is an error that can occur due to lack of system resources or a problem with the printer. (Windows) This is an error that can occur due to lack of system resources. Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur due to lack of system resources or a problem with the printer. Record the steps leading up to the error and contact your system administrator. `01 = Name of the file (Windows) This is an error that can occur due to lack of system resources. 006617 Failed to convert DIB to DDB for image (`01). Record the steps leading up to the error and contact your system administrator. Record the steps leading up to the error and contact your system administrator. (Windows) This is an error that can occur due to lack of system resources. (Windows) This is an error that can occur due to lack of system resources. 006622 Cannot create a region required for business graphics. 006620 Cannot select the charting clip area onto the printers DC. 006618 Failed to draw the bitmap image (`01). (Windows) This is an error that can occur due to lack of system resources. `01 = Name of the file (Windows) This is an error that can occur due to lack of system resources. Record the steps leading up to the error and contact your system administrator. 006619 Cannot access the default printer's driver. 006623 Cannot create a DC required for business graphics. 006625 Business graphics failed while setting up the device (ggWinDevice).SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006616 Failed to load RLE into memory for image (`01). Record the steps leading up to the error and contact your system administrator. Record the steps leading up to the error and contact your system administrator. 9-72 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 006621 Cannot select create a metafile required for business graphics. Record the steps leading up to the error and contact your system administrator. 006624 Cannot create a bitmap required for business graphics. Record the steps leading up to the error and contact your system administrator. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006626 Cannot draw business graphics. `01 = Name of the file (Windows) This is an internal error which should not occur under normal operations. 006706 Failed to identify the start of the report (`01). (Windows) The variable SQRDIR must be defined in the SQR. and so on. `01 = Page number (Windows) This is an error that can occur due to lack of system resources. `01 = Name of the file (Windows) The file was not produced by SQR or it has been corrupted. (Windows) This is an error that should never occur during normal operations.INI file. (Windows) This is an error that can occur due to lack of system resources or it can be due to a damaged LIBSTI. An invalid seek was made for page `01. The LIBSTI. Please contact technical support.INI file resides in the Windows main directory. Record the steps leading up to the error and contact your system administrator. Make sure that the GPATH= and IPT= entries point to a valid SQR BINW directory. (Windows) This is an error that can occur due to lack of system resources.INI file. 006700 006701 SQRDIR is not defined. Record the steps leading up to the error and contact technical support. file locking. Could not allocate memory while attempting to register the .spf filename extension. Could not allocate memory for the page cache. Record the steps leading up to the error and contact your system administrator.). 006702 006704 Cannot open or read file (`01) (`02): `03 006705 File (`01) is not in SPF packet format. `01 = Name of the file `02 = System error code `03 = System error message (Windows) The file was not produced by SQR or it has been corrupted. 006707 006708 Too many errors were encountered while processing the file. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-73 . Record the steps leading up to the error and contact your system administrator. permissions. (Windows) This is an error that can occur during normal operations due to the system environment (for example. Processing has been stopped. Record the steps leading up to the error and contact your system administrator. 006803 `01: Decimal to Integer Conversion Under/Overflow. Check the magnitude and sign of the decimal object to ensure that it falls within the upper and lower bounds of a floating point number. `01 = Name of the routine This is an internal error that should never occur during normal operation. 006802 `01: Decimal Exponent Under/Overflow. `01 = Name of the routine Integer Under/Overflow: Cannot convert input decimal object into a valid integer number. Record the steps leading up to the error and contact technical support. Check the documentation for the current upper and lower bounds of a decimal object. (`02): `03 This message is displayed only once per SPF file. Record the steps leading up to the error and contact technical support. permissions. Check the magnitude and sign of the decimal object to ensure that it falls within the upper and lower bounds of an integer number.). 9-74 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Decimal object exceeds the established floating point boundaries for this machine architecture. `01 = Name of the routine Exponent Under/Overflow: Exponent of decimal number has exceeded the valid boundaries established for the decimal type. 006801 `01: Null Operand Passed as input. file locking. 006804 `01: Decimal to Float Conversion Under/Overflow. Decimal object exceeds the established integer boundaries for this machine architecture. `01 = Name of the routine 006800 `01: Detected internal program error.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006709 Failed to open the image bitmap file (`01). and so on. `01 = Name of the file `02 = System error code `03 = System error message This is an internal error that should never occur during normal operation. (Windows) This is an error that can occur during normal operations due to the system environment (for example. Record the steps leading up to the error and contact your system administrator. `01 = Name of the routine Floating Point Under/Overflow: Cannot convert input decimal object into a valid floating point number. `01 = Name of the routine String To Decimal Conversion Error: Length of input string is greater than precision of underlying decimal object. `01 = Name of the routine (Windows) SQR Print requires that a default printer be defined. Decimal Precision Under/Overflow: Attempt made to initialize decimal object with an invalid precision. `01 = Qualifier `02 = Number of entities in list Correct the source code. The values for '01' and '02' cannot be the same. Check the input precision value against the documented upper and lower boundaries for a decimal object. Please ensure that the truncation/round value is greater than or equal to zero and less than the precision of the underlying decimal object. The value for '01' must be a list of 02 string literals. 006900 There is no default printer set up on your system. 007000 007001 007002 007003 007004 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-75 .INI file. At least one qualifier must be specified.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 006805 `01: Decimal Precision Under/Overflow. The locale '`01' is not defined in the SQR. Either increase the precision of the decimal object or reduce the size of the input mantissa to match the decimal object precision. Please check divisor to ensure that it does not equal zero before attempting to divide. `01 = Locale name Correct the source code. Use the "Printers" applet in the Control Panel to define one. variables or columns. `01 = Qualifier `02 = Qualifier Correct the source code. 006808 `01: Decimal Error: Cannot Divide by Zero. 006807 `01: Truncation/Rounding Error Outside Valid Range for Decimal Object. `01 = Qualifier `02 = Value `03 = List of invalid characters 006806 `01: String to Decimal Object Conversion Error. Correct the source code.INI file. `01 = Name of the routine Truncation/Rounding Error: Input truncation or round value is outside the valid range for this decimal object. Check for a misspelled locale name and/or the SQR. `01 = Name of the routine Decimal Math Divide by Zero Error: Attempt made to divide a decimal object by zero. Use the Control Panel "Printers" applet to define it. The value for '01' (`02) must be a single character which is not in the list: "03". The default locale (`01) specified in the [`02] section of the SQR. 007100 The use of an edit mask or the keywords NUMBER. The value for '`01' (`02) is not properly formatted: Did not find the '>' for the '<nnn>' construct. Correct the source code. `01 = Qualifier `02 = Value `03 = Number of entities in list Correct the SQR. `01 = Qualifier `02 = Value Correct the syntax. MONEY or DATE is not legal when storing numeric variables. `01 = Qualifier from the SQR. `01 = Keyword `02 = Variable name 9-76 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .INI entry. `01 = Qualifier `02 = Invalid character Correct the source code. The value for '`01' cannot be 'DEFAULT' or 'SYSTEM'.INI file. Valid values are: The last character of the '`01' value (`02) cannot be a digit or the minus sign or the same as either of the separators. The last keyword is not '`01'. `01 = Qualifier `02 = Invalid character This message precedes error messages encountered while processing the SQR.INI file `02 = Qualifier's value Correct the source code. The keyword (`01) is not compatible with the variable (`02).INI file. `01 = Qualifier `02 = Value Correct the syntax. The first character of the '`01' value (`02) cannot be a digit or the minus sign or the same as either of the separators. `01 = Qualifier Correct the syntax. `01 = Qualifier `02 = Value Correct the source code. Correct the source code. `01 = Locale name `02 = Section name Correct the syntax. Incompatible source and destination variable types. The following errors occurred while processing the (`01) locale from the SQR.INI file has not been defined. The value for '`01' (`02) is not properly formatted: The value of an '<nnn>' construct must be from 1 to 255. 007101 007102 007103 Correct the source code. The value for '`01' (`02) must be a list of `03 quoted string literals. 007006 007007 00700 007009 007010 007011 007012 007013 007014 The entry (`01 = `02) is not valid. `01 = Locale name Correct the syntax. `01 = Keyword Correct the source code.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007005 The value for '`01' (`02) is invalid. This command is only allowed within local procedures. `01 = ENCODING environment variable setting. The specified encoding scheme is not known by SQR. `01 = Variable name Correct the source code. The SQT file contains a reference to a LET function. 007202 007203 007204 007205 007206 007207 007208 007209 007210 007211 007400 007401 007402 The Double-Byte LET function '`01' is not supported in this version of SQR.`03). 007200 Correct the source code. `01 = Specified precision `02 = Minimum precision `03 = Maximum precision Correct the source code. You cannot declare a global variable from within a procedure. Correct the source code. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-77 . Only string ($) and numeric (#) variables may be declared. The specified precision (`01) is out of range (`02 . '`01' is not a valid value for the ENCODING environment variable. Correct the source code. This command must be before all other commands in the procedure. A string variable name is required here.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007104 The use of an edit mask or the keyword DATE is not legal if both variables are date variables. `01 = LET function name 007201 The precision is specified by a value from `01 to `02 surrounded by parentheses. Correct the source code. Correct the source code. Correct the program logic. Correct the source code. `01 = Minimum precision `02 = Maximum precision Correct the source code. which is not supported by this version of SQR. Variable (`01) is not a decimal variable and cannot have a precision associated with it. The variable (`01) has already been defined as '`02' and may not be redefined. Correct the source code. The variable type has not been specified. Correct the source code. `01 = Variable name `02 = Variable type Correct the source code. Correct the source code. A numeric variable name is required here. Invalid variable name specified. The specified character is invalid in the current character set. ) Invalid entry for keyword. `01 = SQR command name The runtime file was created by the DoubleByte version of SQR and is incompatible with the current version. PDF functionality is not available on this platform.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007403 The Double-Byte SQR command '`01' is not supported in this version of SQR.byte characters. Must specify a SCHEMA. Using `01 edit mask from (`02) against (`03) 007405 007501 007601 Cannot access the Java file (`01) (`02): `03 007602 -EH_Scale: value (`01) is out of range (`02 . Correct the source code. `01 = Specified scale `02 = Minimum allowed `03 = Maximum allowed Enhanced HTML functionality is not available on this platform. which is not supported by this version of SQR. The barcode text '`01' cannot contain double. This warning message can be turned off by setting the “OutputTwoDigitYearWarningMsg” entry int the [DefaultSettings] section of the SQR. -Printer:PD functionality is not available on this platform. 9-78 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Must specify either a PROCEDURE. Correct the source code. 007704 007705 007706 Correct the source code.`03). `01 = Edit mask element `02 = Edit mask being used `03 = Value being applied to the edit mask SQR cannot access the required file. Correct the source code. or GETDATA=. exclusive. CONNECTION '`01' not found. 007404 Double-Byte . Correct the source code. `01 = BEGIN-command in question.INI file to FALSE.sqt files are not supported by this version of SQR. `01 = Bar code text A date edit mask element was detected which could cause date data to be incorrectly interpreted. '`01=`02' May only specify either PROCEDURE=. Correct the source code. COMMAND. Did not find end of paragraph: `01 (No 'end-execute' clause found. 007603 007604 007701 007702 007703 -Printer:EH functionality is not available on this platform. Correct the source code. or GETDATA. `01 = Name of the file `02 = System error code `03 = System error message Correct the command line. or COMMAND=. No such connection. The SQT file contains a reference to an SQR command. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007707 The returned set of Procedure parameters (INOUT and OUT) (length = `01 items) did not include one or more of the specified items. Encountered a parameter of type '`01'. Valid types are either IN, OUT, or INOUT. If no type is entered, the type defaults to IN. The datasource failed to provide the expected return status value. Verify the query metadata. The datasource failed to provide the expected number of elements in the return status list. Failed to login to the requested datasource (Connection='`01', username='`02'). DETAILS: `03 The requested rowset (`01) was not available. Verify the query metadata. Missing or invalid Registry.properties file. Verify that the CLASSPATH includes SQRDIR, that SQRDIR contains the folder with the Registry.properties file, and that the Registry.properties file is valid. The datasource ('`01') does not support the requested capability ('`02'). Check the capabilities list for the datasource, located in the Properties folder. Failed to start the Java Virtual Machine (JVM). Possible causes are: missing or invalid jdk files, incorrect CLASSPATH, or insufficient resources. The current rowset (`01) contained no rows. Check the return status and/or metadata for the requested service to determine the cause. The query failed. DETAILS: `01 Failure setting property '`01'. DETAILS: `02 The value for keyword '`01' exceeds the maximum length of '02 characters. Stored procedure error. 007708 Stored procedure error. 007709 Datasource error. 007710 Datasource error. 007711 Logon failed. 007712 007713 Not enough rowsets. Incorrect environment setup. 007714 Invalid query for datasource. 007715 Incorrect environment setup. 007716 No data. 007717 007718 007719 Query failed. Property-set failed. Keyword value too long. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-79 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007720 A fatal error occurred while fetching against the current rowset: DETAILS: `01 Parameter `01 (`02) was passed to the PROCEDURE as data type `03; expected (`04) type `05. Verify the query metadata. Invalid query parameter: Reason: `01 Too many parameters (= `01) were supplied to the query. Verify the query metadata. Parameter `01 (`02) was passed to the PROCEDURE as type `03; expected type `04. Verify the query metadata. Parameter `01 ('`02', JDO-type `03), specified 'NULL', is a requiredparameter. Specify a value or variable name. The list-variable parameter to the query is too long. Maximum number of elements is 30. Unable to retrieve metadata for Procedure=`01, Schema=`02. DETAILS: `03 Parameter list type mismatch (#`01, SQR type = `02). The datasource expected a parameter of type `03. Verify the query metadata. List size mismatch detected while fetching data of type ROW, `01 items, into SQR list- variable, `02 items. Fetching will proceed to the smaller size. Incorrect syntax for BEGIN-SELECT ... FROM. Options are: FROM ROWSETS=... FROM PARAMETER= $strvar | strlit A failure occurred during row fetch. 007721 A failure occurred during row fetch. 007722 007723 Bad procedure parameter. Bad procedure parameter. 007724 Bad procedure parameter. 007725 Bad procedure parameter. 007726 List too long. 007727 007728 Metadata check failed. Parameter list mismatch. 007729 List size mismatch. 007730 Bad begin-select syntax. 007731 Attempted to pass as INOUT or OUT a parameter which was of type ROWSET (`01). Use of such parameters is supported as IN only, after which they may be used in a BEGIN- SELECT construct. Bad parameter keyword. 9-80 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007732 Attempt to use a scalar SQR variable ('01') to reference a ROWSET procedure parameter ('02'). Use either the keyword 'NULL', or an SQR LIST variable (%var). Verify the query metadata. The list of keywords entered to the PARAMETERS keyword must be terminated with a semicolon. Datasource '01' not found. The Connection being used by this query specifies a datasource which is not listed in the DDO Registry ('02'). DETAILS: `03. Missing one or more DDO {fname} .jar files. Verify the location of the original- installation files, and that they are accessible. Error code: `01. Classpath: `02. Unable to open Connection ('01') to datasource ('02'). Possible causes: (a) the Declare- or Alter-connection specification is invalid, or (b) the datasource is no longer available. DETAILS: `03. Unable to locate one or more entry points in an SQR {fname}.jar file. Verify that the original-installation files have not become corrupted. At least one JNI method pointer was lost. This should never occur: record the steps leading up to this failure, and contact Technical Support. DETAILS: Schema='`01', Proc='`02'. Unable to locate query object '`01' in the specified schema (`02). DETAILS: `03. Invalid &pseudonym or 'TYPE=' datatype specified for a begin- select column-variable. Valid types are: CHAR, TEXT, DATE, NUMBER. Illegal attempt to fetch a non-scalar field into a column variable. Correct the query. Bad proc parameter. 007733 Bad proc parameter. Correct the source code. 007734 Bad proc parameter. Correct the source code. 007735 Bad environment. 007736 Bad environment. 007737 Bad environment. 007738 Bad environment. 007739 Bad environment. 007740 Correct the syntax. 007741 Correct the syntax. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-81 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007742 The output parameter specified in 'Begin- Select ... From Parameter = `01' is not available. Available parameters: `02. The output parameter specified in 'Begin- Select ... From Parameter = `01' is not of type ROWSET. Verify the query metadata. Illegal attempt to assign an SQR variable ('01') of type '02' the value from a DDO object ('03') of type '04'. Verify the query metadata. Illegal attempt to assign an SQR column variable ('01') of type '02' the value from a DDO object of type '03'. Verify the query metadata. Failed to locate the requested Rowset (`01) while processing the query. The last available Rowset number is `02. Verify the query metadata. The query raised a DDO exception. DETAILS: `01. A BEGIN-SELECT paragraph was coded, but the query returned no Rows. Invalid syntax for PARAMETERS=(...) statement. Use: PARAMETERS=( %v | $v | #v | &v | NULL | SKIP | numlit | datelit | textlit [IN | INOUT], ...) All parameters must be specified. Optional parameters which are to be ignored may be specified by the keyword 'NULL' or 'SKIP'. Correct the syntax. FATAL: Failure creating Java object. Attempt to create a List variable of size greater than the maximum size of `01 items. Parameter-list item '`01' is not a member of the parameter list for this Query. Verify the query metadata. Attempt to access List- row (`01) beyond the List size (`02 rows). Bad command. 007743 Bad command. 007744 Bad var assignment. 007745 Bad var assignment. 007746 Not enough RowSets. 007747 007748 007749 Bad query. No data warning. Incorrect syntax. 007750 007751 General failure. General failure. 007752 No such input/inout parameter. 007753 Bad list assignment/setup. 9-82 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007754 007755 Attempt to assign/modify a List row is not compatible with the List definition. Attempt to assign a row to a nonexistant List variable. Define the List first, using the syntax: let %lname[ size ] = list( NUMBER | DATE | TEXT #var | $var [, ...] ) Incorrect syntax for List-variable reference. Use: let [$ | #]var = %listname[nlit | #var].colname Alter-connection statement missing 'DSN=...'. List-definition size specifier must be literal. Attempt to access a non-existent Listcolumn ('01'). Must specify one of the keywords, FROM- ROWSETS or FROM_PARAMETER . Incorrect syntax to Load-lookup 'PARAMETERS=' keyword. Use: PARAMETERS=(slit | nlit | $var | #var | %var | &var, ...) No line wrapping is allowed for this usage. Too many parameters ( `02) entered to Load- Lookup command. Max parameters is `01. Problem executing the cursor for LOAD- LOOKUP table '`01'. DETAILS: `02. Bad return fetching row from database in LOAD-LOOKUP table '`01'. DETAILS: `02 DC, DI sort options not supported with this SQR version. To sort, use SORT=SC or SORT=SI. Must specify a query keyword; PROCEDURE=, COMMAND= or GETDATA=. Unknown column variable type. Bad list assignment/setup. Bad list assignment/setup. 007756 Bad list assignment/setup. 007757 007758 007759 007760 Improper alter-conn. Improper alter-conn. No such list column name. Incorrect syntax for Load-lookup. 007761 Incorrect syntax for Load-lookup. 007762 Incorrect syntax for Load-lookup. 007763 The database server returned an error while trying to execute the SQL statement needed to process the LOAD-LOOKUP command. `01 = Load lookup table name The database server returned an error while fetching the data. `01 = Load lookup table name Database sort not supported for Load- Lookup with DDO. Incorrect syntax for Load-lookup. Specify a keyword representing the query. Unknown data type returned by the server. 007764 007765 007766 007767 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL UNDERSTANDING SQR MESSAGES 9-83 SQR FOR PEOPLESOFT LANGUAGE REFERENCE Error Number Error Message Suggestion/Interpretation 007768 The property `01` was not found in the property sheet for the specified datasource (`02). Available property names are: `03.The datasource property sheet does not include the named property. The specified CONNECTION ('01') references a datasource whose property sheet does not show support for the Get-Data query method.The datasource property sheet does not show support for Get-Data. Attempt to create a Selector (or MDSelector) object failed. This event should not occur. Contact your system administrator. Verify the metadata and correct the syntax. 007769 Verify the metadata and property sheet and correct the syntax. 007770 Failed to create the requested object. Contact your system administrator. 9-84 UNDERSTANDING SQR MESSAGES PEOPLESOFT PROPRIETARY AND CONFIDENTIAL Glossary The terms in this glossary are used among multiple Financials and Supply Chain Management applications. Numbers 401(a)(17) Limits The limitations on the earnings that may be included in the calculation of benefits under qualified U.S. pension plans. 1st Year Amount In PeopleSoft Workforce Analytics, 1st Year Amount is an employee-level compensation amount, totaling the calculations for the first calendar year’s worth of accounting periods, in a compensation scenario. A Abend Abnormal End (to a process). ABM (Activity-Based Management) See PeopleSoft Activity-Based Management. ABPS (Activity-Based Planning and Simulation) See Activity-Based Planning and Simulation. Absence An absence occurs when an employee is not at work (absent) during a normally scheduled work period. Absences may be scheduled or non-scheduled, compensated or uncompensated, excused or unexcused. An absence may occur for a variety of reasons like illness, family emergency, civic obligations (e.g. Military duty or jury duty), or vacation. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 1 GLOSSARY Absence Entitlement Element which defines the rules for granting paid time off for valid absences, such as sick time, vacation, and maternity leave. An absence entitlement element defines the entitlement amount, frequency, and entitlement period. Absence Take Element which defines the conditions that must be met before a payee is entitled to take paid time off. Accepted Exception An exception that has been reviewed and validated (see Time Management). Accommodations Accommodations are efforts your organization is able to make for employees or applicants with disabilities, such as purchasing special equipment or making structural changes to a work environment. Account Management In PeopleSoft Demand Planning, a feature that enables you to divide a centrally held corporate forecast into multiple subsections for easier maintenance and management. These subsections are separate databases that can be distributed to account managers for use and updates, then rejoined with the main database at a later date. Account A code for recording and summarizing financial transactions as expenditures, revenues, assets, or liabilities balances. This is a delivered PeopleSoft ChartField, specific use of which is typically defined by the organization during implementation of PeopleSoft General Ledger. Account Type A name for one of the different kinds of accounts used in a PeopleSoft General Ledger, such as Asset, Liability, Equity, Revenue, and Expense. Accounting Class In PeopleSoft Enterprise Performance Management, an attribute that defines how the particular resource would be treated for generally accepted accounting practices. Inventory denotes whether a Resource will become part of a balance sheet account such as inventory or fixed assets, while Non-inventory denotes that the Resource will be treated as an expense of the period during which it occurs. Accounting Date The date that a transaction is recognized as opposed to the date the transaction actually occurred—the Transaction Date (although the two dates can be the same). The accounting date determines the period in the general ledger to which the transaction is to be posted. You GLOSSARY 2 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY can only select an accounting date that falls within an open period in the ledger to which you are posting. The accounting date for an item is normally the invoice date. In PeopleSoft Asset Management, the difference between accounting date and transaction date determines whether prior period depreciation must be calculated, and how much. Accounting Date must be later than or equal to Transaction Date. Accounting Entry A set of related debits and credits. An Accounting Entry is made up of multiple Accounting Lines. In most PeopleSoft applications, accounting entries are always balanced (debits = credits). Accounting entries are created to record accruals, payments, payment cancellations, manual closures, project activities in general ledger, and so forth (depending on the application). Accounting Entry Template A user-defined table that controls the use of system-generated accounting lines in the posting processes. Accounting Split Method indicating how expenses are allocated or divided among one or more sets of accounting ChartFields. Accredited Education Education above the high school level completed in a U.S. college, university, or other educational institution that has been credited by one of the accrediting agencies or associations recognized by the Secretary, U.S. Department of Education. Accrual Any hours that employees accumulate for use at another time in the form of earned vacation time or sick leave, for example. Accrual Basis Accounting Accounting that records the impact of a business event as it occurs, regardless of whether the transaction affected cash. Accrual Class Codes Classes or categories of accruals. Accrual Type Defines an accrual such as annual leave or sick leave. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 3 GLOSSARY Accumulate Demand In PeopleSoft Demand Planning, a transfer process function that adds demand quantities for an item to any quantities that already exist for the period. Accumulator Element which allows you to combine several elements. For example, an accumulator could consist of all voluntary deductions, or all company deductions, enabling you to accumulate amounts. It allows total flexibility for time periods and values accumulated. See also Time Administration. Accumulator [Global Payroll] Element which provides a means for storing the cumulative values of defined items as they are processed. As you make payments, take deductions, and perform calculations, you’ll use accumulators to track accumulated amounts, or balances. You can accumulate a single value over time or multiple values over time, as your requirements specify. For example, an accumulator could consist of all voluntary deductions, or all company deductions, enabling you to accumulate amounts. It allows total flexibility for time periods and values accumulated. Action In PeopleSoft Deduction Manangement, a task that you perform to obtain information required to resolve a deduction. Action and Conditions A process that defines actions and conditions independently of one another and then combines them to create a complete rule (see Rule Creation). Action Code In PeopleSoft Engineering, a user-defined code associated with an event/action triggered by the implementation of an engineering change order (ECO). Actions could include analyzing an item's existing quantity on hand, scrapping existing inventory, or modifying current documentation. In PeopleSoft Product Configurator, a 2-character code that identifies rule types. For example, FP is the action code for the Finalize Price rule, and CN is the action code for the Condition rule. The rules control the processing path for configured items. Action List An online list of customers who meet predefined credit management criteria. The list also includes appropriate procedures for each action and contact information for the customer. Action Owner In PeopleSoft Deduction Management, the individual assigned a task to obtain information to resolve a deduction. GLOSSARY 4 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Action Reason The reason an employee’s job or employment information is updated. The action reason is entered in two parts: a personnel action, such as a promotion, termination, or change from one paygroup to another—and a reason for that action. Action Reason is used by PeopleSoft Human Resources, PeopleSoft Benefits Administration, PeopleSoft Stock Administration, and the COBRA Administration feature of the Base Benefits business process. Active Control A target control requiring that the user validate the budget against the planning targets before submitting it. If the budget totals are not within the tolerance levels, the system indicates that the status is invalid and the user cannot submit their budget until the budget is modified and the amount is within the tolerance range of the planning target. Activity In PeopleSoft Receivables and Deduction Management, an action taken on an item, such as creating an item, unposting an item, or writing off an item. In PeopleSoft Projects, the unit of work that provides a further breakdown of projects— usually into specific tasks. Resources are assigned directly to activities within a project, not directly to projects. A self-contained task that is part of one or more business processes. Business process maps display the activities that make up the process. An activity consists of steps representing the pages the user needs to complete and events representing the workflow routings triggered by the user's actions. In PeopleSoft Enterprise Warehouse, the work of an organization and the aggregation of actions used for Activity-Based Costing. Activity Attributes Activity Attributes provide pieces of activity information. For example: capacity and performance, cost drivers, cycle time and performance measures. Activity-Based Costing (ABC) A methodology that measures the cost and performance of activities, resources and cost objects, assigns resources to activities and activities to cost objects based on their use and recognizes the causal relationships of cost drivers to activities. Activity-Based Management (ABM) See PeopleSoft Activity-Based Management (ABM). Activity-Based Planning and Simulation (ABPS) ABPS, a feature of PeopleSoft Activity-Based Management, calculates resource demands, new rates, costs, and activity volumes based on demand forecasts. It converts the new PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 5 GLOSSARY resource demands into new cost requirements at the General Ledger item level to feed as input for budgeting. Activity Driver An Activity Driver indicates the amount of demand there is for a particular activity and it is used to assign cost to cost objects. In some instances, an activity driver may represent the yield of an activity. Activity Fragmentation The part of the Employee Profile feature that provides information about the number of employees that is involved in completing a particular activity on a full or part-time basis. Activity ID A unique 15-character alphanumeric identifier given to each activity within a project. Activity IDs need only be unique within a single project. Activity List In PeopleSoft Pension Administration, a checklist used to monitor pension-related activities. Activity Type A user-definable identifier for grouping activities. Activity Type Also known as Activity Code. A categorization of work effort. Typically work effort is categorized as productive or non-productive; Repair, Maintenance, Enhancement, or Improvement; or Development or Construction. Activity type is usually required to support cost accounting or financial accounting (recording) functions. It may also be required to support some organizational administration requirements such as organizational productivity goals, or employee performance measurement. In some companies, activity type is inferred from job function, work group affiliation, or organization. Activity Use An attribute used to describe the behavior of an Activity as defined within PeopleSoft Enterprise Performance Management. A Primary Activity is an activity that is performed for the purpose of directly generating revenue within the course of business. A Secondary Activity is generally performed in direct support of a Primary Activity such as activities related to human resources or MIS. Actual Base Hours This defines the number of hours that an employee is expected to work within a given period under analysis within PeopleSoft Enterprise Performance Management. Hours worked in excess of Actual Base Hours are generally considered overtime, while hours worked less than Actual Base Hours would illustrate that the employee is working part-time. GLOSSARY 6 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Actual Contribution Percentage (ACP) The amount of an employee's after-tax or employer matching contributions made in a Section 401(m) plan on behalf of highly compensated plan participants, divided by the employee's annual compensation, or an amount determined in the same manner with respect to non-highly compensated employees. The Base Benefits business process is set up to perform ACP nondiscrimination tests for Section 401(m) plans. See Nondiscrimination Tests and Highly Compensated Employee. Actual Date Calendar date in which a punch occurred (see Time Reporting). Actual Deferral Percentage (ADP) The amount of salary reduction contributions made by an employee to a Section 401(k) plan for a year, divided by the employee's total compensation for that year. The Base Benefits business process is set up to perform ADP nondiscrimination tests for Section 401(k) plans. See Nondiscrimination Tests and Highly Compensated Employee. Actual Demand In PeopleSoft Demand Planning, an Array of demand by historical period imported from an external system. The demand figures are determined by imported values and typically include shipments, orders booked, orders booked by requested ship date, or shipments. Actual Rates An Actual Rate is the rate that your business currently uses for its business practice. Actuarial Assumptions Any assumptions used to calculate an equivalent benefit for an optional form of payment or an alternative retirement date. Actuarial Valuation A comparison of a pension plan's assets and liabilities. Actuarial Valuation Extract A PeopleSoft Pension Administration data extract containing data that a plan actuary needs in order to determine the plan’s assets and liabilities. Address Type A high-level address classification that identifies addresses associated with a Material Issue. Examples include Ship To Address, Bill To Address, and Ship Notification Address. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 7 Managers create this version by reviewing the forecasts and entering adjustments that cannot be inferred statistically. excepted. Also called “post-tax” deductions. that has the authority to hire employees in the competitive. These deductions are subtracted from gross pay after taxes have been taken out. such as demand filtering and depromotion. Generally. For example. in addition to versions of the statistical forecast. Adjusted Demand In PeopleSoft Demand Planning. or summarization. there is an adjusted version of the forecast. GLOSSARY 8 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . there may be a promotional campaign next quarter that is expected to boost volume for certain products over several weeks. a Statistical Forecast that has been adjusted using management overrides. or major shareholder that has the ability to influence the corporate management decisions. director. The system uses adjusted demand rather than actual demand in the Forecasting Reset process and in the recalculation of model components during period-end processing. an Array of demand after adjustments have been made to the actual demand values. Agency Any Department or independent establishment of the Federal Government. including a government-owned or -controlled corporation. Adjustment Voucher A PeopleSoft Payables voucher that enables you to apply an adjustment to an existing voucher or to relate one voucher to another. Advice The Form that employees who choose direct payroll deposit receive in lieu of a check. Adjustment See Bill Adjustment or Inventory Adjustment. proration. The adjusted figures may include both manual and systemgenerated changes. and senior executive services.GLOSSARY Adjusted In the Enterprise Planning and Simulation forecasting process. Adjusted Forecast In PeopleSoft Demand Planning. Affiliate A control person of a corporation. an officer. After-tax Deductions Deductions that reduce net pay. You can allocate budget planning to detail levels so that you may perform detailed budgeting. as a pattern.GLOSSARY Aggregated In Enterprise Planning and Simulation. each period the statistical forecast is calculated automatically by the system. Usually this allocation is done in proportion to the calculated product forecasts at that level. or multidimensionalizing your output. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 9 . In addition. The type of allocation you select determines the output. Rules use Allocation Manager methods to enrich the PeopleSoft Enterprise Warehouse data. aggregating. summarized) into forecasts for the product family. Allocated Inventory The inventory assigned to a specific stock request. and separate dates. and so on. Aggregate Reporting The ability to report time as a collection or mass. A forecast for each individual product can be computed using history for that product. the forecast at the product family level can be allocated down to the individual products. Allocated In Enterprise Planning and Simulation. Then these forecasts can be aggregated (that is. in a range of dates. the computed forecast and the summarized forecast are two different versions of the statistical forecast. departments. Aging ID A code representing rules for aging open items. Alias Any of several PeopleSoft Pension Administration utilities that look up or calculate employee information. to a common date using an annualized factor. or for an entire crew. Aging Data Updating data from separate sources. This version of the (statistical) forecast is called the allocated or prorated statistical forecast. Allocation Manager Rules In the PeopleSoft Enterprise Warehouse. Allocations enable you to distribute revenue. Allocation Manager Perform allocations using the Allocation Manager. See Allocation Manager Methods. In Time and Labor aggregate time reporting features include the ability to report time in a lump sum. and statistical quantities across business units. Allocation Manager rules allow you to specify the basis as well as the target tables for moving. expense. Budget amounts are allocated to cover. and Spread Even. The primary production BOM is designated as BOM code 1. You can specify up to 98 alternate routings for production routing types by entering additional Routing Codes (greater than 1) for the same routing type. you can associate up to 98 other alternate BOMs with the item. Allowances The amount owed to an employee in addition to base salary and which is not defined as part of gross salary. or offset. Alternate BOM Identifies the multiple ways in which an item can be produced. transmitted to a financial institution to the employee's checking or savings account. This same budget amount appears as a positive amount in the other Budget Center receiving the allocation. Allotment This is a voluntary deduction from pay. Each method enables you to move and/or enrich output. PeopleSoft Budgetingspecific. PeopleSoft Budgeting-specific. the costs in one Budget Center by charging them to another Budget Center. Alternate Account A feature in PeopleSoft General Ledger that enables you to create a statutroy chart of accounts and enter statutory account transactions at the detail transaction level as required for recording and reporting by some national governments. By using BOM codes. Alternative Minimum Tax (AMT) AMT is calculated by adjusting the taxpayer's regular taxable income with a number of tax preference items and adjustments.GLOSSARY Allocation Manager Methods There are several methods: Arithmetic Operation. For example. vacation can be considered an allowance. Tax preference items are positive items increasing GLOSSARY 10 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Alternate Routing A routing. ALM (Asset Liability Management) See PeopleSoft Asset Liability Management. Prorata. An allocation is also the budget amount that is distributed to or from a Budget Center. A budget amount that is charged to another Budget Center appears as a negative amount. Allocations A process of distributing budget amounts to and from other Budget Centers. Employees may elect up to two allotments from pay. usually less preferred than the primary routing. but resulting in an identical item. Tax preference items include gain from the exercise of incentive stock options. Analysis Template A set of pre-defined reports that you can view and publish online. for your analysis needs. rank. Analysis Group A grouping of analysis types. and actual costs (ACT).GLOSSARY Alternative Minimum Taxable Income (AMTI) and are excluded from regular taxable income. committed costs (COM). Analysis groups can be used for project analysis and grouping or for mapping analysis types. Amount Type In PeopleSoft Workforce Analytics. Annual Amount is an employee-level compensation amount. you might want to track budgeted costs (BUD). and then calculates the amount of all the social security contributions for this establishment. to the employee or the employer. Analysis Type A 3-character. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 11 . These templates access data in the Enterprise Warehouse tables. and organize it by function. role and industry. The templates allow you to pivot. Analytic Forecasting Analytic Forecasting is the part of the Planning and Simulation feature that creates forecasts for your business requirements. user-definable identifier that enables you to label the different types of costs. Annual Declaration Report The French Annual Declaration report is a payroll report which checks establishment profiles to see whether an establishment has to produce the report. historical data used both to seed and compare against proposed budgets. drill and chart the data. Annual Amount In PeopleSoft Workforce Analytics. the Amount Type specifies whether a benefits compensation amount is a value or expense. in a compensation scenario. sort. totaling the calculations for a full fiscal year’s worth of accounting periods. Analysis Base Defined static. Analytical Applications See PeopleSoft Analytic Applications. For example. GLOSSARY Annual Leave Annual leave is absence from work with pay and must be approved by the employee's supervisor in advance. 3-15 years . Retired military non-officer (enlisted) receiving pay 4.8 hours per biweekly pay period. Text for the codes is as follows: 1. Annualized Tax Method A payroll tax calculation method that divides the tax on an annualized amount by the number of pay periods in the year to find withholding for a given pay period.4 hours per biweekly pay period. Retired military officer receiving pay and a reemployed annuitant . there is a leave year ceiling of 240 hours on accrual. Part-time Permanent/Part-time Seasonal employees. Annuitant Indicator A code used to indicate the status of an annuitant appointed to a position in the Federal civilian service. companies are required to submit the Annual Workforce Survey by Nationality and Professional Category to the Ministry of Labor.1 hour for every 10 hours worked.. amounts accrued in excess of the ceiling and not used prior to leave year-end are forfeited.0-3 years .1 hour for every 20 hours worked. Annual Workforce Survey by Nationality and Professional Category (Enquête sur l’activité et les conditions d’emploi de la main d’oeuvre) In France.Civil Service GLOSSARY 12 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Generally. Annuitant CSA Number A unique number assigned by OPM for a retired employee. officers. Reemployed annuitant . Retired military officer receiving pay 3. the prospects for the future and major decisions of management. Annualized is the most common tax method. and shareholders held for the purpose of communicating the operating and financial results for the prior year. which includes any employee who does not have French citizenship. Annual Shareholders Meeting A meeting of corporation’s directors. This report provides an analysis of the company’s foreign workforce. based on the number of withholding allowances.. This type of leave (Plan Type 51) is accrued based on years of service: Full-time Permanent/Full-time Seasonal employees . 15+ years .1 hour for every 13 hours worked. and 15+ years .0-3 years .Civil Service/FERS 2.. 3-15 years .. Annuitant Amount The gross monthly annuity a federally retired employee receives.6 hours per biweekly pay period (plus an additional 4 hours in the final pay period of the leave year). these payments are generally made monthly. banking or insurance. It detects when a business rule has been triggered and determines the appropriate action.FERS Retired Enlisted/Reemployed Annuitant . API An Application Programming Interface (API) is the technology that a software product supplies so you can control it or communicate with it from another application.FERS Retired Officer/Former Annuitant . C. Retired military non-officer (enlisted) receiving pay and a reemployed annuitant . the system uses recruitment data to populate the fields in the Personal Data pages. D. APE (Activité Principale Exercée) Codes APE codes classify the type of industry or activity your French company is in. Not applicable (none of the above) Annuitant Indicator (cont) A. B. Applicant Hire Process The procedure of hiring an applicant who has been tracked and administered in the Recruitment pages. PeopleSoft APIs enable the user to perform desired actions upon PeopleSoft data without having to know the internal logic or rules of the program. The APE codes are a normalized set of codes that are required by law and are used in regulatory reporting. options or shares where the price is greater than the current fair market value of the security.Civil Service 6.FERS Annuity A series of periodic payments made to an individual. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 13 .FERS Retired Officer/Reemployed Annuitant .FERS Retired Enlisted/Former Annuitant . F. Once you assign an Employee ID. such as software. Application agent An application agent is an online agent that is loaded into memory with a PeopleSoft page. Under a pension plan. E. Anti-Dilutive Typically. Reemployed Annuitant – FERS Former Annuitant .GLOSSARY 5. BEA Systems' transaction monitor. Approving Official Individual with the delegated authority responsible for signing the action(s) taken on an employee. and don’t rely on external processing. GLOSSARY 14 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Application Server The application server is the centerpiece of PeopleSoft's three-tier architecture. Each application server domain is configured to connect to a single database. Application Server Domain The collection of server processes and associated resource managers defined by a single PSTUXCFG configuration file. Application Engine PeopleTools batch processes consisting of a set of defined SQL statements. It utilizes Tuxedo. Appointing Officer Denotes if the employee has appointment authority based on laws and regulations. Multiple application server domains can exist on the same server machine. since they operate within the database system. Application Journal Template A set of rules and default values to control the creation of journals from accounting entries. You can also unapprove previously approved time. You can approve time by group or by individual employee. Application Engine processes is more efficient than COBOL or SQR.GLOSSARY Application Designer The integrated development environment used to develop PeopleSoft applications. Appointing Authority The basis that authorized the appointing officer to effect personnel actions on an employee. Approve Time The Time and Labor feature that approves all employee daily time before it can be sent to payroll for processing. Application Processor The Application Processor is the PeopleTools runtime engine that controls processing of the application from the time the user requests a panel group from an application menu through the time that the database is updated and processing of the panel group is complete. to manage client transactions and provide the business rules and workflow capabilities of PeopleSoft's enterprise applications. usually the result of a deduction not fully taken. Depreciation Method. Array Dimension Determines which inventory-stocking possibilities are included in a Cube View. Currency Code. Asset Catalog A list of asset profiles which includes information about that asset type. As-of-Dated Refers to a snapshot of the data at a given point in time. Asset Assignment A streamlined means of associating project costs to assets or asset profiles within PeopleSoft Projects. such as estimated service life and depreciation limits. Leasehold Improvements. One way of thinking of an array is that it is a SQL statement that retrieves data from an existing table. for example. and the like. Salvage Value. also known as the asked price. Land. order quantity. Life. Buildings. Asset Category A standard group of assets. Arrears Balance An amount owed to either the employer or employee. and turn rate.GLOSSARY Array An ordered grouping of data by period and year. Asset Budgeting Budget for planned asset acquisitions and the associated depreciation expense that can be associated with a Capital Acquisition Plan (CAP). PeopleSoft Demand Planning uses arrays in forecasting demand. safety stock. Ask Price The price at which someone who owns a security offers to sell it. including Cost. These generally correspond to General Ledger asset accounts. Machinery and Equipment. Assets in one category usually share some depreciation characteristics. This standard one-level dimension consists of the key fields that include. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 15 . and Asset and Depreciation Account. Typical asset categories include Furniture and Fixtures. Array Element which enables you to extract information based on a column value. activity. If an object ID is identified as a target it may be allocated costs from another object ID but may not allocate costs.GLOSSARY Asset Class An asset group used for reporting purposes. It can be used in conjunction with Category to refine asset classification. terminally ill employees can assign their insurance to a Viatical Settlement Firm in exchange for cash (approx. GLOSSARY 16 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Assignment is irrevocable. Assignments must be made in percentages of total insurance versus an assignment of Basic Insurance to one person and Option A to another. which must be identified as a target. Assignment Type This defines the behavior of the object. You can use the information in asset profiles as default values when adding assets. Asset Profile A template that contains standard depreciation criteria for an asset type and its corresponding asset books. The insured no longer has control over his/her insurance coverage and can no longer designate beneficiaries. Life Expectancy is usually 24 months or less for a Viatical Settlement Agreement. Assignment does not have to be to the same person or firm. If the object is identified as a source then costs may be allocated from that object to another object. an item is a co-product on more than one items’ primary BOM. Either all or none of the insurance can be assigned. Option C is excluded. (resource.85% of the face value of the coverage). Asset Life The number of years an asset will depreciate. Additionally. Also see Useful Life. or cost object) within PeopleSoft Activity-Based Management. The assignment of benefits transfers ownership of the FEGLI coverage to the assignee(s). An object ID can be both a source and a target. firm(s). Federal employees can assign their Basic. thereby having the functionality of each. Asset Liability Management See PeopleSoft Asset Liability Management. you are telling the system which BOM to use in exploding the co-product to the next level. Associated Primary BOM With multiple outputs. By assigning an associated primary BOM to a co-product. 60% . Option A and Option B insurance to another person(s). after which time it might be kept or sold for its Salvage Value. it’s possible that a given co-product can be created in more than one way – in other words. or trust(s). Assignment of Life Insurance Effective 10/3/94. ATP-reserved orders are also referred to as promised orders. Auditor Person designated to review expense sheets and cash advances before payment. It is information needed to identify the establishment risk code for insurance purposes. vacation time. The user has an obligation to the customer to fulfill the order quantity by a certain date. This includes setting up a revision scheme or a predetermined. Automatic Spouse Benefit A joint and survivor pension benefit provided without any actuarial reduction to a pension benefit. or Work Accident Section. It includes sick leave. and to satisfy a variety of reporting needs. For example. the element “Store” is an attribute of the dimension “Geography” for the retail industry. ordered list of revision names. and other leaves taken. Audit Trail See Drill-Back Calculation. Attendance Reporting A Time and Labor report that indicates an employee’s attendance record. Automatic Revision Incrementing (Auto Rev) The ability to automatically set up revision control and generate revisions for revisioncontrolled items at the business unit level. An attribute is also a column heading on an analysis and reporting template. Attendance A component of time reporting application whose purpose is to apply business rules related to Benefit Entitlement and Administration and Organizational Administration to time reported as worked or not worked. The automatic benefit is a n% joint and survivor. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 17 . this stands for Section Accident du Travail.GLOSSARY AT Section In France. ATP Reserved Order An order that has been promised against future supply. the employee is still entitled to choose any optional form of payment and any beneficiary for the remainder of the benefit. Attribute An attribute is an element within a dimension. Used by the financial analytic applications in Enterprise Performance Management. Average Static Calc Flag In PeopleSoft Inventory Planning. The average method sets the static policy equal to the weighted-average. summarize amounts for selected ChartField values according to your reporting requirements. (Availability Date = Creation Date + Availability Lead Time) Available to Promise (ATP) The projected supply of a product less the actual demand. the Average Daily Balance Ledger is used for average daily balances. a method used with static policies. time-phased policy over the next argument periods. Average Price The average price derived from either the bid and ask prices (for bid/ask/average) or from the high and low prices (for high/low/average). which is the balance as of the last day of the month. GLOSSARY 18 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Average Daily Balance Ledger (ADB_Ledger) In the PeopleSoft Enterprise Warehouse. and define the periods for these calculations. When demand and lot sizes are not uniform. which informs the sales and marketing department of the products that can still be sold without modifying the master schedule. However. Award A special payment to an employee for certain prescribed kinds of activities or accomplishments. Average Inventory In PeopleSoft Inventory Planning. in that it too supports reporting. For a reporting period (usually monthly) this refers to the average daily balance of an account as opposed to the month-end-balance. Average Daily Balancing A feature in PeopleSoft General Ledger that enables you to target the ChartFields on which you base average balance calculations.GLOSSARY Availability Date The date a lot becomes acceptable for fulfillment in PeopleSoft Inventory or for consumption in PeopleSoft Production Management. the Average Daily Balance Ledger table (PF_ADB_LEDGER_F00) is similar to the functionality of the PF Ledger table (PF_LEDGER_F00). ATP isn’t cumulative – it’s calculated for each period. one half of the average lot size plus the safety stock when demand and lot sizes are expected to be relatively uniform over time. It is a table that is used mostly for processes associated with the financial services industry. the stock level versus time can be charted to determine the average. All background processes are executed through process-specific COBOL programs run outside the Windows environment. Example codes might include out of stock. The U. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 19 . or Commitment Balance. When this value is exceeded. Balanced Scorecard See PeopleSoft Balanced Scorecard. or seasonal. discontinued. Core funds represent the minimum balances that are retained on a long-term basis. Balance Type Balance Type is a lookup code used to define the type of instrument balances that will be stored in the PeopleSoft Enterprise Warehouse and processed by the analytic applications.00 or lower is appropriate for most items. BAD Forecast Ratio In PeopleSoft Demand Planning. Non-core funds are temporary in nature due to their volatility caused by customer preferences for liquidity. an employee can be eligible to receive additional pay relative to a delayed receipt in salary caused by administrative error in processing a personnel action. Background processes are usually scheduled to run on a regular basis.the maximum acceptable value of the ratio of the and the base component (Standard Deviation/Base Component). Examples of different Balance are Current Balance. a BAD ratio of 1. and cannot be utilized on a long-term basis.S. Period Ending Balance. Balance Segmentation Balance Segmentation is used in Funds Transfer Pricing to divide balances in deposit accounts between core (stable) and non-core (volatile) segments. In most organizations. Background Process Any task or process that is grouped with another and runs in the background. the system automatically resets forecast model parameters. Average Daily Balance. the less likely it is that the system will reset the parameters. Office of Personnel Management has established guidelines for Federal agencies on when and how to make these calculations.GLOSSARY B Back Pay Interest Under certain circumstances. building a relatively reliable source of funding to the bank. The higher the value. Backlog Reason Code An identifier indicating the reason an item could not be shipped. we would say BAM model (that is. BAM Template A file created using BAM design tools. XXX I think this term is incorrect because we use BAM to refer to the application. a part of the bank information that identifies business unit banks.MDL. This file has an extension of . The BAM database is physically separate from the Enterprise Warehouse database.) BAM Model The BAM database published from the template. representing the model prior to its creation as a database. either the ExtractTransform-Load (ETL) process or the Multi Currency Engine can be used to convert the monetary amount to the Base Currency Equivalent (BCE) Amount. Base Factor In PeopleSoft Demand Planning. Data is sent to the model through migration processes.GLOSSARY BAM Business Analysis Model. The base budget is distributed as a starting point for Budget to review and edit. Business Analysis Modeler model. Cash Compensation that is typically categorized as fixed. Base Compensation In PeopleSoft Workforce Analytics. It includes base pay and shift differentials as well as associated merit. equity. If we were referring to the business analysis model. those currencies are translated to the base currency for reporting purposes. The base budget can be zero-based or incremental. Base Currency Base Currency is used to consolidate and report financial results of a multinational company. GLOSSARY 20 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Base Budget The initial budget defined by the Budget Coordinator. and step increases. Bank Identification Number (BIN) In PeopleSoft Payables. an element of a smoothing constant simulation set that controls base component smoothing in the Model Reset Simulation process. When a company transacts its business operations in different transaction currencies. This file is published to a BAM database once the model design process is complete. Each application using BAM will deliver templates which the customer will review and publish to a database in their environment. Base Currency Equivalent (BCE) Amount If the monetary amount is in a currency other than the base currency. The model contains both the data and analytic structure used in the application. It is pay for a regularly assigned workweek. Batch processes perform operations—such as pay confirmation. and so forth—on groups of records. Batch-oriented data collection applications. You run these processes from the Process Scheduler.GLOSSARY Base Metric Metric found on a fact table. Base Time Zone Customer defined time zone used for converting reported time to a common time zone for ease of applying rules (see Time Administration). a union-negotiated rate for hazardous work. Also called “pre-tax” deductions. and they are executed through process-specific COBOL programs. Begin Calc Date The date on which PeopleSoft Asset Management begins to deduct from an asset's life. and are usually scheduled to run on a regular basis. you can set up a regular hourly rate plus a shift rate. Batch Batch systems are used when realtime updates are not needed. deduction calculation. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 21 . and so on. Batch Processes Any of the background programs in the client/server environment of PeopleSoft applications. applied prior to the calculation of federal and state/provincial withholding taxes. Begin Depr Date The date on which PeopleSoft Asset Management begins to calculate depreciation for an asset. The text file is fed to a PeopleSoft SQR program that loads the transactions into the database. Begin Depr Date is calculated using In-Service Date and Prorate convention. Before-Tax Deduction Deduction that reduces net pay and FWT taxable gross. Base Pay A pay component included in the job comp (job compensation rate) calculation. A base metric usually contains an aggregate operator. For example. Base Pay Structure A PeopleSoft Workforce Rewards module you use to create or revise pay structures. produce transactions that are collected in an ASCII text file. and to assess the cost and impact of implementing new structures. for example “sum” or “count”. developed in-house or by a third-party vendor. two times salary. full time. Benefit Program A set of benefits and deductions valid for an employee or group of employees. and health benefits dependent on individual company parameters. your company’s life plan type might include benefit plans of one times salary. third party sources. occasional).. Benefit Entitlement Any rules governing the circumstances under which employees are entitled to receive certain benefits. An individual employee may belong to only GLOSSARY 22 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and disability—each with its own eligibility criteria. and specific rules which apply thereto. e. work group affiliation. late. A single company may have any number of programs. or savings. length of employment. Benefit group may include medical. Benefit Deduction Any amount taken from an employee’s pay check to offset all or part of the cost of the employee's benefits. Jobs for which there is no corresponding salary survey data are referred to as non-benchmark jobs. and compensation base. i. dental. early. Benefit Commencement Date (BCD) The date on which a pension payee elects to begin receiving payments. as well as the PeopleSoft Pension Administration function that calculates the benefit. and three times salary. part time. For example.GLOSSARY Benchmark Job In PeopleSoft Workforce Analytics. Benefit Plan Type Any category of benefit. such as reasons-for-claiming or job performance. life. Benefit Plan A specific benefit within a plan type. Benefit Formula The formula that determines a participant’s pension benefit in a defined benefit plan. Typically. death. Benefit Group Part of a group of defaults assigned to job codes. A plan may have several retirement types—normal. Benefit Eligibility The PeopleSoft Pension Administration function that determines if an employee is eligible for retirement or ancillary benefits. entitlement to benefits is based on type of employee (for example. this refers to a Job Code for which there is corresponding salary survey data from published. such as health. Other criteria may also apply. and document location in the file system. The lower the value. Bias Test In PeopleSoft Demand Planning. Bias Signal Limit In PeopleSoft Demand Planning. Sick Leave). Benefit Tables Any of the tables that contain employee benefits information. a number between one and six that indicates how many Forecast Period to test for bias. These are often relevant to payroll processing. a forecasting test that sets the limit for tripping a Tracking Signals. and sometimes variable. If the bias test is violated. Betriebszählung (Company Statistics Report) Also called the OFIAMT report. document size (in bytes). the more likely it is that a tracking signal is set. Benefits compensation is sometimes fixed. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 23 . Benefits Compensation is value associated with employment benefits. Benefits Compensation In PeopleSoft Workforce Analytics. Life Insurance). savings plans. the deductions and benefits contained in that program are the only valid deductions and benefits for that employee. Retirement (annuities. It contains a unique key. BIF file This is the bulk insert file (input. the system records a Tracking Signals error in the period up to the number of periods determined by the bias signal limit. and Paid Time Off (Vacation Leave. field names and values. Bid Price The price a prospective buyer is prepared to pay at a particular time for trading a unit of a given security. pensions). The benefits base will be either the employee Annual Rate or Annual Benefits Base Rate. depending upon the benefit type. Benefits Base The salary used for benefit calculations. This report provides statistics required by the Swiss Federal Department of Statistics (BFS). It can include benefits types for Health and Welfare (Medical.bif) used with the Verity search engine to specify the documents to be submitted to a collection (search index). Bilan Social Report See Employee Survey Report.GLOSSARY one program. Bill To Customer A customer who receives an invoice. Examples of Bill Types include standard and custom order activities. Customer Bill Search enables you to locate a bill by Customer Name. Parameters for bill line search include Reference. Examples of bill sources include order management. Bill Source The point where billing activity originates. Bill Inquiry Phone Bill Inquiry Phone is the number printed on your invoices for your customers to call if they have any questions about their bill. and Amount. GLOSSARY 24 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . quantity. including the charge identifier. Every bill line is related to a bill header that may have one or more bill lines related to it. any group of bill lines. Bill sources may be external to the system (imported through the billing interface) or entered directly online. Date. You can also choose other parameters to limit your search. With Bill Line Search you first search for a particular bill and then a line on that bill. and any other information regarding an individual transaction. Bill Type A category of billing activity variety.GLOSSARY Bill In PeopleSoft Billing. project costing. Bill By Identifier The Bill By Identifier is used to define how billing activity is grouped when added to a bill through the billing interface or the Populate Billing process. Bill Header The record containing information that pertains to the bill as a whole. Bill Adjustment The process of making credit or credit and rebill adjustments to an invoiced billing activity. price. Each bill has a unique bill header that identifies it within the system. Bill Line The basic unit of billing activity representing a billable charge. Bill Search A method of finding a bill or bill line when you don't have enough information to call up the bill directly. and contract administration. depreciation attributes. A BB discount is not deducted from the customer invoice. Billback Discount (BB) A per unit discount which typically requires a customer to perform one or more merchandising activities to receive the discount. Each customer may have multiple locations. how and where productive. non-productive. and what business rules to apply to the borrowed employee’s time for the purpose of compensation and benefit entitlement and administration. Billback discounts can originate from a National Allowance or Customer Promotion. and retirement information—on assets. where HR isn’t involved and a new job record isn’t created. Billing Location A number identifying a customer address. but once the customer performs the merchandising activity. Borrow/Loan The temporary reassignment of an employee to other task reporting or compensation requirements to allow the business to meet unexpected. and are passed to PeopleSoft Order Management for informational purposes only. determined by the company.GLOSSARY Bill Update The process that adjusts bills that have either been entered manually or generated within the system. Companies may have specific rules about how long an employee may be borrowed/loaned. This method is used for Canadian tax processing. See also Casual work Assignment. Billable Indicator A status flag that identifies an item as eligible for billing to a customer. Book In PeopleSoft Asset Management. Bonus Tax Method Annualizes your year-to-date earnings by multiplying them by the number of pay periods in the year. fluctuations in staffing or work load. and compensated absence time will be charged. this kind of reassignment is done informally at a local level. Typically. a data location storing financial information—like cost. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 25 . but must have one Primary Location at which you contact them. a sales representative or broker can approve payment for the discount amount. Billback discounts are recognized as a liability when the product is shipped. Blackout Period The period of time. Blackout Periods can affect the trading of some key individuals or can be placed on the entire company. which prohibits certain activity in the company stock. short-term. a “breadcumb trail” appears that shows the path you’ve selected. The result is then available for use in other items such as formulas. Breadcrumbs Breadcrumbs show the navigation path to the current web page location. In the Funds Transfer Pricing (FTP) application. if the break price is $36. Break Punch An in/out punch of when a time reporter takes a break. Break Price The price used to determine which options are eligible for repricing. Branch A tree node that rolls up to nodes above it in the hierarchy. After you've defined a table. if any. Each registry level is separated by an angled brace (>). military service in which the employee served. They maintain only sales records and stocks for their clients. (who are not responsible for sales) Brokers do not maintain records on all your company’s certificates. Break in Service A period of time for which an employee does not meet stated service requirements. and you can select any level to navigate directly back to that level. Branch Of Military Service Identifies. Break Funding charges are factored into the transfer price for a loan that may be prepaid. Unlike Transfer Agents. the system finds a corresponding row on that table and returns the value of the bracket. as defined in the Tree Manager. GLOSSARY 26 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .GLOSSARY Bracket Brackets are a way to look up and retrieve database table values. Brokers Individuals or organizations who buy and sell securities. then all outstanding option with a grant price of $36 and greater are eligible for repricing. As you drill down through the different levels of the registry. Often they are account executives who work for firms registered with the Stock Exchanges and the SEC. A typical Breadcrumb would look like this: Home > HR > Administer Workforce > Benefits Break Funding Charges assessed for mortgages that are paid off before maturity. For example. this type of account will not accept transactions. Budget Analyst A role within PeopleSoft Budgeting. Budget Activity A type of activity peformed using PeopleSoft Budget Planning. your department dimension will be your Budget Center Dimension. and Position Budgeting. Budget Analysts are typically people within an organization responsible for reviewing and analyzing a prepared budget before submitting it to the Budget Coordinator.” Budget Category A set of related expenses that are accumulated for proposal budgets and reporting to a sponsor. PeopleSoft Budgeting-specific. Formerly called “system-maintained account. Budget Center Dimension In PeopleSoft Budgets. Budget Amount Ledger Stores budget amounts and is updated by posting budget entries. You’ll assign Budgets Users to the nodes and detail values on the tree you use to build your Budgets Center Dimension. transfers. You can only budget with this account. or pass with a warning. PeopleSoft Budget Planing-specific.GLOSSARY BSC (Balanced Scorecard) See PeopleSoft Balanced Scorecard. to see if they pass. the processing of source transactions against control budget ledgers. fail. Budget activities include Line Item Budgeting. Budget Allocations. the dimension by which you distribute budget data. If you budget by department. and adjustments. For example. The estimated cost for a set or class of accounts. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 27 . Budgetary Account Only An account used by the system only and not by users. any entity responsible for producing or reviewing budget data. Line Item Mass Adjustments. a Budget Center might be the individual departments responsible for producing budgets. Budget Category Numeric/alpha identification given to each category of positions. Budget Center In PeopleSoft Budgets. Budget Check In commitment control. or override the tolerance limits for a transaction rejected due to exceeded tolerance limits. budgeting setup. Budgeting Functions PeopleSoft Budgeting’s six main action categories. data integration and my profile. budgeting analysis. The Budget Coordinator is typically located within an organization’s central budget office and builds the budgeting model. and other budget options and control parameters. causing an Error or Warning to be issued. Budget Coordinator A role within PeopleSoft Budgeting. the sources of data that will be available to budget users. Your user role determines how many of these functions display and are available. See Error Exception and Warning Exception. Budgeting Model The framework for an organization’s budget development process. Budget Control In commitment control. Budget Detail A level of itemization that when combined makes up a major budget category. the methods that will apply to line-item budgets. Budgeted Rates In PeopleSoft Activity-Based Management. Budget Error Exception A transaction that fails budget checking. the rate your organization uses based on the budget. including: system administration. With this feature you can override the controlled budget for a transaction that failed budget checking due to insufficient funds. The Budget Coordinator typically defines the model and includes the time period of a budget cycle.GLOSSARY Budget Check Override Selective suspension of Budget Processing. Budget coordinators are responsible for monitoring the budget process. GLOSSARY 28 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . you can prevent a purchase order from being dispatched to a vendor if there are insufficient funds in the related budget to support it. Business unit defines a Budgeting Model. It enables you to track transactions against corresponding budgets and abort a document’s cycle if the defined budget conditions are not met. time period for phases within a budget cycle. When you push the Override button. budgeting preparation. the system flags the transaction to allow the Budget Processor to process successfully regardless of available funding. it ensures that commitments and expenditures don’t exceed budgets. PeopleSoft Budgeting-specific. For example. You can cancel the override any time before the Budget Processor is run by clicking the Cancel Override button. PeopleSoft Budgeting-specific. or controlled budget ledger for budgeting. Budget Period The period in which you define plans to meet your organizations training requirements. assign alternate Budgets Users. for base pay rules budget plans are a rollup of values for like Action Reasons. PeopleSoft Budgeting-specific. Budget Preparer A role within PeopleSoft Budgeting. Budget Phase In PeopleSoft Budgets. Budget reviewers are typically people within an organization responsible for reviewing and approving a prepared budget submitted by a Budget Preparer. Budget Seeding Represents a new budget or forecast. a span of time during which a budget or portion of a budget is to be completed. You’ll filter dimensions. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 29 . project budget ledger. enable Position and Asset budgeting. a budget type is an indication of whether the organization uses a standard budget ledger. For example. Budget Reviewer A role within PeopleSoft Budgeting. For variable pay rules budget plans are a rollup of the values for like Variable Compensation Plan IDs. The interval of time (such as 12 months or 4 quarters) into which a period is divided for budgetary. such as historical data that is manipulated to develop a more current representation for a proposed budget. Uses detail data as the budget seed or basis to create the base budget that represent the level of detail in which budget numbers are prepared. and reporting purposes. The ChartField allows maximum flexibility to define operational accounting time periods without restriction to only one calendar. Budget preparers are typically people within an organization responsible for developing the detailed budget for a Budget Center and submitting it to a Budget Reviewer or Analyst for review and approval. Budget Plan In PeopleSoft Workforce Rewards. and specify Budgets User notification options at the Phase level. A budget plan is a rollup of like compensation rules.GLOSSARY Budgeting Type Associated with the budget ledger type set definition. Budget Justification Written explanation further defining the what and why of a budget category. when working with a Compensation Planning BAM model. PeopleSoft Budgeting-specific. A Business Interlink Definition is added to the Application Designer’s objects at the same level as Fields. Built-in function Prior to PeopleTools 8. Records. Business Interlink Definition A definition encapsulating an external Transaction or Query and providing a set of generically typed input/outputs that can be assigned to PeopleCode variable or Record Fields at runtime. This model specifies the routing. consecutive. in your code.GLOSSARY Budget Translation Trees Trees translate (summarize) source transactions into the appropriate levels for processing against control budgets. etc. Budget View A user-defined view where selected dimensions. Budget Warning See Warning Exception. GLOSSARY 30 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . You’ll also assign these users to the tree representing your Budget Center Dimension. Budget Year The institutionally defined. ScrollSelect. You’ll designate Budgets Users on the Budgets Users page through the Coordinate Budgets window. columns and rows of data determine the layout of line-item budgets affecting the view or entry of data. Panels. like FetchValue. and doesn't (generally) have any dependencies. etc. is on a line by itself. This is because you usually budget above the level of your source transaction ChartFields on a tree. resources. A built-in function. Budget Type Indicates whether a budget is for expenditures or revenues. there were only built-in functions. 12-month period to which a financial transaction or summary applies.0. Budgets User In PeopleSoft Budgets. and materials that are necessary to produce the item. You don't have to instantiate anything before you can use a built-in. Build Option A detailed PeopleSoft Planning model that specifies a method of building an assembly item. any user who needs to gain access to the Budgets. when coded for an external system. the user of that object can retrieve the outputs of the external service. or other high-level language methods that. Visual Basic. It is composed of the following components: 1) An External System. The Business Interlink Object can be executed to perform the external service. (The catalog of Transactions. when coded for an external system. 2) Generic definitions for a Transaction/Query command interfaces. 4) Business Interlink Plug-in. encapsulate that external system and provide the execution methods to match the Business Interlink Design-Time Plug-in. after appropriate substitution by the driver. Business Planning The type of planning that focuses on elimination activities that are not needed by changing the drivers. Once a Business Interlink Object is executed.GLOSSARY Business Interlink Design-Time Plug-in An XML file that. Classes and Criteria specific and meaningful to that external system. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 31 . Business Interlink Object An instantiation based on a Business Interlink Definition. Business Interlink Framework The framework for integrating any external system with PeopleTools application objects.) Business Objects A way of identifying those mass changes that have been designed to be referenced by a flexible formula and provide them with a shorter name to simplify the creation of flexible formulas. the transaction/query/class associated to the Business Interlink Object will be executed once per each row of the input buffers corresponding to the input Records. it is executed only once. 4) Business Interlink Definitions. encapsulate that external system and provide a catalog of Transactions. The Business Interlink Objects use buffers to receive input and send output. Business Rules Rules that can process information differently depending on the values of data in the PeopleSoft Enterprise Warehouse. Actual data can be added to the inputs of the Business Interlink Objects once the appropriate bindings are provided. Business Interlink Runtime Plug-in A set of C++. If there is only one row. Classes and Criteria provided by the Design-Time Plug-in can also be provided by the Runtime Plug-in. When a Business Interlink Object is executed. Rebate and penalty calculations can be implemented for buying agreements. and pass journals to general ledger units. purchase order. PeopleSoft General Ledger business units typically comprise individual entities for accounting purposes. The Manufacturing business unit must be identical to the Inventory business unit in order to link the manufacturing and inventory processes. Calculation In PeopleSoft Pension Administration. the determination of a participant’s pension benefit. A PeopleSoft Inventory business unit is a storage facility that maintains its own replenishment and costing methods. You can automatically generate sales orders or create sales orders online from buying agreements.GLOSSARY Business Unit A corporation or a subset of a corporation that is independent with regard to one or more operational or accounting functions. Cafeteria-style benefits may or may not include flexible credits. Business units in PeopleSoft Projects represent operational structures but not necessarily independent financial units. base currency. PeopleSoft Purchasing business units share vendor. PeopleSoft Payables business units are either Vouching (have payables accrued to them) or Charge to (have voucher expense distributions charged to them). The Order Management business unit controls certain order processing parameters (tax and freight calculation methods. and receiving information with PeopleSoft Payables units in the same SetID. credit card hold options. and so on) for its associated PeopleSoft eStore and Mobile Order Management merchant variants. as well as its own definitions and guidelines. C Cafeteria-Style Benefits Any programs offering several benefit plans from which participants make elections. Buying Agreement You can structure flexible and easy-to-use buying agreements for customers or groups of customers. You can set up maximum amounts and specify the minimum dollar value per order placed against it. Business Unit Audit List One or more business units specifically targeted for expense report and cash advance audits. GLOSSARY 32 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . your accounting calendar defines the time periods to which you post transactions for different ledger group and business unit combinations. You can have multiple calendars. and minimum and maximum coverage amounts. including as-of dates for age. It also controls the order in which the Calendars are processed. Calculation Rule [Global Payroll] Any rule you develop using combinations of elements to command the system to perform a type of calculation. Canadian Industrial Sector The Canadian industrial classification code with which employees are associated for Canadian employment equity reporting purposes. Canada Academic Teaching Surveys Statistics Canada requires that all Canadian universities (all degree granting institutions) produce full-time and part-time Canada Academic Teaching Surveys. The system first looks to see whether you are using a work center specific calendar. Calendar Scope A time period type (Day-Factored. or Week-Factored) for use in building your time period calendar. a list defining the start and end dates for each time-phased period. It also contains daily weights for distributing raw data into different period buckets. premium. These reports are a legislative requirement. rounding rules. Calendar In PeopleSoft Manufacturing. If none is defined. planning and scheduling functions base start and due dates on a five-day workweek. PeopleSoft HRMS 8 provides you with the functionality to code HRMS information using Statistics Canada codes and create both the full-time and part-time Academic Teaching Surveys. You can only group calendars together that are for the same country (based on pay entity country). another for budget and forecast activity. and still others for special reporting or transitional needs. If no production calendar is defined. it looks at the production calendar.GLOSSARY Calculation Rule Criteria for calculating benefits. Calendar Group ID Allows you to group together multiple Calendars that you want to run together at the same time. and coverage calculations. service. In PeopleSoft Demand Planning and Inventory Planning. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 33 . Any number of program and plan combinations can use a single set of calculation rules. In PeopleSoft General Ledger. Month-Factored. a list defining the days your enterprise is available and the hours of operation for each day. so you can keep a calendar for actuals. Capacity Fence A time fence that indicates that date and time after which PeopleSoft Enterprise Planning or Production Planning solvers ignore capacity violations. allowing reserved and allocated items to be returned to inventory. Cancellation In the context of an employee stock plan. Capacity Multipliers A multiple used in PeopleSoft Enterprise Planning and Production Planning to determine the available capacity on a resource. Candidate Keys In PeopleSoft Demand Planning. Cancellation A process that terminates stock fulfillment requests. you can use it to vary the resource’s available capacity over time. Budgeted assets and actual expenditures can be associated with a CAP Plan so the owner can track planned against actual costs. Capital Acquisition Plan (CAP) A method of projecting and tracking capital expenditures for a project. GLOSSARY 34 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Since a capacity multiplier is effective-dated. such as a termination of employment) in which outstanding securities are declared void and inactive and returned to the pool of securities reserved for issuance under the plan or retired. The solvers do not use this date in processing capacity violations. Canadian Standard Occupational Classification (SOC) Codes SOC codes are occupational classification codes for Canadian companies provided by the government. Capacity Rate A rate you assign to a capacity cost object. This enables you to track and report on excess capacity.GLOSSARY Canadian National Occupational Classification (NOC) Codes NOC codes are occupational classification codes for Canadian companies provided by the government. a transaction (usually triggered by a specific event. elements of data that can be used to construct the Forecast Item key field at different levels of the forecast. Derivatives. when the difference is positive. a value that shows the cost associated with holding a dollar of inventory for one year. Capital Market securities refer to instruments that are bought/sold by the institution for its own investment account. Participants are made up of interested parties that choose to supply or acquire the capital funding through such vehicles. Budgeted assets can be associated with an overall CAP Plan and a CAP Sequence. In the PeopleSoft financial analytic applications. recognized at the time the property is sold. Generally includes both equity and debt securities. Capital gains can be either short-term (where the capital asset was held for 12 months or less) or long-term (where the capital asset was held for 12 months or more). Carry-Forward Residual contributions that remain in a stock purchase participant’s account after the purchase of shares that are used toward future purchases. and have responsibilities for handling health and safety incidents. if that level of detailed tracking is desired. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 35 . The capital markets set the product prices and interest rates. Case Officer In Germany employees in your company are designated as Case Officers. Carrying Cost In PeopleSoft Inventory Planning. Cash Balance Accounts The PeopleSoft Pension Administration function that tracks the activity in an employee’s hypothetical account under a cash balance plan. Capital Gains Tax A tax on profits from appreciation in owned real property. Capital Market Instruments are assorted financial instruments issued by organizations to raise capital for funding operations. Capitalization The total types and amount of the outstanding securities that have been issued by a corporation.GLOSSARY Capital Gain The difference between an asset’s purchase price and selling price. The value is presented as a percentage. debt instruments. Capital Markets Instrument In the financial services industry. real property includes owned company shares. equities and foreign exchange instruments that are traded in highly liquid markets represent the instruments. CAP Sequence Number The number that distinguishes a small project belonging to a CAP plan. class. interest rate. product pricing indices. the optionee is required to pay in cash the total option price plus any withholding taxes due to the company. payment dates. Catalog The list of transactions. discount rates. a new Job record is NOT created). This user performs the same activities as the Budget Preparer role when access is granted. term. Casual Preparer An additional user role at the lowest level of budget preparation for a budget center. such as loan prepayment rates. See also Borrow/Loan. There are four types of catalogs: transaction. The system does not. It generates actual and projected cash flows for financial instruments by using output from the other support modules. Cash Compensation consists of direct cash payments made to an employee for base compensation and short-term variable compensation. and product definitions (such as start and end dates. repricing and compounding frequency. enable the Casual Preparer role to define their own private views for lineitem budgeting. Cash Compensation is a component of direct compensation. The plan periodically credits a percentage of pay to each employee's hypothetical account. Often compensation rules that accrue to the temporary assignment override the compensation rules that apply to the employee's normal work assignment. Casual Work Assignment The temporary assignment of an employee to a work position or location to meet the needs of the business. Cash Exercise At the time of exercise. GLOSSARY 36 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . balance amount. The Financial Performance Measures module accesses the cash flow results to calculate the required financial measures. and configuration parameter. Typically. Cash Flow Generator This is a support module for the PeopleSoft financial services analytic applications. however. there is no Human Resource activity to support the work assignment (that is. and accrual basis) to generate the cash flows. operator. deposit runoff rates. classes.GLOSSARY Cash Balance Plan A defined benefit plan designed to look like a defined contributory plan. Catalog A way of organizing your training courses into classifications for increased flexibility. and queries used to interface to the external system. Catalogs consist of categories and subcategories. Integration users are presented with this list when they pick the type of Business Interlink Plug-in they are going to use. Cash Compensation In PeopleSoft Workforce Analytics. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 37 .000. and When both the old and new positions are under the same type ungraded wage schedule. Category Tree A hierarchical structure that groups products by category to control how they are displayed in PeopleSoft eStore web pages. If the retiree dies before payment period is over. a change-to-lower grade changes the employee to a position with a lower rate of basic pay. CBM See PeopleSoft Customer Behavior Modeling. under a ten-year certain and continuous payment option. respectively) covering a range of employee personnel/payroll data. Also knows as a "Term Certain and Continuous" payment option. A retiree who lives longer than ten years continues receiving payments after the ten year period until death. Census Metropolitan Area (CMA) Code In Canada this code is prescribed by the government and refers to the area of an urbanized core with a population of at least 100. Certain Only Payment Option A form of pension payment where the benefit is paid out entirely over a specified period of time—usually five. or in different pay-method categories. the remaining payments are made to a beneficiary. Central Personnel Data File (CPDF) Two types of reporting made by agencies to the OPM include the Dynamic and Status files (quarterly and monthly. ten. a retiree who lives less than ten years receives payments until death. Categories can consist of subcategories that provide further course definition. Certain and Continuous Payment Option A form of pension payment where the benefit is paid out for the lifetime of the participant with a specified number of payments guaranteed so that a beneficiary will receive payments until the end of the guarantee period if the employee dies before the guaranteed payments are complete. then the retiree's beneficiary continues to receive payments for the remainder of the ten year period. Also known as a "Term Certain" payment option. or fifteen years—with no ongoing payments after the specified period. For example.GLOSSARY Category Categories are the primary level of a two-tier structure of training courses. Used also by Mobile Order Management to enable product information to be accessed by a wireless device. a change-to-lower grade changes the employee to a lower grade. Change To Lower Grade • • For positions under the General Schedule or under the same wage grade schedule. ChartField Balancing PeopleSoft enables you to set up ChartFields and indicate that you want specific ChartFields to match (balance) on the debit and the credit side of a transaction. depending on the PeopleSoft application. The process of editing journal lines for valid ChartField combinations based on user-defined rules. other than these four. Some tables contain only one field as the key. you must enter the same Class. on the user-defined line. ChartField A field storing a chart of accounts. ChartViews Charts of data in the model.GLOSSARY Charge Out A Material Issue used when the item is scheduled for future return. and Budget Period ChartFields on both sides of the accounting entry. and so on. but you can modify any ChartFields. Child nodes—projects. Check In/ Check Out The process of retrieving planning activities from the BAM database (check out) and posting changes and results back into the database (check in). department codes. ChartKey One or more fields that uniquely identify each row in a table. Child A node or detail on a tree linked to another. The system always requires that total debits equal credits. When you enter a transaction. presented through the Worksheet which retains the ability to drag dimensions on the chart as desired. You indicate that these on a panel that these ChartFields are required. resources. and so on—can be rolled up into the parent. the Fund and Budget Period are already set up in the system to balance ( match). Fund. along with Fund and Budget Period which should already be selected. ChartField Combination Edit Also called Combo Edit. while others require a combination. customers. ChartField values represent individual account numbers. Program. GLOSSARY 38 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . suppose you want to balance by Class and Program. and so forth. For example. When you work with Controlled Budgets. higher-level node (referred to as the parent). A node can be a child and a parent at the same time depending on its location within the tree. S. The codes are: • • citizen other Civil Service Retirement System (CSRS) A retirement plan available to employees of the federal government. Classification Code Need App A code that categorizes an engineering change. Clock Hour Reporting Method of reporting time by recording actual times in and out (start and stop) (see Time Reporting). Citizenship Code Numeric indicator as to whether the employee is a U. Formerly called “subclassification. Quality. Class catalog Lists classes used to interface to an external system.S. Upgrade. A node can be a child and a parent at the same time depending on its location within the tree. citizen or a foreign national serving in the U.45%) of the Social Security tax. Example classification codes include the following: Mandatory. By enabling chunking. A Class can also contain lists of basic types or objects. higher-level node referred to as the parent. These jobs run in parallel (behind the scenes) to process data efficiently. DeptID. 1984. Class ChartField A ChartField value that identifies a unique appropriation budget key when you combine it with a Fund. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 39 . multiple jobs are spawned from one Jobstream. Coverage includes a basic annuity plan with employee contributions and the Medicare Hospital Insurance component (1. Chunking Chunking is a PeopleSoft Enterprise Warehouse mechanism that makes voluminous processing easier through the use of multiple small parallel processes. Child nodes can be rolled up into their parent.GLOSSARY Child A node or detail of a tree linked to another. A class contains data members of basic types and/or objects that are typed after another class. and Safety. and Program Code as well as a Budget Period. Optional. CSRS covers all employees appointed to a position in the federal government before January 1. may or may not mean making a unique copy. the CMA code is prescribed by Statistics Canada. this refers to legislation that requires employers to offer continued health care coverage to employees. divorce. Collection To make a set of documents available for searching in Verity. Defined as an offset number of days to the pay period end date.000. for example). and materials management operations for a specific Business Unit. and lot retest dates. application processes account for these closure dates when determining Lead Time and dates for anticipated fulfillment processing dates (scheduled shipment dates. scheduled arrival dates. you must first create one or more collections. clone will always mean to make a unique copy. COBRA (Consolidated Omnibus Budget Reconciliation Act) In PeopleSoft Workforce Analytics. and refers to the main labor market area of an urbanized core with a population of at least 100. so if the underlying object is changed. A collection is set of directories and files that allow search application users to use the Verity search engine to quickly find and display source documents matching various search criteria. whether employee or dependent. Closure Calendar A calendar that establishes closure dates for shipping. receiving. Copy may mean making a new reference to an object. or retirement. Codepage One character set. Any individual. both the copy and the original change. Close Price The price of the final trade for a security at the end of the trading day.GLOSSARY Clone To create a unique copy of an object. who lose benefits coverage under certain defined conditions such as voluntary termination. CMA (Census Metropolitan Area) Code In PeopleSoft Workforce Analytics. on the other hand. stored GLOSSARY 40 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Cloning The process that enables you to copy run controls to create employee schedules from existing Run Control ID’s that have already been executed and saved. and their dependents. becoming an overage dependent. has the option to elect COBRA coverage. Typically. Close Date The date in which time entry is no longer allowed for a given pay period. that is covered under a health plan at the time of a qualifying event. Copy. When used in PeopleCode. A collection is a set of statistics and pointers to the source documents. PeopleSoft maintains a set of collocations (one per language code) for each search index object. Compa-Ratio is most commonly defined as the relationship between current pay and the midpoint calculated as: (Incumbent Pay/Midpoint)*100. Examples include Annually. This method is used for Canadian processing only. See the Northern Ireland Report for more information. such as Catholic or Protestant. the gross is then divided by the number of tax periods specified on the paysheet. This is the composite number of shares available and tradable on the open market. Commercial-Off-The-Shelf (COTS) Equipment or software that is currently sold commercially to at least one customer. Compa-Ratio In PeopleSoft Workforce Analytics. Community Background In the United Kingdom Community Background refers to the religious category. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 41 . Combined Federal Campaign (CFC) A vehicle used by federal employees to contribute to a charity or charities of their choice. this is the frequency at which a job is paid. Since a collection can only store information for a single locale. or in percentage form by dropping the multiplication operation. Compensation Frequency In PeopleSoft Workforce Analytics. of employees.GLOSSARY in a proprietary format on a file server. This is the value you use for reporting or quoting pay. Monthly and Weekly. Commission Tax Method A payroll tax calculation method that adds year-to-date earnings to earnings for this pay period and finds the annualized gross by multiplying by the number of pay periods in the year. Much less common is the use of a compa-ratio calculation as: range midpoint/market rate. job applicants or appointees. Usually expressed in whole numbers. Commitment Control Commitment control includes budget control and commitment accounting functionality. Common Shares Issued and Outstanding Represents the residual ownership interests in the corporation. is associated with an expiration and is used as reported time (see Attendance). an evaluation of an applicant's education and GLOSSARY 42 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . skill. and compensation budgets are allocated throughout an organization.Competency In PeopleSoft Workforce Analytics. This is the rate the company uses for quoting and reporting pay. Compensation Package All of the base and non-base components on a job row. may consist of a written test. Competency Strategy The type and number of roles. accomplishment. or work performed on behalf of a business entity. or National Vocational Qualification (NVQ). and budgeting and forecasting compensation spending. Compensation The process by which a worker is remunerated for services rendered to. this is the compensation rate for a job. tasks. competencies and accomplishments essential to accomplishing a business scenario based on your strategic business goals. this is the process through which employee compensation plans are defined. Competency is a knowledge. tasks. setting individual pay levels. Compensation Rules Business methodology or logical process that is applied to reported time in order to determine payable time (see Time Administration). This data is migrated from internal source systems into the data warehouse tables of the PeopleSoft Enterprise Warehouse. ability. Competency Inventory All of the roles.GLOSSARY Compensation Planning In PeopleSoft Workforce Analytics. Compensation Rate In PeopleSoft Workforce Analytics. The competitive examination. Comp time (compensatory time) A PeopleSoft Time and Labor-managed employee benefit where time off is granted in exchange for time worked based on customer-defined criteria. Competitive Appointment An appointment to a position in the competitive service following open competitive examination or under direct-hire authority. Major components of compensation planning include designing pay structures. that is open to all applicants. competencies and accomplishments possessed by the workers in the current workforce. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 43 . The end date is measured from the employee’s grant date. In PeopleSoft Benefits Administration. the process of consolidating multiple load lines. Compressed Split In PeopleSoft Demand Planning.GLOSSARY experience. Concurrent Offerings Multiple stock purchase offerings that are active and outstanding at the same time. Configuration Costing The overall process of reviewing and evaluating anticipated cost data for a configured item. an optional function that allows a split database to be compressed so it can be transferred to an account manager’s computer. For example. for example. Positions in the legislative and judicial branches are outside of the competitive service unless they are specifically included. into one asset. Configuration Code A unique 50-character identification code that accurately tracks and costs inventory with the PeopleSoft Product Configurator. Concurrent Processing The situation in which you run multiple batch processes at a time. Competitive Service All positions as defined by 5 USC 2102 in the executive branch of the Federal Government are in the competitive service unless they are specifically excluded from it. It corresponds to a lot number for a non-configured item. Consolidate Assets In PeopleSoft Asset Management. it might set up configuration and communication parameters for an external server. and/or an evaluation of other attributes necessary for successful performance in the position to be filled. Compress The act of placing a Planning task as early as possible in the schedule without violating any constraints. Configuration parameter catalog Used to configure an external system with PeopleSoft. usually coming from a separate application. simultaneous open enrollment and event maintenance qualifies as concurrent processing. Consolidated Bill A grouping of bills gathered together for invoice presentation. and accounting date for all composite members reporting to one composite asset. with a page summarizing the bills as a group. the process of summing all open Add and Adj transactions by transaction type. Internal contacts are your employees who manage the relationship with your customers. BI Shortages. a constraint can consist of one or more filters and is used to define complex business logic. Interactions with customers can be recorded via PeopleSoft Conversations. Constraints In the PeopleSoft Enterprise Warehouse. RM Shortages. Transaction Date. The bills belonging to a consolidated bill are invoiced and printed together. that. when violated. External contacts are your customer’s representatives who can access self-service transactions GLOSSARY 44 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . from handling billing inquiries to product/warranty questions. Consumption Pattern In PeopleSoft Activity-Based Management. to basic product/service questions. an attribute used to describe how an activity interacts with the cost objects to which it has been assigned. and Excess Inventory. this group of accounts should normally net to zero. Missed Promise Dates. Contacts can be internal contacts or external contacts. Missed Inventory Targets. Contact A person associated with a Customer ID. Consolidations The PeopleSoft Pension Administration functions that accumulate hours. See also Temporal Constraint.GLOSSARY Consolidate Depreciation In PeopleSoft Asset Management. earnings. Once eliminated. A batch type activity may only be performed periodically for a given range of transactions. and pension contributions based on payroll data. Self service interactions can be recorded through PeopleSoft Contact Us. Sustaining type activities generally occur to support the overall operation of a company unrelated to products produced or customers served. Constraints are based on DataMaps. must be repaired to produce a valid schedule. A unit type activity can expect to be performed on a regular basis so that each time a product is produced. For example. each time a machine is setup to produce another product type. Capacity Overloads. Constraint A limit to a schedule. Consolidations-Elimination Set A related group of intercompany accounts that is processed during consolidations. Userconfigurable Planning constraints include Missed Request Dates. Changeovers. Contracting Officer's Technical Representative (COTR) Individual responsible for monitoring a contract and its associated tasks and deliverables. Contributions are deducted from the participant’s paycheck and used to purchase stock pursuant to the offering and purchase period they are enrolled. or a trust. Content references fall into three broad categories: target content. the context in which the PeopleCode program is currently executing. picking. bin to bin transfers. Contacts must have a User ID to access self-service transactions. Contingent Beneficiary In PeopleSoft Pension Administration. including a child. Contractor Any individual or non-employee reporting time that will not be paid through the payroll system. Container An Inventory stock unit for receiving. Content Reference Content references are pointers to some kind of content registered in the portal registry. that is. putaway. Spousal consent is required in order for an employee to name a contingent beneficiary. any non-spouse pension beneficiary. Contact Us A method by which customers and unregistered guest users send email messages to specific addresses or members of the merchant’s organization. and physical accounting. Contribution Represents money a stock purchase participant elects to contribute to the plan. templates. adjustments. and template pagelets. Each container is associated with a unique container ID. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 45 . Contracting Officer (CO) Individual who has the authority and the official responsibility to produce a sound acquisition document.GLOSSARY and receive documents such as sales order acknowledgements. Contextual reference PeopleCode refers to a row or buffer field determined by the current context. other relative. shipping. Merchants can also define automatic response messages. These are typically either URLs or iScripts. Contributions are typically a percentage of pay deducted from the employees’ paychecks. and control and response criteria for a specific product and process. purchase orders. measurement. vendors. such as what accuracy to expect and what statistical method to apply. Control Number A sequential identifying number used to identify an exercise. Conversations may be tied to items.GLOSSARY Contributory Plan A Pension plan to which employees contribute. For example. GLOSSARY 46 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Control Hierarchy The relationship between business units. active budgetary controls over transactions. Conversation Any notes. Control Plan In PeopleSoft Quality. a plan that brings together application. or bills of lading. Control groups are used by the Analytic Forecast Component to govern particular properties of the forecast rule. Control Budget Commitment control enables you to establish budgets that provide extensive. Control Group A mechanism to relate vouchers together for the purpose of controlling voucher input into PeopleSoft Payables. and control groups in PeopleSoft Payables that defines which processing data will be automatically entered on each voucher. Designating a ChartField as the control allows you to set attributes for a specific value of the ChartField that are different from the attributes specified for the budget type in general. They manage differences among forecasts within a set. origins. The Control Group code is assigned to a group of Forecast Item and controls the forecast development and tracking for each item in the group. you can override this value. or detail of a telephone call between an employee and a customer. Control ChartField A control ChartField is a key ChartField that you designate to be the control field. transcript. A set of parameters that determines the major forecast process options. if the tolerance for a Projects budget type is set to 10% in general. Generally used for assigning vouchers to data entry personnel and for reviewing input. rather than just passively recording transactions. payments. Forecast elements are assigned to exactly one control group. document references. making it higher or lower for specific projects. Copy Bill In PeopleSoft Billing. the online environment providing for the replication of a single bill. The term is used to make a distinction between the chart of accounts typically used to record and report financial information for management. Conversion Loader A sample SQR delivered with PeopleSoft Asset Management that transfers data from multiple fixed-length ASCII files into sample. Publicly held companies are required to file documents with the SEC which include: • • • Registration statements for newly-offered securities Annual and quarterly filings (Forms 10-K and 10-Q) Proxy materials sent to shareholders before an annual meeting PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 47 . relational conversion tables. this is equivalent to the Account (ACCOUNT) ChartField. and the general public. Core Functionality Core functionality is the set of information in PeopleSoft HRMS that is common to your entire global workforce tracking needs—and is always displayed on the primary page. workweek or pay period in which a time reporter must be present for work in a flexible work schedule (see Scheduling). Conversion data profile A conversion data profile takes the values from a particular PeopleSoft database table (such as the table holding bank transaction codes) and specifies how that value appears in PeopleSoft Business Documents. stockholders. Core hours The hours a workday. generating a new bill with its own unique invoice number.GLOSSARY Conversion data profile A conversion data profile takes the values from a particular PeopleSoft database table (such as the table holding bank transaction codes) and specifies how that value appears in PeopleSoft Business Documents. as opposed to a chart of statutory (Alternate ) accounts required by a regulatory authority for recording and reporting financial information. Corporate Account In PeopleSoft applications. Corporate Reporting Companies with more than $10 million in assets whose securities are held by more than 500 owners must file annual and other periodic reports. summarizing and reporting costs to management. recording costs. See also Individual Retirement Record (IRR). used to improve the valuation of the company’s common securities outstanding as well as the Earnings Per Share (EPS). Cost Basis Typically. Typically. an organization. However. the appraised value of the asset at the time of death is the cost basis. Cost Accounting A method where business costs are accumulated and distributed to products. Federal employees covered by the CSRS retirement plan require SF-2806-1. are segregated for accounting or reimbursement purposes. This reduces the Common Shares Issued and Outstanding. usually at a premium above the current market price) Filings related to mergers and acquisitions Corporate Repurchase When a corporation elects to repurchase some of it’s own securities. in the case of death of an optionee. GLOSSARY 48 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . in which all related costs attributable to some center within a business (such as an activity. this refers to the original price of an asset used in determining capital gains. A Correction IRR is also used if original retirement deductions were over-reported. classifying costs. or discrete undertakings on an equitable basis. Cost accounting requirements and financial accounting requirements are not necessarily synonymous. There are a variety of cost accounting methods. Correction to IRR An IRR type used when corrections need to be made to an original IRR that has already been submitted to the Office of Personnel Management (OPM). processes. or a program). but they all share the same basic functions. Cost Center A Time and Labor Business Unit. Cost Assignment Resources assigned to cost objects or activities.GLOSSARY • • • Annual reports to shareholders Documents concerning tender offers (a tender offer is an offer to buy a large number of shares of a corporation. often a corporate customer receiving correspondence for associated child customers. allocating costs to products or activities. Correspondence Customer A customer to whom all correspondence (statements) is addressed. Federal employees covered by the FERS retirement plan require SF-3101. and LIFO. Your model’s resources and activities are linked to the cost objects. DC area. Cost Objects Cost objects represent cost information about products. Specific Serial ID. Cost Row A cost transaction and amount for a set of ChartFields. Cost flows available include Specific Lot ID. A profile is associated with a cost book and determines how items in that book are valued. Cost Profile A combination of a receipt cost method. customers. A support cost object may be used in a similar manner but may be further allocated to other support cost objects or primary cost objects. Cost Of Living Allowance (COLA). They are the final results of the activities performed by your business. FIFO.GLOSSARY Cost Element See Inventory Cost Element and Manufacturing Cost Element. customers and channels. Examples are products. Cost Profile Group A grouping of items for the purpose of costing transactions and valuing inventory for a given book. a cost flow. and channels. They are often the focal point of profitability analysis. and a deplete cost method. Non-Foreign A cost-of-living allowance payable to an employee at a location in a non-foreign area where living costs are substantially higher than those in the Washington. Assigning an item to a cost profile group determines the books used by the item when accounting for that item. A primary cost object is typically the main focus of the activity-based management analysis. as well as how the material movement of the item is valued for the book. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 49 . Cost Roll-up A process for calculating item costs. Cost roll-up provides a summation of all of the costs associated with the bill of material structure and the routing used in producing the item. customer or channel that you wish to calculate cost for. Cost of Capital An attribute used to describe the behavior of a particular cost object. Cost Flow Determines how depletions will occur for purposes of costing a transaction. They are the final results of the activities performed by your business. representing the focal point of costing and profitability analysis. This may be a product. but can use any combination of BOM/routing codes). Counts are used primarily during proration calculations. Valid values include production (rolls up only manufacturing data and uses only the primary BOM and routing. Federal employees are mandated by court orders to continue covering or begin covering their former spouses and/or children under their federal employee benefit programs (health. Count Point A predefined step on a routing or operation list where you can gather operation completion information. with any combination of BOM/routing codes). court orders that stipulate that an employee must continue or begin the coverage features for all employee benefits must be enforced. but can potentially be utilized in other situations as well. Court-Ordered Garnishments As prescribed in Title 5. proposed costs (which could be used in preparation for the next standard cost period). Counts Count elements allow you to count the number of days or hours from a specific period of time. engineering (can roll up with either manufacturing or engineering data. and the system automatically backflushes the prior operations. or collection of commercial indebtedness are served on the appropriate entity within the Federal agency and implemented as offsets against the employee's salary. life. GLOSSARY 50 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or activity-based costs (which include costs for items that consume a given activity). United States Code and Title 5. Cost Version Type A combination of cost types and cost versions used in cost rollups. court orders enforcing child support.GLOSSARY Cost Template A collection of cost components that you can apply to a group of purchased items. Court-Ordered Benefits Coverage As prescribed in Title 5. alimony. or simulation (only rolls up with manufacturing data. Examples of cost types include current costs (which reflect the item's current bill of material or routing). United States Code and Title 5. You define the appropriate points on the routing. Count Grade A user-defined evaluation of a counting event. Cost Type A user-defined method of categorizing item costs in Manufacturing for simulations and whatif analysis. each with a code of 1). Code of Federal Regulations. record completions at these count points. and thrift savings). This is only used on production IDs. Code of Federal Regulations. CRAM (Caisse Régionale d'Assurance Maladie) In France. The system shows you time that has already been created. CRAM is the regional social security body which oversees the running of CPAMs. If you’re managing a French workforce you’ll need to identify and track the CPAM offices that impact your enterprise. Credit Analyst A required field used in PeopleSoft Receivables. Billing. Created Time Time collecting device time or elapsed time generated by the system based on the time reporter’s schedule (see Time Administration) Creating Time The preliminary generation of time segments as close as possible to their likely values when you officially report time—so that the information on the time records is as fresh and current as possible. Create Missing Items In PeopleSoft Demand Planning and Inventory Planning. CRAM offices work with companies to both prevent and compensate workers for industrial injury. CPAMs are regulated and established by the French government. Order Management. that is. the credit analyst assigned to the customer is used as the default. and Deduction Management when working with items. a feature that enables automatic system generation of master records that don’t exist in the system. CPAMs are the local social security offices that manage health coverage for French workers. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 51 .GLOSSARY Coverage An employee’s chosen benefit plan and coverage level. what sort of benefit is provided as well as the value. based on a riskier credit rating. The process fills in reporting day gaps as defined by work schedules. rather than you having to create it “on the fly” when you come in to report. Each item must be assigned to a credit analyst. CPAM (Caisse Primaire d'Assurance Maladie) In France. If no credit analyst is assigned to an item. Create Date The date that you extracted a deduction or offset to PeopleSoft Deduction Management or created a split deduction. Credit Risk Spreads In the financial services industry. the additional charge to a risk-free interest rate. Such employees are subject to different tax and social security rules. Cube See Multidimensional Database (MDDB). Crew Reporting A Time and Labor process that enables you to report the earnings which consist of one or several time reporting codes and associated quantities of hours. Critical Success Factors (CSFs) In PeopleSoft Balanced Scorecard. and coverage percentage limits for Life and AD/D plans. Cross Border Walker This term is used in Europe for an employee who lives near a border in one country and works in another country. The parent working view and dimensions determine what forecast data is included and how aggregates are formed. amounts. CREF Acronym for Content Reference. or units. The system transforms the information into instances of daily time for each crew member for the entered date. The process is used when adjustments have been made to a working view and are then required in a related view. Cross-Plan Validation The process by which the PeopleSoft Benefits Administration determines enrollment prerequisites for benefit plans. things that an organization must do well or excel at to achieve its goals. a process that enables the balancing of forecasts between selected levels of related views with the same Forecast Item key. Cube View In PeopleSoft Demand Planning. CRM Warehouse See Warehouses. Key Performance Indicators are attached to CSFs. GLOSSARY 52 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . You can define four types of cross-plan validation prerequisites: prerequisites based on plan types. dependent enrollments.GLOSSARY Credits See Flexible Credits. Cross-View Reconciliation In PeopleSoft Demand Planning. defines the user's own view of a forecast. One or more key factors or objectives that must be accomplished for a particular strategic thrust. and task information for one date under report for a user-defined crew. benefit plans. Although there can be only one definition of Current Period per installation. CUSIP (Committee on Uniform Securities Identification Procedures). such as in the case of sales commissions. You can import market data from outside sources such as Bloomberg. Current Period (Time and Labor) In Time and Labor.GLOSSARY Cumulative Tax Method A payroll tax calculation method that adds together year-to-date earnings and earnings for the current pay period. then annualizes the result before calculating tax. business calendars for markets outside the organization’s domestic operations that reflect the foreign markets’ holiday schedules. the employee's current pay period which will be determined via the employee's Pay Group affiliation. CUSIP Number A nine digit alphanumeric number associated with issuers’ securities. or manually enter the data. Current Year A period for event maintenance processing. A uniform numbering system widely used to identify specific securities and their issuers. An Historical Time Reporting Transaction is one that has an effective date before the first day of the employee's current pay period. Current Period The earliest pay period for which the close date has not passed (see Time Reporting). and for which pay has not yet been confirmed. upload the data from a spreadsheet. A Future Time Reporting Transaction is one that has an effective date after the last day of the employee's current pay period. Currency Calendar In the financial services industry. Curve Generator A supporting module (common to financial services industry applications) that enables you to construct curves used to determine appropriate interest rates for given maturities and / or time periods. Current View A reporting screen in Time and Labor whose effective date is within the date boundaries of an employee's current pay period. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 53 . You can then build configured curves from segments or combinations of other curves. Currency Conversion Engine A PeopleSoft Enterprise Warehouse Engine that processes financial information in multiple currencies. the user can change it manually. This method is useful when Payrolls vary greatly in amounts from pay period to pay period. Cut Session Cut sessions are a means of dividing a course session. Cycle Procedures Inventory planning tasks that need to be performed on a regular basis to ensure an up-to-date Inventory Policy. aging. and instructor. You use cut sessions where a course session does not run on consecutive days from start to finish. Cycle Count A manual counting event that does not cover an entire inventory business unit. Each cut session has it’s own start/end date. Usually includes every item (and lot. Tasks include generating a policy and reviewing Work Queue messages. items. GLOSSARY 54 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . location. actions. you would divide the course session into four cut sessions. if applicable) in a location or family. and should always be performed if the forecast or Control Group or Policy Item parameters change. A customer tree is used to establish and distribute funds and to determine authority levels for promotional activities. For example. Customer Tree A user-defined graphical representation of your current sales organization. and conversations. Custom Statements commonly define employee groups and benefit formulas. Customer Inquiry A window containing options to review customer balances. history. each of which is two days long. The tasks can be performed either at the end of a processing period or within the period. if you have a course that runs for two days a week for a month. Cycle Interval The number of days between cycle counts. or if there are multiple instructors or locations.GLOSSARY Custom Statement A user-created logical or mathematical expression that determines information about an employee in PeopleSoft Pension Administration. Customer Scorecard See PeopleSoft Customer Scorecard. at their most simple level. data elements are used as the basis for key performance indicators. Data Entry Access List Used to present a concise list of often-performed data entry tasks to a user. Data Loader Data Loader is a PeopleSoft Enterprise Warehouse utility that moves data from the Operational Data Store staging area to either the ODS reporting area or the Data Warehouse. Data Extract A report that creates a file used to transmit data to a third party on magnetic media. analytical application engine results. transform it. products. define a subset of data and the rules by which to group it. departments. statistical quantities and other measures across business units. data elements are rules that tell the system what measures to retrieve about your workforce groups. customers and channels—any field or logical group in the chart of accounts.GLOSSARY D DAT file A text file (input. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 55 . Data Manager A PeopleSoft Enterprise Warehouse engine that distributes revenue. It is also used as a means of posting to the Performance Ledger. The Data Loader utility is made up of several pages that allow you to enter Metadata to define your source and target records and your transformation rules and then perform the load by running an Application Engine.dat) used with the Verity search engine that contains all of the information from documents that will be searchable but not returned in the results list. Data Elements Data elements. For PeopleSoft Balanced Scorecard. Data Loader Map Defines how to extract data from the Operational Data Store (ODS). There is no meaningful printed output for this type of report. The target table can reside in the warehouse or the ODS layer. You can define a number of types and options within this engine. For Workforce Analytics. expense. and load to a Target Table. and as target values for Key Performance Indicator (KPI) objects. You can assign multiple control plans to a single data entry access list. DataSet DataSets are used as input for various engines and processes. See Data Manager Methods. and data elements in the Key Performance Indicator Manager. Each method enables you to move and/or enrich engine output. enabling you to more easily understand the functional aspects of the process. drivers in Activity-Based Management. Data Mart Builder The Data Mart Builder is a multiple Application Engine (AE) process. GL Mapper. and Tree Aggregation. optimized to support the analysis needs of the enterprise. Data Warehouse A large database containing data summarized from one or more transactional systems.GLOSSARY Data Manager Rules In the PeopleSoft Enterprise Warehouse. the underlying logic is the same. aggregating. To identify each data row uniquely. Data Mart A Data Mart is a data structure that uses a central fact table and related dimension tables to generate a “relational cube” or directly generate an Insight report. Spread Even. Data Manager rules use Constraints to specify the source as well as the target tables for moving. An increasing GLOSSARY 56 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . DataSets provide a user defined set of information to the engines. Users analyze the data in the warehouse using Online Analytical Processing (OLAP) tools and ad hoc query/reporting tools. the Data Manager. Each DataSet is created by a process specific setup. that is. user defined functions. Data Manager Methods There are several methods: Copy. the Analytic Forecasting component. Rules use Data Manager methods to enrich the PeopleSoft Enterprise Warehouse data. Data Row Contains the entries for each field in a table. or multidimensionalizing your engine output. DataMaps bring together information from many different tables and fields and define it all as one entity or table. However. DataSets use Constraints to restrict used columns and restrict returned rows. Prorata. that creates a Data Mart. DataMaps Information that builds upon the data captured in the TableMap records. a framework of procedural programs. An ideal data warehouse contains all the data necessary to make business decisions. the system uses a key consisting of one or more fields in the table. for instance. DataMaps enable you to define a logical view of the physical PeopleSoft Enterprise Warehouse tables. Date Eligible To Retire Date an employee is eligible to optionally retire based on the combination of age and service that meets legal requirements.GLOSSARY number of organizations have "virtual" data warehouses. or determine a new date by taking a starting date and either adding or subtracting a period of time to come up with another date. you use a date element. Date Classified Date the Position Description is approved by Management/Position Management. In PeopleSoft Planning. a file that stores schedule information such as tasks. Data Warehouse Tables Data Warehouse tables act as the portal for getting data into the PeopleSoft Enterprise Warehouse from PeopleSoft. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 57 . The dataset is similar in content to a spreadsheet. calendars. and so on. For error detection and handling For data validation. Date If you want to either include a date in a calculation. Date See Accounting Date Transaction Date or Effective Date. See also PeopleSoft Enterprise Warehouse. Database Alias The PeopleSoft Pension Administration utility that looks up employee data. For aggregation. Dataset A file containing data to be analyzed by the Quality Server program. These tables are used: • • • • As targets for loading operational data. OLTP applications or other “outside” sources. but rather a collection of specialized (and distributed) data marts. where the data warehouse is not one physical database. resources. union dues. Using this method. (See Understanding Workgroups. Deal Type PeopleSoft Treasury has categorized deals into several basic deal types from which you can choose when defining an instrument. See also Benefit Deduction and General Deduction. GLOSSARY 58 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Decompressed Split In PeopleSoft Demand Planning. Deduction Reason Code that describes the type of deduction. Deduction Date The as of date for the deduction item in PeopleSoft Receivables. It’s used to determine the “logical” date of a punch. a method that can be used with several types of Inventory Policy. When assigned to a write-off resolution. it determines what accounting entries to create.) Days Supply In PeopleSoft Inventory Planning. a specific number of days of supply for an item should be used to calculate the item's inventory policy. Deduction Any amount taken from an employee’s pay check each pay period. a function for returning a compressed split database to its original form. See also Compressed Split. The Date Under Report does not have to equal today’s date. Deductions may include health or medical benefits. and so on.GLOSSARY Date Under Report The date (day) in PeopleSoft Time and Labor for which time is being reported. Day Breaker Customer defined time that is used to determine when one day becomes the next. Deduction Item An individual item that you created in receivables and is an open receivable on the customers account due to a deduction that they took in a payment for a receivable item. Death Coverage The PeopleSoft Pension Administration function that determines the factor used to reduce an employee’s benefit when the plan charges for PRSA coverage. If the debt does not default. individual components are handled through kit issues/returns. A definition has to be explicitly associated with an employee Group Definition before it can be applied. the identification of employees who are likely to leave the organization based on predefined assessment criteria. an approach used by financial institutions to predict a decline in portfolio value. Defection Analysis In PeopleSoft Workforce Analytics. Definition or Function Definition The parameters for any of PeopleSoft Pension Administration’s nineteen core functions. annuities. Note: Profit sharing can be considered direct pay if paid out in cash on a periodic basis or deferred pay if cumulative with the intention of payment in the long-term future. Deduction subsets minimize data entry time in special processing situations such as bonus check runs. This is used when entire kits need to be returned. there is no change in the value. Default Mode (DM) model In the financial services industry. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 59 . Only two outcomes are considered – default or non-default. If the debt does default. stock awards and profit sharing. Deferred Compensation Compensation payments that are payable to an individual in the future such as pension plan payments. then the loss is calculated as the difference between what was contractually owed and the value of any collateral recovered.GLOSSARY Deduction Specialist The individual responsible for tracking and resolving deductions in PeopleSoft Deduction Management. Defined Benefit Plan (DB Plan) A retirement income plan (usually called a pension plan) where the employee's benefit is definitely determinable based on a plan-specified benefit formula. Deduction Subset A group of deductions selected from a company’s standard set of deductions. Dekit The ability to return material issued in kits to inventory. Deferred Vesting The adjustment made to the original option’s vesting schedule that pushes the vesting into the future. You can set a demand priority from 1 to 998 with 1 being the most important level. Demand Priority The placing of importance on independent demand. a set of rules that will sort demand so the most important demand will have the first opportunity to reserve available inventory. The Planning engine uses the demand priority value to determine the order in which you fulfill the demand. Demand Number The configured product sub-component sequence number. The priority value of 999 is reserved for the system. the system automatically adjusts it to the level of the boundary and logs a message to the Work Queue. Demand Planning In PeopleSoft Activity-Based Management. If the demand falls outside of a band that is considered reasonable. Demand Filtering In PeopleSoft Demand Planning. The difference between these results is typically referred to as the retro “delta.” A retro delta can represent either an underpayment or an overpayment that results in an adjustment to the payee’s earnings. This could be an employee demand. The system compares the recalculated results to the original results. specifies the confidence interval within which demand is considered to be reasonable. Demand Collection of training requests. this type of planning focuses on studying the impact of cost objects and activity volumes. Delta When retroactive processing occurs for a given payee. a departmental one or a company-wide demand. If demand priority rules have GLOSSARY 60 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .GLOSSARY Delete Non-Matching Items In PeopleSoft Inventory Planning. Demand Filter Width In PeopleSoft Demand Planning. The item deletion occurs when the system generates the policy. Actual demand that is outside the confidence interval is automatically filtered and replaced by the value at the edge of the interval. an option used in the Generation process to delete Inventory Planning items that don’t have corresponding items in Demand Planning. provides a way to detect and highlight unusual demands and forecast errors. Demand Priority Rules In PeopleSoft Inventory. The value is expressed as a percentage. the system recalculates each element generated for the payee. Deplete Cost Method Determines how you cost a depletions transaction within a book. This is valid only in the year the asset was acquired. Depreciation . This figure is then multiplied by the percent of years to depreciate. Periodic Weighted Average.Declining Balance Budgeting calculates this as: Cost minus Accumulated Depreciation divided by Life divided by number of periods per year. It results in a higher depreciation expense in the early years of an asset.Double Declining Balance Budgeting calculates this as: Cost minus Accumulated Depreciation multiplied by 2 divided by Life divided by number of periods per year. Perpetual Weighted Average. processing those with the lowest rank value first. Per-Period Straight-Line depreciation is calculated as the cost of an item minus the salvage value divided by the number of periods to depreciate. Depreciation . the Material Reservations process (INPLDMND) sequences orders by priority rank.GLOSSARY been defined. Depreciation . which decreases as you near the end of its useful life. Non-Cost. which decreases as you near the end of its useful life. and sum of the years.Straight Line A method of depreciating asset value in equal amounts across the life of the asset. Depreciation . The deplete cost methods available include Actual.Sum of the Years A depreciation method equal to the value of the remaining years of life divided by the sum of the years remaining is multiplied by the Net Book Value. Depreciation Methods The various methods of spreading the aquisition cost across the life of an asset rather than expense the full value of an asset at the time you acquire it The value of the asset consequently decreases (or depreciates) through time. This results in a higher depreciation expense in the early years of an asset. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 61 . Depreciate When in Service A switch that indicates whether PeopleSoft Asset Management should allocate depreciation as of the date an asset was placed in service. which decreases as you near the end of its useful life. It results in a higher depreciation expense in the early years of an asset. The four depreciation formulas delivered with PeopleSoft Budgeting include: declining balance. straight line. double declining balance. and Value at Current Standard. a view option that assists in summarizing the rows of data in lineitem budgeting. This employee is considered for pay and strength count purposes to be permanently occupying his/her regular position. the process of making an adjustment to actual demand data that removes the effect of a promotion during a defined period. Swift ID. chain. a detail is documented with an SF52. or CHIPS ID. consisting of Transit Number. The geography dimension would include company. Derived Metric The result of a calculation on a report of base metrics. district. customer. and finally store attributes. Detail Tree A tree that employs ranges of detail values under each node. A single element of a budgeting model. and vendor. region. DeptID A ChartField that defines departments or administrative offices that have operational. time.GLOSSARY Depromote In PeopleSoft Demand Planning. used to pinpoint a particular piece of data. such as time. in the retail industry a set of dimensions could be geography. such as product. and location. you must manually specify the detail values. these dimensions typically represent the ChartFields used by your organization during your budgeting process. or operating unit. DFI ID (Depository Financial Institution ID) A PeopleSoft Payables bank identifier. product. the system creates an adjusted demand entry that is equal to the Prorated Forecast. such as account. In terms of data analysis. Detail A temporary assignment to a different position for a specified period when the employee is expected to return to his/her regular duties at the end of the assignment. In PeopleSoft Budgeting. product. As a promoted period moves into history. department. Dimension A single element of a business model. product. or location. In PeopleSoft Budgeting. fiscal and/or budgetary responsibility for specific sets of activities. department. dimensions can be thought of as criteria. A dimension is also a column heading on an analysis and reporting template which you can drill through or roll up to the multiple levels. project. GLOSSARY 62 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Cube Manager uses the term Conforming Dimension. Unless the agency chooses to use an SF50. For example. Geography and Product. bonus). Direct Calculation Calculate actual and directly assigned dollars. Direct Compensation In PeopleSoft Workforce Analytics. base pay.GLOSSARY Dimension Table In the PeopleSoft Enterprise Warehouse. including time period and associated user data definitions. profit sharing. incentive. Disbursement views are built directly from the working views and inherit many working view attributes. shift differentials) and variable pay (for example. promotion. is not an employee of the corporation. Note: Profit sharing can be considered direct pay if paid out in cash on a periodic basis or deferred pay if cumulative with the intention of payment in the long-term future. from the parent working view. Dimension Tables store additional attributes or data about Facts. training. benefits. Cash payments made to workers in exchange for their contributions to the organization. generally. A Director. Director An affiliate of the company who holds a seat on the Board of Directors for the corporation. Disability and Discrimination Act of 1995 In the United Kingdom this act makes it unlawful to discriminate against individuals on the basis of their disability in relation to recruitment. Disbursement View In PeopleSoft Demand Planning. Channel. terms and conditions of employment. Direct Compensation is typically categorized as including Cash Compensation and Long-term Variable Compensation. Disability Rate Code The desired percentage of disabled persons that should be employed by French employers. a direct cost of an activity or a cost object. An example is the salary cost of employees working on a project. as mandated by the French government. a Forecast View that allows the forecast from a working view to be reported on using an alternate key. and dismissal. Direct Cost In PeopleSoft Workforce Analytics. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 63 . Direct pay is typically categorized as fixed pay (for example. Some example dimensions include Customer. Direct Compensation is payment made to workers in exchange for their contributions to the organization. between the option price and the fair market value of the corporation’s stock on the date of exercise. benefits. A distribution profile can be used to set up defaults for how the system should distribute costs associated with a position’s salary. In the case of Incentive Stock Options. and budget amounts. This figure can then be modified based upon management’s perception of actual value created by the group or employee. or it’s budgeted. Discretionary Plan In PeopleSoft Workforce Analytics. When a customer orders a product. the system uses this network to determine which warehouse the stock ships from. Distribution Provide a repository of time and associated estimated and actual allocated labor costs to other systems The process of assigning values to ChartFields.GLOSSARY Discounted Stock Option Rights to a stock option at a price less than 100 percent of fair market value at the time of grant. less any fees. the holding period is one year of the date of exercise and two years of the date of grant. GLOSSARY 64 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . A distribution is a string of ChartField values assigned to items. and earnings. the holding period is one year from the purchase date and two years from the enrollment date. payments. expressed as an opportunity. Distribution Network A distribution network is a prioritized list of Inventory business units (IBUs). Disqualifying Disposition (DD) When an optionee sells or otherwise disposes of the shares of stock acquired through the exercise of an incentive stock option or through an employee stock purchase plan before the holding period for preferential tax treatment has lapsed. Distribution Profile A definition of ChartField distributions assigned for compensation costs. At the time of disposition. if any. If the sale price is less than the fair market value of the stock on the date of exercise. group. Compensation income in a disqualifying disposition is equal to the difference between the total fair market value on the purchase date and the total purchase price. In the case of purchases through an employee stock purchase plan. this is a plan for distributing compensation awards that provide managers the ultimate discretion over a pool of money which is either funded based on company. The discretionary award determination is sometimes guided by a pre-determined percent of the participant’s salary. the individual recognizes compensation income equal to the difference. the compensation income is limited to the total sales price less the total option price. PeopleSoft Budgeting-specific. or employee performance. You can associate pertinent documents with engineering change requests (ECR). the PeopleSoft system assigns a document sequence number to that document. purchase orders. accounting date. invoices. Document Sequencing A flexible method that sequentially numbers the financial transactions (for example. and document type. item revisions. and edit documents in a secure vault. prorated by the class of security and paid typically in the form of money or stock. production component lists. launching them from within PeopleSoft applications. or journal). Distribution Type An identifier that defines one of the different transactions that move an item into or out of an inventory business unit. all documents you enter are numbered sequentially. Document management enables you to seamlessly perform online document queries and view documents directly. or journal) when you create a document for a business unit that you have enabled for document sequencing. engineering change orders (ECO). and production operation lists. bills. and document type—and that within each transaction type. manufacturing and engineering routings. Document Management The process through which a user has complete control of document version including the ability to view. The system determines the number by the values of the business unit. journal code. bills of material. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 65 . and payments) in your system for the purpose of statutory reporting and tracking of commercial transaction activity. Distribution types are used to create debit and credit transactions to the general ledger via the Journal Generator. Dividend Distribution of earnings back to shareholders.GLOSSARY Distribution Rule You use distribution rules to determine the order in which the system searches for matches against the distribution sets matrix when sales orders are entered. Distribution Set Distribution Sets assign account distribution information to combinations of defining elements used on sales orders. voucher. When you create a document (such as an invoice. voucher. Document sequencing requires that you classify all financial transactions into three transaction types—journal type. The amount of a dividend is decided by the Board of Directors and is usually paid quarterly. query. Document Sequence Number A value that the PeopleSoft system assigns to a document (such as an invoice. Draft Worksheet A work space used in PeopleSoft Receivables to track a draft through its processing life cycle. At that point it becomes a Qualified Domestic Relations Order. necessary when using document sequencing. Document type is the only required category. The order is not in effect until it is determined to be “qualified” by virtue of meeting certain requirement. because the values of the other two categories can be derived from document type. This value allows a margin of error for an item during cycle count reconciliation based on item cost. For instance. Dollar Tolerance In PeopleSoft Inventory. Drill-Back Calculation Assigns indirect dollars and Drill-Back calculations. It represents the business purpose of a financial transaction. you can drill down to the expenses for each department in the division. Also. the acceptable cost difference between expected cycle count quantities and actual quantities counted. Domestic Relations Order (DRO) A preliminary version of a court order (usually stemming from a divorce settlement) ordering a division of a participant’s pension benefits. if you’re looking at an expense figure for a division. The standard double byte character set name format in PeopleSoft applications is: [last name] space [first name]. GLOSSARY 66 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Document type is within one and only one journal code. such as domestic customer invoice or customer credit memo. Double Byte Characters If you’re working with Japanese or other Asian employees. Drill Down The ability to go down to the next level of detail in a set of data. or QDRO. this picks-up all costs in the Calculations Detail (CALC_DETAIL_F00) that was assigned during direct calculations. if you’re looking at an expense figure for a division. you can drill down to the expenses for each department in the division. Drill Down The ability to go down to the next level of detail in a set of data.GLOSSARY Document Type The final level of three categories for defining a financial transaction (or document). you can enter the employee’s name using double-byte characters. For instance. journal code is within one and only one journal type. For example. OLAP tools provide a powerful DSS. typically aimed at analysts and line managers. drivers are a means of assigning dollar amounts from resources. you can calculate the duration between his birth date and the calendar period end date. the utility that calculates the length of time between two dates. Drivers In PeopleSoft Activity Based Management. For example.GLOSSARY Driver Lookup Table Tables associated with a driver that enable different rates and amounts unique to a budget center. activities. duration. percentage. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 67 . The driver values and the defined relationship then combine to produce a projection of the financial result. and intensity). and different ways of specifying how those dollar amounts are calculated (amount. as well as different ways that dollar amounts are assigned (depending on assignment type and object type). In PeopleSoft Business Planning. Dynamic Tree A tree that takes its detail values—Dynamic Details—directly from a table in the database. rather than from a range of values entered by the user. All employees who fit this criteria at processing time belong to the group. Drivers can also be assigned across business units. and direct). In this context. a driver should be interpreted as a projection of external factors and other indicators. and cost objects to other resources. Duration In PeopleSoft Pension Administration. DSS (Decision Support System) A DSS is a workstation-based analysis and reporting system. There are different types of driver categories (transactional. Dynamic Group A group in Time and Labor that enables you to establish criteria or attributes for a group of employees. a projection of the number of square feet used (driver) and the price per square foot paid in rent (driver) can combine to produce a projection of rent expense (financial result). Duration [Global Payroll] An element type that calculates a period of time between two dates. if you want to determine a payee’s age. a driver can be defined as a set of values that are used as an input to another process. The user can the define a relationship between the driver and a financial result. activities. and cost objects throughout the model in PeopleSoft Activity-Based Management. spread even. DRO See Domestic Relations Order. or other calculation routines. E Earliest Change Date Determines both the range of dates and the amount of data that will be processed for each time reporter (see Batch Processing) Early Punch A punch that is more than the predefined number of hours/minutes before a scheduled punch where a time reporter is warned Early Retirement Date (ERD) A retirement date earlier than a plan-specified “normal” retirement date. or some other percent of a budget. You can specify that you are to receive a warning when commitments and expenditures reach a predetermined percentage of budget. For example. warning of possible future budget exceptions. By using dynamic views. plus other types of compensation and holiday. Employees usually must meet age and/or service requirements to be eligible for early retirement. hours worked. Earning Group Part of a group of defaults assigned to job codes. Early Warning In commitment control. and bonus pay. and early retirement benefits are often reduced to compensate for the longer duration of payments. you streamline the working view and can complete the working-view design without having to anticipate all conceivable adjustments. vacation. Earnings The amount owed to an employee based on salary.GLOSSARY Dynamic Views In PeopleSoft Demand Planning. 80%. GLOSSARY 68 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Early Retirement Factor The reduction made to an employee's benefit if the employee elects for early retirement. a Forecast View that allows interaction with the forecast data using an alternate key structure. Earnings group may include non-salaried items such as holidays and bonus pay dependent on individual company parameters. Early/Late Adjustments The PeopleSoft Pension Administration function that calculates early retirement factors or late retirement factors. you can instruct the system to let you know when commitments and expenditures reach 50%. Examples include salary. commission. Economic Loss In Funds Transfer Pricing. the inbound EDI Agent loads trading partner data (flat files) into the PeopleSoft database using transaction. calculated by applying the theoretical value of the interest rate differential (IRD) against a cash flow stream. EDI Agent Used in EDI processing. Net income (reported or estimated) for a period of time is divided by the total number of shares outstanding during that period. Economic Value Added is a financial metric that factors into the measurement of an activity’s profitability the cost of economic capital assigned to that activity. Organizational Administration instructions. Earnings Type may also contain Benefit Entitlement and Administration instructions. and retirement pay. Analysis. this refers to the break fund economic loss. overtime or leave. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 69 . map. Earnings Type An abbreviated and encrypted set of business instructions containing compensation instructions. bonuses. based on the amount of the prepayment or cancelled draw-down. and other instructions. and Retrieval) An electronic system implemented by the SEC that enables companies to file documents in conjunction with disclosure requirements mandated by the SEC. Financial Accounting instructions. work group and labor affiliation instructions. and trading partner definitions set up using EDI Manager. Earnings Per Share (EPS) The portion of a company's profit allocated to each outstanding share of common stock. EDGAR (Electronic Data Gathering. Economic Value Added In the financial services industry. taxation instructions.GLOSSARY Earnings [Global Payroll] An element type that defines the different types of compensation that are added to a person’s pay. Earnings Code Codes that represent the various types of earnings such as regular. The outbound EDI Agent extracts information from the PeopleSoft database and generates data files that can then be processed for transmission to a trading partner. Earnings Accrual Class Categorizes a set of accruable earnings. GLOSSARY 70 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . or postdate information in order to enter it before it actually goes into effect. trading partner profiles. showing the percentage of income actually paid in taxes. Effective Tax Rate The ratio of income tax paid over gross income. The Effective Date usually defaults to your system’s current date. Effectivity Date The date on which a component can be added or substituted in production. As fields are entered into a PeopleSoft application. the number of periods of historical demand used in the Model Reset process. Effective Sequence A system-generated number assigned to distinguish between two job entries with the same effective date. Effective Periods In PeopleSoft Demand Planning. such as the Department table. and translation maps for EDI transactions. typically specified on an item's bill of material. Effective Date A method of dating information in your system.GLOSSARY EDI Manager A suite of online pages used to define transaction sets. You can predate information to add historical data to your system. You can predate information to add historical data to your system. The value can be used to exclude older. Edit Table A table on the database that has its own record definition. possibly unrepresentative historical demand data from model Optimization. Effective Date A method of dating information in your system. they can be validated against an edit table to ensure data integrity throughout the system. EEO Company Code In the United States companies are assigned this federal code for EE0 and VETS100 reporting. or postdate information in order to enter it before it actually goes into effect. and typically requires less knowledge about the underlying transactional systems. Element Name Name assigned by the user for data fields. Element Group’s expedite the process of manipulating earnings and deductions. OLAP tools provide a powerful EIS. An Element can be one or more columns of data in an Enterprise Warehouse table. deductions. Department. An EIS provides a higher-level view of the data than a DSS. subscription data from a third party. preexisting Profiles. absence entitlements. and absence take elements. Element Group Element Group identifies a group of elements to provide eligibility. Financial Management Service's financial system. Electronic Certification System (ECS) An automated Payment Voucher authorized by the Certifying Officer for use within the Treasury Department. elements. associated with a single dimension (for example. You can then use this as a notational shortcut—instead of having to list each element. or objects. Primary elements are comprised of earnings. This method can be used for scheduling of elapsed time reporters (see Scheduling.GLOSSARY EIS (Executive Information System) An EIS is a workstation-based analysis and reporting system for executives. the names you give to new rules. Elapsed Schedule A method of scheduling a time reporter’s time that is based on TRC and duration. Element In PeopleSoft Global Payroll. For example. PeopleSoft provides a method to record and generate data files for on. Population. Elapsed Time Service A method of calculating a period of service that uses only the start and end dates of the period to determine the amount of service. or Channel).) Elapsed Time Reporting non-clock time in increments of hours or partial hours (see Managing Time / Understanding Time Reporting). formulas. Product. Supporting elements are element components that are combined to create primary elements. you can use the element group name. and data mining scores. and tables. an element refers to both primary elements and supporting elements. Hours worked or other measures of the actual work performed during the period are not taken into account.and off-cycle processed payments. elements are used to create a Profile. Customer. rules. An Element can also be KPI. In PeopleSoft Enterprise Performance Management. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 71 . rejection. absence entitlement. GLOSSARY 72 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . publishing. Also. Employee ID A unique identification code for an individual associated with your organization. Unlike period segmentation. and/or targeting. Eligibility Rule PeopleSoft Benefits Administration uses eligibility rules during Benefits Administration processing to determine which benefit programs and options an employee is eligible for. Eligibility Group Eligibility groups define the possible earnings. Employee Accounts The PeopleSoft Pension Administration function that tracks employee contributions to a pension plan. there is only one gross-to-net result set. requiring the affected element (and perhaps a subset of other elements) to be calculated multiple times on either side of the date on which the change takes place. element segmentation is used. the system segments only the elements you select. and absence take elements that a payee might be eligible to receive. and creates separate result columns only for the specified elements. deduction. Eligibility rules are closely associated with event rules: they determine what options an employee can have.GLOSSARY Element Segment When an element changes mid-period. while event rules determine which of those options an employee will actually be able to choose. the PeopleSoft Pension Administration function that determines this amount. This enables you to group payees so as to assign eligibility for certain pay elements. Elimination Set See Consolidations-Elimination Set. Employee An individual employed by an organization and administered as an employee in the PeopleSoft Human Resources system. Employee Paid Benefit The portion of a pension benefit funded by the employee’s own contributions to the pension plan. In element segmentation. Email Template Pre-defined parameters that establish automatic email generation during budget submittal. Employer’s Liability Insurance Associations (Berufsgenossenschaften) Social Insurance in Germany is maintained and administered by private organizations that act as employer’s liability insurance associations. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 73 . Employment Equity Computerized Reporting System (EECRS) Canadian companies are required to report to the Federal Government on employment equity. Employee Survey Report The Employee Survey Report is an annual regulatory report that the French government requires from employers with more than 200 employees. who administer and pay out funds to workers who are injured on the job. Employee Training Cost Amount budgeted to pay for students’ salaries while on training courses. Employee Survey In PeopleSoft Workforce Analytics. a method for capturing information about the activities performed by a given employee as well as the amount of time they spend performing each activity to perform activity-based management. Employment Cost Index (ECI) Adjustment Annual increase to wages established/permitted by statute. Employers pay out premiums to these associations. The report is communicated to both labor unions and the government.GLOSSARY Employee Profile This PeopleSoft Activity-Based Management feature enables time and labor information to be part of an analysis. Employee Stock Purchase Plan A type of statutory stock option plan through which employers grant options to their employees in order to provide them with additional forms of compensation. In French it is called "Le Bilan Social". which creates a data interface file to the federal government’s Employment Equity Computerized Reporting System (EECRS). Employer Identification Number (EIN) In the United States a company is typically defined as a business enterprise that has a unique federal Employer Identification Number (EIN) for payroll tax reporting purposes. It provides a snapshot view of the company over the past 3 years for about 200 indicators. PeopleSoft Human Resources contains the Canadian Employment Equity report (PER101CN). and subassemblies that form the basis of all item and product structures. It just means that if the situation as it exists today does not change. separate from production. It is a projection of future expenses based on the situation. consisting of engineering bills of material (EBOM). and seamless integration to a document management vault. released by engineering to modify or correct a part and/or bill of material. separate from production. you will spend all of those funds by the end of the fiscal year. ECRs can also be routed for review and approval. EBOM cost rollup capability. A numeric value (0. 1. engineering change orders. EBOM cost roll-up capability. 2) is assigned to each job as a way to uniquely identify that job record. engineering change orders. Engineering Bill of Material (EBOM) A listing of all the parts. Engineering Cost Version The process of generating cost versions for new and modified configurations based on engineering bills of material (EBOM) and costing data. PeopleSoft Engineering uses ECOs to manage and document required assembly and component changes. raw materials. Engineering Change Order (ECO) A revision to a blueprint or design. as we know it today. engineering change requests. EBOMs differ from MBOMs (Manufacturing Bills of Material) in that they are not visible within Production Planning or Production Management and are isolated from Manufacturing. When workflow is enabled. Engineering Change Request (ECR) A document that allows you to request manufacturing process improvements and report product defects directly to the engineering department. GLOSSARY 74 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Engineering Workbench An engineering environment. Encumbering funds is not the same as spending them or even guaranteeing that you will spend them. online BOM comparisons. Engineering Workbench An engineering environment. engineering routings. and seamless integration to a document management vault. engineering change requests. consisting of engineering bills of material (EBOM).GLOSSARY Employment Record Number (EMPL RCD#) A field in PeopleSoft Human Resources Management Systems and PeopleSoft Workforce Analytics that indicates an employee has multiple job records in the system. after which they change into ECOs. online BOM comparisons. Encumbrance A claim against funds. human resources. requisition posting is a Purchasing process. to produce standard supplemental accounting entries. and payroll applications. It can be used with or without any PeopleSoft application. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 75 . For example. The term includes financial. and cash clearing is a Payables process.GLOSSARY Enterprise In PeopleSoft Time and Labor. an identifier or label. Entry Event An automated process that generates multiple debits and credits resulting from single transactions. manufacturing and supply chain. It can be used as a standalone corporate portal that does not access PeopleSoft data at all. supplemental accounting entries based on Entry Event codes. Entry Event processes combine to form Entry Events. all of the business units of the installation site. Entry Event Code Designation of an Entry Event. Enterprise Performance Management (EPM) See PeopleSoft Enterprise Performance Management Enterprise Portal The PeopleSoft Enterprise Portal is a separate product offering purchased independently of any other PeopleSoft applications. Enterprise Resource Planning (ERP) The encompassing term for all the transaction-oriented database applications an organization deploys across it’s business enterprise. Entry Currency The currency used to enter budget data. Each process can involve one or several Entry Event Steps. Entry Event Process An accounting transaction. among others. Entry Event Generator A mechanism that generates standard. Enterprise Warehouse (EW) See PeopleSoft Enterprise Warehouse Entry Authority Authorization granted by employees to specific user IDs for entering expense data on their behalf. and prepare revenue estimates. this automated process reduces the process time and reduces the possibility for errors. Equity Increase In PeopleSoft Workforce Analytics.GLOSSARY Entry Event Step Part of an accounting transaction. the BUDG process includes these steps. EPM (Enterprise Performance Management) See PeopleSoft Enterprise Performance Management Equal Employment Opportunity Commission (EEOC) In the United States the EEOC requires that most companies file one or more reports from a series named EEO-1 through EEO-9. ERISA (Employee Retirement Income Security Act of 1974) The U. Entry Type Any activity that creates or updates an item. among others: prepare allotment budgets.S. Federal legislation enacted to prevent abuses of employee pension rights by employers. Equivalent Standard Deviation In PeopleSoft Demand Planning. a Standard Deviation developed during the Model Reset process that enables you to compare standard deviations from different models. prepare organization budgets. Entry On Duty Date (EOD) Date that indicates when an employee started to work at his/her current agency. The deviation is calculated by multiplying the Model Equivalency Factors defined on the Control Group by the standard deviation. For example. Equitization A process that enables parent companies to calculate the net income of subsidiaries on a monthly basis and adjust that amount to increase the investment amount and equity income amount before performing consolidations. Entry Event steps combine to form Entry Event processes. These reports include counts by federal employment categories of male and female employees in certain ethnic groups. GLOSSARY 76 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Equity Increases are base pay increases granted to bring an employee’s pay up to some internally specified standard for your organization. For organizations with complicated parent/subsidiary business unit relationships. Ethnic Code The Federal Office of Management and Budget (OMB) racial and ethnic census categories used for classifying individuals in U. Estimated Shipments A group of shipment schedules used to manage sales order requested shipment data and actual shipment data. increasing the budget amount. For the transaction to proceed. indicates the number of future periods to use for the calculation of forecast errors. then the forecast error in April 2001 (after posting demand for April) would be determined by comparing the actual demand for April and the April forecast generated in February 2001.S. such as canceling or reducing the transaction amount. Evaluation periods are set separately for each view. Estimated Gross Estimated labor cost associated with reported time (see Managing Time.GLOSSARY Error Exception A transaction that is stopped because the budget limits would be exceeded if it continued. action must be taken. ETL (Extract-Transform-Load) See Extract-Transform-Load. Government reports. ETL maps ETL maps provide rules for importing your source data to the data warehouse tables. Used in conjunction with weight and volume pricing and freight charge calculations. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 77 . or transferring available funds from another budget. Evaluated Receipts Settlement (ERS) A PeopleSoft Payables feature that matches receipts against purchase orders and generates vouchers without requiring an invoice. Error Ratio The ratio of the statistical Standard Deviation to the base component that gives an indication of the accuracy of the forecast. overriding the budget limits. Understanding time Reporting Codes). The ratio is presented in the PeopleSoft Demand Planning Audit and Accuracy Review and is calculated during the Forecast Calculation Process. For example. Evaluations Periods In PeopleSoft Demand Planning. if the number of evaluation periods is two. As each point is encountered. SavePreChange. Event Class An event or type of event that results in a change of benefits eligibility for an employee or dependent. Event rules should not be used to determine eligibility. Changes involving maintenance include new hires and re-hires. Event Maintenance The process that enables you to manage ongoing enrollments during a plan year. the system writes a line to a trigger table. OnRouteSubscription. Event Trigger You use triggers to tell the system that when a change takes place to certain data (an event). GLOSSARY 78 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . the system reads the data from the trigger table and performs the appropriate action. See also PeopleSoft Enterprise Performance Management (EPM). Event Rule Used by PeopleSoft Benefits Administration to determine how events are processed by the system. Then when it’s time for the action. family status changes. Event Occurrence or happening. Event rules look at the benefit plan options an employee is eligible for and determine which options the employee can actually choose. Expected Losses In the financial services industry. the amount the institution predicts it will lose in portfolio value. Event classes are prominently used in COBRA and Benefits Administration processing. Event rules are closely associated with eligibility rules but it is important to note that they are not the same. triggering any PeopleCode program associated with that component and that event. and changes to benefits eligibility. Loan loss reserves are set aside to cover the expected losses. EW (Enterprise Warehouse) See PeopleSoft Enterprise Warehouse. it should perform an action automatically. When the event occurs. and so on. terminations. Examples of events are FieldChange.GLOSSARY Event Events are predefined points either in the Application Processor flow or in the program flow. the event fires on each component. GLOSSARY Excepted Service As defined by 5 USC 2103. Exchange Rate Variance In PeopleSoft Cost Management. while an exception which is a result of an employee not clocking in has a High severity (see Time Management). reported time. the change in currency exchange rate between the time the item is received into inventory and vouchered in Accounts Payable. and enables you to drive pricing with a promotional structure. For example. in exception which is a result of an employee clocking in late may have a Medium severity. a matching feature that compares the exchange rate on the purchase order and the invoice and then copies any variance to PeopleSoft Inventory tables for analysis and accounting purposes. Exception Time Reporting A method of time reporting where only differences to the schedule are provided (see Time Reporting). In PeopleSoft Payables. Exception Severity The degree of importance associated with an exception. Exclusive pricing can be set up for a specific time frame and associated with particular orders. reported or payable time that require audit or review (see Time Management) Exception Rules A rule (s) that is applied to scheduled. Exception User or system delivered. Exclusive Pricing Supersedes all pricing structures in effect for customers and products. defined conditions applied to scheduled. Executive Schedule (EX) Compensation and pay plan used by the Executive Branch of the federal government. except Buying Agreement. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 79 . the Excepted Service consists of those civil service positions that are not in the competitive service or Senior Executive Service. Excess Plan A pension plan where the benefit formula provides an increased benefit for Final Average Earnings above a specified integration level. Statutory pay limits are derived from several of the pay levels within this plan and imposed on the General Schedule and other existing pay plans throughout the Federal government. and payable time in order to determine conditions which require audit or review (see Time Administration). This compensates for the fact that Social Security benefits are based only on earnings up to a specified maximum. GLOSSARY Exercisable The option shares that are available to the optionee to exercise. Exercise Proceeds Cash. country. including cash or stock paid by individuals to exercise options and cash company tax savings from deducting non-statutory option profits at exercise. Exercise Price The price per share required to exercise a stock option. tracking. stock or other recognition received by a company as a result of option exercises. GLOSSARY 80 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Exercise Date The date on which an individual purchases underlying shares from and option grant or transacts a simultaneous purchase and sale of underlying option shares through a cashless exercise and collects option profit in cash or shares. Expense Location Amount Authorized spending defined for an expense type in a particular expense location and currency. or continent. Exercise The transaction in which an individual purchases or “exercises” the right to purchase the option shares. and reporting of expense activity. The IRS refers to the purchase of company stock in an employee stock purchase plan as an exercise. Expense Type Means of itemizing various kinds of business expenses. dinner. or ground transportation. Expense Location Group Collection of expense locations based on a common classification such as state. Expense Type Edit User-defined requirement that mandates input of additional data—such as an airline ticket number or number of nights in a hotel—when an expense type is selected in an expense report. Expense Location Geographic area defined to enable the recording. Examples are hotel. documentation. generally at the end of the option term. Express Customer A customer for whom the minimum necessary information is entered. Expiration Date In PeopleSoft Inventory. manuals. Expensed items can only exist as components on a BOM and cannot have a BOM. routing. Express Order An order entry shortcut in PeopleSoft eStore and Mobile Order Management whereby the customer populates the shopping cart and goes directly to the order summary to checkout. The system will automatically cancel vested shares not exercised at the end of the expiration grace period. duplicate information is not stored on the database. the date a lot exceeds its Shelf Life and is no longer acceptable for fulfillment or consumption. The length of the option term and the date of expiration are established in the Grant Agreement. (Expiration Date = Creation Date + Shelf Life) Expiration Date The last day of an option term in which the option is canceled and no longer exercisable. or production area/item definition. Since expressions are resolved at run-time. Expressions Expressions enable you to create pseudo-columns made up of mathematical calculations based on actual fields on a table.GLOSSARY Expense Type Group Expense types that are classified together for reporting and tracking. Expiration Grace Period When you enter a stock action allows the exercise of the already vested shares as of the action date. bypassing any billing or shipment modification screens. Billing and shipping information defaults in as previously entered. Expensed Item Non-inventory item which may represent software. Expiration The process by which the outstanding shares of an option cease to be exercisable. or any item for which no quantity on hand is maintained. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 81 . but which can be specified on a bill of material (BOM). the system will calculate the date these shares expire based on the grace period defined on the Stock Action Rules page for that stock action. and may be subject to special compensation rules. Extra time may be scheduled in advance of when it is worked. data migration typically refers to information moved from outside sources into the Operational Data Store tables. indirect compensation and deferred compensation. Extraction A reusable query that specifies what information should be retrieved from the Quality database. Financial rewards would include direct compensation. external data may include third party salary surveys and benchmark metric surveys. Extract-Transform-Load (ETL) The extraction and transport of data from one server to another remote server.GLOSSARY External Data Data from external sources. Within PeopleSoft Enterprise Warehouse. Non-financial rewards are provided to the individually and viewed as a benefit by the individual based on the culture of the organization such as the size or location of one’s office. Typically categorized as financial and non-financial rewards. indirect compensation and deferred compensation. In PeopleSoft budgeting ETL specifically refers to the process by which financial and human resource data is extracted from PeopleSoft Financials and HRMS and transferred to the PeopleSoft Enterprise Warehouse which PeopleSoft Budgeting uses to access and record data transactions. Extra Time Any hours worked outside of an employee's normal (scheduled/shift) hours or days. tangible rewards given to an individual. External Scheme In the United Kingdom an External Scheme is a vocational training. In PeopleSoft Workforce Analytics. education and job placement program involving an employee. Financial rewards would include direct compensation. Non-financial rewards are provided to the individually and viewed as a benefit by the individual based on the culture of the organization such as the size or location of one’s office. Extrinsic Rewards Tangible rewards that can be given to the individual. For instance. It may be treated differently than standard time for purposes of Benefit Entitlement and Administration. GLOSSARY 82 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . in PeopleSoft Workforce Analytics. an employer and the government. External System Any system that is not directly compiled with the PeopleTools servers. Typically categorized as financial and non-financial rewards. The program offers Basic Insurance coverage and three types of optional coverage: Option A (Standard). or sales numbers. AMEX. FMLA regulations contain provisions regarding employer coverage. actual.GLOSSARY F Fact Facts are numeric data values from fields from a source database as well as an analytic application. NASDAQ. or by union contract. Fair Market Value Tracking Methods Methods used to track and report trading activity on various exchanges (i. NYSE. budget data. he/she is eligible to participate in the FEGLI program. This requirement may be superseded by state or local laws when the lesser law is to the greater benefit of the employee. Family Medical Leave Act (FMLA) A federal regulation that protects health benefits and job restoration for employees who must take a leave from work to care for themselves or family members. but typically determined by financial factors or set by an outside valuation company. continuation of health benefits. A fact can be anything you want to measure your business by. notice and certification. employee eligibility and entitlement. The stock market sets the fair market value for a public company. Federal Employee Group Life Insurance Program (FEGLI) Generally. he/she is covered automatically for Basic Life Insurance and premiums will be deducted from gross salary unless coverage is waived within the first period of eligibility. PeopleSoft Benefits applications offer FMLA Plans that help employers and employees determine FMLA eligibility and schedule and track FMLA leave requests. and Option C (Family). For a private company the fair market value is more subjective. regular workweek for a group of employees. and job restoration. etc…). PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 83 . revenue. if the employee has Federal retirement coverage or is on a temporary appointment exceeding one year. Option B (Additional). FLSA Overtime requires that all nonexempt employees be paid at a rate of time-and-one-half for all hours over 40 physically worked during a workweek. Once eligible. Fair Market Value (FMV) The price of a company stock based on the current market value as determined by supply and demand. A fact is stored on a fact table. or a valuation method. An FSLA Workweek is a permanently established. Fact Table A fact table is where facts are stored in the PeopleSoft Enterprise Warehouse.e. Fair Labor Standards Act (FLSA) A federal regulation governing several time and labor issues. for example. Federal Reserve Transit Number A unique identifier for U.S. Department of Labor. FERS covers all employees appointed to a position in the federal government after January 1. the employee pays both the employer and employee shares. Federal Employer Identification Number (EIN) Used to identify the tax accounts of businesses. If under a temporary appointment. The Federal employer shares the cost of the premium (about 75%). It also includes a feature to authorize agencies to make advance salary payments to attract candidates for open positions which have consistently been hard-to-fill in certain geographic areas. the employee is entitled to coverage by the FEHB program if appointed to a position with Federal retirement coverage or has been on the rolls on a temporary appointment for more than one year. and a TSP. which have employees or operate business as a partnership or corporation. Federal Employees Retirement System (FERS) A retirement plan available to employees of the federal government.GLOSSARY Federal Employee Pay Comparability Act (FEPCA) This law provides a structure and methodology to determine and authorize locality-based pay adjustments to Federal employees in order to elevate their basic pay to be commensurate with private sector employees working in the same occupations in the same geographic localities. which adjudicates the claims and compensates the employing agencies for the employee's pay and benefits during the claim period. 1987. Federal Insurance Compensation Act (FICA) Employee and employer contributions to Social Security. the employee pays the employee share and a portion of the employer’s share. Federal Employees Health Benefits (FEHB) Generally. Employees file claims with the U.S. actual premiums depend on the plan selected. Coverage includes Social Security. a basic annuity plan. allowing banks to transfer funds within the Federal Reserve system.-based banks. Businesses. must obtain an EIN. GLOSSARY 84 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . A feature of this law provides for the continuation of pay (COP) without charge to leave for up to 45 calendar days due to disability and/or medical treatment following a traumatic injury. Federal Employees' Compensation Act (FECA) This law provides compensation and medical benefits to civilian employees of the United States for disability due to personal injury or disease sustained while in the performance of duty. Office of Worker's Compensation. If the position is part-time. The result is used as a component of the pension benefit formula. Fill-In Employment Employment held by persons during the time period after leaving their regular occupation in anticipation of. Final Average Earnings (FAE) The PeopleSoft Pension Administration function that averages earnings from a specified period of an employee’s career.GLOSSARY Feeder Line A type of production line replenishment used in PeopleSoft Flow Production. FEGLI Living Benefits Act Beginning 7/25/95. Filters are used in templates to limit your information from a pick list of attribute values. This result is then used for further processing in the normal calculation. If you are using feeder line replenishment. and certain self-employed individuals. the individual is considered terminally ill if his /her life expectancy is 9 months or less. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 85 . purchase or release dates for which shares remain available for sale. a Federal employee who is terminally ill may elect to receive a lump-sum payment equal to the full amount of basic life insurance only. but before entering. The tax is levied on employers. and run for a specified set of periods. An election to receive this benefit is irrevocable. FIFO (First In First Out) Method used by companies to record Disqualifying Disposition Income. or a limited portion designated in multiples of $1000. military service. If a company uses this method they record the optionees disposition of shares by attributing the shares to the earliest exercise. employees. FICA (Federal Insurance Contributions Act) FICA consists of both a Social Security (retirement) payroll tax and a Medicare (hospital insurance) tax. Filter A filter creates a subset of information. run for one payee. smaller production lines create subassemblies that feed directly to your production line. A fictitious calculation is always started from inside a normal calculation. A fictitious calculation is a subcalculation run during a normal calculation to determine a net that would have been computed if certain parameters were used. Fictitious Calculations Fictitious calculation rules perform temporary calculations. Final Table Merge Engine Final Table Merge Engine is used by the PeopleSoft Enterprise Warehouse. and Curve Generator. In terms of the reporting hierarchy. and Monte Carlo simulation for PeopleSoft Asset Liability Management.e. liabilities. Its calculations include: measures of duration. where processing can continue. Product Pricing. a product or service sold by a financial institution to its customers. A product may be treated like a generic description or category. while an instrument is a specific instance of a category. At the end of the jobstream. The one should not be mistaken for the other (i. the Merge Engine runs and merges the output temporary tables into the final tables. Financial Instrument In the financial services industry. A business’ financial accounting requirements are not necessarily the same as its cost accounting requirements. while an instrument falls under a product. a product falls under a ledger account. the extent to which a company’s financial accounting system meets its cost accounting needs depends on how it has chosen to describe its chart of accounts and the level at which it has chosen to record financial transactions.GLOSSARY Final Forecast The final forecast is the prorated version of the adjusted forecast. In terms of the reporting hierarchy. summarized to all levels of the product hierarchy. GLOSSARY 86 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and expenses to determine its net worth and to produce financial statements. the Financial Performance Measures program performs calculations on financial instruments based on the rules defined in the Financial Calculation Rules module. and using input from the Cash Flow Generator. Stratification engine. a specific product or service sold by a financial institution to its customers. A product may be treated like a generic description or category. as long as it continues to meet its legal and regulatory requirements. while an instrument is a specific instance of a category. a product falls under a ledger account. revenues. Financial Accounting The accounting for a business entity’s assets. Within Generally Accepted Accounting Principles. Financial Performance Measures (FPM) For the financial services industry. a business has some latitude as to when and how to record its financial transactions. it moves enriched data from one table into another. Financial Product In the financial services industry. while an instrument falls under a product. the immediate results are stored in temporary tables. option-adjusted spread and option-adjusted cost for PeopleSoft Funds Transfer Pricing. This is the best-guess version of the forecast that is used to make all decisions dependent on the forecast. When you run a job in a jobstream. Fixed Basis The basis option enables you to create the data for the Basis online. The user defines corporate financial policies. which are then applied to cash flows for a given future accounting period. Fixed Picking Bin A dedicated picking location for an inventory item. Fixed Period Requirements In PeopleSoft Enterprise Planning and Production Planning. products created by financial institutions and sold to retail customers. The Fixed Basis is a predetermined table that can be populated online. Fixed picking bins are replenished from bulk locations when the available quantity falls below the optimal quantity. Product prices and interest rates are set by the financial institutions and take into account its customers’ behavioral models. and force balancing rules. It is available with all methods except when Period-Based Allocation is being used. Fixed Percentage A fixed percentage value. Financials Warehouse See Warehouses. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 87 . Used with the Allocation Manager. or pro-forma. Fixed Offering The offering type is fixed when the end date of each offering is the same for all employees regardless of the employee’s grant dates. as part of the rule. First Year Amount See 1st Year Amount. The Financial Statement Simulator engine drives costs and revenues to accounts on PF_LEDGER_F00 via a scenario. dividend distribution frequency. Fixed Basis is used with the Allocation Manager only. financial statements. such as corporate tax rates. Financial Statement Simulation A facility within Planning & Simulation which establishes rules for simulating future period. The source pool amount will be split based on this percentage to get the target amount.GLOSSARY Financial Services Instrument In the financial services industry. a lot-sizing technique that sets the order quantity to the demand for a given length of time. Fixed Source The fixed source option enables you to create the data for the Source online. and minimum and maximum parameters. The Fixed Source is a predetermined table that can be populated online. Flexible Credit Any credit associated with a given benefits program. The employee then submits claims for authorized expenses. Flexible TimeSpans can be as long or as short as you like—covering multiple years or a single day.GLOSSARY Fixed Plan A stock purchase offering period where the ending offering date will be the same as the purchase date. Flexible TimeSpan A user-defined period into which costs can be collected. or type of coverage. Reorder Point. Eligible employees will always purchase stock on the specific purchase dates and by the purchase rules you define. Credits based on an entire program can be applied toward the benefit costs however the employee chooses. It is available with all methods except when Period-Based Allocation is being used. All employees associated with a GLOSSARY 88 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This method can be used for scheduling clock and elapsed time reporters (see Scheduling) FLSA Status A PeopleSoft Human Resources term that is used to indicate whether a job is exempt or nonexempt according to the Fair Labor Standards Act. This method can be selected as an inventory policy for order quantity. plan. safety stock. as part of the rule. Flexible Work Schedule A method of scheduling a time reporter’s time that is based on a range of flex hours of start and stop times and core work hours. Fixed Source is used with the Allocation Manager only. The main purpose of Flexible TimeSpans is to assist you in analyzing costs. Flexible Hours Hours during the workday. Fixed Quantity An Inventory Policy method that defines a fixed amount of an item to be ordered to meet replenishment needs. workweek or pay period during which a time reporter covered by a flexible work schedule may choose to vary his times of arrival and departure from the worksite (see Scheduling) Flexible Spending Account (FSA) An account to which an employee and (optionally) an employer pledge an annual amount for a plan year. Forecast Item In PeopleSoft Demand Planning. and so forth. This period can also be described as the last actual demand period to have had an impact on the forecast. Forecast Definition Forecast definitions are a set of forecasting rules that generally govern multiple forecasts distinguished by key properties such as products. a process used to manage forecasted demand over a period of time. Forecast Level See Level. channels. customers. even if the total forecast cannot be met entirely. Forecast Fulfillment In PeopleSoft Demand Planning. The components of a forecast item key are defined for each level in a forecast view.GLOSSARY particular job will receive that job’s FLSA Status. Forecast Element Each forecast within a single definition is called a Forecast Element. FLSA Status is an eligibility determination factor for PeopleSoft Benefits Administration. This process also makes adjustments for promotions and filters for abnormal demand. the process by which a Statistical Forecast is generated for each item at each level of the view. Forecast Attribution A FSI (financial services industry) transformation process through which forecasted product originations are pooled and run through the cash flow engine for future periods. When a Forecast Item is set to recalculate. Forecast Calculation Process In PeopleSoft Demand Planning. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 89 . a logical item used as the basis to forecast demand. the system tries several forecast calculation methods and picks the one with the least amount of error. Forecast Start Period/Year Determines the most recent period for which demand data is available for a forecast view. The process makes it possible to divide the total forecast demand into portions so that certain portions can be met. Forecast Period A period in time as defined by the calendar for which data is processed through the PeopleSoft Demand Planning model. as the pay out rule is defined.S. a percentage. reflects state and federal taxes. tips and other compensation from the previous year. The pay out rule can be based on a flat amount. This report. or a data element. Medicare wages. a Trust Territory of the Pacific Islands.GLOSSARY Forecast View See View. or any territory or possession of the U. This form. distributed employees by January 31 of each year. provides unaudited financial information and other selected material. Formula Plan This compensation distribution plan type is based on a pay out rule. including stock option plans. filed pursuant to Rules 13a-13 or Rule 15d-13. GLOSSARY 90 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . in a Formula Plan the pay out is based just on the pay out rule. Whereas a Target Plan distributes pay out based on a comparison of a performance measure against a target. which public companies are required to file quarterly with the SEC. Form 10-K A form used for annual reports pursuant to Section 13 or 15(d) of the Securities Exchange Act of 1934 for which no other form is prescribed. the District of Columbia. Form 10-Q A form used for quarterly reports under Section 13 or 15(d) of the Securities Exchange Act of 1934. Form W-2 A form used by employers to provide workers with a statement of wages. used to report on the number of plan participants.S. Form S-8 A form used to register securities offered by a reporting company under its employee benefits plans. Formula Element which enables you to define your own formulas for use—gives further flexibility to define complex organizational needs. Also called the Registration Statement under the Securities Act of 1933. the Commonwealth of Puerto Rico. Foreign Education Education acquired outside of any state of the U. and tips withheld. social security. Form 5500 Participant Count Extract A PeopleSoft Pension Administration data extract containing data that a plan administrator needs in order to complete IRS Form 5500.. liquidity premiums. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 91 . Full-Time Equivalent See FTE. FTP (Funds Transfer Pricing) Base Rate In PeopleSoft Funds Transfer Pricing (FTP). or incentive programs. and Benefit Formula. Function Result also refers to the value produced by the rules. Function A category of pension calculation. budgeted and capacity rates calculated by the Activity-Based Management (ABM) Engine. this refers to the basic charge or credit that is applied to a ledger account.GLOSSARY French Professional Elections French companies employing a certain number of employees must hold elections for selecting personnel representatives (Délégués du personnel). FTP (Funds Transfer Pricing) See PeopleSoft Funds Transfer Pricing. Frozen Rate A rate that is applied to allocate resources to activities in place of the actual. FTE (Full Time Equivalency) FTE is the percent of full time the employee should normally work in this job. for such factors as geographic premiums. These rules match Definitions—the specific parameters for the function—to the Groups of employees that use that particular definition. embedded options. Function Result The calculation rules for any of PeopleSoft Pension Administration’s nineteen core functions. or an off-balance sheet position. Final Average Earnings. FTP (Funds Transfer Pricing) Adjustments Adjustments made to the PeopleSoft Funds Transfer Pricing (FTP) base rate. Full time is defined by the Standard Hours specified in either the Salary Plan Table or the Default Standard Hours specified in the Installation Table. PeopleSoft Pension Administration divides a pension calculation into nineteen “core functions” such as Service. a product. and members of the Work Council (Comité d'Enterprise). parking. HR Action/Reason. Frequency. and bonds.GLOSSARY Fund ID In the financial services industry. Funds Transfer Pricing (FTP) See PeopleSoft Funds Transfer Pricing. union dues. Formula. GLOSSARY 92 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . General Deductions are calculated from the General Deduction Table. and Run Types. General Deduction Any non-benefit deduction. Generation Control Generation control elements allow you to indicate to the system whether to process an element based upon criteria you define. Future Period Any pay period which is not current and whose close date hasn’t passed (see Time Reporting). garnishments. Fungible This term describes a resource used for multiple activities. Segment Status. Benefit Deductions draw on one of the benefits tables. General Schedule (GS) Compensation and pay plan used by the Executive Branch of the federal government. General Ledger Distribution The process and guidelines by which accounting information is transferred from your PeopleSoft Receivables or Deduction Management system to a general ledger system. There are six parameters that control this function and comprise the definition of the generation control element—HR Status. Fund ID is a lookup code used to track investment funds associated with a financial instrument or account. Examples include charitable deductions. Provided primarily by the financial analytic applications to track investment funds for insurance policies. G Gang Reporting See Crew Reporting. Future Periods The number of periods of future forecasts maintained by the PeopleSoft Demand Planning system. A Goals Matrix can be used to in conjunction with a pay out distribution plan called a Target Plan. For Stock Administration. the price break tables are set up to indicate what product the user receives as a free premium based on defined quantities or prices. Goals Matrix In PeopleSoft Workforce Analytics. weighted. The giveaway item does not have to be the same product that the customer is purchasing. the period of time an optionee has to exercise an option after termination and before the option expires. The levels are established and designated within a specific pay plan by law or regulation. The system automatically adds an order line for the free item. Giveaway Adjustment Type In PeopleSoft Order Management. You can combine and standardize multiple performance goals into a single. Grade A range of pay in a graduated scale that includes positions of different occupational groups." and so on." "SQR Report. a matrix used to create calculation rules for group or employee performance goals. For instance. Geo RSZ Code This code is for Belgian employers to track the geographical location for RSZ codes.GLOSSARY Generic Conversion Factor A conversion factor that applies universally between two units of measure. goal score. the generic process type "SQR" includes all SQR process types. Generic Process Type This term applies to Process Scheduler. Giveaways cannot be applied to the total order. The factor is used in the conversions between levels of PeopleSoft Demand Planning Forecast Items and Inventory Planning Policy Item. you may set up a price break that indicates that a purchase of 100 widgets entitles the customer to one or more free T-shirts. Geographic Location Code In Canada this code is prescribed by the government and refers to the location a business is in. For example. Process types are identified by a generic process type. Grace Period A period that is a number of hours or minutes before or after a scheduled punch where a time reporter’s punch is accepted. The work performed should be equivalent as to the level of difficulty and responsibility and the level of qualification requirements of the work. such as "SQR Process. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 93 . against which actual performance is compared. new legislation. To be creditable. and not education consisting of undergraduate and/or continuing education courses that do not lead to an advanced degree. This is the price per share the individual must pay when exercising the option. or write-offs). The change might be caused by a plan merger. matches. vesting schedule and other terms and conditions of the stock option or stock award. Gross-up The process used to calculate taxes and resultant gross pay from a check for an exact net amount. Gross Salary The sum of an employee’s salary and earnings defined as part of gross salary.e. Group In PeopleSoft Billing. payments.. such education must show evidence of progress through a set curriculum. The date the company enters into the grant agreement. GLOSSARY 94 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The date on which an option or other award is granted. i. transfers. Grant Date The date the individual begins participating in a stock purchase offering. Grandfathered Benefit A benefit that an employee was entitled to prior to a change in the plan and that defines the employee’s new minimum level of benefits. The underlying stock’s fair market value on this date generally derives the option price. it is part of a program leading to a master's or higher degree.GLOSSARY Graduate Education Successfully completed education in a graduate program for which a bachelor's or higher degree is normally required for admission. Grant A contractual right giving an individual the option to purchase a specified number of shares of stock through an Equity Compensation Plan. Grant Price The price per share at which the stock option was granted. a specific term for a posting entity composed of one or more transactions (items. or a plan amendment. Grant Agreement The legal document issued by a company defining the number of shares granted. Also known as an option. deposits. grant price. The gross salary is used to calculate budget amounts for benefit plans defined as a percentage of an employee’s salary. Group Asset Depreciation The depreciation of a group asset calculated using an average service life set by a local regulatory agency and a calculated group depreciation rate. or only a specific group. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 95 . you might want your employees to only access their own records. Group Security [Time and Labor] The ability to grant access to employee time. In PeopleSoft Pension Administration. you’ll use Custom Statements to define criteria for grouping employees. In Time and Labor. maintenance. For example. employees are placed in groups for time reporting purposes. where depreciation is calculated. It is used to depreciate the sum of the costs of its associated group member assets. Group Security The ability to grant or deny access to groups. groups identify which employees are eligible for what forms of compensation. or allow your supervisors who handle all of the time input for have access to specific groups.GLOSSARY Group Any set of records associated under a single name or variable in order to run various calculations in PeopleSoft Business Processes. you can vary rules for different classes of employees. Cost information for all group members of a group asset is summed up to the group asset level. payment. Group Member Asset A financial asset with cost information. transfers. You can set up group security by Group ID or by user ID. and/or other requirements. You can restrict the user from accessing everyone. Group Asset A financial asset with no cost information. This feature also provides the ability for employees to report their own time. or unposted. by providing security through Time and Labor’s groups functionality. Group Coverage (Or Generic) Qualification Standards Standards prescribed for groups of occupational series that have a common pattern of education. Group Type An indicator of the activity that created the billing group: billing. experience. for example. then by associating calculation rules (Definitions) with specific Groups. or allow the user to be able to access only their own records. while in Administer Variable Compensation. The HIPAA certificate will be used by subsequent health coverage carriers to evaluate pre-existing condition clauses. Health and Safety Executive (HSE) Health and Safety reporting for your UK operations is sent to the local office of the HSE per the requirements of the RIDDOR (Reporting of Injuries. if applicable. This certificate lists group health coverage an employee had for the twelve month period prior to the date coverage ended as a result of termination of coverage. Highly Compensated Employee (HCE) An IRS employee category applied to employees who are considered “highly compensated” according to a federally set standard. This distinction is used for the purposes of nondiscrimination tests. PeopleSoft Benefits applications enable you to comply with this act. Diseases. to determine that Section 401 and Section 129 plans do not discriminate in favor of highly compensated employees. Hazard/Disposal Code An inventory item group sharing a disposal routine. Health Benefits Code An alpha/numeric code that identifies each Health Benefit plan. Health Benefits Effective Date Date the health benefit plan goes into effect or the effective date of cancellation.GLOSSARY H Handicap Code A code that identifies a type of physical or mental impairment that substantially limits one or more of an employee's major life activities. and Dangerous Occurrences Regulations). HIPAA The Health Insurance Portability and Accountability Act of 1996. Hierarchy Hierarchy refers to the relationship between the levels in a dimension. which requires that employers provide Certificates of Group Health Plan Coverage to employees who have their health coverage terminated. Headcount The number of people represented by a given Employee Survey record in the PeopleSoft Enterprise Performance Management product line. GLOSSARY 96 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Historical Rules An element used to set up rules that retrieve data from prior periods. estimated daily or period use. Historical Usage Calculation Method In PeopleSoft Inventory Planning. The hold flag is maintained at the contribution page. to receive preferential tax treatment on a disposition of shares. Historical rules can be used in formulas and fictitious calculations. Holding Period Typically refers to the holding period required for ISO’s and Qualified Section 423 Purchase Plans. Hold Purchase A flag that tells the system to keep this participant in the purchase process. maximum possible usage. Historical periods must be a minimum of two years in order to support the development of seasonal models based on an item’s demand history. Hold Position Description The new position description number that is the result of a reclassification action prior to the NOA being processed. See Disqualifying Disposition.GLOSSARY Historical Periods In PeopleSoft Demand Planning. The historical demand quantity is determined by one of four methods. Hold Within Grade Increase (WGI) Due Date WGI due date prior to an employee receiving a temporary promotion. a component that indicates the maximum number of periods of historical demand maintained for a Forecast Item within a Forecast View. Necessary in order to establish the WGI due date if returning to original grade/step. Lead Time. The usage is based on the review of historical demand over the number of effective periods. a method that defines the set safety stock or minimum inventory level. and static values calculations. Hold Last Equivalent Increase (LEI) Date held by an employee for this event prior to receiving a temporary promotion. Hold Grade/Step Grade/step the employee was in prior to receiving a temporary promotion. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 97 . GLOSSARY Hours Counting Service A service calculation that uses actual or generated hours to determine the service credited to a pension plan participant. imputed income refers to the value of excess Group Term Life or Dependent Life coverage. In the Money Option When the fair market value of the stock is greater than the grant price of an option. In general. HR Action/Reason Category A group of related job actions—for example. In Punch Indicates start of a shift. hire and rehire—treated similarly for pension purposes in PeopleSoft Pension Administration. or other period worked rather than counting actual hours. Ignore Violations The ability to report over capacity violations but not to score or repair them during the optimization process. I Ignore Plan Complex event processing feature of PeopleSoft Benefits Administration that enables the user to designate plan types linked to a particular Event Rules/Event Classification combination as being unaffected by Benefits Administration processing. but that uses a set number of hours per day. Hours Equivalence Service A service calculation that uses hours to determine service. GLOSSARY 98 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . HRMS Warehouse See Warehouses. Imputed Income Theoretical income that a company pays on behalf of an employee but the individual does not actually receive. This “theoretical income” must be added to the employee’s gross wages. week. and increased focus on specific performance indicators.e. the INAIL code is used to classify jobs according to the level of risk associated with the job and the related risk insurance required by the employer.GLOSSARY INAIL code In Italy. or the date such plan is approved by stockholders. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 99 . it must have the following characteristics: • The option must be granted pursuant to a plan which includes the aggregate number of shares which may be issued under options and the employees (or class of employees) eligible to receive options. or for group levels such as teams. The option must be granted within 10 years from the date such plan is adopted. missing employee ID. only by him. alignment of employee and shareholder interests. at the time the option is granted. whichever is earlier. divisions. The option price is not less than the fair market value of the stock at the time such option is granted. including cost control. • • • • • Incomplete Punch A punch that cannot be processed (i. during his lifetime. The optionee. pay plans that are formula-driven based on the expected results defined at the beginning of a performance cycle. and. Incentive plans are used for a variety of reasons. and which is approved by the stockholders of the granting corporation within 12 months before or after the date such plan is adopted. Incentive plans are designed for the individual worker. Incentive Plans Pay plans that are formula-driven based on the expected results defined at the beginning of a performance cycle. The option is not transferable by such individual otherwise than by will or the laws of descent and distribution. divisions or company wide. and is exercisable. business units. does not own stock possessing more than 10% of the total combined voting power of all classes of stock of the employer corporation or of its parent or subsidiary corporation. Incentive plans can be designed for the individual worker or at group levels such as teams. Incentive Pay Plans In PeopleSoft Workforce Analytics. Incentive Stock Option (ISO) For an option to be considered an Incentive Stock Option. INAIL codes are defined by the employer. invalid date or time). The option is not exercisable after the expiration of 10 years from the date such option is granted. business units. or companywide. medical. Incumbent An employee currently assigned to a position. Inherit Control Group Policies In PeopleSoft Inventory Planning. for particular occupational series of positions within a series and are used in conjunction with a group coverage (generic) standard.g. See also Correction to IRR. e. vacation. unemployment insurance). See COBRA and Secondary COBRA Events. as well as divorce. reduction in hours.GLOSSARY Incremental Budgeting A budgeting option during budget development that uses prior year actual or budget values as a basis and then applies a percentage that increments the base. Typical initial COBRA events include loss of benefits eligibility due to termination. PeopleSoft Budgeting-specific. short-term disability. sick). vision. Individual Occupational Requirements Requirements. parking. dental. Common types of indirect pay include health and welfare benefits (for example. a feature that controls whether the policy for an item is set explicitly or defaults from the associated Policy Control Group. Indirect Compensation Typically involves non-cash types of compensation awarded to the individual in exchange for their contribution to the organization. Employees covered by the FERS retirement plan require SF-3100. retirement. holiday gifts). holiday. and Medicare entitlement. Individual Retirement Record (IRR) Used by the Office of Personnel Management (OPM) as the basic record for determining the retirement benefits payable to separated federal employees and their survivors. In addition. club memberships. payment for time not worked (for example. death of employee. the SF-2806-1 and SF-3101 are used for corrections to the IRR.. and military leave. experience or education. long-term disability. GLOSSARY 100 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Initial COBRA Events The event which makes an individual eligible for COBRA coverage. Employees covered by the CSRS retirement plan require SF-2806. and employee services and perquisites (for example. A series of check boxes enable you to define which policies to inherit. Indirect Cost A cost that is assigned by management to an activity or a cost object. An example is the cost of office space assigned to an activity. the date upon which an asset is placed in service. Insider An officer. The securities law broadly prohibits fraudulent activities of any kind in connection with the offer. or social/professional classification code. Inservice placement also includes noncompetitive conversion f appointees whose Federal excepted positions are brought into the competitive service under Title 5 CFR 316. or restorations. Inservice date is used in conjunction with an asset's prorate convention to determine Begin Depr Date. transfer.75% of Final Average Earnings over $10. In-Service Date In PeopleSoft Asset Management.000 integration level: 1% of Final Average Earnings up to $10. such as PeopleSoft Time and Labor.GLOSSARY INSEE (National Institute for Statistical and Economical Studies) Codes INSEE is an official statistics and economics organization in France. Integration Level The salary level in a defined benefit excess plan at which a higher benefit rate becomes applicable. Instances of positive input can be entered manually. INSEE codes for your French company's organizations are used in regulatory reporting. and Department of Defense/Nonappropriated Fund (DOD/NAF) and Coast Guard NAF employees whose positions are brought into the competitive service. or can be system generated. the following formula uses a $10. reassignment.702. reinstatement. or sale of securities. Inservice Placement Includes a noncompetitive action in which a position is filled with a current or former competitive service employee through promotion. This category may also include other employees of the company and people who obtain nonpublic information about the company.000 plus 1. reemployment. Insider Trading When a person trades a security while in possession of material non-public information in violation of a duty to withhold the information or refrain from trading. INSEE PCS (Classification par Catégorie Socio-Professionnelle) Code Each PeopleSoft Human Resources French Jobcode is linked to a four-digit INSEE PCS. director or principal shareholder of a publicly owned company and members of his or her immediate family. For example. Instance A row of data on the Positive Input table. purchase.000. They can also be received from other applications. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 101 . change to lower grade. Each integration template you create defines a specific set of business units from your other financial applications. You can use Integration Templates to set up joint ventures. Interface Loader An SQR delivered with PeopleSoft Asset Management that is used to transfer load lines into the PeopleSoft Asset Management loader tables. and to run rate scenarios and analysis in real time.GLOSSARY Integration Template A high-level template that defines the integration between PeopleSoft Projects and your other financial applications. Interest Rate Modeling An FSI feature that allows you to model interactively interest rate scenarios for Asset Liability Management. The interest plus the employees’ stock purchase contributions are used to purchase stock at the end of the purchase period. this support module describes in granular terms how a group of customers holding a specific type of instrument with a particular interest rate will respond to changes in interest rates in the market. or other legacy ERP systems used by your organization. Interunit Account The account for each business unit to which other business units in the same corporation refer when they need to distribute amounts across business units. These accounts are used to keep the individual ledgers in balance when a single transaction affects multiple business units. between two known values. GLOSSARY 102 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Each project is then assigned an integration template containing this preset integration information. Intensity The cost for each unit of the activity driver. Interpolation To calculate a value of a function. Internal Data Data from PeopleSoft ERP systems. or series. and new transactions added to that project will reflect the business units defined in the integration template. Interest Some companies pay interest on the monies that are being withheld from employees’ paychecks. Interest Rate Sensitivity Model In the financial services industry. InterUnit Transfer A transfer that occurs between different business units. 2) You want to define replenishment rules for a specific location of your business that manages inventory. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 103 . overhead. Examples include freight. as opposed to Extrinsic Rewards which are tangible rewards. Intrinsic Rewards A reward that is generated by the worker internally such as job satisfaction. IntraUnit Transfer A transfer that occurs within one business unit. Inventory Cost Element A cost that can be associated with inventory items and inventory transactions. and transportation. 3) You maintain standard and average costs in a specific location of your business that manages inventory. Each cost element has a unique cost code. Interunit Transaction A transaction that involves moving amounts from an account in one PeopleSoft General Ledger business unit to an account in another General Ledger business unit. You establish a separate inventory business unit (IBU) for any one of the following reasons: 1) You want on hand visibility to a specific location of your business that manages inventory.GLOSSARY Inter-Unit Drivers Drivers that provide a means of establishing relationships between the cost objects of one organization with the supporting activities of the organizations that share business units and models. Inventory Item A tangible commodity that is stored in an Inventory business unit (Ship From warehouse). Inventory Business Unit Usually a warehouse. Inventory Adjustment A process that enables you to change the quantity of an item in the inventory system to match the actual physical quantity found in the Storage Location. Inventory Location See Storage Location. or out of the inventory business unit. Those in pending status can be updated and corrected. A final status indicates that the IRR has been processed and can't be updated or corrected except through a Correction IRR or a Supplemental IRR. safety stock. IRC 423 (Internal Revenue Code 423) The section of the IRC that defines a Qualified Employee Stock Purchase Plan. Inventory Transaction An event that moves inventory into. Reorder Point. as well as any LWOP and any basic pay that was received when an employee was not covered by the CSRS or FERS retirement plans. IRR Remarks Special remarks that are documented on an employee's IRR. GLOSSARY 104 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . IRR Worksheet A preliminary IRR form that enables an agency to print a pending IRR for a separated employee. a set of rules that controls how inventory policy values are calculated for items. and standard issues. For example. The elements that make up inventory policy are order quantity. if necessary.GLOSSARY Inventory Policy In PeopleSoft Inventory Planning. Inventory Transaction Group An identifier that categorizes transactions by type for costing purposes. Agencies can also use the IRR Worksheet to view a current IRR for an active employee. IRR Remarks can be set up ahead of time and can be system-entered text or employee-specific. within. and minimum and maximum policies. you can group all types of interunit transfers together. Invoice Format Identifier An identifier for the formatting options that determine the sorting and summarization levels of invoice information. Examples include material transfers. IRR Status IRRs can be in pending or final status. IRR Fiscal Data Accumulation This report accumulates all retirement deductions for employees. Inventory policy is defined at the Policy Control Group and stockkeeping-unit levels. inventory adjustments. review it and make corrections. the system withholds taxes as if the option is a non-qualified stock option. a process that enables you to interact with the forecast in a manageable manner and perform "what-if" analysis by comparing the effects of different forecast models. Item See Inventory Item Planning Item or Receivables Item. the system withholds taxes if an exercise occurs more than twelve months from the termination date. If the termination reason is death. the system always treats the option as an ISO. maximizing design reuse. and Inventory integrate to Item Content Providers. and an exercise occurs more than three months from the termination date. Item Simulation In PeopleSoft Demand Planning.GLOSSARY ISO IRS $100K Limit The limit the IRS places on the exercisable value of Incentive Stock Options (ISOs) of $100K per calendar year based upon the fair market value at the time of grant (Section 422 of the Internal Revenue code). and the information is used by many other PeopleSoft applications. • • Issue See Material Issue. If the termination reason is disability. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 105 . Item Content Provider Third-party software consisting of web-based catalogs of item and price information. Engineering. Item Rounding Rules A set of rules determining how fractional values are rounded so that calculations result in whole numbers. PeopleSoft Purchasing. Depending on the termination reason the option is treated: • If the termination reason is for any reason other than death or disability. These systems benefit the design and purchasing of new products by accelerating item location. and reducing acquisition costs. Rounding rules are used in conjunction with Quantity Precision Rules. ISO to NQ Grace Period The period of time after which an Incentive Stock Option is treated as a Non-Qualified Stock Option for tax purposes upon the termination of employment according to Internal Revenue Code Sections 421 and 422. Issuer A legal entity that has the power to issue and distribute a security. GLOSSARY Item Type An identifier that defines inventory items at a very high level. and session handoff. and Work In Progress. Job Code Cost Evaluation of salaries for specific job codes. For example. Item-Specific Conversion Factor A conversion between the same two units of measure when the measurements have a different value for an item. This concept saves you a lot of time as you only have to recalculate those payees who have had a data change or who you indicate you would like to be recalculated. the families Computer Items and Office Furniture might be categorized by types like Outside Manufacturing. Job Code An ID for a job as defined on the Job Code table. Finished Goods. Job Code Components The pay components assigned to a job code by associating rate codes with job codes on the Default Compensation page or the Non-Base Compensation page of the Job Code table. GLOSSARY 106 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and may include sets of Item Families. Iterative Processing Refers to a concept on only re-calculating those payees who have had changes and need to be recalculated (if you choose to run your payroll multiple times before actually finalizing it). For example. Java Station Listeners (JSL) The JSL handles the work of the client connection. making service requests from the Jolt Repository. J Java Server Handlers (JSH) The JSH manages network connectivity. Job Compensation Rate The compensation rate of the corresponding job row. and translating Tuxedo buffer data into the Jolt buffer. tracking client messages. a conversion between packaging unit and stocking unit. GLOSSARY Job Events Actions relevant to an employee’s employment—such as a hire. commercial organizations may also use this SQR to provide a summary of their staffing by department. Journal Code The second highest level of three categories for defining a financial transaction (or document). PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 107 . Examples of journal code are domestic sales and export sales. Although it is mainly designed for government sector organizations. labor. and overhead required to complete the job are attributed to the job cost. A single journal usually includes multiple lines. Job Order Cost Accounting A cost accounting method that attempts to develop a discrete cost for each job performed or product produced. This category is preceded by journal type and followed by document type. Only the material. or termination—that can affect benefit program or plan eligibility. balanced entry for a given journal. Joint and Survivor Payment Option A form of pension payment in which benefits are paid for the life of the participant and a beneficiary. necessary when using document sequencing. Journal Template A list of the characteristics of the general ledger journal entries that will be created from your PeopleSoft Receivables system. PeopleSoft Asset Management and Billing require one journal generator template for each transaction type. Joint Staffing Report In the United Kingdom governmental agencies are required submit the Joint Staffing Report. job code. Used by PeopleSoft Benefits Administration. transfer. The sum of the monetary amounts for the journal lines in one journal totals zero (debits = credits). gender and full/part time employment status. See Event Class. Journal Line A record storing a double-sided. Journal Generator Template A table containing defaults to be used in journal generation. the benefit continues (often in a reduced amount) for the life of the beneficiary. Jolt A BEA/Tuxedo companion product that runs on an application server domain and is used to listen for Web Client Java requests and transfer them to Tuxedo. Should the beneficiary outlive the participant. This category is followed by journal code. KPIs are high-level measurements of how well an organization is doing in achieving critical success factors. the journal voucher is linked to an existing voucher. Keep Ledgers in Sync An option in PeopleSoft General Ledger that defines how a transaction should be posted—to all ledgers in a ledger group as opposed to only a single specified ledger. while others require a combination. Key See ChartKey. necessary when using document sequencing. Skill is an observable GLOSSARY 108 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . then document type within the journal code. Skills. Journal Voucher A PeopleSoft Payables voucher that enables you to make accounting entry modifications while keeping your PeopleSoft General Ledger and Payables systems in sync. KPI (Key Performance Indicator) See Key Performance Indicator. Key Performance Indicator (KPI) KPI is used by the PeopleSoft Performance Management analytical applications. these are attributes required to perform a job and are generally demonstrated through qualifying experience. Some tables contain only one field as the key. Key One or more fields that uniquely identify each row in a table. or training.GLOSSARY Journal Type The highest level of three categories for defining a financial transaction (or document). And Abilities (KSA) Also known as Competencies. A KPI defines the data value or calculation from the Data Warehouse tables upon which an assessment is determined. Like the adjustment voucher. education. Knowledge is a body of information applied directly to the performance of a function. K Kanban ID A unique identifier used to track Kanban cards and replenishment requests when using PeopleSoft Flow Production. Examples of journal types are sales journal and purchase journal. Knowledge. GLOSSARY competence to perform a learned psychomotor act. Last Putaway Date The item's most recent putaway date in the inventory business unit. The labor dilution process takes the costs that the payroll system has calculated for payable time. Last Equivalent Increase (LEI) Reflects the effective date of the last step received in grade or the last promotion. This information is stored with each inventory item. Labor Distribution Amount An actual labor cost associated with reported time. Ability is competence to perform an observable behavior or a behavior that results in an observable product. L Labor Costs Actual expenditures associated with salary portion of time reporter expense. Last Physical Counting Event The last date the inventory item was counted. Labor Distribution The process of distributing payroll expense to the corresponding payable time entries generated in PeopleSoft Time and Labor. Labor Dilution A process that occurs after the Labor Distribution process in PeopleSoft Time and Labor. Last Purchase Date The item's most recent purchase date in the inventory business unit. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 109 . determines an average or rate per hour. Last Putaway Document Number The item's most recent putaway document identification number in the inventory business unit. whichever is most current (does not include QSI). Used as the basis to establish an employee's WGI due date. and applies the average amount evenly across all reported hours for the day. Lead-Time Period Usage An inventory planning method for calculating historical usage of an item.GLOSSARY Last Receiving Date The item's most recent receipt date in the inventory business unit. many of these positions are entitled to additional special pays. The purchase lead time is rounded up to a specified number of periods. The historical demand is calculated as the maximum usage during these periods and the safety stock or minimum-stock level is set to this value. Law Enforcement Officers (LEOs) Positions within the Federal government involving law enforcement. STD. This process is managed by HRMS (see Time Reporting). Vacation. The maximum period value is then used as the safety stock or minimum stock level. Last Shipping Date The item's most recent ship date in the inventory business unit. Leave Accruals Hours that employees earn to use at another time. The historical demand is prorated on a daily basis and then multiplied by the number of days lead time for each effective historical period. Leave accrual processing is used to determine the employee’s leave accrual award and resulting leave balance. Leave Plan A method for earning and managing leave time. Last Shipping Document Number The item's most recent shipping document identification number in the inventory business unit. and LTD. This method should be used for items that have a steady demand pattern throughout each period. Lead-Time Estimated Usage An inventory planning method for calculating historical usage of an item. such as. Leave Accrual Processing Processing of leave accruals is used to maintain employee leave balances. GLOSSARY 110 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Leave Time entitled to an employee as a benefit. such as annual leave and sick leave. All leave benefit plans accrue leave by length of service or number of hours worked. Under FEPCA. Sick. GLOSSARY Leave Without Pay (LWOP) Total (Cumulative) An employee's cumulative number of hours of leave without pay (LWOP)." Can also be used to indicate how shares should be processed. Ledger Mapping Ledger mapping is a process that enables you to relate expense data from your general ledger accounts to resource objects. and fiscal year. Legend ID A way of recording information that is displayed upon the Issuance Instruction Report. Trades. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 111 . Level A section of a tree that organizes groups of nodes. the members of which will represent the members of your ledger type dimension. as in the case of Swaps. Ledger Type The unique combination of a single ledger. Ledger Template A table containing records and fields common to all ledgers that ensures that all ledgers specified in a ledger group share the same physical layout. Ledger Group In PeopleSoft General Ledger. or a budgeted amount that can be used to calculate the capacity rates as well as budgeted model results. Each level is related in a hierarchical definition with other levels in the view. Ledger Mapping enables you to map general ledger accounts to the EW Ledger table. A level definition contains descriptive and control data that relates to the operation of the forecast at each level within the view. Ledger Type Set A collection of ledger types. Defines a set of Forecast Item with a common key structure. You can also use ledger mapping to map dollar amounts (referred to as rates) to business units. You can map the amounts in two different ways: an actual amount that represents actual costs of the accounting period. Can be used to record a notice that should appear on the back of a stock certificate indicating that the shares represented are "Restricted Securities. Multiple ledger types make up a ledger type set. a group of ledgers consisting of one primary ledger andsecondary ledgers. Multiple ledger line items can be mapped to one or more resource IDs. Repurchases and SAR Exercises. In the PeopleSoft Enterprise Warehouse (EW). scenario. They also include revenue estimates. Line Schedule Editor (LSE) PeopleSoft Production Planning utility or tool that displays production tasks for multiple products on multiple resources across multiple periods of time. a feature that enables you to establish product forecasts based on predefined patterns in an item's life cycle. Literal Mapping In PeopleSoft Demand Planning. This enables you to set an available field value for all the loaded rows. populating the PeopleSoft Benefits database with plan-level election information. future. The goal is to provide a relatively constant total retirement income both before and after Social Security eligibility. GLOSSARY 112 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Level Income Payment Option An annuity form of pension payment in which payments are increased in early years (prior to eligibility for Social Security benefits) and decreased in later years when Social Security benefits are also received. includes processing of current. and previous period time from scheduling and time capture through Time Administration and distribution.GLOSSARY Level The section of a tree that organizes groups of nodes. LIFO (Last In First Out) Method used by companies to record Disqualifying Disposition Income. Line-Item Budgets The budget amounts associated with ChartField distributions that make up an organization’s budget. PeopleSoft Budgeting-specific. purchase or release dates for which shares remain available for sale. Load The feature that initiates a process to automatically load information into a PeopleSoft application—for example. Line-item budgets include personnel costs as well as operating and maintenance costs. a mapping option for formatting data that is common to all records being imported. Life Profile In PeopleSoft Demand Planning. If a company uses this method they record the optionees disposition of shares by attributing the shares to the most recent exercise. Lifecycle (of Reported Time) A representation of time through the various stages of Time and Labor. User-Field Code are used to determine the list of valid values for the field. WIP. Loader Table Any table in PeopleSoft Asset Management used to store load lines before they are loaded into the system as open transactions. Loan Exercise A form of cash exercise. and project ID) to the storage area. All inventory locations in a storage area use the storage area account. and a separate street address. product. If a user-defined field is marked to require local table validation. Location Accounting An accounting method that captures and records material movement within the warehouse. and charges. You can access this information when you click on the appropriate country flag push button in the global window. department. Every customer role must have a primary location. and INTFC_PHY_B. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 113 . volume. INTFC_PHY_A. Load Planning is also used to estimate shipping weight. Local Code In PeopleSoft Demand Planning. Location Code Locations enable you to indicate the different types of addresses a company has—for example. which will be used throughout the system on all panels that display a customer address. another for shipping. You set up load activation on the Load Activation page. packs. providing accounting visibility based on where the inventory resides. The primary location—indicated by a 1—is the address you use most often when contacting the customer. and ships orders by Load ID. The loader tables comprise INTFC_FIN. You can designate certain Storage Area as raw material. a third for postal deliveries. Load Planning The PeopleSoft Inventory feature that picks. Each of these addresses has a different location number. or when you access it by a local country menu. including security. or finished goods by assigning the corresponding account ChartField (account. and may be different from the customer's main address. Local Functionality Local functionality is the set of information in PeopleSoft HRMS that is available for a specific country.GLOSSARY Load Activation Load Activation enables you to specify exactly which part of your Data Mart to build. a type of validation used for a user-defined field code. typically requiring a loan agreement and a promissory note. one to receive bills. GLOSSARY Location Summary A Picking Plan option that sorts the picking plan according to the highest-level sort options defined and prints the order lines and the total item quantity to pick from each Storage Location. Because the layout of the printed report reflects the actual positions of stock to be picked, personnel can follow a serpentine path through the warehouse, fulfilling all orders on the picking plan without revisiting locations. Lock for Confirm A flag on the Pay Line record that enables users to access the database 7 days a week, 24 hours a day, without affecting or interrupting payroll processing. Issues a warning message “A payroll is currently in process for this employee. This data will not be processed until the next payroll." Log file One way that you can monitor the build process is to review the log files that the build process automatically generates. Keep in mind that the log file is entirely separate from the script file; do not confuse the two. How much information that the log file contains is up to you. You can set up your logging so that all status (both good and bad) appears in the log, or you can specify that just the errors or warnings appear in the log. This section describes the options you can specify in regards to the Build log file. Long-Term Variable Compensation In PeopleSoft Workforce Analytics, a component of direct compensation that consists of longterm payments to an employee in the form of stock programs, and deferred compensation. Lookup Codes In the financial services industry, these are user-defined codes that enable the system to define and categorize incoming Instrument table information. They also provide a means for you to report on specific data, such as treasury position, balance type, and ledger account. Lot Status The status assigned to a lot. In PeopleSoft Inventory, a lot’s status can be Hold, Open, Rejected, or Restricted. Lump Sum A tax method that determines withholding based on the Canadian Lump-Sum tax table. Lump Sum Payment Option A form of pension payment in which some or all of a participant's benefit is paid as a single sum. GLOSSARY 114 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Lump Sum Reporting A Time and Labor process that enables you to report time in a lump sum of hours or units for a single Time Reporting Code, and quantities of time. The system uses a batch process to gather the information you enter, perform edits, and update the daily time tables. The system uses the default assignments you establish for workgroups, taskgroups, shifts and so on. M Maintenance Worksheet A work space for creating write-offs, matches, or adjustments to clean up posted items. Manage Base Pay Structure See Base Pay Structure Manage Compensation Planning A PeopleSoft Workforce Rewards module that facilitates modeling and analysis of compensation costs across organization units, specific job classifications, or groups. You can focus on the impact of changes to workforce size, or on changes to fixed and variable compensation elements, and determine their effects on current and future payroll costs. Manage Market Compensation A PeopleSoft Workforce Rewards module you use to match your company’s jobs to similar jobs found in published market compensation surveys. You then calculate a target market rate based on a weighted average from multiple surveys. This market rate is then used to assess your company’s gap to market and to perform cost impact analysis. Manage Retention Planning A PeopleSoft Workforce Rewards module that enables organizations to analyze the factors that lead to employee turnover, and how retention of key employees affects business performance and goals. Manual Checks Any checks calculated and prepared outside of the PeopleSoft Payroll system that you must enter into the system manually. Manual Count A PeopleSoft Inventory procedure in which you enter the actual count data and then create the counting event with its header, item records, and count quantities. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 115 GLOSSARY Manual Events Events that are inserted by the user manually through the BAS Activity table. Events are actions that occur, which potentially change employee benefit coverage eligibility—see Event Class for more information. Used by PeopleSoft Benefits Administration. Manufacturing Cost Element A particular category of an item's cost. For example, when you produce a subassembly that has a cost of $100, the cost can be broken down further into material costs, labor costs, and overhead costs. Manufacturing Execution Systems (MES) Third-party system that enables detailed planning and execution of production activities from production order release to completing finished goods. PeopleSoft Manufacturing integrates to MES. Manufacturing Task Any job that can be performed within your manufacturing facility. A manufacturing task is associated with the work center in which the task is completed. Map File A file that defines the relationship between fields in a third-party system and PeopleSoft Demand Planning tables. Mapper Type This defines whether you are mapping actual or budgeted general ledger line items to resource ID within PeopleSoft Enterprise Performance Management. Marginal Tax Rate The tax rate that applies to the next dollar of income generated. Market Compensation A compensation review process in which you match your company’s jobs to similar jobs found in published market compensation surveys, for the purpose of establishing new target market rates. Also referred to as Market Based Pricing or Market Analysis. Market Capitalization The value of a corporation as determined by the fair market value of its issued and outstanding common stock. It is calculated by multiplying the number of outstanding shares by the current fair market value of a share. Analysts look at market capitalization in relation to book, or accounting, value for an indication of how investor’s value a company’s future prospects. GLOSSARY 116 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Market Rate Compensation rates, usually for regular base compensation or total cash compensation, found in published salary surveys. You use the Market Compensation module in PeopleSoft Workforce Rewards to age and weight this data, to create market rates you can compare against your organization’s current pay rates. Mark-to-Market (MTM) Model In the financial services industry, the reevaluation of a portfolio’s position at current market levels. Market Variance A comparison of the difference between an individual's, or group's, actual compensation, and available market compensation data for a comparable population in industry. Market compensation data is usually tied to job codes, and comparisons are usually made between similar jobs. Although the variance to market can be evaluated for any of the compensation components in the Compensation tree hierarchy (such as Total, Direct, or Base), market compensation data is most typically available for, and used in evaluating Base Pay (Base Salary). The main point of reviewing the market variance is to evaluate how well your workforce is paid in comparison to both prevailing compensation in industry, and your own organization's compensation strategy. Mass Adjustment A process of applying an amount or percentage change to one or many line item budgets at once. PeopleSoft Budgeting-specific. Mass Cancellation of Requisitions and Purchase Orders A utility that allows you to select and cancel groups of requisitions and purchase orders. You can use this utility during the year as well as at year-end in preparation for closing. The utility enables you to specify ChartField criteria for selecting documents for cancellation. For example, you can select all requisitions or purchase orders for a particular fund and organization, which have a remaining balance. Then you may select a subset of those records to approve for cancellation. Mass Change A user-configurable entity that defines the movement of data between the tables that store your business information. Mass Changes enable you to define the criteria by which you move or replace data in your tables. Based on the configuration of your system, Mass Change dynamically builds data access and gives you complete control over your system processing. Mass Change Template The foundation for defining mass changes. Mass change templates enable you to control which fields will be available for the operator to specify when defining a mass change, and whether those fields will be used as selection criteria or defaults. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 117 GLOSSARY Mass Change Type The building blocks used in defining mass change templates. Mass change types specify which records the resulting mass change will select From the database, alter, and subsequently write back To the database. They also set up system field defaults that run behind the scenes to ensure that this mass change is processed correctly. Mass Validate Metadata Utility A PeopleSoft Enterprise Warehouse utility that enables you to validate, but not compile, Metadata objects. Mass Validate certifies all “as of dates” created for Filters, Constraints and DataSets for the specified run date. This utility helps ensure that your Metadata is valid at run time and increases your chance of a successful engine run. Match A process in PeopleSoft Workforce Planning, by which the system compares the roles, competencies, and accomplishments in the current competency inventory, with the requirements of a given competency strategy. Matched Punches A period between two consecutive punches during which some activity happens measured intervals. Match-Funding In the financial services industry, Match Funding refers to funding an asset with a like (term to maturity) liability. This helps an organization apply the appropriate funds transfer price. Although the actual asset might be funded with shorter-term liabilities, it does provide a better measure of financial performance for that asset, such as Risk Adjusted Return on Capital. Material Costing An inventory accounting method that assigns a cost to items in inventory. These costs can be assigned equally across all items or tracked individually for each item. Material Issue An event that triggers stock fulfillment requests for items in inventory. Material News Company news that could be expected to affect the value of a company's securities or influence investors’ decisions. Material news includes information regarding corporate events of an unusual and non-recurring nature, news of tender offers, unusually good or bad earnings reports, and a stock split or stock dividend. Material Release A PeopleSoft Manufacturing process that—after material has been picked—decrements on hand inventory balances for the inventory storage areas and increments inventory to the WIP GLOSSARY 118 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY locations defined by the routing or production area. The process also changes the production ID's or production schedule's status from Released to In Process. MAX Method See Maximum Method Policy. Maximum Compensation Hours The greatest number of hours to be paid for a specified TRC (see Time Reporting). Maximum Lead-Time Usage In PeopleSoft Inventory Planning, a policy control value that sets the safety stock level to the maximum quantity required during the lead time. This method is normally used when the demand for an item is low or intermittent but sufficient stock must always be available. Maximum Method Policy In PeopleSoft Inventory Planning, a policy that controls the way in which the system determines a reasonable high limit for the maximum inventory level of an item. The system provides warning messages when the inventory level exceeds the maximum level. Maximum Taxable Wage Base An annual earnings threshold used for Social Security purposes. Pension plans sometimes provide different levels of pension benefits for earnings above and below the Maximum Taxable Wage Base. Measure A measure represents the amounts brought into a cube—the numerical data. In data warehousing, a Measure is a field type used interchangeably with fact. Measures are types of amounts. Any numeric field you want to apply a Data Manager rule against should be a measure. Measure ID In the Define Market Compensation module of PeopleSoft Workforce Rewards, a Measure ID is the identification code for a measure. For market compensation surveys, the Measure ID describes the percentile for each type of pay, as well as the regression statistic type. In PeopleSoft Workforce Analytics, for Benchmark Surveys, the Measure ID describes the type of benchmark. Measure Value In PeopleSoft Workforce Rewards, Measure Value is the calculated market rate value from market compensation surveys for a given percentile of a market rate, and for a given scenario and job code. This is the annual rate you compare against the compensation paid for similar jobs in your company. The Measure value can also be the regression statistic value used for PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 119 GLOSSARY Regressing Market rates. In PeopleSoft Workforce Analytics, for Benchmark Surveys, the Measure Value is the delivered Benchmark Ratio. Member A member is the OLAP equivalent of a node or detail value on a PeopleSoft tree. A member is a single item within a dimension, such as a single product name, department ID, or part number. Member names must be unique, even across dimensions. Cube Manager uses the term Dimension Field Mapping to identify members, dimension parents, and label mappings. Merchant In PeopleSoft eStore and Mobile Order Management, a level of online (web or wireless device) display and order processing controls set by the seller. See also Merchant Variant. Merchant Variant Associated with a user ID, a subordinate level of merchant controls that enable customers to access different variations of the same PeopleSoft eStore website. In PeopleSoft Mobile Order Management, variations are primarily used to differentiate order processing options and fulfillment methods or locations. Merit Matrix In PeopleSoft Workforce Analytics, a matrix used to define the amount rules for base compensation increases for your workers. A Merit Matrix provides the salary increase parameters for each review rating in a rating scale. The salary increase parameters are expressed in terms of a percentage. The percentage increase amounts are usually structured to express the company’s pay strategy relative to employee performance, and the employee’s degree of range penetration in their salary range. Merit Matrix Increase In PeopleSoft Workforce Analytics, an increase to an employee’s base pay awarded based upon a Merit Matrix. Message definition The object definition specified in Application Designer which contains message information for PeopleSoft’s Application Messaging system. Metadata Information about data. Metadata is the information a database or application stores to describe your business data. At its simplest, metadata defines the structure of a data field—its data type and size, for example. Metadata can also describe more complex data relationships, such as the rollup structure for a chart of accounts. Reporting and analysis tools should be able to use this metadata to let users access data just as they would from within the application, without having to understand how it is stored. GLOSSARY 120 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY For Enterprise Performance Management, metadata is used to describe the data stored in the PeopleSoft Enterprise Warehouse. There are different types of metadata, for example, TableMaps, DataMaps, and constraints. You typically define these when you set up the warehouse; however, Metadata (particularly constraints and DataMaps) is used to develop business rules that manageaspects of the dimensional models. Metadata enables technical users to define relationships between warehouse tables and enables business users to easily identify the data that interests them without having to know the database structure. Meta-SQL Meta-SQL: Meta-SQL constructs expand into a platform-specific SQL substrings. They are used in functions that pass SQL strings, such as in SQL objects, the SQLExec function, Application Engine programs, and so on. Metastring Metastrings are special expressions included in SQL string literals. The metastrings, prefixed with a percent (%) symbol, are included directly in the string literals. They expand at run time into an appropriate substring for the current database platform. Method A method can only be executed from an object, using dot notation. You have to instantiate the object first, before you can use the method. For Enterprise Relationship Management, a method is the algorithm or formula that defines how the budget amount for a line-item budget is calculated or how it is derived if a calculation is not necessary. Types of methods include amount per FTE, itemization, annual percent growth rate based on a historical figure, and number of units multiplied by cost per unit. PeopleSoft Budget Planning-specific. Method Amount The amount for a line item budget resulting from the application of a method. It represents the budget amount after the method is applied to a line-item budget but before any adjustments or allocations are applied. PeopleSoft Budgeting-specific. Method Base The defined value to which a method is applied, if applicable. Not all methods require a base. PeopleSoft Budgeting-specific. Method Driver The factor used in a method’s algorithm. For the method, amount per FTE, FTE is considered the driver. PeopleSoft Budgeting-specific. Method of Payment In PeopleSoft Grants, designates whether a payment is to be through a cost invoice or a Letter of Credit. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 121 GLOSSARY Method Parameter A defined and derived value within a method, which drives an expense or revenue calculation. For the method, Amount per FTE, the number of FTEs is considered the driver parameter. PeopleSoft Budgeting-specific. Metric A metric is a calculation of facts. A metric is usually a number, but can be anything you want to measure. Metric Object Security Metric Object Security determines whether an individual can see a metric object in a Data Mart. Midpoint (Pay Range Midpoint) In PeopleSoft Workforce Analytics, the middle value in a pay range, halfway between the minimum and the maximum, calculated as (Minimum + Maximum)/2. Midpoint Progression In PeopleSoft Workforce Analytics, the percentage difference from one grade midpoint to the next higher-grade midpoint, calculated as (Midpoint2 – Midpoint1)/Midpoint1. MIN Method See Minimum Method Policy. Minimum Benefit See Grandfathered Benefit. Minimum Compensation Hours The lowest number of hours to be paid for a specified TRC (see Time Reporting). Minimum Method Policy In PeopleSoft Inventory Planning, a policy that controls the way in which the system determines a reasonable low limit for the minimum inventory level of an item. The system provides warning messages when the inventory level drops below the minimum level. Missed Punch A punch that is not entered at the scheduled time (see Time Reporting). GLOSSARY 122 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY mkvdk Verity’s command-line tool used to index a collection, insert new documents, perform simple maintenance tasks like purge and delete a collection, and control indexing behavior/performance. MLS Multilingual support. Modal transfer Modal transfers allow you to transfer an operator from one component to another component (the modal component) modally; that is, requiring the operator to OK or Cancel the modal component before returning to the originating component. Modal transfers give you some control over the order in which the operator fills in pages. They are useful for finite tasks related to the main transaction. They are particularly useful in cases where data in the originating component can be derived from data entered by the operator into the modal component. Model Equivalency Factors In PeopleSoft Demand Planning, factors that adjust model errors to allow a fair comparison. During the Model Reset process, the errors associated with each of the models are multiplied by their associated factors. The factored errors are then compared to select the model with minimum errors. Models In the PeopleSoft Enterprise Warehouse, Models enable replication of an organization’s business processes for analysis of cost flow through customers, departments, and channels. Model Recalculation In PeopleSoft Business Planning, users may checkout slices of the entire model for their appropriate role. This requires the entire model to be periodically recalculated to incorporate the users changes for dependencies in other areas of the model. Morphing Morphing is a technique of automatically transforming the look and feel of an interface based on the needs of an active object. The Application Designer toolbar and menus dynamically transform based upon the type of object definition that is active. Mortality Table A table showing rates of death by age. Mortality tables are part of a pension plan’s actuarial assumptions. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 123 GLOSSARY Moving Average In PeopleSoft Demand Planning, a model that averages a selected number of the most recent demand periods and creates a forecast of demand for the next and subsequent periods. Multibook A functionality supporting the requirement of a company to carry one set of books in their local currency (functional currency) and another set of books in the currency of their parent company (reporting currency). In PeopleSoft General Ledger, multibook functionality is multiple ledgers having multiple-base currencies defined for a business unit, and the option to post a single transaction to all base currencies (all ledgers) or to only one of those base currencies (ledgers). Also commonly known as dual-book. Processes in PeopleSoft applications that can create both application entries and general ledgers denominated in more than one currency. Multicurrency The ability to process transactions in a currency other than the business unit’s base currency. Multidimensional Analysis A type of analysis that enables you to look at data from many different dimensions, or attributes. You identify the dimensions of the data, then combine the dimensions in various ways. For example, you might identify five dimensions of your sales data: sales, region, channel, product line, and time. Once you’ve identified the dimensions, you can “slice and dice” the data based on combinations of these dimensions, such as sales in the Western region for the last quarter. Multidimensional Database (MDDB) A database that stores data for multidimensional analysis in a proprietary multidimensional format. Users access MDDBs exclusively for reporting and analysis, never transaction processing, so they are optimized for retrieval speed. For Enterprise Performance Management, a Multidimensional Database stores data for multidimensional analysis in a proprietary multidimensional format. These databases are used exclusively for reporting and analysis, and never transaction processing, so they are optimized for retrieval speed. Multiple Jobs Multiple jobs allow you to hire an employee into more than one concurrent job and have them processed through Payroll, Benefits, and Pension. In order to enable this feature, the Multiple Jobs check box must be selected in the PeopleTools Options page. Multiple-table dynamic tree The user drills down through a hierarchy of parent and child records. GLOSSARY 124 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Multivariate Forecasting Techniques In Enterprise Planning and Simulation, this is a forecasting method that uses both the recorded history for the target value and the history and forecasts for other variables (causal factors) to infer, not only a forecast for the target value, but also a functional relationship between the causal factors and the target value. N National Association of Securities Dealers, Inc. (NASD) Self-regulatory organization of the securities industry responsible for the regulation of The NASDAQ Stock Market and the over-the-counter markets. The NASD operates under the authority granted it by the 1938 Maloney Act Amendment to the Securities Exchange Act of 1934. National ID Number Different countries track some form of National ID for payroll, identification or benefits purposes. For example, German workers are assigned a Social Insurance Number, UK workers have a National Insurance Code, and US laborers have a Social Security Number. Each of these different types of National IDs has unique formatting requirements associated with them as well. Nature Of Action (NOA) Code Indicates the type of personnel action being processed. Nature Of Action Description Describes the NOA code. Nature Of Action Effective Date The date the personnel action is effective. Negative Amortization Occurs when a loan payment does not cover the interest due on the loan payment, resulting in an increase of the principal amount. Net-To-Zero Adjustment A prior period adjustment where no compensation affecting fields on the pre-existing (original) record are changed by the adjustment. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 125 GLOSSARY New Hire Report In the United States the Personal Responsibility and Work Opportunity Act of 1996 (the socalled Deadbeat Dads law) requires employers to report new hires to specified agencies within a pre-determined number of days from the hire date. Next Level Item In PeopleSoft Demand Planning, the Forecast Item at the next level that contains the current item as a child. This is the key of the group item at the next level up and is always within the same view. Next Year PeopleSoft Benefits term referring to the next open enrollment processing year. NIC (Numéro Interne de Classement) Code In France NIC numbers identify the entities inside the same enterprise, and represent an Internal Filing Number. No Control A target control that allows the user to submit a budget even if it is not within the planning target and the tolerance levels. The system tracks the budget against the defined planning targets but does not generate any warnings or validations. Users can still compare their planning targets against their budget amounts on the Planning Targets page in Line Item Budgeting. Node An individual item on a tree. Nodes summarize detail values or other nodes, and may or may not roll up into other nodes or levels. Node A node is a name that you can use to refer to some source of HTML content. In more practical terms, a node is a URI string that defines the database and server to be used when the portal servlet attempts to retrieve content, proxy addresses, and assemble pages. Non-Base Pay A pay component not included in the job comp rate calculation. It is used by payroll only in the paysheet calculation. For example, non-base pay can be set up for additional work, holiday pay, bonuses, and so on. Non-Benchmark Jobs See Benchmark Jobs. GLOSSARY 126 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL non-employee earnings will not be updated to Payroll and they will not be paid through the Payroll system. time spent in meetings.GLOSSARY Noncompetitive Action An appointment or placement in a position in the competitive service that is not made by selection from an open competitive examination. and that is usually based on current or prior Federal service. Although non-employee time will be entered into Time and Labor for the purposes of managing their Task time. See Highly Compensated Employees. Used by PeopleSoft Benefits Administration. Non-Employee Those workforce resources hired to perform a specific job and/or hired for a specific period of time. Non-Qualified Dependent Dependents such as domestic partners. travel time. See Event Class. This could include time spent in training. and Appointments and conversions to career and career-conditional employment made under special authorities covered in 5 CFR 315. A noncompetitive action includes: • • • All of the types of actions described under inservice placement. Non-Productive Time Any employee scheduled work time spent on tasks (or non-tasks) other than those which the employee was hired to perform. Subpart F. Non-Job Event Actions which result in changes to an employee’s personal or demographic information that also affect benefit program and plan eligibility—such as an a state or postal code change. a family status change like a divorce. and time spent reporting time. PeopleSoft Benefits applications enable the creation of benefit programs that offer health and life coverage to nonqualified dependents. and other people who do not meet the definition of qualified dependents as presented in IRS Section 152. Non-HR Employee [Time and Labor] An individual employed by the corporation who is administered outside of the PeopleSoft Human Resources system. and Section 129 dependent care reimbursement plans do not discriminate in favor of highly compensated employees. Nondiscrimination Tests (NDT Tests) Tests used to help employers ensure that their organization’s 401(k). or a birthdate change.701. 401(m). their children. above Appointments of non-Federal employees whose public or private enterprise positions brought into the competitive service under Title 5 CFR 316. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 127 . S. plan benefits are generally paid directly from the employer's assets. Difference between the fair market value on the date of exercise and the grant price is treated as compensation income. withholding tax obligation arises at the time of exercise. Features are: • • • • • • • The grant price may be less than fair market value (with some exceptions under state law). Consultants and Board of Directors). companies can design nonqualified options in almost any way they like. instead. In the U. Normal Retirement Date (NRD) The date on which an employee is eligible to retire and begin receiving pension benefits. such as an employer's portion of a 401(k) plan.. Company receives a tax deduction equal to the compensation income recognized. Normal Line Of Promotion (Career Ladder) The pattern of upward movement from one grade to another for a position or group of positions in an organization. No taxable income is recognized at the time of grant. Normal Form of Payment The payment form associated with the amount calculated by the benefit formula. Normal Hours The hours an employee is normally expected to be at work for any given workweek. Eligibility for normal retirement is typically based on age only.GLOSSARY Nonqualified Plan A plan that doesn’t conform to ERISA rules. Generally. Options can be granted to anyone (Employees. Pension Administration uses it as a basis for converting to optional forms of payment. Grants are not limited to employee of the company or subsidiary. Nontaxable Benefits Any employer contributions that are not subject to Federal Withholding Tax. Employers cannot take a tax deduction for contributions to a nonqualified plan. Nonqualified Stock Option (NQ) Any option that does not satisfy the conditions of a statutory stock option under the Internal Revenue Code and therefore does not qualify for preferential tax treatment. GLOSSARY 128 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Hospitalization coverage. Promotion NTE Date: Specific NTE Date: Specific time for an increase in grade on a temporary basis. Normalized Loss In the financial services industry. Similar to the bank’s loan loss reserve. and so on. Protestant. No salary is paid for the period.GLOSSARY Normalized database A normalized table adheres to certain standards designed to improve the productivity of the database user. nPlosion A PS/ nVision feature that enables you to expand rows and columns in your spreadsheet to underlying details. such as first normal form. Suspension NTE Date: Specific time an employee is to be on suspension. LWOP NTE Date: NTE date is the last day the employee is in leave without pay status. Other) of the workforce. by financial product. The report indicates the religious composition (referred to as Community Background—Catholic. second normal form. Normalized Loss is the expected loss on a loan and is netted out of the profit and loss statement for management accounting or profitability measurement purposes. allowing data to be combined in many different ways. The standards for a normalized database are called forms. The employee is scheduled to return to duty the next workday. Position NTE Date: Indicates the length of time a position is available for use. it enables the institution to analyze and account for expected losses on a more detailed level. job applicants and appointees. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 129 . as in drilldown. Normalization makes the database much more flexible. Not To Exceed (NTE) Date Types are as follows: • • • • • • • Appointment NTE Date: Indicates the length of time a person may serve in a position. Classification Temporary NTE Date: Established temporary date that is used for a temporary classification of a unique position. Northern Ireland Report In the United Kingdom the Fair Employment (Northern Ireland) Act of 1989 requires private sector employers with more than 10 employees to submit the Northern Ireland report to the Fair Employment Commission annually. Off Day A 24-hour period rounded by daybreaker with no associated shifts (see Scheduling). Off Date A specific date that is defined as an off day (see Scheduling). For example. GLOSSARY 130 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . the Accounting Series. holiday. Off Day Type A classification of off days (i. Offer Period This is the period of time in which an employee’s ESPP share price is determined. Off-Cycle Processing The process of calculating and creating a paycheck for one or more employees aside from the normally-scheduled (on-cycle) payroll run for their pay group. GS-0510). You typically use off-cycle payroll processing for employees who are being terminated.GLOSSARY Numeric constant Numeric constants are any decimal number used in PeopleCode. The menus that use the component are its object references.. Occupant Of Position/Vice Indicates new position or former occupant of a position. in the case of a component.g. In the PeopleSoft Enterprise Warehouse. you set up such models using the Scenario Manager. They are designated by a title and four digit number (e. and employees who received an incorrect paycheck during a normal on-cycle payroll. Object reference An object reference is one that uses the current object. plant shutdown) (see Scheduling). pages within the component are related objects.e. Occupational Series Code Designates a grouping of positions similar in work and qualification requirements. O Object-Based Modeling Object-Based modeling technology enables you to create parent and child models. new hires who weren't entered into the system in time for the last on-cycle payroll run. Official Languages Act (OLA) Canadian federal institutions are required to report on the official languages used in their departments. CFO. COO. Official Forwarding Address An employee's mailing address following separation. Ontario Employment Equity Commission (OEEC) The OEEC requires employers in Ontario to complete workforce surveys. Off-invoice discounts can originate from a National Allowance or Customer Promotion. Offset Plan A pension plan where the benefit formula includes an offset of a portion of the participant's Social Security benefits. Official Personnel Folder (OPF) The repository of a Federal employee's official documents related to Personnel history. OLAP is the multidimensional analysis of application data. OLAP Online Analytical Processing. in accordance with the Official Languages Act (OLA). performed interactively. Official Personnel Folder (OPF) Address Indicates the address where the Official Personnel Folder is maintained. The acronym contrasts with OLTP (Online Transaction Processing). and are passed to PeopleSoft Order Management so the discounts are applied correctly during order entry. CIO. Corporate Secretary. Off-Invoice Discount (OI) A per unit discount deducted from the customer invoice and given by a manufacturer for promotional activities.GLOSSARY Officer An insider who sits on the Board of Directors and who is also an employee of the corporation. CTO. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 131 . and Treasurer. such as processing invoices or enrolling employees in benefits programs. Examples include CEO. OLTP (Online Transaction Processing) OLTP refers to the applications that perform the business transactions that keep your company running. which is what most production business application systems do. within those programs.January 31. Open Price The price at which a security starts a trading day. GLOSSARY 132 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . for minimizing overtime costs. and using one or more resources. Optimization In PeopleSoft Demand Planning. For FEHB processing. OPM Office of Personnel Management. it is generally the time period from mid-November through mid-December. OPF Code Indicates where the OPF is maintained. Open Transaction A transaction that has not yet been processed in PeopleSoft Asset Management. benefit options. Open Season A time period during which Federal employees are open to re-enroll in a specific benefit plan and option. Operation In PeopleSoft Manufacturing. a job or task performed in a specified amount of time. done in one work center. these are semi-annual and are generally held from May 15 .GLOSSARY Open Enrollment The scheduled annual re-enrollment of plan participants into appropriate benefit programs and. the process of evaluating and improving forecast model parameters. The Optimizer can be prioritized for meeting due dates. Optimize The process of creating a new PeopleSoft Planning schedule by repairing the violated constraints in a schedule automatically. Operational Data Store (ODS) A staging area in PeopleSoft Enterprise Warehouse for source application data and preprocessed data for tables optimized for reporting.July 31 and November 15 . Open Seasons can be scheduled at varying times throughout the year and multiple Open Seasons can occur concurrently with each other. Open seasons for FEGLI are infrequent and special notification from the OPM would be issued to all Federal employees should they occur. For Thrift Savings Plan (TSP) processing. and so on. These options are considered granted on the offering begin date. and lump sum options paid out in a single payment. the difference in the average expected return between an instrument without embedded options that are otherwise identical to the fully loaded instrument and the instrument fully loaded with embedded options. Order Line Number The line associated with an order identification number. Incentive Stock Options (ISO). for all projected interest rate paths generated using Monte Carlo simulation. the average return expected for an instrument. Nonqualified Stock Options (NQ). and Expirations. PeopleSoft Stock Administration supports the following stock option types.GLOSSARY Option A contractual right that gives the individual the option to purchase a specified number of shares of stock through an Equity Compensation Plan. Optional Forms of Payment Any alternative forms of payment available to a participant retiring under a pension plan. Cancellations. Also known as a grant. Restricted Stock Award (RSA). Regulatory agencies also refer to an option as the right to purchase stock in an employee stock purchase plan. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 133 . The order line identifies an item and the requested quantity. Tandem Incentive Stock Options/Stock Appreciation Right (ISO/SAR). Option Adjusted Cost (OAC) In the financial services industry. Order Group Order groups link order terms that default into sales orders and quotes when you select an order group code. Options Outstanding The total number of option shares held by optionees. certain term options paid over a specified number of years. It is the number of Grants less the number of Exercises. These can include: annuity options paid over the participant’s (and possibly a beneficiary’s) lifetime. over the short-term risk-free rate. Option Adjusted Spread (OAS) In the financial services industry. Option Types Types of stock options. Tandem Nonqualified Stock Option/Stock Appreciation Right (NQ/SAR). Includes option profits upon exercise of non-statutory options. Ordinary Income Tax An individual’s tax on earnings from wages. Original Option A stock option that is eligible for repricing. Out Punch Indicates the end of a shift. a policy that determines how replenishment order quantities are calculated for an item. Such options are also described as being "underwater. it costs more to exercise than the underlying stock is worth. tips. When an option is out-of-the-money. external. and all other sources except capital gains." Output Result Tables Refer to the database tables that are populated with information at the end of each pay calculation. or use an economic order quantity calculated by the system. GLOSSARY 134 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . you can use a static number. Origin ID A code that identifies the location of a payment deposit in PeopleSoft Billing. or lock box interface. Output VAT VAT collected on sales or outputs. Origin ID also distinguishes the method of the payment's entry: online. Billing origin ID identifies the remit to origin for billing. OSHA 200 Occupational Injury and Illness Recordkeeping Log In the United States this record-keeping logbook meets reporting requirements for reporting occupational injuries and illnesses to the Occupational Safety and Health Administration (OSHA). This option has a grant price greater than the current FMV. This function is mainly used for specifying where the customer should send payment. provide upper and lower limits. Out-of-the-Money A term used to describe an employee stock option when the current market price is below the option grant price. It lists the case numbers and details of each injury and illness that occurred during a calendar year.GLOSSARY Order Quantity Policy In PeopleSoft Inventory Planning. For example. P Package level The top level of organization is the package level. Page Assembly Page assembly is one of the functions of the portal servlet. but no tax is applied. Override Rate Cost per hour or unit reported with time used to replace the time reporter’s default rate. Only options with a status of ‘active’ or ‘suspended’ are considered outstanding. The package is the entire transaction set file. Outstanding Option A stock option that still has unexercised (vested or unvested) uncancelled or unexpired shares. Outside The Register Appointment An appointment in the competitive service made under an agency's applicant supply system because either there is not a sufficient number of eligibles on the appropriate register or no competitor inventory exists. retrieving the content.GLOSSARY Outside Scope of VAT A transaction determined as not subject to VAT. Options with a “pending” status are not included. Page A page defined in Application Designer as part of a PeopleSoft Internet Architecture application. and the same product. Agencies are also authorized to make temporary limited appointments outside the register at grades GS-12 and below. addressed to your company much as a mail package would be. The transaction is still logged in the VAT transaction table. Page assembly involves intercepting the user’s content request. No VAT code is associated with this type of transaction. at the same time. (see Time Reporting) Override text Text not derived from field descriptions. To complete the page assembly process. the portal servlet merges content from any HTML documents that it retrieves along with the defined template PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 135 . and properly formatting it using a pre-defined portal template. Overlapping Promotions Multiple customer promotions related to the same customer. such as summary and detail budgets. Page buffer Consists of rows of buffer fields that hold data for the various records associated with page controls. With common stock. The assembled page is then sent back to the user’s web browser as a single HTML document. Running concurrent processes greatly reduces the amount of time it takes to run within the system. GLOSSARY 136 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Par value has no relation to fair market value. related display records. Parent/Child Models Object based modeling technology enables you to create parent and child models. Parallel Processing In the PeopleSoft Enterprise Warehouse. including the primary records. Parent Budget In commitment control. parallel processing is a system function that "locks in" the information you use for processing. Some companies issue no par value stock. you set up such models using the Scenario Manager. A pagelet is smaller than the typical page dimensions in many PeopleSoft applications. derived/work records. the company issuing the stock sets par value. Pagelet A page designed to appear on a customized homepage. Par Value The nominal or face value of a security. you can build a hierarchy between different budgets. and translate table records. In the PeopleSoft Enterprise Warehouse. Parent node A tree node linked to lower-level nodes or details that roll up into it. Specifying a relationship of parent and child between a summary and a detail budget for purposes of budget inquiries enables you to retrieve information about either budget through the other. It can be based on either a page designed in Application Designer or on an iScript. This enables the system to run identical or similar processes at the same time without impacting your results.GLOSSARY HTML. It establishes a price floor below which shares may not be issued. A node can be a parent and a child at the same time. depending on its location within the tree. Paired Punches Two punches for the same employee in chronological order that exists for the purpose of determining the duration between the punches. or units and task information once for an employee. or responsible for. associated hours. terminate. Partial Pay The pay processed whenever a job record has an effective date in the middle of a pay period. See Event Class for more information. a financial instrument or group of instruments. amounts. Examples of passive events include an employee’s reaching the age of retirement. Pay Types of "pay" are as follows: PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 137 . these rules are based on age and service criteria. Events are actions that potentially change benefit coverage eligibility.GLOSSARY Parent Task A higher-level Planning task in a schedule's hierarchy that drills down into subtasks. Participation The PeopleSoft Pension Administration function that determines whether an eligible employee has met the plan's rules for joining the plan. Typically. Participants Individuals who elect to participate in the stock purchase plan. Generally. Participation ID In the financial services industry. The system transforms the information into instances of daily time for each scheduled employee work day based on the employee’s schedule. rather than by a direct data entry action. and its end time is the end time of its latest subtask. this is a lookup code used by the financial analytic applications to identify the participants (syndicators) involved in. The system responds by sending an email to the user of the next budget center level indicating that the budget exceeded planning target tolerance levels. transfer. Passive Events Events that are initiated by a change that has taken place over time. Planning tasks are distinct from Manufacturing tasks. Pattern Reporting A Time and Labor process that enables you to report a start and stop date. a pattern of one or several time reporting codes. or change the rate of pay for an employee mid-period. Its start time is the start time of its earliest subtask. Passive Control A target control allowing the user to submit a budget even if it is not within the planning target and tolerance rules. this happens whenever you hire. g. etc. The pay entity is a legal definition of an organization from a payroll perspective.GLOSSARY • Basic Pay: generally. Pay Components. the total amount of pay received during any one calendar year at the rate fixed by law or administrative action for the position held by the employee or judicial official prior to any deductions and not including any special payments or premium pay. Pay Entity A pay entity is the organization responsible for making payments to payees. an organization and a pay entity are the same. night differential. an annuity (if any). In many cases. PeopleSoft Global Payroll does not define a relationship between an organization and a pay entity. You can also use a pay entity to define the type of currency to be used when processing calculations. Gross Pay: total compensation earned by an employee. plus awards (if any). that serves as a basis for computing an employee's pay. Pay Calculation Formula that calculates an employee's gross to net. Rows in the compensation record. Includes basic pay plus locality pay. GLOSSARY 138 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .).. overtime. Pay Calendar Payroll processing cycle for a given pay group. administratively uncontrollable overtime (AUO). Pay Frequency Defines how often employees in a pay group are paid—weekly. • • Pay Basis A code indicating the principal condition in terms of time. availability pay. monthly. special payments (if any). deductions. availability pay (if any) for LEOs. holiday pay. annuitant. Premium Pay: pay provided to an employee as a regular addition to basic pay (e. procedures or criteria. or survivor of a judicial official prior to any deductions. and so on. They build the compensation packages in the compensation record. However. and taxes for pay groups assigned to a given Pay Run ID. biweekly. Pay Confirmation Process in which the system updates all to-date totals on the database for earnings. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 139 . Payable Date The date that a corporate distribution. etc. to target the market 50th percentile).GLOSSARY Pay Group A set of employees grouped together for payroll processing. The system creates one Process Stat record per payee for each calendar. You build these to match your organization’s needs. A pay group is made of payees that the system processes at the same time during a pay run. Payee Process Stat Record A record created for each payee during the payroll process. Pay Slip Either an actual check or an advice notice of a direct deposit. such as a dividend. UJ. Pay Structure consists of a series of pay ranges or grades. A pay slip is the details of a payment you’ve made. e.g. A payee can be an employee or a non-employee of an organization. each with a minimum and maximum. You develop pay structures to support and reinforce your company’s pay strategy (for example. Pay Periods are defined by their beginning and ending dates. It’s a way of “bundling” payees for more efficient processing. Payable Time Time that is ready to be collected by the payroll system (see Time Reporting). Pay Plan A code that denotes the pay schedule under which an employee is paid . UG. is payable to the record holders of a corporation’s securities. JS. Pay Structure In PeopleSoft Workforce Analytics. Payee Any payroll recipient. Pay Period The established time segments for which employees in a pay group are paid.. PayCycle A set of rules that define to PeopleSoft Payables the criteria by which it should select scheduled payments for payment creation. Payment Interface An Application Engine process that loads payment information from the Banks Statement tables and the Staging tables to the Application tables and performs various checking and default operations. Payment Worksheet The work space in which open items are paired with unapplied payments. and tax information and job data. Records holding data necessary to process a payroll. such as the amount of regular pay. Paysheets Repository for the raw data necessary to calculate pay for employees. company. A payee section defines a set of elements that is to be resolved for a particular payee. taxes. additional pay (if any). Payline Record containing standard payroll information for an employee. such as employee. including earnings. GLOSSARY 140 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and tax information. Payment Selection A process by which PeopleSoft Payables selects scheduled payments that are eligible to be paid in a pay cycle. Payment Schedule A schedule of payment dates for leased assets. Payment Predictor PeopleSoft Receivables' automatic cash application feature that pairs open items with unapplied payments based on predefined algorithms. and accounting data. Payroll Process Tables. hours. Payroll Certifying Officer The individual with the delegated authority for approving all items relating to payroll for those employees under his/her authority. number of regular hours. deductions.GLOSSARY Payee Section Type of section that can be added to a process list. but hasn't yet been posted.GLOSSARY PBGC Rates and PBGC Grading The interest rates published monthly by the Pension Benefit Guaranty Corporation. it determines the lateness preference ranking for dependent demand tasks. There is an "immediate" rate that applies once benefits commence as well as a series of “graded” rates—calculated based on the immediate rate—that are used during the time between benefit determination and a deferred benefit commencement. The method ties tasks together in order to explicitly record which supplies are being used to satisfy which demands. Through this process. determining how the schedule's score will be calculated. Penalty A user-assigned value for constraints that can be violated. It is the label for those time transactions that are waiting to be used by the business (for example. PeopleCode PeopleSoft's proprietary language. the system uses the pending items to update customer balances—either by creating new items or by adding item activity lines to existing items. terminated deferred vested. based upon existing data or the PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 141 . Pension Status An employee’s standing with regard to a particular pension plan. and future pay periods. the Planning engine first determines which independent demand has the highest priority. Pending Time Time that has been reported or is assumed to have been reported (based on employee work schedule and calendar date) that has not been used by the business entity. During the Receivable Update process. Pending Item Information in PeopleSoft Receivables that has been entered in or created by the system. Pending Exceptions are future dated (future is defined to be for a date under report beyond the last date of the employee's current pay period). Pending Exception Any known exception to an employee's scheduled workday. Pegged Chain A method the PeopleSoft Enterprise Planning and Production Planning solvers use to determine feasible plans. PeopleCode generates results based upon specific actions. it is executed by the PeopleSoft Application Processor. current. Pending Time may be for past. approved and unapproved time not yet updated to Paysheets). Use the Control Page to assign a higher penalty to violations that are more critical to your schedule or a lower penalty to constraints that you can deal with externally. Then. For example. or in pay status. Setting the penalty configures the constraint to your priority. employees can be active participants. PeopleSoft Analytic Applications These are applications within Enterprise Performance Management (EPM) that help you enrich the data in the PeopleSoft Enterprise Warehouse and perform forward looking simulations and scenarios. monitor and manage interest rate risk. PeopleSoft Asset Liability Management (ALM). PeopleSoft Asset Liability Management (ALM) PeopleSoft Asset Liability Management provides financial service institutions with the analytical tools to define. PeopleSoft Activity-Based Management identifies and assigns operational activities to products. PeopleSoft Balanced Scorecard (BSC) PeopleSoft Balanced Scorecard converts an organization’s vision and strategy into a comprehensive set of performance and action measures that provide the basis for a strategic management system. liquidity risk. This application resides on the EPM database. primarily using the ODS layer of the PeopleSoft Enterprise Warehouse for its data. that is referenced within a PeopleSoft page. and to some extent exchange rate risk. PeopleSoft Balanced Scorecard (BSC). PeopleSoft Business Analysis Modeler (BAM) A multi-dimensional modeling tool used to support several analytic applications. These applications include: PeopleSoft Activity-Based Management (ABM). measure. PeopleSoft Budgeting A budgeting application that is a combination of Education and Government (E&G) Budget Planning and Budgets (commercial). enabling a coordinated approach to expense and PeopleSoft Activity-Based Management.GLOSSARY actions of a user. customers. GLOSSARY 142 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . usually a Record Field. and PeopleSoft Workforce Rewards. PeopleCode Event An action that an end-user takes upon an object. Business Interlink Objects are executed by calling the execute() method from PeopleCode. PeopleSoft Funds Transfer Pricing and PeopleSoft Risk Weighted Capital are applications that target the financial services industry (FSI). PeopleSoft Activity-Based Management (ABM) A PeopleSoft Analytic Application that aligns organizational costs with operational activities. or services. options risk. The primary audience for PeopleSoft Asset Liability Management is the financial institution’s Asset/Liability Committee (ALCO). PeopleSoft Funds Transfer Pricing (FTP). PeopleSoft Risk Weighted Capital (RWC). This makes external services available to all PeopleSoft applications wherever PeopleCode can be executed. See also PeopleSoft Balanced Scorecard PeopleSoft Enterprise Performance Management (EPM) Enterprise Performance Management is a comprehensive. You can then publish the results to another transactional application. and error tables. and present information to provide the optimal environment for business intelligence. customer activity. reference. credit or psychographic information. This scorecard facilitates the measurement and communication of customer satisfaction. PeopleSoft Business Planning integrates with PeopleSoft Analytic Forecasting. adjusted for risk and cost variables. PeopleSoft Funds Transfer Pricing is an interest rate that represents the value of an asset or liability to the institution. d) use a data mining tool to create a predictive model. PeopleSoft Funds Transfer Pricing (FTP) A PeopleSoft Analytic Application that enables an institution to accurately measure and tune profitability. specific to the institution. The PeopleSoft Enterprise Warehouse consists of dimension. b) create segments and samples from the profile to efficiently target marketing campaigns and further analyze customer behavior. integrated analytic business solution designed to increase the value of organizations by enabling people to make better decisions. PeopleSoft Workforce Analytics. PeopleSoft Customer Scorecard A product that provides a pre-defined set of customer-oriented key performance indicators (KPIs). and objectives across your organization. and can also serve as a standalone data warehouse. The PeopleSoft Enterprise Warehouse provides the tools necessary to query. the institution can remove the PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 143 . By assigning PeopleSoft Funds Transfer Pricing to each item on the balance sheet. PeopleSoft Enterprise Warehouse (EW) PeopleSoft's data warehousing solution. as well as the Operational Data Store (ODS). It is the central repository for data that will be used with the analytic applications in the Enterprise Performance Management product line. PeopleSoft Funds Transfer Pricing is based on market rates. fact. to help you build a scorecard specific to your organization. PeopleSoft Customer Behavior Modeling A PeopleSoft application that enables you to: a) create a customer profile by extracting customer data from the Enterprise Warehouse. PeopleSoft Activity Based Management.GLOSSARY PeopleSoft Business Planning A planning application that enables financial executives to model various alternatives and set corporate financial targets to achieve their strategic goals. and PeopleSoft Budgeting applications. The tables in the PeopleSoft Enterprise Warehouse are maintained separately from your transaction-based systems to allow for comprehensive analysis of data originating from any Online Transaction Processing (OLTP) or legacy system. e) score the customers in your profile using the predictive model. reporting and ETL tools (Informatica PowerMart). c) append to it additional data from external sources such as demographic. analyze. The PeopleSoft Enterprise Performance Management product line consists of the PeopleSoft Enterprise Warehouse and optional analytic applications and Data Mart products. Modules include Market Compensation. You integrate data from multiple internal and external sources. It helps to manage strategic employee compensation. goals. and Retention Management. and sales process. It helps you determine the effectiveness of marketing events based on factors such as number of leads generated. enrich it using rules you define based on any data in your PeopleSoft Enterprise Warehouse. which includes the PeopleSoft Workforce Rewards analytical application and the PeopleSoft Workforce Analysis Insight. or transaction generates income given its perceived level of risk as quantified by the allocation of capital. PeopleSoft Operations Data Stores (PODS) See Data Warehouse Tables PeopleSoft Marketing Insight A tool that helps you analyze your marketing campaigns and activities. so that profitability measurements are based on factors within their control. PeopleSoft Workforce Rewards PeopleSoft Workforce Rewards is an analytical application you use to align your workforce compensation and retention initiatives with the strategic objectives of your organization. Workforce Simulation. customer. discount analysis. such as pipeline status. product. PeopleSoft Risk Weighted Capital (RWC) A PeopleSoft Analytic Application that enables the financial services industry to accurately measure capital that has accounted for risk. and simulate multiple scenarios of future workforce compensation and GLOSSARY 144 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . RWC allocates capital to various levels within a financial institution according to risk. credit quality. The complete solution set includes the PeopleSoft Enterprise Warehouse and PeopleSoft Balanced Scorecard products. that is. It helps you answer questions such as: Are we effectively handling customer issues? Has contact center performance changed from last year to this year? Which product quality issues are most prevalent? PeopleSoft Workforce Analytics (WFA) PeopleSoft’s complete workforce analysis solution. PeopleSoft Sales Activity Insight A tool that helps you analyze key components of the sales process. as well as retention. campaign return on investment. and competencies. pricing and product strategy. PeopleSoft Support Insight A tool that helps you determine the effectiveness of your customer service organization. Base Pay Structure. and campaign forecasted costs to complete.GLOSSARY effects of interest rate volatility from business units. providing the opportunity to measure performance based on how well each business unit. Compensation Planning. profiles of respondents. Period Closing Offset In Time and Labor. Percentage Tolerance The acceptable percentage difference between expected cycle count quantities and actual quantities counted in PeopleSoft Inventory.GLOSSARY retention activity. Period of Interest The maximum period of time containing the data needed to run all the rules in a rule program (see Batch Processing) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 145 . Performance Appraisal Due Date Date established based on the WGI or LEI for the yearly appraisal of an employee. The value is derived from the percentage of replenishment cycles that will complete without a stockout. Period Method In PeopleSoft Inventory Planning. based on existing menu definitions that have been imported into the portal registry. a method used to determine how a single static policy value is to be calculated from time-phased results with static policies. Percent Cycles Without a Shortage In PeopleSoft Inventory Planning. the closing date beyond which this pay period is not considered current any longer. a method used with safety stock policies. This method defines the percentage of the total quantity ordered that must be filled without a backorder. You then analyze and evaluate your scenarios. Performance Appraisal Code Indicates the level of performance of an employee. if the period’s closing date is different from its end date. PeopleSoft Portal The portal bundled with every PeopleSoft 8 application. This value provides a margin of error for an item during cycle count reconciliation count quantities. a method that can be used with safety stock policies. It provides a simple navigation system. Navigation to content outside of PeopleSoft applications is not provided. and make actionable decisions you can communicate back to your PeopleSoft ERP systems for execution. Percent Demand Fill In PeopleSoft Inventory Planning. You can enter a positive or negative number of days. For a given establishment.GLOSSARY Period Segmentation When an element (like compensation rate) changes mid-period. internal process. Periodic Processing In PeopleSoft Pension Administration. any of several batch processes that a plan administrator must run on a regular basis—for example. customer. this report lists current employees and employees who left up to 5 years ago. and leaves of absence. PF Ledger The PF Ledger (PF_LEDGER_F00) is an important fact table within the PeopleSoft Enterprise Warehouse. Usually there are four: financial. a category for organizing critical success factors and key performance indicators. requiring all other elements in the process list to be calculated multiple times on either side of the date on which the change took place. transfers. Personal List A user-created list of products defined in PeopleSoft eStore. learning and growth. consolidation of payroll data. salary increases. Personnel Action Personnel actions are changes to employee data or status resulting from such activities as promotions. Perspective In PeopleSoft Balanced Scorecard. Personal Register (Registre Unique du Personnel) In France. at any given time. period segmentation is used. using the components that were effective during the different time slices. GLOSSARY 146 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . a Personal Register. terminations. The primary function of the PF Ledger table is to support PeopleSoft Enterprise Performance Management reporting. The system calculates each element more than once. The system keeps the results of these calculations separate with the object of creating two gross-to-net result sets. used to quickly populate the shopping cart when creating a new order in either PeopleSoft eStore or Mobile Order Management. The data that gets posted to the PF Ledger must be accurate and clean. Personnel Representatives (Délégués du personnel) In France it is mandatory for companies with more than 11 employees to elect personnel representatives who will represent all of the employees before management. companies are required to be able to produce. PIA PeopleSoft Internet Architecture. You perform matching and generate transactions to reconcile the data in Asset Management with the results of your physical inventory. Costs can then be calculated by project phases. startup. Plan Administrator The person selected by the employer to perform the administration of a plan under PeopleSoft Pension Administration. and a browser. These temporary placeholders have to change into approved items before transferring engineering bills of material (EBOM) to manufacturing bills of material (MBOM). rather than separate legal entities. a web server. enabling you to generate physical inventory results for review. regardless of how the count was created or the data collected. You then scan the assets and load the data gathered during the actual physical inventory into Asset Management. Phase Type A label for the different phases you want to define for a project. PIN stands for Pay Item Name. This is the fundamental architecture on which PeopleSoft 8 applications are constructed. the process by which you extract asset data from the Asset Management database to load into your bar code scanning device.GLOSSARY PF Business Unit PF Business Units differ from other PeopleSoft Business Units in that they represent functional or strategic areas of an organization. construction. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 147 . and cleanup. Physical Accounting The PeopleSoft Inventory feature that updates tables based on count result input. In PeopleSoft Global Payroll. Piece Work Method of compensating time reporters based on units completed rather than hours worked PIN Technical term for an element. Placeholder A temporary location designator in an engineering bill of material for a component item that has yet to exist. consisting of an RDBMS. Examples include planning. Physical Inventory Process In PeopleSoft Asset Management. an application server. PIN is often referred to in the online object names and within the batch code. GLOSSARY Plan Eligibility The PeopleSoft Pension Administration function that uses job data to determine whether an employee may participate in a pension plan. An employee can be eligible based on job data but not be participating because of an unmet service or age requirement. Plan Type A unique ranges of codes used during payroll calculation to determine deduction processing rules. See also Benefit Plan Type. Plan Year The annual period that a pension plan uses to measure service, earnings, and benefits. Generally, the pension plan year will match the fiscal year of the plan sponsor. Planning Item A non-inventory item designated as being used for planning purposes only. It can represent a family or group of inventory items. It can have a planning bill of material or planning routing, and can exist as a component on a planning bill of material. A planning item cannot be specified on a production or engineering BOM or routing, nor used as a component in production. Quantity on hand will never be maintained. Planning Level The level ona dimension’s tree used for planning. Typically, a customer will choose not to plan at the lowest level of available detail, such as the individual product level. Instead, the individual products are mapped to their corresponding product group and the planning is done at the product group level. Planning Targets The amount the budget must equal, such as a budget spending limit or cap for expenses where users can not exceed the amount. Planning Targets are presented at a summary level. This term is interchangeable with Spending Limits. Planning Target Tolerance The percentage and/or amount a user can be over or under the planned budget target. Planning Target Control Values set at the user role level, including no control, active control, and passive control. For more information see no control, active control, and passive control. Planning Task Any activity in PeopleSoft Planning that creates a schedule. GLOSSARY 148 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY PODS (PeopleSoft Operations Data Stores) See Data Warehouse Tables POI. Personnel Office Identifier. Also known as Submitting Office Number (SON). These are codes assigned by the OPM to the office(s) delegated authority within an agency to process personnel actions on Federal employees. Pointers A pointer is an "address" of a driver quantity, or value, within the Enterprise Performance Management product line. Pointers are used as a means of defining where driver quantities exist in tables that reside in the PeopleSoft Enterprise Warehouse. Pointers enable you to extract values from any location in the warehouse and then use these values as driver quantities. There are three different kinds of pointers: explicit, implicit, and multidimensional. Policy Control Group In PeopleSoft Inventory Planning, a feature for setting up order quantity, safety stock, reorder quantity, and maximum and minimum policies. The Control Group is assigned to a set of Planning Item. The policies of the associated planning items can be set explicitly or defaulted from the policies on the policy control group. Policy Generation In PeopleSoft Inventory Planning, a set of run options used to control the functions and behavior of the Policy Generation program. Policy Item An item record which is related to a location and for which Inventory Policy is held. A policy set, Planning Item ID, and Location ID uniquely identify a policy item. The combination of an item and a location is called a stockkeeping unit. Policy Set Defines a set of the items for which Inventory Policy is to be calculated. Each policy set is assigned a unique ID and includes information that defines, for example, the associated Forecast View, time periods, and planning horizon. Policy Simulation In PeopleSoft Inventory Planning, a feature that simulates the effects of various stocking scenarios, compares current policy with simulated policy, and determines the best inventory investment strategy. Population A Population is defined on top of DataMaps created using Enterprise Warehouse metadata. The Population builder allows you to easily format a SQL statement, using filters, to select PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 149 GLOSSARY rows from one or more tables joined together in a DataMap. You can view the results of a Population directly from the browser. Pop Up Payment Option A variation on a joint and survivor payment option under which the benefit payable to the participant is increased if the beneficiary should die prior to the participant. Portal A portal is a web site that helps you navigate to other web-based applications and content. Users often consider a portal their “entry point”—the place they typically visit first after launching their web browser. Portal Registry The portal registry is a tree-like structure in which content references are organized, classified, and registered. It is a central repository that defines both the structure and content of a portal through a hierarchical, tree-like structure of “folders” useful for organizing and securing content references. Portal Registry API The Registry API is provided for accessing each portal registry from PeopleCode, COM, Java, or C programs. Providing the same kind of registry management capability as the online administration pages, it can be used by external systems to update the registry to reflect changes in the content reference URL, taxonomy, and effective dates. The Registry API is fully described in the PeopleCode documentation. Portal Servlet A Java servlet that runs on a web server. The portal servlet intercepts user requests for content, retrieves content, and builds a single HTML document to be displayed in the user’s browser. Portal Solutions Portal Solutions are separate product offerings from PeopleSoft that consist of pre-built, packaged solutions focused at different audiences (customers, suppliers, and employees). Because they are both pre-built, supported application products, Portal Solutions can be deployed swiftly and easily, saving significant resources when compared to other custom-built solutions. Position The officially assigned duties and responsibilities that make up the work performed by an employee. Positions are linked to Job Codes, which can be considered the electronic version of the Position Description. There can be a many-to-one relationship between the Position and Job Code. GLOSSARY 150 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Position Budgeting The budget amounts (salary, benefits, and earnings) associated with positions within an organization. Position budgeting can be calculated based on position information loaded from a human resource system. Position budgets are used to generate line-item budgets for personnel costs. PeopleSoft Budgeting-specific. Position Change A move by an employee to another position during the employee's continuous service under the same appointment within the same agency. Position Date Created Date the position was created for use in the agency. Position Description (PD) In accordance with OPM guidelines, an official description, authorized and approved by an agency official, describing duties and responsibilities to be performed. Position classification standards are used to describe the work, classify the work components by occupational series, and factors (e.g. supervisory control, scope, complexity, competencies required) are used to determine the grade level (i.e., salary range) for the position. Position Description Number A number assigned to identify various types of Position Descriptions. Position Description Required Identifies those positions for which a position description must be maintained. Position Number A number that identifies an authorized Position. Positive Input Data such as hours worked or a bonus amount entered for elements that change each pay period. Positive input can be entered manually, generated by the system, or received from other applications. Positive Task Reporting A method of time reporting in which all required task elements must be provided (see Time Reporting) Positive Time Reporting A method of time reporting in which all elements of time must be provided (see Time Reporting) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 151 GLOSSARY Post Differential Percent Additional compensation that may be paid to certain employees who work in Guam or the Northern Mariana Islands. Post Differential, Non-Foreign A differential payable to an employee at a location in a non-foreign area if conditions of environment differ substantially from conditions of environment in the contiguous United States and warrant its payment as a recruitment incentive. Post-56 Military Deposit The OPM provides guidelines to Federal agencies on how to calculate and process these voluntary employee deductions from pay toward the employee's current retirement fund for those periods of eligible military service. Posting In PeopleSoft the process by which accounting entries are created or updated based on user transaction input and accounting entry templates. In PeopleSoft Receivables, posting is also known as Receivable Update. These posted accounting entries in the feeder systems,such as accounts receivable or accounts payable, must be further processed by the Journal Generator to create journal entries before posting to the General Ledger occurs. Post-Tax Deductions See After-Tax Deductions Pre-encumbrance An encumbrance that occurs before an employee/employer relationship exists. You encumber funds for an employee you have on staff; you pre-encumber funds for an employee that you anticipate hiring. For example, you would pre-encumber funds for a new position that has just been approved but not filled. Pre-encumbrance Ledger Stores pre-encumbrance amounts. Updated by posting pre-encumbrances, such as purchaseor hiring-requisition source transactions (including journal entries). Premium Any additional compensation for extra hours worked, often expressed in terms of factorabove-normal-per-hour pay, such as time and a half (where one-half is premium pay), double time or triple time. Also, any additional pay provided to a time reporter based on compensation rules (see Time Administration in your PeopleSoft Time and Labor PeopleBook). GLOSSARY 152 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Prenote A prenotification or waiting period requested by banks before processing payroll direct deposits. Pre-Retirement Survivor Annuity (PRSA) A benefit paid to a beneficiary if a pension plan participant dies before commencing benefits. Qualified plans must offer a pre-retirement survivor annuity, although the employee can be required to pay for the coverage with a reduction in the benefit. Pre-Tax Deductions See Before-Tax Deductions Previous Day's Close The previous trading day's last reported trade. Price Break Defined in PeopleSoft Order Management, and linked with price sets, a price break defines the actual adjustments that are made to the list price. They are valid only within a time frame you establish. Price Rule Used in conjunction with price sets, rules are essentially a decision tree that establishes the search order the system uses in reviewing sets for a match on the variables they reference for price adjustments. Price Set Linked with price breaks, a price set specifies the parameters for your price adjustment. It establishes selection criteria, determines whether the break is based on quantity or price, and defines how the adjustment is applied. Price Source A service provider or publication that reports the trading activity for a stock traded on stock exchanges. Examples include Wall Street Journal and Bloomberg. Primary event code Primary event codes, also called purpose codes, specify the status of the transaction: whether it's a new transaction, a cancellation, a duplicate, a status request, and so on. Every transaction has a primary event code assigned to it. Primary Insurance Amount (PIA) The benefit amount calculated under the Social Security benefit formula. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 153 GLOSSARY Primary scroll record Primary scroll records are the principal SQL table or view associated with a page scroll level. A primary scroll record uniquely identifies a scroll level in the context of its page: each scroll level can have only one primary scroll record; and the same primary scroll record cannot occur on more than one scroll at the same level of the page. Prior Period In Time and Labor, any payroll period before the current one. Prior Period Adjustment A change or correction to previously reported time or task information, or an insertion of time or task information. Often requires the original report to be offset (reversed) and the correct information to be recorded. (see Time Reporting) Priority Rank The numeric value assigned to inventory Demand Priority Rules. The lower the number, the higher priority of the rule and the orders matching that rule. Private A tracking method used by a privately held company to track their daily prices. The Board of Directors typically establishes a price for a period of time. Stock of a privately held company is not traded on an exchange. Private Views User-defined views available only to the user who created them. For more information, see Budget Views. Process See Batch Processes. Process Definition Process Definitions are created in the Process Scheduler Manager pages to define each specific run request. A Process Definition is comprised of a variety of variables including panels associated with a request, Process Groups, output parameters, run locations, and many more. Process Group Used to associate specific Process Definitions with a Class Profile in Security Administrator. This allows administrators to restrict an operator's ability to initiate requests. GLOSSARY 154 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Process Instance A unique number that identifies each process request. This value is automatically incremented and assigned to each requested process when the process is submitted to run. Process Job Multiple Process Definitions can be logically linked into a job request to process each request serially or in parallel, and optionally initiate subsequent processes based on the return code from each prior request. Process List The set of instructions the system uses during a payroll process to determine which elements to resolve. A process list is comprised of sections that identify the sets of elements to be resolved. You build process lists and attach them to calendars. Process List Manager The program used during batch processing that reads the Process List and calls the PIN Manager to resolve elements on the list. Process Request A single "run request," such as an SQR, a COBOL program, or a Crystal report that you run through Process Scheduler. Process Run Control A PeopleTools variable used to retain Process Scheduler-defined values needed at runtime for all requests referencing a run control ID. This is not to be confused with application run controls, which may be defined with the same run control ID, but only contain information specific to a given application process request. Process Scheduler A PeopleTool that performs tasks behind the scenes of your application. It can run several kinds of processes, such as COBOL, SQR, and Application Engine programs. You can schedule processes to run on a regular schedule or at your request. Processes can run on your workstation or on a server. Process Scheduler Server Agent The server-based program (PTPUPRCS) that manages the selection, validation, and initiation of all queued requests for each defined server within your batch environment (Process Scheduler). Process Type A global process definition under which related process definitions are grouped. This allows for easy maintenance of Process Definitions that share common parameters. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 155 GLOSSARY Processing group In order to partition application processing between the client and the application server, it is necessary to define units that, as a whole, run in one location or the other. We call these units processing groups. Processing groups can encompass one or more PeopleCode events. Some processing groups can run either on the client or on the application server, such as Component Build and Component Save. Product A commodity primarily defined in PeopleSoft Order Management. It may be: 1) The Order Management view of an inventory item that has attributes the same as or different from those of its inventory counterpart. 2) A commodity that is not a stocked inventory item such as a product kit or a service. 3) A tangible commodity that is drop shipped from another vendor and is never stocked in inventory. Product Alternate Alternative products that can replace the product ordered when it’s out of stock or a problem with a particular product temporarily prevents shipment. Product Catalog A configurable list of available products that may be of interest to a specific customer. You can create two types of catalogs—inclusive catalogs that contain all the products you want made available to a customer and exclusive catalogs that contain the products you want to withhold from your customer. By attaching product catalogs to a Sold To customer, you define the products they can buy. Product Definitions This support module describes how other support modules process the instruments that belong to a particular product. For example, different products have different cash flow characteristics and may be stratified differently, or may react differently to changes in interest rates. This module enables you to specify each of these actions for each instrument. Product Kit A commodity that consists of a fixed set of components that are sold together. It appears as a single line on an order, but is represented by multiple lines on shipping documents. Product kits may comprise inventory items, non-stockable products, or a combination of both. Product Kit Component A commodity that is part of a product kit. It may be an inventory item or a non-stockable product such as a service. GLOSSARY 156 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Product Pricing Model In the financial services industry, this defines models that describe indices upon which future rates are paid or charged for an individual product. Product Tree A user-defined graphical representation of a company’s product structure. A product tree defines how products are promoted and determines what users have authority to promote those products. Production Maintenance Spreadsheets A set of spreadsheets generated by an nVision process, containing production ID and production schedule data extracted from PeopleSoft Production Management. You can add and maintain production quantity data using these spreadsheets and then import the data back to Production Management. Production Option Effective-dated combinations of BOM codes and routing codes. You can create multiple effective-dated BOM code/routing code combinations (or production options) for an item. These combinations can be extracted to PeopleSoft Production Planning. They enable the specification of multiple production variations for an item and provide control of seasonal variations by effective date. Production Option Cost A cost based on a specific BOM/routing combination (also known as a production option). The Production Option Cost utility rolls up production options costs based on specific BOM/routing combinations, enabling you to cost individual production options and later to have the DataLink pass this cost to the Planning engine. If this utility isn’t run, the Planning engine will use the standard item cost based solely on the primary BOM and routing instead. Productive Time Employee scheduled time spent performing any task for which a position was created; work performed on behalf of a business entity that is required for that entity to fulfill its business purpose. Employees doing the work they or someone else was hired to do. Productive Unit In Italy employers organize employees into productive units based on agreements between the unions and the employer. Profile A data set that you aggregate from the Enterprise Warehouse, according to the filters you specify, the Key Performance Indicators you select, and the 3rd party demographic data you include. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 157 GLOSSARY Profile Factor In PeopleSoft Demand Planning, the weight index assigned to each Forecast Period to take into account seasonal fluctuations in demand. The factor or index typically measures the percentage of difference between the base demand and the expected actual demand in the period. Profiles Group of employees defined according to a list of job codes and departments. You can use these profiles to ascertain training demands within your organization based on set criteria. Profit Manager The Profit Manager is a set of integrated tools that enable true profitability reporting. Profit Manager features are tightly integrated with the PeopleSoft Analytic Applications and provide you with ways to ensure data integrity, edit data, and post data to the Performance Ledger table. Project The highest level of hierarchical organization within PeopleSoft Projects. Projects provide the structure to which activities and resources are added. Each node on a Projects tree represents a project. Projects can contain other projects as well as activities and resources. This provides a hierarchical relationship between projects and facilitates cost roll-ups. In Enterprise Performance Management you use a Project to create or modify a Profile. A Project contains pointers to data elements that you include in a Profile. Project In PeopleSoft Time and Labor, a specific endeavor undertaken to achieve a specific goal. Typically, projects are approved and undertaken with level of cost, schedule, and performance already agreed upon. A project is composed of a set of tasks, each of which requires staffing, provisioning, and/or scheduling. Project progress is often measured in terms of task completion. Project ID The name or number by which a project is to be identified in all tables and pages. Project Type A user-definable grouping of projects. Project types are optional. Projected Run Date In PeopleSoft Demand Planning, a calculation made that projects a life volume for a period based on a calculated run rate or performance ratio. GLOSSARY 158 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY Projection. An estimated pension benefit calculated as of a future date or any estimated data used as the basis for such a calculation. Promotion • For positions under the same type job classification system and pay schedule, a promotion changes the employee to a higher grade level or makes permanent a Promotion NTE; When the old and new positions are under different job classification systems and pay schedules, a promotion changes the employee to a position with a higher rate of basic pay or makes permanent a Promotion NTE. • Promotion Pattern In PeopleSoft Demand Planning, an Event function that enables you to apply weights to promotions across a range of Forecast Period. Prompting Profile A task profile usually used by account managers as a way of creating task profiles for employees who report task time differently by customer. For example, you might have an account manager who has fifty customers; when the account manager comes in each day to report time, the system will display all the customers, and indicate which customers it will use as a default if she doesn’t manually report time. Prorated In Enterprise Planning and Simulation, prorated is when the computed forecast and the summarized forecast are two different versions of the statistical forecast. In addition, the forecast at the product family level can be allocated down to the individual products. Usually this allocation is done in proportion to the calculated product forecasts at that level. This version of the (statistical) forecast is called the allocated or prorated statistical forecast. Pro-Rate Purchase A purchase in which the number of shares to be purchased is prorated according to a specified factor. This may occur when the total number of shares to be purchased is greater than the number of shares allocated to the stock plan from the treasury. Prorated Forecast In PeopleSoft Demand Planning, a forecast developed by factoring the group forecast down one level at a time to make the sum of the item forecast equal to the aggregate forecast. The prorated forecast tends to be more accurate than the Statistical Forecast. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 159 GLOSSARY Proration Rule Element that defines how you want to prorate an item. You use proration rules in numerous places—for instance you could prorate an earning, deduction, or many of the elements that make up an earning or deduction. Proration Threshold Ratios In PeopleSoft Demand Planning, the upper and lower ratios used as thresholds for Reasonableness checks when a forecast is developed using proration. Provider An entity, such as an insurance company, that provides one or more of the benefits your company offers. For example, Metropolitan Life Insurance Company is a provider to companies that use a Metropolitan life plan. Proxy Person A highly compensated executive. Corporations must include information regarding the most highly compensated executive officers in their proxy reporting. Proxy Statement The document that must accompany a solicitation of proxy appointment under SEC regulations. The purpose of a proxy statement is to provide shareholders with the appropriate information to make an intelligent decision. PSADMIN A PeopleSoft utility providing a menu interface to create, configure and administer application server domains and the Process Scheduler Server Agent (Batch Server). PSADMIN A PeopleSoft utility providing a menu interface to create, configure and administer application server domains and the Process Scheduler Server Agent (Batch Server). PSAPPSRV PSAPPSRV is the main server process running within a domain. PSSAPPSRV performs the functional requests, such as building and loading components. It also manages the memory and disk-caching for PeopleTools objects on the application server. Each PSAPPSRV process maintains its own memory and disk cache. It provides authentication services for incoming users. For instance, it checks the PeopleSoft OPRID against the directory server or PSOPRDEFN table. GLOSSARY 160 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY PSQCKSRV Essentially.EXE). Publish/Subscribe Publish/Subscribe type messaging is performed with PeopleTools Application Messaging technology. You can send data from one PeopleSoft system to another in an asynchronous mode—meaning the two systems don’t have to be sending and receiving at the same time. and exclusively designed to process PeopleSoft Query transactions. quantity. item. Pull Ticket A document containing the details of a single request replenishment request. You use pull lists in PeopleSoft Flow Production with Inventory replenishment. This server process is designed to improve overall application server performance whether or not you have PSQCKSRV configured. see Budget Views. It is specifically. which can be very SQL intensive. It is an optional Server Process designed to improve performance by handling items in the PSAPPSRV transaction request queue. and item quantity required in a specific sorting sequence. PSQCKSRV is a copy of the PSAPPSRV. Public Company A company that has held an initial public offering and whose shares are traded on a stock exchange or in the over-the-counter market.” Pull List Similar to a pick list. PSSAMSRV It processes conversational SQL transactions primarily for Application Designer. source. PSQRYSRV is designed to alleviate the workload of PSAPPSRV. For more information. You use pull tickets in PeopleSoft Flow Production with Inventory replenishment. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 161 . It performs quick. quantity. read-only SQL requests. a pull list contains multiple replenishment requests. PSQRYSRV Like the PSQCKSRV server process. Public Views Coordinator-defined views. including Kanban ID. Public companies are subject to periodic filing and other obligations under the federal securities laws. PSQRYSRV is designed to specifically handle all user-generated queries submitted by PeopleSoft Query (PSQED. and To locations. available to anyone using the application. This is possible because the message transfer is accomplished through a Web server with an “http: gateway. including the location. month and year and time zone (see Time Reporting) Punch Duration Length of time between two punches in increments of hours or partial hours (see Time Reporting) Punch Matching Area of the application which converts paired punches to punch duration by processing rounding rules and assigning the tasks to the appropriate logical day based on rules established by the user Punch Restriction The facility to constrain a time reporter’s ability to create a punch that deviates from the schedule (see Time Reporting) Punch Type A user defined classification of punches. In. Not many corporations permit pyramiding. i. Start. GLOSSARY 162 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . day. Pyramiding A computer calculation enabling an individual owner of one share of stock to use the stockswap technique to exercise a stock option of any size without using cash. The purchase is made using current contributions from a participant and any carry-forward remaining for the participant from previous purchases.GLOSSARY Punch Precise instances of date and time recorded for a user and measured in seconds. Stop (see Time Reporting) Purchase The issuance or purchase of shares through a stock purchase program. Purchase Price The discounted price paid for the shares at the end of a purchase period. minutes. Purchase Price Variance A PeopleSoft Payables matching feature that compares purchase order and inventory prices for any variance in the prices. Out. hours. Purge Rules The rules that define criteria to clear data you no longer need from previous open enrollment processing cycles in PeopleSoft Benefits Administration.e. skills. and analysis. and abilities that could be expected to enhance significantly performance in a position. Quality Function A level of configuration that enables you to define the fields and attendant information that provides a base level for inspection plan and integration. but are not essential for satisfactory performance.GLOSSARY Q QDRO See Qualified Domestic Relations Order. Base Benefits enables the tracking of QMCSOs for dependents. Quality functions enable you to map process-specific field information into PeopleSoft Quality for identification. tracking. Qualifying Dispositions A transaction whereby a participant sells shares acquired through a stock purchase plan two years after the grant date and one year after the purchase date. QDRO Alternate Payee A former spouse who is entitled to a portion of a participant’s pension benefits as a result of a court order. QJSA (Qualified Joint and Survivor Annuity) A post-retirement death benefit for a spouse. This is normally the result of a divorce and gives a portion of the pension benefits to the former spouse. Qualified Domestic Relations Order (QDRO) A court order ordering a division of a participant’s pension benefits. Quality Ranking Factors Knowledge. QMCSO (Qualified Medical Child Support Order) A QMCSO is a court order that requires a group health care plan to provide benefits to the child of a participant as part of a child support arrangement on the behalf of that participant. Applicants who possess such PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 163 . Qualified Plan A pension plan for which the employer can take tax deductions for contributions to the plan. Investment income of the plan trust fund is not taxable to the employer. Plans subject to this requirement must provide an annuity for the life of the participant with a survivor annuity for the life of the participant’s spouse. Tax law places restrictions on the plan rules. the method used to determine how available quantity will be allocated to prioritized demand lines when using the online reservations page. All operators and class catalogs are dynamically provided through the Business Interlink Plug-in. Quantity Precision Rules A set of rules specifying whether item quantities for a given unit of measure are expressed as whole numbers or as decimals. The criteria are composed of <lefthand-side> <Relational Operator> <right-hand-side> statements that can be concatenated using a set of logical operators. Quantity precision is set at the inventory SetID and itemUOM levels. Query A set of data members that are selected from a Class catalog (provided by the Business Interlink Plug-in) as well as a generic form of Criteria. a time reporting code and task information for a single employee. replacing the scheduled time with the entered Time Reporting code and the number of scheduled hours on a day-to-day basis. Range Penetration is the degree to which an employee’s actual pay has progressed through their salary grade. The system transforms the information into instances of daily time based on the employee’s schedule or default work schedule. and is expressed as a percentage. Quality Step Increase (QSI) A step increase awarded to an employee for sustained high quality performance. R Race And National Origin Code A code that identifies the employee's basic racial and national origin category. The calculation is: GLOSSARY 164 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . but no one may be rated ineligible solely for failure to possess such KSAs. Quantity Allocation Method In PeopleSoft Inventory. Quality Server A PeopleTools-based analysis and graphing program. Range Penetration In PeopleSoft Workforce Analytics.GLOSSARY KSAs may be ranked above those who do not. Range of Dates Reporting A Time and Labor process that enables you to report a start and stop date. Rate Code Alphanumeric reference to the cost per hour or unit of time reported to a specific TRC. Effective dates define different rates for different budget periods. Typical rate types are current. These different types of rates are appropriate for different types of accounts. Rate Code Group A rate code group is a number of pay components (represented by rate codes) bundled into a subset of a compensation package. Valid values are Flat Amount. Percent. Range Width In PeopleSoft Workforce Analytics. average. but others rates such as average. and the online system does not edit any of the data you enter against other tables. the difference between the maximum and the minimum values of the pay range calculated using the following formula (and expressed as a percentage): (Maximum – Minimum)/Minimum. There are several conversion rates for any pair of currencies including not only the current rate. Rate Code Type Defines how the monetary value of the rate code is calculated. Rate codes are then used to represent pay components in pages and when you configure compensation packages in the compensation record. You cannot prompt for valid values in any of the fields. historical. floating. and so on. Rate Combinations The combination of rate types and conversion rates with account types that is linked to your budgeting model. which are used by a batch process that reads. and historical. The rate code group is used to calculate percentage-based components that do not apply the percentage to all pay components in the compensation package. The system populates temporary tables. edits and moves the data into the appropriate time and labor tables. Hourly Rate + Flat Amount. Rapid Time Entry The process that enables you to enter daily time for single employees without the system editing your field entries. and Points. asking. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 165 . The compensation rate code type is defined on the Comp Rate Code table.GLOSSARY Range penetration = (Employee Base Pay – Range Minimum)/(Range Maximum – Range Minimum). Rate Code [Global Payroll] IDs for pay components. Rate code groups are constructed on the Rate Code Groups page. Rate codes define rates of pay and are set up in the Comp Rate Code table. commercial. Hourly Rate. GLOSSARY 166 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . In Enterprise Performance Management. Any number of benefit program and benefit plan combinations can use each set of rates. or schedules. Rating Model The scale used by your company to measure competency proficiency. The default rating model is the PSCM (PeopleSoft Competency Management) Rating Model that PeopleSoft delivers with your PeopleSoft Human Resources System. or general.GLOSSARY Rates The arrays of values used to calculate the cost of a plan to an employee. This is a financial services industry term. Recalculate VAT at Payment Allows the VAT amount to be adjusted at the time of payment if an early payment discount is taken. This calculation option is only valid when VAT is calculated at Gross. Reasonableness In PeopleSoft Demand Planning. service-related. Rates can be agegraded. a forecasting feature that uses the existing model and its associated parameters to create a new forecast. lines. typically this is distinguished from a rounded punch (see Time Reporting) Reason Code Reason Codes provide explanations for occurrences such as returned stock and changes to order headers. Reassignment Change of an employee from one position to another without promotion or change to lower grade. Recalculate Forecast In PeopleSoft Demand Planning. depending upon the benefit plan type. Raw Punches See Actual Punch. Reason Code A code describing employee time such as comments for sick time or travel time. the system automatically adjusts it and sends a warning message. a technique that checks the trend and projected annual growth to make sure that a forecast is realistic. a rate is determined by the user and specifies the dollar amounts to be calculated for each model. If a forecast falls outside either boundary. The Board of Directors sets the Record Date. This means that you reconcile the difference between Account/Instrument balances. and serial number are also identified. Items and payments combined comprise a customer's balance. In the PeopleSoft Enterprise Warehouse. you’ll run the PF Reconciliation engine after a period to compare “to and from amounts” between tables such as REVENUE_F00 and PF_LEDGER. or debit memo. An item can be an invoice. lot suffix. reconciliation differs slightly when it is performed within the PeopleSoft Enterprise Warehouse and when it is performed within the PeopleSoft Analytic Applications. Non-Cost. In PeopleSoft Funds Transfer Pricing (FTP) and PeopleSoft Risk Weighted Capital (RWC). Receivable Update See Posting Receivables Item An individual receivable. the lot. and Standard. Reconciling the total balances is the second step. Reconciliation Within PeopleSoft Enterprise Performance Management. or the GL_LEDGER and the PF-LEDGER. If the respective tracking is activated. which are risk weighted according to the basis rules you have assigned. Typically. Receipt Line A line associated with a Receipt ID that identifies an item and quantity. Record Definition A logical grouping of data elements. instruments. reconciliation identifies differences between Performance Ledger balances and the instrument or position balances. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 167 . credit memo. Receipt cost methods include Actual. Record Date The date a stockholder must officially own shares in order to vote at the meeting or to derive an adjustment resulting from a stock split or a stock dividend. The first step in reconciling basis rule balances is to reconcile the individual balances for accounts.GLOSSARY Receipt Cost Method Determines how you cost receipts. and the difference between Account/Position balances. reconciliation is a period-end process that posts journal entries to the Performance Ledger for the discrepancies found when you reconciled the individual balances. and positions. it may be necessary to record both input VAT and output VAT on the same transaction. this flag indicates that you are recording input VAT on the transaction. this would be a situation where the purchaser was required to self-assess VAT. This flag. TableSet sharing can be accomplished quickly and easily. where it is assumed that you are always recording only output VAT. is used to determine the accounting entries created for a transaction and to determine how a transaction is reported on the VAT return. in conjunction with the Record Input VAT Flag. Generally. where it is assumed that you are always recording only input VAT. or Receivables. this flag indicates that you are recording output VAT on the transaction. or Receivables. This may be different from the "Beneficial Owner" of the stock. where it is assumed that you are always recording only input VAT. This flag. or in Employee Expenses. Record Output VAT Flag For certain transactions within PeopleSoft Purchasing. eliminating an enormous amount of redundant data entry To act as a safety net—Record Groups ensure that that TableSet sharing is applied consistently across all related tables and views in your system.GLOSSARY Record field Once a field is inserted into a record definition it becomes known as a Record Field within the record. and General Ledger. this flag is always set to Yes. and General Ledger. These temporary tables leave the fact tables accessible for processing other jobs simultaneously without impacting your processing. Payables. Record groups exist for two basic reasons: • • To save you time—with Record Groups. where it is assumed that you are always recording only output VAT. Record Suites Record suites are temporary tables that enable the system to track how many processes are running. Billing. is used to determine the accounting entries created for a transaction and to determine how a transaction is reported on the VAT return. Payables. or in Employee Expenses. This flag is not used in Order Management. in conjunction with the Record Output VAT Flag. Record Owner The "Stockholder of Record" of the stock. For all cases within Purchasing and Payables where VAT information is being tracked on a transaction. Record Input VAT Flag Within PeopleSoft Purchasing. Record Group A set of logically and functionally related control tables and views. GLOSSARY 168 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This flag is not used in Order Management. Within these situations. Billing. an address and a language spoken. Reemployed Annuitant An employee who has retired from Federal employment and is receiving an annuity. they may simply be another way to geographically categorize an area. Referential Integrity Issues that occur when an update to an instance of one object invalidates one or more instances in a related object. Region Codes Regions may or may not be physical entities. when checked and recorded against a budget. Employees covered by the FERS retirement plan require SF-3103. When a region does represent a physical entity. a reference transaction is a source transaction that is referenced by a higher-level (and usually later) source transaction. In other words. His/her salary is reduced by the amount of the annuity. the region code has the same characteristics as a business. Reference Designators A user-defined alphanumeric identifier that determines where a component is placed in an assembly. such as a purchase requisition. cause the system to concurrently reference and relieve all or part of the amount of a corresponding pre-encumbrance transaction. Employees covered by the CSRS retirement plan require SF-2807. referential integrity makes sure the changes do not adversely affect another area of the application. Register of Separations and Transfers (ROST) The ROST is a regulatory compliance document used by federal agencies to summarize the information in an employee's Individual Retirement Record (IRR). Refresh Time The process that retrieves the appropriate current version of objects related to employee time (such as task profiles or work schedules) and associates them with that time.GLOSSARY Reduction In Force (RIF) Method used to reduce the number of government workers in an agency. Reference Transaction In People Soft commitment control. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 169 . in order to automatically reverse all or part of the referenced transaction’s budget-checked amount. For example. the amount of an encumbrance transaction (such as a purchase order) will. when you make a change to one area of the application. that is. This avoids duplicate postings during the sequential entry of the transaction at different commitment levels. The ROST is a one-page cover sheet that accompanies a batch of IRRs being submitted to the Office of Personnel Management (OPM) at the time of an employee's separation from a federal agency. Regulatory Region The Regulatory Region functionality in PeopleSoft HRMS is designed for use in performing regulatory and regional edits. Related Education Education above the high school level that has equipped the applicant with the KSAs to perform successfully the duties of the position being filled. and control what codes and values the operator sees. A Regulatory Region can be any country (or province or state) where there are specific laws and regulations addressed by functionality in PeopleSoft HRMS. an employee's normal (scheduled/shift) work hours. a Regulatory Region is a region with a common regulatory framework. Regular Time In PeopleSoft Workforce Analytics. A major component of the registration statement is the prospectus that is to be supplied to prospective purchasers of securities. such as a country (CAN for Canada). compensation rate for a job. Regression Analysis A statistical technique that determines the relationship between two or more variables. Regression predicts the value of one variable (the dependent variable) based on one or more independent variables. does not include variable compensation. including their participation in same-day sale transactions and sell to cover exercise. Education may relate to the duties of a specific position of to the occupation. the annualized. In Enterprise Performance Management.GLOSSARY Registration The name or names that appear on the stock certificate to indicate who owns the stock. Consists of fixed compensation. Regular Time An employee's normal (scheduled/shift) work hours. or a smaller state or provincial entity (CANBC for British Columbia). perform set processing. Regulation T Federal Reserve Board regulations governing the extension of credit by brokers or dealers. You’ll use Regulatory Region to drive PeopleCode edits. Registration Statement The document that must be filed to permit registration of an issue of securities under the Securities Act of 1933. but must be appropriate for the position being filled. quoted. GLOSSARY 170 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Regular Base Compensation In PeopleSoft Workforce Analytics. similar to vesting schedules. This option will have a grant price lower than the original stock option. Replacement Option The “new” “replacement” stock option that will replace the original stock option.GLOSSARY Release An industry standard term associated with the lifting of a company’s Repurchase Option from a portion or all shares from a Restricted Stock Award (RSA). a policy that determines when a replenishment order is launched for an item. a replenishment request can be created. the employee will receive an automatic grant of a new stock option at the then-current fair market for the shares that they exercised or for the shares that they used to swap. When the physical quantity in a location falls below the reorder point. it's useful to look at open items for the Remit From group. Remit From Customer A customer who is responsible for payments billed to other customers. A reload option feature provides that upon a stock exercise. lead time demand. Remark Codes Codes that cause the printing of pre-set text passages on a notice of action form. Reorder Point The identifier that automatically locates a replenishment need for an inventory item. Relevant Constraint A constraint PeopleSoft Planning considers when it calculates a score and when it optimizes the schedule. Reorder Point Policy In PeopleSoft Inventory Planning. Remittance Worksheet A work space in PeopleSoft Receivables used to select drafts for remittance to the bank. typically by means of stock swaps. The policy has several methods that include days supply. RSA’s are subject to release schedules. Reloads Some stock option plans provide for the grant of a “reload” stock option in connection with stock option exercises. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 171 . and Fixed Quantity. See also Scorecard and Optimize. During cash application. Some passages are general purpose and others are specific to the personnel action being processed. GLOSSARY 172 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This usually occurs when an individual fails to meet the vesting requirements on a RSA or option that is exercised before it vested. the process can occur on an ad hoc basis or at predefined reorder points. You can generate replenishment requests manually or automatically using backflushing. Repurchase The reacquisition of shares of stock from an individual by a corporation. Reporting Persons typically include Directors. such as a business unit or department. Reported Time Clock time or elapsed time provided to the system by the user (see Time Reporting) Reporting Person An insider that is regularly considered by the SEC to have material information and policymaking authority for the corporation. Repricing Election Eligible optionees can choose (elect) to accept the corporation’s repricing offer or choose to decline the offer. each report instance can share the same layout while containing data unique to these particular ChartFields. or for a group of ChartFields. usually "Out-of-the-Money" stock options for lower-priced options. Using Scope. Replenishment Request In PeopleSoft Flow Production. In PeopleSoft Inventory. or Workflow notifications. These individuals are subject to the reporting requirements promulgated by Section 16 of the Securities Exchange Act of 1934. The corporation might pay the original cost of the shares to the individual or the fair market value of the shares at the time of repurchase. pull tickets. Each instance contains data specific to an individual ChartField. Repricing An agreement between the corporation and the optionee that allows the optionee to cancel an outstanding high-priced. Report Scope A feature that creates multiple instances of an nVision report using a single report request.GLOSSARY Replenish A process that indicates when items need to be resupplied from external sources. You can communicate that request using pull lists. an online request for material made when the material is needed. such as all sales departments. and shareholders with 10% holding interest in the equity of the registrant’s securities. Officers. exclusive option to repurchase up to the number of shares that constitute Unreleased Shares at the original purchase price per share. The Company shall exercise said option. as under the Model Business Corporation Act. Reservation Method The method used to reserve soft reservation items — either batch COBOL reservations or online allocation and reservation. Resolution An activity that closes or partially closes a deduction. a function of the Forecast Calculation Process that determines which forecast model will produce the best forecast. the repurchase is prohibited unless the corporation remains solvent. such as matching it to a deduction authorization. Reserved A flag indicating that the inventory item is reserved for stock fulfillment in the inventory business unit. writing it off. Resolution Entry Type Code that identifies how to process activities for items in PeopleSoft Deduction Management and how to create accounting entries. Repurchase Right A company's contractual right to buy back from an employee any stock resulting from the exercise of the option. The buy back can be at fair market value. The repurchase of outstanding shares is regulated under the laws of all states (except Massachusetts). Resolution Method A set of rules that defines how to automatically match or write-off deductions in PeopleSoft Deduction Management.GLOSSARY Repurchase Option An irrevocable. or sending it back to PeopleSoft Receivables. or the original purchase price. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 173 . Reserved Orders Orders that have been reserved against on-hand available quantity at the business unit-item level. Reserved orders are found in the DEMAND_INV table. Reset In PeopleSoft Demand Planning. meaning the model with the lowest ratio of error. book value. in both the equitable and bankruptcy senses of insolvency and after taking any liquidation preferences of other outstanding stock into account. Under some laws. The Resource Amount maps to the Posted Total Amount when posted to the general ledger. a Resource Driver defines the quantity of resources used by an activity. any homogeneous grouping of general ledger line items. specific resource transaction. and costs of capital such as information systems. and electrician hours. any crews.GLOSSARY Resolution Worksheet The workspace in which deduction items are paired with offset items and resolved or written off in PeopleSoft Deduction Management. Resource Planning focuses on resources allocations that create expected results like driver rates and cost object costs. Resource Driver In Activity-Based Management. Resource categories are optional. In PeopleSoft Activity-Based Management. real estate taxes. For example. GLOSSARY 174 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . You can define relationships between the resource types within a resource group to facilitate analysis of project costs. Resources are consumed in the performance of these activities. and tools that can optionally be used at work centers to complete tasks. resources might include salaries. Resource In PeopleSoft Manufacturing. office rentals. plumber hours. Resource Category A field for defining individual resource types more specifically. machines. In a service business. and other associated costs. if you have a resource type of labor but want to break it down further for tracking purposes. Resource Group A category of resource types. if you had resource types for standard labor and overtime labor. For example. you might define resource categories of architect hours. In PeopleSoft Performance Measurement. depreciation. and thus denote operating costs. Resources Resources are the economic elements that are required to perform the activities associated with your business. carpenter hours. Resource Planning In PeopleSoft Activity-Based Management. resources are typically regarded as the groupings of one or more general ledger accounts. you could group them together in a resource group to calculate total labor. Resource Amount The monetary amount of a single. Resource Source A field on each resource transaction that identifies the system in which the cost originated. run allocations with project resources as the target. Resource Transaction An individual cost line within PeopleSoft Projects. you might want resource subcategories of regular hours and overtime hours. For example.GLOSSARY Resource Quantity A field on each resource transaction that identifies nonmonetary quantity. Resource Supplied An attribute that enables you define a resource as committed or flexible. A committed resource is one that will not likely change in the short term. and resource groups. project closure. For example. carpenter hours. For example. and resource categories of architect hours. or perform internal transactions such as billing. and plumber hours. or adjustments. Restricted Punch A punch which is not accepted because it occurs outside of the predefined number of hours and minutes before or after a scheduled (Understanding Time Collecting Device) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 175 . they are used in conjunction with resource categories. Resource Type The resource transaction field in PeopleSoft Projects that identifies the resource associated with a given cost. It is through resource transactions that individual costs and types of costs are tracked. Resource types may be very general or very specific depending on your needs. Resource Subcategory A field for defining individual resource types and categories more specifically. A flexible resource is more likely to change within the short term. Resource Use Resource Use defines the behavior of a resource within PeopleSoft Enterprise Performance Management. if you have a resource type of labor. Each resource transaction contains a cost and a quantity and as many identifiers of that cost as necessary. Resource transactions are created when you receive information from other systems. on a resource line for 12 ball valves the quantity would be 12. PeopleSoft Payables would be the resource source for a resource transaction created from a voucher in that system. resource subcategories. Resource subcategories are optional. An intermediate resource is a grouping of general ledger line items that may be allocated to another intermediate resource or to a primary resource. without the benefit of a registration statement. the vesting occurs. (Retest Date = Creation Date + Retest Lead Time) Retirement Types of retirement are: • • • • • Mandatory Retirement. Retirement Coverage Code A code used to denote an employee's retirement coverage. Special Option Retirement. typically granted at the par value or for no consideration. When the goal is achieved. Restricted Stock Awards (RSA) An award of shares of stock to an individual. has all other shareholder rights over these shares such as. ILIA (In Lieu of Involuntary Action) Retirement. the date a lot should be inspected to determine whether it is still acceptable for fulfillment or consumption. Retained Grade Effective Date Date employee became eligible or began receiving a retained grade and pay. The major ones include the following: • • • Civil Service (CSRS) Federal Employees Retirement System (FERS) and FICA Foreign Service (FS) GLOSSARY 176 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . either the passage of time (vesting) or the attainment of a specific goal. Voluntary Retirement. The shares are awarded on the basis of some future performance goal. Retained Grade Expiration Date Expiration date of an employee's retained grade and pay. The shares are issued in the name of the individual at the time of the award and are held in escrow until vesting occurs.GLOSSARY Restricted Securities Securities issued privately by the company. Retest Date In PeopleSoft Inventory. typically. Restricted securities are subject to a holding period before they can be sold under Rule 144. If an employee terminates prior to the vesting of the shares then the company normally repurchases the unvested shares. voting and dividend rights. Disability Retirement. The individual. Return Type Code A designator on returned material authorizations (RMAs) that indicates what actions the return initiates. with a corresponding increase in the stock’s value. Late or modified union contracts. and Dangerous Occurrences Regulations) Health and safety regulations in the United Kingdom requiring employers to report certain types of health and safety incidents to the Health and Safety Executive (HSE). RIDDOR (Reporting of Injuries. Reversionary Annuity A form of pension payment where the retiree foregoes all benefit during his or her lifetime so that the entire benefit is paid as an annuity to a beneficiary after the retiree’s death. Diseases. the benefit is forfeited. Rider A special court-ordered or regulatory provision that may be applied to an enrollment to expand or limit any dependent or beneficiary coverage.Special (for LEOs) FERS and FICA .Special (for LEOs) Social Security System None Retroactive Benefits/Deductions Deductions taken or benefits granted due to a recalculation of previous benefits and deductions. Reverse Split A reduction in the number of outstanding shares of a corporation’s stock. This may include replacement of the product or the creation of a credit memo in PeopleSoft Billing. this is a user-defined formula that the system uses to derive risk weights. late paperwork. Risk Function In Risk Weighted Capital.GLOSSARY • • • • • CSRS Offset CSRS . If the beneficiary predeceases the retiree. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 177 . and delays in benefit enrollment processing may all result in a need for benefit/deduction recalculation. market. ROE (Record of Employment) Reason Codes ROE codes are defined by the Canadian government for employers to record employment actions such as Return to School or Pregnancy Leave. Role user A PeopleSoft Workflow user. GLOSSARY 178 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . this defines the types of risk associated with your business or activity. and is used to calculate capital allocation or normalized loss for the account or activity. For example catastrophic. It allows the system to uniquely identify the user and to determine what data the user has access to. ROLAP.GLOSSARY Risk RuleSet Used to assign a number of rules to a basis. Used to group together a number of rules that frequently apply to the same type of balance. regulatory. interest rate. Risk Weighted Capital (RWC) See PeopleSoft Risk Weighted Capital RIZIV Code This code is for Belgian employers to track the Federal Institute for Illness and Disability Insurance category. competencies and accomplishments required for a job code or a position. you can include role users in your workflow who aren't PeopleSoft application users and who don't have Operator IDs. Plus. PeopleSoft Workflow uses Role User IDs rather than Operator IDs because it needs different kinds of user information than the rest of the system does. legal. credit. Risk Weight In Risk Weighted Capital. Risk Type In Risk Weighted Capital. for example---and what role the user plays in the workflow. Role A role consists of a designated set of tasks. Specifically. ROLAP (Relational Online Analytical Processing) ROLAP refers to the analytical processing and analysis of a relational Data Mart cube. it needs to know how to route work items to the user---an email address. is a form of OLAP that leverages the power and flexibility of relational databases. the risk weight is assigned by risk type. foreign exchange. A person's Role User ID serves much the same purpose as their Operator ID does in other parts of the system. operational. for processing by the PeopleSoft Risk Weighted Capital Application. Engineering Routings differ from Manufacturing Routings in that they are not visible within Production Planning or Production Management and are isolated from Manufacturing. or many of the elements that make up an earning or deduction. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 179 . It consists of sequentially numbered operations that reference the task to be performed. Your business rules typically specify what user role needs to do an activity. rolling budget balances forward from the budget ledger you are closing (the source budget ledger) into the new (target) budget ledger. Routing (Manufacturing and Engineering) A set of information detailing the method to manufacture a particular item. Rolling Plan An ESPP offering period where the purchase date is measured from the offer start date. Roll Up The act of totaling sums based on information tree hierarchies. In PeopleSoft Enterprise Planning and Production Planning. you may elect to reset your employees to the new lower purchase price. the work center in which the task is to be performed. and unit of measure can also be rolled up. The process is also referred to as summarization. Roll Forward In commitment control. The offering period is now based of the new purchase date. the resources to be used. the process of adding up the demand and forecast Array from one level to the next from child to parent. You can roll up data for any group of details that you have defined as dependent with the Tree Manager. and the time required to complete the task. You use rounding rules in numerous places—for instance you could round an earning. Information such as caption. If at the purchase date. Rounded Punch A punch that has a company’s rounding requirements applied to it (see Time Administration) Rounding Rule Defines a rounding rule. a utility that moves tasks from the past to a valid point in the future using time periods rather than fixed dates. such as clerks or managers. deduction. Rollup In PeopleSoft Demand Planning. A role is a class of users who perform the same type of work. description. the current stock price is lower than the last stock purchase price.GLOSSARY Roles Roles describe how people fit into the workflow. This is also the rule under which a company may be sued for false or misleading disclosure. Routings specify where the information goes and what form it takes—email message. or exception requirements (see Creating Rule) Rule 10b-5 A SEC rule that prohibits trading by insiders on material non-public information. (2) a oneyear holding period for "Restricted Securities. (4) an amount limitation. The requirements include (1) current public information about the issuer. Rule 144 A SEC rule that applies to public re-sales of restricted securities as well as all sales by affiliates. task allocation. a valid method for replenishing supply for an item. Routings Routings connect the activities in the workflow.GLOSSARY Routing Option In PeopleSoft Planning. RSZ Categories are associated with a Contract Type. or worklist entry. Routing Transit Number (RTN) A number that identifies the financial institution to which an electronic payment should be sent for deposit. There are two types of routing options: build options and purchase options. Rule Representation of a company’s compensation. An item may have more than one routing option. RSZ (Rijksdienst Sociale Zekerheid) Category Codes These government defined Social Insurance category codes are used to maintain social security records for your Belgian employees." (3) unsolicited brokers' transactions. electronic form. They are the system's means of moving information from one place to another. Statute and Substitute for Claeys Formula calculations. from one step to the next. and (5) a Form 144 filing. the greater of 1% of the outstanding stock or the average weekly trading volume may be sold during any three-month period. Rule Actions Functions that can be used in the creation and application of a rule (see Time Administration) Rule Elements Customer defined pieces of information which are passed to Time Administration in order to apply and evaluate rules (see Time Administration) GLOSSARY 180 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . This is particularly helpful if there are multiple basis rules for the same account node. Run control pages generally start some type of program that manipulates data in some way. product node. Rule Program Specifies the set of rules the Time Administration process will execute and the order in which it will execute the rules. Rules determine what activities are required to process your business data. for instance. Rule Sets are also used with the Data Manager. Rule Results Net effect of the application of a rule. Process Scheduler. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 181 . and with the Currency Conversion engine. Rule Sets can control the execution sequence of your rule combinations. or both. initiation of workflow. notification rules for irregular attendance. Rules/Time Administration A physical implementation or execution of a company’s compensation. filter combinations. such as the batch processing of a payroll run. Rules Rules are your company's business practices captured in software. Some examples are. Rule Set Rule Sets enable you to apply basis rules to your PeopleSoft Analytic Application in the sequence that you prefer. compensation rules for overtime and holidays. the creation of time. or position source code. The first occurrence on the node will be applied and any other occurrence will be ignored.GLOSSARY Rule Period A Time & Labor period used in the evaluation and application of a rule (see Time Administration). Run Control ID A unique ID to associate each operator with their own run control table entries. and rules for just about any other time-reporting situation that requires special processing. exception and task rules (see Time Administration) Run Control A run control is a type of online page that is used to begin a process. modification of reported tasks (see Time Administration) Rule Templates Templates used to quickly create a variety of rules for the Time Administration program to execute when processing reported and/or scheduled time. Sales Person A required field used in PeopleSoft Receivables. RWC (Risk Weighted Capital) See PeopleSoft Risk Weighted Capital S Safety Stock Policy In PeopleSoft Inventory Planning. a policy that determines how safety stock quantities are calculated for an item. Salary Plan A plan of salary defaults.GLOSSARY Run ID Code that uniquely identifies a Run Control for batch processes. grades. If no GLOSSARY 182 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Sales Order Rebate and Penalties Rebates or penalties that are calculated against sales orders independent of Buying Agreement. Order Management. and Deduction Management when working with items. Salary Group Part of a group of defaults assigned to job codes. Salary Rate of compensation received by an employee. The policy has several methods that include days supply and percentage of demand fill. and step components Salary Step Components Pay components assigned to a salary step by entering the corresponding rate codes on the Salary Step Components page. including Straight Line. A salary group may include items such as steps and grades dependent on individual company parameters. Salvage Value An estimate of the amount of money one might receive upon selling an asset once that asset reaches its useful life. Each item must be assigned to a credit analyst. Billing. Salvage value is used in several depreciation calculations. Scenarios enable you to study various changes in organization models you created. a scale that defines the lowest. and highest levels of performance needed to achieve associated minimum. The broker uses the proceeds of the sale to pay the company the exercise price and any tax withholding and the optionee the net cash (less any brokerage commission/fees). Scale On a Goals Matrix (In PeopleSoft Workforce Analytics). Using this method.GLOSSARY credit analyst is assigned to an item. The scale can be used to standardize multiple performance goals to a common scale of measurement. Sample Method One method of entering characteristic readings for a quality control plan. These are referred to as the Threshold. and maximum levels of compensation pay out. and Stretch levels. In the case of an Historical Scenario all future looking fields will be display only and the Scenario Manager component serves as a wrapper to run any analytic engines. middle. and time to be worked by a Time Reporter (see Scheduling) PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 183 . The exercise of the option and sale of the underlying shares take place simultaneously. In the case of a Forecast Scenario. Target. Schedule Specific task. You establish them on the Product Attributes by UOM page. Sales UOM The only units of measure that can be referenced on sales orders and quotes. midpoint. and economic assumptions that make up the scenario. you create a scenario ID that you use with all run controls. Scenario A scenario is a particular outcome you are analyzing when you run in Scenario Manager. respectively. In PeopleSoft Budgeting a scenario is a ChartField used in PeopleSoft Budgeting to identify different budget iterations that use different assumptions. then all the characteristics for the next sample and so on. the credit analyst assigned to the customer is used as the default. the Scenario Manager refers to all the business rules. There are two types of scenarios defined in the Scenario Manager: Historical and Forecast. For each parent and child model you want to study. Same-Day Sale An exercise and sale occurring on the same day. forecasts. date. for one given control plan you inspect all the characteristics for the first sample. See also Penalty. Scheduled Punch. yellow.S. Scorecard A weighted sum of constraint violations in a schedule that evaluates the schedule's validity (that is. Also has a second meaning related to the Payment Voucher processing for the ECS. Schedule Reconciliation helps U. GLOSSARY 184 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . federal agencies meet their requirement to schedule or group together payment orders for submission to the Treasury Disbursing Office. or green scores that show its assessments. views of a strategy tree’s components and Key Performance Indicators with red. Schedule Template An ordered pattern of workday(s) and/or off day(s) used in scheduling (see Scheduling) Schedule Type In PeopleSoft Payables. Schedule 13G is a short-form version of the 13D and may generally (but not always) be used only by institutional investors. acceptability). an indicator of the nature of items purchased with a Payment Schedule. The schedule line identifies an item and scheduled ship quantity that may be different from the requested quantity due to item availability. Schedule Reconciliation In PeopleSoft Payables. Schedule Number A number identifying the salary table form that an employee's pay is computed. A time reporter’s expected punch (see Scheduling) Scheduling A function of PeopleSoft Time and Labor and PeopleSoft Global Payroll that enables you to create work schedules and assign them to employees. Schedule Line Number The line associated with an Order ID. In PeopleSoft Balanced Scorecard. the process of reconciling scheduled payments by Payment Schedule ID. Schedule Group A category of employees or employee groups associated for purposes of time scheduling. The score is calculated by adding the value for each relevant violated constraint.GLOSSARY Schedule 13D or 13G Disclosure forms required to be filed with the SEC and the company by a shareholder (or shareholders) that own(s) more than 5% of a public company. Weight and Relevant Constraint. SearchQuery A set of objects that allow the programmer to pass a query string and operators to the search engine and receive a set of matching results with keys to the source documents from the search index in return. or retirement). Seasonal Index In PeopleSoft Demand Planning. number of occurrences. a Seasonality group is a group of items with similar seasonal patterns. The seasonality group profile is more stable than individual profiles of the contributors because the Aggregation process smoothes out random errors. Typically a group of items is designated as a contributor to the seasonality group. measures the amount by which a forecasting period is influenced by seasonal effects. it must fulfill the following qualifications: The participant must already be enrolled in COBRA coverage as a result of an initial COBRA event. the initial COBRA event must be one that is associated with a change to the employee’s job status (such as a reduction in hours. The index typically measures the percentage of difference between the base demand in the period and the expected actual demand in the period. and the PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 185 . In Enterprise Planning and Simulation. proximity to other words. are stable.GLOSSARY Scrap Any material outside of specifications and possessing characteristics that make rework impractical. insert. Search index items contain a set of statistics about the document that has been indexed (keywords. Seasonality Group In PeopleSoft Demand Planning. termination. and have at least two years of demand history. SearchIndex A set of objects that give the programmer the ability to create. delete. by averaging their history values over a year and determining where they were above and below average. and update a search index and the items within it. For an event to qualify as a secondary COBRA event. Seasonality groups capture means seasonal behavior among related products. or file path). a group of Forecast Items with a repetitive pattern of demand from year to year where some periods are higher than others. Secondary COBRA Events COBRA qualifying events that extend the amount of time a participant is eligible for COBRA coverage. Contributors are chosen because they are representative of the group. To determine if a forecast element is seasonal or nonseasonal.identifies the weight index assigned to a forecast time period to take in account seasonal fluctuations in the demand. database key. Seasonal Profile In PeopleSoft Demand Planning. and so on) as well as a key that can be used to point to the document (a URL. An index of 100 indicates an average period in a seasonal cycle. and payee. If an employee files the election. You define your payroll process by creating sections and adding them to process lists. taxes are based on the fair market value on the date the restrictions lapse. Section 16(a) Provision of the Securities Exchange Act of 1934 that requires company insiders to file changes in beneficial ownership of the company’s equity securities and periodic reports disclosing their holdings. or a request for a sample. sub-process. or death of employee). Securities Act of 1933 Often referred to as the "truth in securities" law. with any future appreciation taxed as a capital gain. and other fraud in the sale of securities. which will be higher assuming the stock has appreciated in value. For example.GLOSSARY secondary event must be one of the COBRA event classifications that involves loss of coverage for the dependent (such as divorce. Secondary event code Secondary event codes. Section 83(b) Election A tax filing within 30 days of grant that allows employees granted restricted stock to pay taxes on the exercise date. or sale and purchase. also called transaction codes. rather than the date when restrictions lapse. Not all transaction types include secondary event codes. It is also known as the "short-swing profit" rule. Section A set of logically related elements that are to be resolved during the payroll process. taxes are based on the fair market value on the exercise date. specify the type of transaction in detail. of the company’s equity securities within a period of less than six months must be returned to the company. a rush order. marriage of dependent. the act requires that investors receive financial and other significant information concerning securities being offered for public sale. a transaction's secondary event code could say that the transaction is a catalog order. and prohibits deceit. GLOSSARY 186 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Section 423 The Internal Revenue Code section that regulates Employee Stock Purchase Plans. You can create four different types of sections: standard. generate positive input. If the employee does not file an election. See COBRA and Initial COBRA Events. misrepresentations. Section 16(b) Provision of the Securities Exchange Act of 1934 that requires that any profit realized by a company insider from the purchase and sale. This includes the power to register. and adjustments. Security Event In commitment control. Segmentation You can “segment” components of pay based on such events as changes in compensation. The Act empowers the SEC with broad authority over all aspects of the securities industry. For example. Self-Service Application Another name for PeopleSoft's HRMS and ERP applications accessed using a browser. and inquiries. employee status. exception overrides and notifications. events that trigger security authorization checking. Security Clearance Security Clearances (Classified. Selective Merge In PeopleSoft Enterprise Warehouse the selective merge allows for an additional WHERE clause when you delete a merge. and American Stock Exchange are SROs. Selective Factors Knowledge. transfer agents. but are determined to be essential to perform the duties and responsibilities of a particular position. such as the New York Stock Exchange. The National Association of Securities Dealers. skills. and oversee brokerage firms.GLOSSARY Securities Exchange Act of 1934 The Congressional act that created the Securities and Exchange Commission. abilities or special qualifications that are in addition to the minimum requirements in a qualification standard. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 187 . Applicants who do not meet a selective factor are ineligible for further consideration. which operates the NASDAQ system. transfers. or job changes during a pay period. regulate. such as budget entries. The various stock exchanges. The Act also identifies and prohibits certain types of conduct in the markets and provides the Commission with disciplinary powers over regulated entities and persons associated with them. The Act also empowers the SEC to require periodic reporting of information by companies with publicly traded securities. Top Secret) are granted to employees by government agencies and are usually associated with jobs that bring employees into contact with classified government projects or sensitive technologies. you can set up your system to trigger segmentation of earnings results on the pay slip when there is a change to the job change action/reason field. if an individual changes jobs in the middle of a pay period and your organization has a practice of separating components earned in the first job from those earned in the second job. Secret. is also an SRO. and clearing agencies as well as the nation's securities self regulatory organizations (SROs). Seniority Rate Codes A premium paid for seniority or for the length of time an employee works for an organization. such as "MgrGetObject + parameters". GLOSSARY 188 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Service Buy Back The process by which an employee repays a pension plan in order to restore service credit that was forfeited when the employee withdrawal previous contributions. it sends a service name and a set of parameters.GLOSSARY Sell to Cover Exercise When an optionee sells a portion of the option shares to cover the exercise cost and any applicable taxes. SQLAccess. The application server associates the service request with the appropriate server process to complete the transaction. RemoteCall. When a client workstation sends a request to the application server. employees withdraw contributions upon termination and initiate service buy back processing upon rehire. The server process carries out a client request by making calls to a service that executes SQL against the database. Seniority Pay Components Pay components whose rate codes are assigned to the seniority rate code class SENPAY (provided by PeopleSoft) on the Comp Rate Code page. and so on. Seniority Pay A premium paid for seniority or for the length of time an employee works for an organization. Examples of services are MgrGetObj. Server Process A server process is executable code that receives incoming client requests on the application server. allowing you to access the seniority pay functionality. Service A service performs a particular task of an application. It shows the gross debit/credit balances in addition to the net balance for each account stored in the ledger. Separate Debit and Credit A feature in PeopleSoft General Ledger that captures and reports in greater detail the accounting information that resides in balance sheet accounts. Service The PeopleSoft Pension Administration function that determines how much service credit an employee has accrued. Typically. This feature also supports reversing—debit and reversing—credit journal entries for error correction. "stock price. See. These shares are therefore canceled from the option and can be returned to the plan. the data members of that class. Stock options give you the option to purchase a certain number of shares of company stock. also. Shape For a transaction. such as termination of employment in which the unvested shares as of the date of termination are no longer available for future vesting and exercise. Sex Code Used to indicate gender. SetID The label that identifies a TableSet." Shareholder Owner of one or more shares of stock in a corporation. Share A share of a company's stock. plus cancellations that revert to the Plan pool. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 189 . Share Price The price per share of a company's stock. The employee “purchases” this service by paying into the plan. For a class. the set of inputs and outputs for that transaction. Shares Cancelled This is usually triggered by a specific event. Service Schedule A table showing how much service an employee earns based on the number of hours the employee worked during the year or month. Shares Available to Issue The total number of shares authorized. retired to treasury or allocated back to a group. Also known as a stockholder or investor.GLOSSARY Service Purchase The process by which an employee gets additional pension service credit for periods not normally considered eligible. Shares Exercisable The number of shares that are vested and available for exercise. less shares granted. Shares Expired Option shares that no longer are exercisable at the end of the option term. This date is usually the earlier of the exercise period for vested shares after termination of employment or the full length of the option term. Shares Outstanding The number of company shares currently held by shareholders. rotating. and/or split.GLOSSARY Shares Exercised The number of shares purchased upon exercise of a stock option. Shift Code A numerical shift identifier that is unique within a SetID. Shift Bonus A fixed amount (either a flat dollar figure or stated in terms of an employee's rate) paid for working a particular Shift. or ten to six. or ten to six. Shift Differential Additional compensation paid an employee for time worked during certain shifts. such as nine to five. Typically. and consists of clock hour Start and Stop times (two to allow for split shifts). hour worked. any given shift may or may not have an associated Shift Differential or Bonus. Shifts may be constant. four to eleven. four to eleven. the block of hours that an employee works in a day such as nine to five. such as double-time for late night shifts. Shift is used as a template of clock hours for scheduling an employee or group of employees to be at work or available to work (on call). A shift is always associated with a Work Schedule. repeating. duration (see Scheduling) GLOSSARY 190 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Shift Elements Individual components of a shift such as TRC start and stop time. as tracked by the transfer agent Shift [Time and Labor] The block of hours that an employee works in a day. In PeopleSoft Time and Labor. In PeopleSoft Workforce Analytics. a premium paid for work over regular pay. In PeopleSoft Workforce Analytics. meal periods (two) and relief periods (two). for which employees on certain shifts may be eligible. shift differential is administered as a flat amount per shift. and/or as a percentage of the amount paid per shift hour or shift worked. Shift differentials are usually stated as an additional rate or factor. The length of the option term is defined in option agreement. parent. the system reserves the order with the highest priority. On Call) (see Scheduling) Shift Type [Time and Labor] Time and Labor defined classification of shifts. or sale and purchase. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 191 . If schedules are encountered with the same priority. so that the short seller can eventually cover at a price lower than the original sale. thus realizing a profit. of the issuer's equity securities by an insider within a period of less than six months. necessitating its purchase or delivery some time in the future to "cover" the sale. A short sale can be "naked. includes bonuses and commissions. Short-term Variable Compensation In PeopleSoft Workforce Analytics. where both roll up into the same parent.e. this is cash compensation paid to a worker that is not fixed. Short-Swing Transaction A purchase and sale. Shift categories are used in the creation of time reporter schedules (see Scheduling) Shipping Priority Code Shipping Priority Codes act as tie breakers during order reservation in PeopleSoft Inventory when different orders are scheduled for the same delivery date and time." in which case the seller does not deliver the shares being sold short and must provide the broker with collateral. A short sale is usually made with the expectation that the stock value will decline. Or the short sale can be "against the box. Sibling A tree node at the same level as another node. depending on its location in the tree. and child all at the same time. Valid shift categories include Flex. The shift type can be used in the evaluation of rules or exceptions (i. When the reservation process in Inventory encounters a situation where there are more orders than available stock. See "Section 16(b)" above.GLOSSARY Shift Name Customer defined nomenclature for a shift (see Scheduling) Shift Type A customer-defined classification associated with a shift. General and Elapsed. At the time of the short sale. Short Sale The sale of a security that is not owned or is not delivered at the time of the trade." in which case the seller delivers the shares being sold short for the broker to hold "in the box" until the seller chooses to close out the short position. the broker borrows stock to deliver on the settlement date. A node can be a sibling. orders are then considered by order date. Sick Leave Sick leave is accrued by full-time permanent/seasonal employees at the rate of 4 hours every biweekly pay period. with no payments made after the death of the participant. The SIRET number is a combination of the SIREN and NIC numbers. and child all at the same time. parent. The SIREN code is assigned to a company when it registers as a business with the French government. A node can be a sibling. Simulated Workforce In the PeopleSoft Workforce Rewards product. depending on its location in the tree. In France the SIRET is an identifying number given to a French business by the INSEE. SIREN Code (Système Informatique pour le Répertoire des Entreprises) This stands for the Electronic List of Enterprises. This number is used by the tax and social security authorities to identify a business enterprise and its entities. and identifies the purpose of the establishment for regulatory reporting purposes in France. after being authenticated by one PeopleSoft application server. Single Life Annuity A benefit payable during the lifetime of the participant. Sibling A tree node at the same level as another node.” Single Signon This refers to the process by which a user can. it is accrued at one hour for every 20 hours worked. for part-time permanent/seasonal employees. Also referred to as a “life only annuity” or a “straight life annuity. depending on its location in the tree. Manage Compensation module. A node can be a sibling. where both roll up into the same parent. access a second PeopleSoft application server without entering a user ID or password. an official statistics and economics organization in France. parent. the calculated Simulated Workforce = Existing Employees + New Simulated Employees + ReducedEmployees.GLOSSARY Sibling A tree node at the same level as another node. where both roll up into the same parent. GLOSSARY 192 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . SIRET (Système Informatique pour le Répertoire des Établissements) This stands for Electronic List of Entities. and child all at the same time. and left margin areas of the web page template. you “slice” off part of the cube or “dice” it to get to an individual cell. Social Security Number Nine numeric digits assigned to an individual by the Social Security Administration. PeopleSoft General Ledger processes (such as Consolidations). Source Transaction In commitment control. encumbrance. When your data has three (or more) dimensions.GLOSSARY Site Tree In PeopleSoft eStore. a product manager’s access to the system can be restricted to only the products he or she is responsible for by defining “Products” as a slice dimension. expenditure. and which can be checked against commitment control budgets. footer. a process by which the system establishes the target market compensation rates to use for compensating workers in non-benchmark jobs. user IDs (such as CLERK123). Slice Dimension A model dimension used to restrict user access to the system. Unlike a segment (or period). For example. a pre-encumbrance. For example. Slotting In PeopleSoft Workforce Rewards. recognized revenue or collected revenue transaction. with each side representing a dimension. a hierarchical structure that controls navigation. or other applications (such as PeopleSoft Payables). as well as content and behavior within the header. When you analyze the data. These can include job titles (such as CFO). Also known as a Taxpayer Identification Number (TIN). and assigning this person the members of the “Products” dimension he or she can access. Source The Source table stores valid journal entry and posting sources. a slice does not represent a separate gross-to-net process since it affects only a limited set of elements within a period or segment. slices have their own begin and end dates. any transaction generated in a PeopleSoft or third-party application that is integrated with commitment control. Slice and Dice Another term for multidimensional analysis. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 193 . you can think of it as being arranged in a cube (or hypercube). Like segments. Slice The span of time into which an element is segmented as a result of element segmentation. ). Special Rates Higher salary rates for specific grade levels and occupational groups determined by OPM for employees working in specific geographic areas. SpeedType A code representing a combination of ChartField values. severance pay. skills. but little or no data in some of those dimensions. executing limit orders on behalf of other exchange members for a portion of the floor broker's commission. The goal is to create dense cubes and only use dimension intersections where data actually exists. Percentages can optionally be related to each ChartKey in a speedchart definition. SpeedTypes simplify the entry of ChartFields commonly used together. the cube is considered sparse. and abilities to perform successfully the duties of the position and is typically in or related to the work of the position to be filled. SpeedChart A user-defined shorthand key designating several ChartKeys to be used for voucher entry. Special Payments A payment that occurs once or under special circumstances (e. Specialized Experience Experience that has equipped the applicant with the particular knowledge. compensatory time reimbursement. pension and retirement plans use special accumulators. Specialist A member of a stock exchange who maintains a fair and orderly market in one or more securities. longevity bonus.. preventing wide swings in stock prices. and buying or selling for the specialist's own account to counteract temporary imbalances in supply and demand. Special accumulators can add to or subtract from a pool of earnings. separation bonus. vacation.GLOSSARY Sparsity/Density A multi-dimensional concept of whether data exists at intersections of dimensions. bond refund. A specialist or specialist unit performs two main functions. etc. Each area is assigned a separate Schedule Number. If a cube has many dimensions. back pay interest. Sparse cubes take up unnecessary disk space and reduce calculation performance. Special Accumulator A device that accumulates earnings from different sources for a specific purpose. lump sum leave. A 401(k) plan might use a special accumulator to calculate a deduction using regular. GLOSSARY 194 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . death payment.g. 401(k). and overtime earnings. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 195 . Split and Join In PeopleSoft Demand Planning.GLOSSARY Spending Limits See Planning Targets. and age. They also play a role in monitoring employment fairness. example. The uniting of the payment cash with the payment advice when they have been received as separate information through EDI. the portions are joined back into a single forecast. a Custom Statement that defines any criteria that must be met before the plan will provide an Automatic Spouse Benefit. a time reporter comes to work as a busboy for the lunch shift from 12-2 p. sex. and nondiscrimination in terms of nationality. Spokesmen Committee (Sprecherausschusse) In Germany the Spokesmen Committee represents the interest of the management in your company before the ownership. The new deduction retains the original item ID with an added suffix number.m. Split Shift Periods of productive time split up by period of non-working time. After changes are complete. Split Deduction Deduction that you create by splitting an existing deduction into two deduction items. although they play a co-determination role on individual employment contracts. The Spokesmen’s Committee is consultative in nature. an informational-only form of pension payment that tells what the spouse’s total benefit would have been if the retiree had chosen the spouse as the beneficiary rather than a nonspouse beneficiary.the process of subdividing a forecast so that multiple users can make changes to their portions of the forecast. You cannot pay pension benefits based on this form because it is informational only. the plan may require that the employee and spouse be married a full year before they are eligible for an automatic spouse benefit. equity. and dismissals. race. religion. and then returns to work from 68 for the dinner shift (see Scheduling) Split Stream Processing The matching of a payment’s cash information with the payment advice information when they have been received as separate transmissions through EDI and lockbox. For example. Spouse Demonstration J&S In the PeopleSoft Pension Administration system. Spouse Eligibility Alias In PeopleSoft Pension Administration. hiring. or (2) the difference between an option’s exercise price and the market price at the time of exercise (i. analyze the differences between the two and their causes (Variances). Staging ID An identifier for a putaway plan. Standard Price In PeopleSoft Demand Planning..e. representing detailed estimates of each element of cost entering into the purchasing or manufacturing of an item. fixed cost associated with an Inventory Item or Forecast Item.GLOSSARY Spouse Eligibility Statement See Spouse Eligibility Alias. either (1) the difference between the bid and asked prices for an over-the-counter stock. SQL Objects Used to create rules that are more complicated than templates or actions and conditions allow—select statements. the standard selling price associated with a Forecast Item. At higher levels in the view where there is no standard price available. Standard Form (SF) A standardized form for interagency use by the Federal government. look at how much it does cost (Actual). Standard cost is used when minor variations in an item's cost are not needed. The use of standard costs also enables management to determine how much an item should cost (Standard). The inventory system sequentially assigns Staging IDs when it creates the putaway plan. Standard Cost A predetermined. and sub-queries ST (Strategic Trust) See Strategic Thrust Staged Date The date an item was received into the inventory business unit. the summarization function can be set up to develop one. the profit component of the exercise). table joins. and compute economic order quantity. Spread Depending on the context. Standard Unit of Measure The smallest unit of an item that a PeopleSoft application tracks. The price can be introduced into the system directly in forecast item maintenance or indirectly using the demand transfer interface. insert statements. The SF prefix is the most common but not exclusive one in usage. GLOSSARY 196 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . keyed by process instance. Status Checking In PeopleSoft Projects. that must be created and maintained for each Application Engine program. Cash Balance Account. State Record The State Record is a PeopleSoft record. classified. The alternative would be to load the entire accrual history. The group remains the same at all times until you change it. an online warning will display or the transaction will be rejected. used for tracking and monitoring statistical data. using a statistical code of WS may represent the number of Workstations.. accrued Service. Status Position Code A code that identifies the various conditions of a position. Statistical Code The unit of measure used for tracking and monitoring statistical data. For example.. Statistical Forecast In PeopleSoft Demand Planning.GLOSSARY Startup Data In PeopleSoft Pension Administration. a control feature that can be applied to transactions coming into Projects from cost feeder systems.g. the Workstations account uses EA (each) as a generic unit of measure. etc. If the incoming transaction does not conform to predetermined status and analysis conditions. Static Policy Controls Determines how a static (versus time-phased) Inventory Policy is to be calculated. Static controls use period and average methods and their arguments. The State Record defines the fields that an Application Engine program uses to pass values from one SQL statement to another. a forecast developed at each level of the forecast pyramid and that considers the item’s history in isolation. frozen. For example. e. while the Floor Space statistical account might use square feet and the Work Days account would use days. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 197 . Static Group An employee group in Time and Labor that enables you to control its creation and maintenance. or Employee Account data loaded into the system in the form of an opening balance and “as of” date. Statistical Account An account that has an associated unit of measure. Stock Appreciation Rights (SAR) A contractual right to receive. Stock Awards Stock allocations that are processed in the Manage Variable Compensation business process. Stock In corporate finance. and common stock equivalents are traded by members of the exchange. different employees may have a different number of steps within their primary pay level). Stock Administrators manage Stock Option Plans. Step A secondary level or subcategory within the primary pay level (depending upon pay plan. Stock Administrator An individual who administers and manages the corporation’s benefits and/or equity compensation plans. Step Progression In PeopleSoft Workforce Analytics. stocks. Employee Stock Purchase Plans. This individual serves as the contact for transfer agent and broker inquiries. In PeopleSoft. Stock Option A contractual right granted by the company. to purchase a specified number of shares of the company’s stock at a specified price (the exercise price) for a specified period of time (generally five or ten years). PeopleSoft Stock Administration supports only tandem SAR’s. Restricted Stock Award Plans. Such exchanges have a physical location where brokers and dealers meet to execute orders to buy and sell securities. the form in which an owner's interest is represented. this is equivalent to the Alternate Account (ALTACCT) ChartField. Stock Exchange An organized marketplace in which bonds. acting as agents (brokers) and as principals (dealers or traders). Each exchange sets its own requirements for membership. a pay increase granted to an employee or group whose salary plan includes steps within grades. Each step increase is a step up the pay range for the employee. Stock Administration creates stock grants from finalized stock awards. Assuming that the exercise price is the GLOSSARY 198 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . the appreciation in the value of the employer’s stock over a certain period of time. either in cash or employer stock. generally under a stock option plan. distributed in units known as shares. and Stock Bonus Plans. A SAR can be used alone or in tandem with Incentive Stock Options (ISO/SAR) or Nonqualified Stock Options (NQ/SAR).GLOSSARY Statutory Account Account required by a regulatory authority for recording and reporting financial results. Stockholder of Record Person or entity. and also in order to keep the identity of the beneficial owner confidential from the company. without a corresponding change in the assets or capital of the issuer." The stockholder of record acts in part as a way of safekeeping stock certificates that might otherwise be lost by the beneficial owner. See. because the option effectively gives the optionee the right to buy stock in the future at a discount. Also known as a "ticker symbol". Stock Split A change in the capitalization of an issuer that increases or decreases the number of securities outstanding. named on the issuer's or transfer agent’s stock record books as the owner of shares held in "street name. they surrender already-owned shares of stock to pay the total required option exercise price and/or taxes for the option being purchased. Stock Trading Symbol The three or four letter symbol used to identify a company's stock on the stock exchange where it trades. Stock Purchase Participant An individual who participates in the corporation’s Stock Purchase Plan. Stock Purchase Plan A type of broad-based stock plan that permits participants to use payroll deductions accumulated over a period of time to acquire stock from the company. For example. the option will become more valuable if the fair market value goes up. Stock Swaps A payment method that can be used to cover the cost of the exercise price and taxes depending on whether it is allowed by the plan. When an employee elects to exercise a stock option by means of a stock swap. the employee thereafter has the option to purchase 50 shares at $5 per share. Stock Withholding A cashless method of satisfying the withholding taxes due upon the exercise of a stock option by authorizing the company to withhold from the shares being exercised a number of shares equal to the taxes. "share price. also.GLOSSARY same as the fair market value on the grant date. often a broker or the Depository Trust Company. if an employee has options to purchase 25 shares at $10 per share and the company has a 2-for-1 stock split. The surrendered shares are usually valued at the fair market value of the company’s stock on the date of exercise. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 199 . Stock Price The price per share of a company's stock. and adjusts the value of the securities accordingly. Storage areas might include shipping and receiving docks. and Critical Success Factors. Key performance indicators may be attached to strategic thrusts as long as there aren’t critical success factors below them. Strategy Tree In PeopleSoft Balanced Scorecard.GLOSSARY Stock-In Probability A replenishment option for defining transfer parameters for PeopleSoft Demand Planning or Inventory Planning upload files. Storage Level A hierarchical subdivision of a storage area. warehouse zones. May be temporary or short-term in nature. with each level representing a physical subdivision of the area. The option is the percentage of time you want to have the item on hand for the Business Unit and is used to calculate safety stock. Learning and Growth. actions the organization must take to implement strategy. and Internal Processes. These are made up of Vision. This is the smallest definable physical space within an Inventory Business Unit. Customer. four to five statements or paragraphs that summarize the core components of an organization’s strategy. Strategic Initiatives In PeopleSoft Balanced Scorecard. GLOSSARY 200 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Storage Location The combination of a storage area and that area's most detailed storage level. Strategic thrusts describe the key areas across which a scorecard is balanced. but typically strategic thrusts aren’t directly associated with key performance indicators. Stop Time Out punch Storage Area A division of a Business Unit used to store material and to track Inventory Transaction. Strategic Thrusts. the hierarchical relationships of the objectives your organization is striving to achieve. Each storage area can be divided into a maximum of four levels. Strategic Thrust (ST) In PeopleSoft Balanced Scorecard. more specific descriptions of what you must do to achieve that goal are defined by critical success factors. and typically balanced across four major categories: Financial. staging areas. They are themes or goals your organization is striving to achieve. Used as the foundation for a scorecard. and inspection and quality control departments. Street Name See "Stockholder of Record". String constant String constants are delimited in PeopleCode by using either single (‘) or double (") quote marks. periodic increments. this is the level of performance for which an employee achieves maximum pay out. Stretch In a Goals Matrix performance scale (In PeopleSoft Workforce Analytics). grouping operations. The strike price is typically the fair market value of the stock on the grant date. Stratification Wizard enables you to stratify your data according to tiers. Streams An optional feature that enables you to reduce processing time by processing groups of payees simultaneously. The FTP rate for the instrument is then calculated by weighting the cost of funds rate for the cash flow in each time period by the term of the cash flow. This approach matches the projected cash for the instrument in each time period. Performance above this level receives no greater pay out. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 201 . Strip Funding One of several methodologies used by PeopleSoft Funds Transfer Pricing (FTP) to derive maturity when calculating FTP rates based on matched maturity funding.GLOSSARY Stratification Engine A support module that structures the volume of financial accounts and balances at a large financial institution to a manageable scale for processing by the PeopleSoft Funds Transfer Pricing (FTP) and PeopleSoft Risk Weighted Capital (RWC) applications. Strike Price The price per share which must be paid in order to exercise the stock option. with a specific cost of funds rate for that cash flow. and numeric increments. It categorizes data by a range of values and summarizes data based on rules you define for FTP and RWC. and summarization actions to be performed. Also known as the "exercise" or "grant" price. Stratification Wizard Stratification Wizard is a tool you can use to quickly create new stratification rules or update the existing rules. Stratification Wizard prompts you for each of the possible source and destination fields. It also enables you to leave the data aggregated. discrete values. You can include conditional logic within a sub-process section. business unit/item. and bill of material/engineering bill of material. an operation performed on a production ID would be a subtask of the production order. Subscription The process of mapping fields. or create your own. events. selecting data parameters and submitting the information to an outside vendor. PeopleSoft applications provide a variety of standard SQRs that summarize table information and data. The substitute item can be defined at three levels: setID. and profiles. Substitute Item In PeopleSoft Manufacturing. Subtask A lower-level Planning task in a schedule's hierarchy that rolls up into a parent task. You can use these reports as is.GLOSSARY Structured Query Report (SQR) A type of printed or displayed report generated from data extracted from a PeopleSoft SQLbased relational database. customize them. Style File (Verity) Collection style refers to a set of configuration options that are used to create the indexes associated with a collection. summary ChartFields must be used in the summary ledger data record to accommodate the maximum length of a node name (20 characters). SubCustomer Qualifier A value that groups customers into a division for which you can generate detailed history. When detail values are summarized using tree nodes. Summary ChartField A feature for creating summary ledgers that roll up detail amounts based on specific detail values or on selected tree nodes. Sub-Process Section A type of section you can add to a process list. A collection has one collection style and it is defined in a set of style files before creating the collection. For example. GLOSSARY 202 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . aging. Summarization Process See Rollup. an item that can be used when there are no primary components available in inventory or when there is a long-term shortage of the original item. Sub-process sections are especially useful for performing iterative processes such as gross ups (calculating the gross amount for a given net amount). This super tree contains all tree changes for a certain period of time enabling you to analyze effective dated trees more easily. meaning the sum of the children's forecasts for the parent. Support Costs Activity costs not directly connected to production. Summary Ledger An accounting feature used primarily in allocations. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 203 . They increase the speed and efficiency of reporting by eliminating the need to summarize detail ledger balances each time a report is requested. and PS/nVision reporting to store combined account balances from detail ledgers. A summary tree structure specifies the details on which the summary trees are to be built." In a summary tree. detail balances are summarized in a background process according to userspecified criteria and stored on summary ledgers. Instead. summary trees enable you to define "trees on trees. inquiries. The summary forecast at level one (1) is always zero since there is not a logical lower level. the detail values are really nodes on a detail tree or another summary tree (known as the basis tree). a type of forecast that results from adding up the adjusted forecast totals from the next lower level. and applied once.GLOSSARY Summary Forecast In PeopleSoft Demand Planning. Supply Chain Warehouse See Warehouses. Super Tree Utility A PeopleSoft Enterprise Warehouse utility that enables you to combine multiple effective dates of a tree into one. Supplemental IRR An IRR type used when a federal employee's retirement deductions were originally underreported. Summary Tree A tree used to roll up accounts for each type of report in summary ledgers. The percentage depends on state requirements. they are added together. The summary ledgers are then accessed directly for reporting. Supplemental Tax Method A payroll tax calculation method that uses a straight percent rather than allowances. Summed Adjustment Type When the system finds multiple summed discounts. In effect. An agency can create a Supplemental IRR to report the difference in the retirement deduction amount to the Office of Personnel Management (OPM). brackets. such as brackets. They are not stand-alone. Database system elements contain payee-related data that can be used frequently in a calculation. quotes. System Element In PeopleSoft Global Payroll. a company may stipulate to suspend vesting of shares. rates. such as department ID. and personal data. sales orders. an item suspended by the system. Only applicable if the Stock Action is LOA. and fictitious calculations. The support modules perform processes that are used in the financial services industry. and Buying Agreement. Supporting Element Overrides Provide a mechanism to override various supporting element types. They are only utilized by two of the PeopleSoft Analytic Applications: Risk Weighted Capital (RWC) and Funds Transfer Pricing (FTP). Suspended Item In PeopleSoft Demand Planning. Suspend Exercise As a condition of a leave of absence. Only applicable if the Stock Action is LOA. There are two types of system elements: database system elements and system-computed elements. they are used in combination with other elements to create rules. location. durations. Supporting Elements Supporting elements are building blocks for other elements. at various different levels. System-computed elements are automatically populated by the payroll process.GLOSSARY Support Modules The support modules are a collection of engines and analysis models that derive values. and variables. and prices. Suspend Vesting As a condition of a leave of absence. If a company does not Suspend Vesting then the Vest Deferral Grace Period and Service Rule are not applicable. The suspension is due to the lack of demand for the number of periods defined for the item's Control Group. system elements are delivered and maintained by Peoplesoft. a company may stipulate to restrict the exercise of shares during the leave or for a period of time. formulas. rounding rules. You can assemble support teams and associate them with ship to customers. financial calculations. PeopleSoft Analytic Applications take this data and use it for further processing. In PeopleSoft Global Payroll. Support Team A group of people working together to sell to and/or support a customer. GLOSSARY 204 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Typical supporting elements are arrays. dates. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 205 . TableSet Sharing Specifying the control table data for each business unit so that redundancy is eliminated. along with their associated General Ledger distributions. System-Defined Count The PeopleSoft Inventory feature that employs user-defined criteria to begin the count creation process. you can look up an interest rate based on a year. For example. TableMaps In the PeopleSoft Enterprise Warehouse. T T+3 The obligation in the brokerage business to settle securities trades by the third day following the trade date. or an actuarial factor based on an employee’s age. TableMaps define the physical relationships between related tables. Table The underlying format in which data is stored by columns (fields) and rows (records. or instances). Table Lookup A utility in PeopleSoft Pension Administration that finds an unknown value based on a known one in your data set.GLOSSARY System Functions A list of all activities that the system supports. "Settlement" occurs when the seller receives the sales price (less the broker’s commission) and the buyer receives the shares. maintained to reflect customer credit standing. System-Defined History Any statistical information updated by the posting and aging programs. TableSet A group of rows across control tables identified by the same SetID. TableMaps allow you to define “families” of related tables and the columns that define the key relationships between the tables. a plan for distributing compensation awards. the application determines what the actual end date should be. this is the performance level your organization establishes as the norm for performance and pay out. Target Currency The value of the entry currency or currencies converted to a single currency for budget viewing and inquiry purposes. engineering or marketing) is found by subtracting the desired profit margin from a competitive or estimated price. in which the level of the award is linked directly to a predetermined level of performance that a defined measure is evaluated against. increase the business unit’s net income by 10% and each member of the group will be eligible for an award equal to 5% of base pay. and depending on the work schedule templates. Target End Date The intended end date for employee schedules in Time and Labor reporting. For example. Target Cost A desired target cost (for production. Target Plan In PeopleSoft Workforce Rewards. Target Grade Highest obtainable grade for a position.” Target Rate In PeopleSoft Workforce Rewards. You establish a target end date.GLOSSARY Tardy The circumstance when a time reporter reports for work after the scheduled start time Target In a Goals Matrix performance scale (In PeopleSoft Workforce Analytics). Target Matrix In PeopleSoft Workforce Rewards. Think of these target rates as pay guidelines. in support of your company’s overall pay strategy. GLOSSARY 206 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . the Target Matrix defines the level of award to be paid based upon a predetermined level of performance that a defined measure is evaluated against. a Target Plan for a Sales group might be as follows: “As a group. calculated market rates you choose to use as new target pay rates for the jobs in your organization. fields for reconciliation are defined for both a source and target view. income. such as salary plans or employee reviews. Task See Manufacturing Task and Planning Task Task A piece of work assigned to or demanded of a person. defining labor agreements on issues such as standard working hours. the of the views being reconciled during the Cross-View Reconciliation process. During the process. (i. Company.GLOSSARY Target View In PeopleSoft Demand Planning.e. a unit of work (see Time Reporting) Task Entity Individual component of a task. equally distributed or by prompt) (see Time Reporting) Task Rules A methodology that is applied to scheduled. Activity ID. The Tariff Area is often split along regional lines (such as Bavaria or Berlin). can also be applied based upon the Tariff Area. The task profile fields that appear on the page are established by the Task Profile Template. Project ID. reported and payable time to allocate or redistribute task assignments (see Time Administration) Task Transfer Department transfer PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 207 . Task Profile A way of viewing or establishing where to allocate employee task information for a day and time. and vacation. Task Profile Entity that establishes the default values for optional and required task elements. This can be for single or multiple tasks. Tariff Area In Germany. Department. percentage distribution. additional labor agreement terms beyond those in the Tariff. default values based on hours allocation. for example. This contract is valid for all of Germany for the business or industrial sector the company is working in (such as Banking or Metal). Tariff In Germany a Tariff is a contract between the employee’s unions and the employers' association. Business Unit (see Time Reporting). Work order. PeopleSoft Planning constraints include finish to start. Templates allow a developer to build an HTML page by combining HTML from a number of sources. This allows for parallel data processing.GLOSSARY Task Values The customer defined value for a specific task element i. submitted on magnetic media to the government. there may be one template pagelet for the universal navigation header and one template pagelet for the target content. in a given template. Taxable Benefits Any employer contributions that are subject to Federal Withholding Tax. Customer 1. Team Member An individual who is part of a support team. start to finish. Technical scenarios allow technical users to define chunking criteria that enable chunks to run in parallel. GLOSSARY 208 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .e. For example. task template. associated with a web page. start to start. TDS (Transfert de Données Sociales) In France the TDS is a social security transfer report. Template A portal template is simply HTML code. finish to finish. and task profile(s) for time reporters that share the same task reporting requirements. Temporal Constraint A relationship between Planning tasks that defines their sequence and timing in a schedule. Template Pagelet One piece of an overall template. Templates do two basic things: define the layout of the page. project 1. Temporal constraints cannot be violated by the Optimizer. and define where to get HTML for each part of the page. Each team member may be in a commissionable or non-commissionable role. to define the style and layout of the page. etc (see Time Reporting) Taskgroup Identifies the default time reporting templates. Technical Scenario In PeopleSoft Enterprise Warehouse technical scenarios allow you to set up the object type values that the Resolver uses to chunk the record/TableMap you’ll resolve. a remote process). this is the minimum threshold for adequate performance. based on the marginal cost of funds of similar liquidity and tenor. If the transaction exceeds a predefined tolerance. Threshold In a Goals Matrix performance scale (In PeopleSoft Workforce Analytics). the application server sends the SQL to the database and then returns results to the client in the form of lightweight Tuxedo messages.GLOSSARY Temporary Continuation of Coverage (TCC) The TCC program. Term Certain Payment Option See Certain Only Payment Option. a control feature that can be applied to transactions entered directly into Projects or integrated into Projects via the INTFC_PROJ_RES table. provided the individual pays the full cost of coverage. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 209 . the designated level of performance below which it is inappropriate to pay incentives. requires Federal agencies to provide to separating Federal employees the opportunity to temporarily continue their FEHB coverage for up to 18 months (unless involuntarily separated because of gross misconduct). Within PeopleSoft. a warning will display or the transaction will be rejected. It represents the length of time an instrument is available as either a source or use of funds. Termination A transaction in which an employee ceases to be an employee of the corporation. including both the employee and government share and a two percent administrative charge. Term Certain and Continuous Payment Option See Certain and Continuous Payment Option. as prescribed by the OPM. Threshold Checking In PeopleSoft Projects. Three-Tier A three-tier architecture introduces an intermediary application server between the client workstation and the database server to improve performance. Think-time process Think-time functions suspend processing either until the user has taken some action (such as clicking a button in a message box). Tenor Used by the PeopleSoft Funds Transfer Pricing (FTP) application to refer to the maturity of an instrument. or until an external process has run to completion (for example. Agencies may elect to provide this service inhouse or enter into cross-servicing agreements with another Federal agency. The FTP application calculates the transfer price for an instrument. rates. i. time capture device. and returns errors and questionable items to the time reporter for correction or scrutiny. Tiers are ranges that you set up for stratifying your instrument data (such as amounts. Also known as a "stock trading symbol". etc. SQL objects. IVR. and applying an organization’s compensation.e.GLOSSARY Thrift Savings Plan (TSP) A voluntary retirement savings and investment plan for Federal employees administered by the Federal Thrift Investment Board. (see Time Reporting) Time Collection A Time and Labor feature that collects positive and exception time reports. applies appropriate business rules and edits to the reported time to ensure validity and reasonableness. In other words. and exception rules to both reported and scheduled time. templates. Time Administration A process which provides four [separate] different online tools for creating. actions and condition. and user exits Time and Labor Period A distinct. Fax.. Employee 123 is assigned to clock group 1 and can then punch in at either clock 1 or clock 2. clock group 1 is made up of clock 1. Ticker Symbol The three or four letter symbol used to identify a company's stock on the stock exchange where it trades. Tiers In the financial services industry. You define Tiers within Stratification Engine. and clock 2. (see Understanding Time Collection Device) GLOSSARY 210 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Time Collection Device A group of time collection device lumped together and named for ease of assignment to employees. task. configurable period of time used by all the PeopleSoft Time and Labor processes (see Time Reporting) Time and Labor User Either a Time Reporter or a Time Manager Time Capture Device Third party system or methodology for collecting elapsed or time capture device time. maintaining. and numbers) into specific groups. Time collection is also responsible for scrutinizing future (previously) posted time information for correctness when those reports are ready for use. Time Reporter Information Values associated with the Time Reporter that are displayed when entering or viewing reported time and facilitate the processes of Time Reporting and Time Management (see Time Reporting) Time Reporting Any information required by a business unit that can be attributed to an individual employee (worker/contractor) and can be expressed in hours. PeopleSoft Planning time-fence types include start of time. Time Reporter Any employee or contractor for who time is reported or generated in PeopleSoft Time and Labor. planning close date (demand time fence). You establish day. action message cutoff. a user-defined parameter that specifies the business rules to be used in the generation of the plan. Time Fence In PeopleSoft Planning. purchase order fence. weeks. You can categorize time periods in terms of days. end of time. and so on. Time Manager An individual who supervises Time Reporters Time Period A period of Time used in Time and Labor rules processing. holidays. or month-type periods for use when you apply rules for compensation. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 211 . and planning time fence. This dimension defaults to a two-level hierarchy consisting of the Inventory Policy year and a standard period. or months.GLOSSARY Time Collection Device time Reporting time by recording actual starts and stop times (see Time Reporting) Time Dimension Determines how date-related information is presented in a Cube View. Time Report A payroll time and/or labor distribution time report for an employee for any date within the employee’s current period. leveling fence. week. such as monthly. GLOSSARY 212 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . The Time Reporting Code represents the level at which a business actually needs to track employee time to support all of its administrative and compensation needs. Tolerance In PeopleSoft Projects. TimeSpans can also be used with Flexible Formulas in PeopleSoft Projects. employees can accrue benefits differently at different times. amounts. excluding revenues applied to increase budget limits. a value that is defined at either the project or activity level as either a percentage of a project’s funding or an actual amount. is required.GLOSSARY Time Reporting Code A hybrid of two PeopleSoft objects: the Payroll Earnings Type and the Human Resources Absence Type. includes both direct compensation and benefits compensation. rather than a specific date. the percentage over budget that you allow. Time Reporting Code Type Categorization of a time reporting code. that can be used in various PeopleSoft General Ledger functions and reports when a "rolling" time frame. this is generally the officially recognized compensation provided an employee in the course of their employment with an organization. TimeSpans Relative periods. benefits and deferred compensation for all current workers. Valid categories include. such as year-to-date or current period. In commitment control. Cash Balance Accounts. Total Authorized But Unissued The combined total number of shares from Shares Available to Issue plus Total Options Outstanding. units. non-cash programs. ex-workers and individuals associated with exworkers who receive compensation due to the employment of the ex-worker. Time Segment For Service. and Employee Accounts. hours or a combination of hours and amounts (see Time Reporting) Time Reporting Group See Group [Time and Labor]. Total Compensation In PeopleSoft Workforce Analytics. Total Compensation Management The ability to track and report on all types of cash programs. The period of time during which employees use a particular rule is that rule’s time segment. before the system creates an exception. and less often recognized total non-compensation. it includes Learning and Development compensation such as training. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 213 . It is also known as the Declaration 2483 Report. The types of inputs and outputs are based on a set of generic types. and Workplace Environment Compensation such as telecommuting privileges or other prerequisites. The associated external system or the Business Interlink Plug-in understands this command. this is the often unrecognized compensation an employee receives in the course of their employment with an organization. Total Rewards In PeopleSoft Workforce Analytics. The associated external system or the Business Interlink Plug-in understands this command. The types of inputs and outputs are based on a set of generic types. There are six tracking signals associated with each Forecast Item that correspond to the six most recent historical periods. The purpose of the report is to receive tax deductions from the government based upon the amount of money your company has spent on training. Total Options Outstanding The number of company shares currently held by shareholders as tracked by the transfer agent.GLOSSARY Total Non-Compensation In PeopleSoft Workforce Analytics. less Exercises and less Cancellations. Transaction A named command with optional named and typed inputs and outputs. this is the total rewards provided to an employee by their employment with an organization. Derived by using the number of Prior Outstanding plus Grants.a forecasting tool that detects bias in the forecast and provides an early warning of an unstable forecast. Tracking Signals PeopleSoft Demand Planning. Training Report 2483 The Training Report 2483 is a French regulatory report used to declare vocational training your company has provided to your employees. Trade Payment An authorization for a customer deduction in a Promotion application. Transaction A named command with optional named and typed inputs and outputs. it includes their officially recognized total compensation. generally. Tour of Duty The scheduled days and hours per day of attendance at a duty station for an employee. GLOSSARY 214 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Transaction Date The date a transaction actually occurred as opposed to the date the transaction is recognized— the accounting date (although the two dates can be the same).GLOSSARY See also Inventory Transaction or. These are translated to the base currency for consolidation and reporting of financial results. the original currency in which a company conducts its business activities. In PeopleSoft Asset Management. it may use different transaction currencies. When a company has multinational operations. an additional field on each resource transaction that is used in conjunction with accounting entry templates. The accounting entry templates for those resource transactions lines can then use the same transaction types. Transaction codes enable you to deal with exceptions to your accounting entry templates without having to create additional transaction types. Transaction Loader The SQR in PeopleSoft Asset Management that transfers load lines from the Loader tables into the PeopleSoft Asset Management Tables as assets and open transactions. Transaction group The package can contain one or more transaction groups. transaction codes identify special asset transactions and are used in conjunction with transaction type to create accounting entries. Transaction Dated Data aggregated over a date range. Each transaction group is a set of transactions of the same type. Transaction Code Identifies what action has taken place against the position. Resource Transaction. for PeopleSoft Projects. but specify different accounts. You can set up separate accounting entry templates for resource transactions containing the transaction codes you create. with the same trading partners involved. Transaction Costing See Multidimensional Costing Transaction Currency In the financial services industry. Transaction Code In PeopleSoft Projects. Transaction catalog Lists transactions used to interface to the external system. If the transfer type value is both. Transfer Punch The start of a work period that specifically denotes a change in task and usually compensationrelated characteristics Transfer Type An interunit transfer setting PeopleSoft Production Planning and Enterprise Planning use to determine where it will obtain item data for transfer tasks. the Planning engine only processes the transfer item for a single location. and the databases that support them. transactional system databases are not usually the best source of data for analysis. Transfer Agent An individual or firm who that keeps a record of your shareholders and the number of shares they own. these are tables that contain dynamic information and are keyed by business units. In the accounting entry templates each transaction line is assigned a specific general ledger account.GLOSSARY Transaction Tables In the PeopleSoft Enterprise Warehouse. Transfer Forecast In PeopleSoft Inventory Planning. Unlike Brokers. Transactional System A business application for performing the business transactions that keep your company running. The process only transfers items from Demand Planning that have been set to update the Inventory Policy. the Planning engine processes the transfer item using data from both the To and From units. Transfer Agents are not responsible for selling stocks. If the type is a supply or demand transfer task. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 215 . The transaction lines are then transferred into accounting entry templates. Instead they are primarily concerned with maintaining records on all stocks which your company has issued. For each transaction type you create you define specific transaction lines. are optimized for quick transaction processing. Transactional applications. Transfer Agents also issue new share certificates and cancel old certificates. Transaction Type The building blocks of accounting entry templates in PeopleSoft Asset Management and Projects. reducing the time for plan processing. Because they are constantly changing and are not optimized for data retrieval. Transfer Worksheet A work space for transferring an open item from one customer to another. a Generation process option that transfers the forecast from the target view in Demand Planning forecasts. Translate Table A system edit table that stores codes and translate values for the miscellaneous fields on the database that do not warrant individual edit tables of their own. which are ultimately assigned to workgroups. In most cases PeopleSoft maintains the Translate Table. or to a charity. Travel And Relocation Date Length of time an employee must remain in the Government after the Government has paid to relocate him/her from one official duty station to another or for initial appointment. Multiple Workgroups can share these TRC Programs. or any other account position that is the result of trading room and treasury operations. This deduction is used by the region to subsidize transportation. Treasury Interface files These are DOS-based files generated by PeopleSoft in accordance with FMS file layouts for transmission of payment data to one of the FMS' Regional Financial Centers. TRC Program A program that runs the level at which an organization actually needs to track employee time to support all of its administrative and compensation needs.GLOSSARY Transferable Stock Options Options that may be transferred by the optionee. Translate Table A system edit table that stores codes and translate values for the miscellaneous fields on the database that do not warrant individual edit tables of their own. GLOSSARY 216 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Treasury Position Code In the financial services industry. generally only to a family member or to a trust. and the URSSAF notifies establishments of this rate on a yearly basis. The transportation lead time is used in calculating the scheduled shipment and scheduled arrival dates on the order when you enter either a requested arrival date or a requested shipment date. Transportation Lead Times The transportation lead time is the in-transit interval from the date and time a shipment leaves your warehouse (Inventory Business Unit) to the date and time it arrives at your customer's receiving dock. Transport Rate The Transport is a statutory deduction in France. TRCs are assigned to TRC Programs. limited partnership or other entity for the benefit of family members. such as foreign exchange. this is a lookup code used for off-balance sheet treasury position accounts. derivatives. and maintain and build roads. Each establishment has a rate. precious metals. corporate divisions. Tree control Tree Control is a hierarchical search tool that you can imbed in a panel. Required under generally accepted accounting principles. a company may not vote its own shares held in treasury. this is a calculation of the cost to the organization of employee turnover. You may also view the detail objects that have changed. Trigger See Event Trigger. projects. Tree Compare Utility A PeopleSoft Enterprise Warehouse utility that enables you to compare effective dates for trees. or moved from one parent to another. Turnover Costing In PeopleSoft Workforce Analytics. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 217 . Tree The graphical hierarchy in PeopleSoft systems that displays the relationship between all accounting units (for example. Tree Controls give the user a view of hierarchical data structures and enable them to drill down through the hierarchy to a particular row of data.GLOSSARY Treasury Stock Shares of a company’s stock that have been repurchased or otherwise reacquired by the company and are "held in treasury. account numbers) and determines roll-up hierarchies. reporting groups. deleted. Tree Denormalizer The Tree Denormalizer Application Engine process converts trees into multi-column data format so they can be used by third-party OLAP or ROLAP tools." Whether the treasury shares count as "issued" or as "outstanding" shares of the company is a matter of state corporate law. Trustee Extract A PeopleSoft Pension Administration data extract containing data that a third party needs in order to produce pension checks. in dollars. The results page shows nodes that have been added. Treasury Stock Method The method of calculating primary and fully diluted earnings per share when common stock equivalents such as unexercised stock options exist. Generally. GLOSSARY 218 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .g. Underwater Option When the current market price is below the option exercise price. Two-Tier A two-tier architecture refers to the traditional client/server model in which a client workstation connects to and sends SQL directly to the database server. a 99. system administration. U Underlying Security The security underlying a stock option that an optionee has the right to buy. these occur when the economic capital is exhausted and the insolvency rate is exceeded. logging and other application server processing.03% estimated probability that the unexpected losses will exceed economic capital (or shareholder equity). When an option is underwater. Such options are also described as being "out-of-the-money.GLOSSARY Turnover Rate In PeopleSoft Workforce Analytics. it would cost more than the underlying stock is worth to exercise the option. Underpayment Adjustment Limit The maximum amount or percent above which underpayment adjustments are not allowed for a given business unit. Type of Appointment Indicates the specific type of appointment. Unexpected Losses In the financial services industry. server process initiation. or the security underlying a convertible security. etc." Underwriter An investment banking firm that actually buys the shares from the company in a public offering and then resells them (at a slightly higher price) to its customers.. Unexpected losses are determined by a targeted insolvency rate (confidence level). full time temporary. the rate that employee’s are leaving the company. part-time permanent. time-outs. for example. compression.7% confidence level indicates that there is a 0. data encryption. e. TUXEDO BEA's middleware product used to manage transaction queues. Union code may be used by human resources to group similar jobs or bargaining units together.GLOSSARY Union Code Part of a group of defaults assigned to job codes. units of measure might describe dimensions. are not exercisable. Unscheduled Punch A punch that is made be a time reporter who was not scheduled (see Time Reporting) Unvested Shares Unvested stock options are options that have not vested and. or business activities. or amounts of locations. Unit of Measure (UOM) A type of unit used for quantifying in PeopleSoft systems. pounds. Univariate Forecasting Technique In Enterprise Planning and Simulation. The concept of unit is generic enough that the units can be other measures besides number of employees. Unit of work Each transaction group includes one or more individual units of work. Unit Code In the financial services industry. usually originating from a different application. Examples include inches. Unitize Assets The process of unitizing a single load line. For example. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 219 . A unit of work is a single transaction that you want to commit or rollback as a whole. and standard cost dollars. Or in the hotel industry the unit could be the number of rooms. and signoff) the universal navigation header can also display a welcome message for each user. into multiple assets in PeopleSoft Asset Management. Favorites. intended to appear at the top of every page as long as the user is signed on to the portal. workhours. weights. A typical measure would be the number of employees in a company. dependent on individual company parameters. Universal Navigation Header Every PeopleSoft portal includes the universal navigation header. Depending on the application. Unit Code is used as an alternate means of measuring the relative size of companies participating in external surveys. the Univariate Forecasting Technique is a forecasting method that uses only the recorded history for the value to forecast its future. volumes. therefore. in the hospital industry the unit could be the number of hospital beds. In addition to providing access to the standard navigation buttons (like Home. containers. These fields provide for storage of additional data that is not supplied by the standard set of fields in the system.a definition of a set of user-defined fields that contain data specific to the installation. User-Field Code PeopleSoft Demand Planning. The following is an example of a URL: http://serverx/InternetClient/InternetClientServlet?ICType=Script&ICScriptProgramName=W EBLIB_BEN_401k.GLOSSARY URI A URI does not include the query string (the text following a ? on the URL). but does not include any parameters being passed to that resource.data held in user-defined fields. and assign a weight or importance to the roles. by which you assign an overall monetary value to a competency strategy for your organization. the URI portion of the URL is as follows: http://serverx/InternetClient/InternetClientServlet URL In this document. the term URL refers to the entire query string. User-Defined History A summary of customer receivables activity that is defined by the user.PAGES. From the above example. GLOSSARY 220 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL .FieldFormula. User Data PeopleSoft Demand Planning. Value allocation A process in PeopleSoft Workforce Planning. V Valuation The way a company represents the value of a non-monetary award such as stock.iScript_Home401k URSSAF Code The URSSAF is the body responsible for ensuring payment of Social Security contributions by all French employers. The fields can also become part of the key for the Forecast Item at each level within the Forecast View. Useful Life The amount of time an asset may be depreciated. You can think of it as a subset of the URL that points to the resource. A plan in which either the number of shares and/or the price at which they will be issued is not known on the grant date. When calculating VAT at gross. The amount of VAT calculated using this method is the amount that is to be paid. The system then allocates a breakdown of the value to roles. The early payment discount is not taken PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 221 . Variable Plan. VAT Account Type A code that identifies the different types of accounting entries that must be created for VAT transactions.GLOSSARY competencies and accomplishments in the strategy. that is paid out in variable amounts. Value Objects are a metadata layer that provides descriptive information about fields and values. The account type is used in conjunction with the VAT code and VAT transaction type to determine the VAT ChartFields used for a given VAT accounting entry. VAT Calculation Method Options are Net or Gross. Variable Compensation In PeopleSoft Workforce Analytics. and accomplishments in the strategy based on their relative weighting or importance. regardless of whether the early payment discount is actually taken at time of payment. direct compensation that is not fixed. or number. Variable Temporary storage for use or defined information used in the creation and application of rules (see Time Administration) Variable [Global Payroll] An element type that defines and stores values such as a character. such as bonuses and commissions. These codes are also used to categorize transactions in the VAT transaction table. the VAT is initially calculated based on the gross transaction amount. You can use variables to create generic formulas for situations where you use the same values over and over again in a calculation. Value Object In the PeopleSoft Enterprise Warehouse. VAT apportionment is the mechanism that allows you to specify the ratio of taxable activity to exempt activity for individual ChartFields. When calculating VAT at net. competencies. VAT Apportionment For mixed activity. the early payment discount is applied to the goods amount before calculating the VAT. Value Objects are used as constants in Data Manager target object definition. date. If you choose invoice. but only one country can be designated as the VAT entity’s home country. the transaction is still logged in the VAT transaction table. if you choose payment. but no tax is applied. VAT Entity The level or entity within an organization at which VAT reporting is performed. VAT Code The tax code used to define a percentage the system uses to determine the VAT amount. If inclusive. and VAT transaction type. The transaction is still logged in the VAT transaction table. VAT Rebate Percent Within Canada. the VAT is not stated separately but is included with the goods amount. the VAT amount is stated separately from the goods amount. Options include Invoice or Payment. and the ChartFields for a VAT code don’t reside with the tax authority but are determined by the combination of the VAT code.GLOSSARY into account at this point. VAT Declaration Point When VAT transaction information is declarable for reporting purposes. A zero-rated VAT code should be associated with transactions where exoneration applies. in some countries an adjustment is made to the VAT amount at the time of payment. Although no tax is applied to the transaction. the percentage of VAT that is not normally recoverable but which may be refunded in the form of a tax rebate. VAT account type. VAT entities can be registered for VAT in multiple countries. For these cases. GLOSSARY 222 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . However. VAT Calculation Type Options include Exclusive or Inclusive. with a few exceptions. for Public Service Bodies. VAT Exonerated A transaction where the purchaser has been determined as not subject to VAT. there may be an exoneration certificate number tied to the purchasing entity (either the customer or the VAT entity) as proof of exoneration. You may also specify any VAT exceptions—either exoneration or suspension from paying VAT—for any country in which the entity is registered. The tax authority tied to the VAT code generally consists of a single authority. VAT and Intrastat reporting information and VAT default information are defined for each country in which the VAT entity is registered. VAT Exempt Supply or Purchase A transaction where the product or item is non-taxable or exempt from VAT. If exclusive. the system will recognize VAT at the time of payment. the system will recognize VAT at invoice time. if the early payment discount is taken. No VAT code is associated with the transaction. The VAT code is similar to the sales and use tax code. VAT Transaction Type Used to categorize VAT transactions according to particular VAT accounting and reporting requirements. VAT Transaction Table Stores detailed transaction information for VAT reporting. VdkVgwKey values must be unique across all collections that will be searched in any one application. and enables discounted or standard submission for bank processing.GLOSSARY VAT Recoverability Percent The percent of VAT that’s recoverable. Vendor Draft A draft issued by a vendor. you may associate either the ratio of taxable activity to exempt activity directly with the Use ID. or mixed. PeopleSoft Receivables generates vendor drafts. and how and if the transaction is reported on the VAT return. exempt. VdkVgwKey A key within a Verity BIF file for every document to be indexed. what accounting entries are required. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 223 . It is the primary source of information for all VAT reports. VAT Treatment A description of how the transaction must be treated for VAT purposes. or you may indicate that this ratio is determined at the ChartField level. The VAT code and the VAT transaction type are used in conjunction with the VAT account type to obtain the ChartFields for accounting entries. PeopleSoft Payables receives vendor drafts and associates the appropriate vouchers. Where activity is mixed. VAT Use ID A code used to identify the type of activity in which a purchased good or service will be used. VAT Registration Countries Country codes associated with a VAT registration number for a particular customer or VAT entity. Verity The third-party search engine integrated with the PeopleSoft Portal. This is used to determine how VAT defaults are applied. Each application is responsible for writing to this table and also to a cross-reference table used to link entries in the VAT transaction table with entries within each application. Activities are categorized as taxable. provides a flexible worksheet environment for approval management. and therefore to determine a recoverability percent and a rebate percent (when applicable) that will be applied to a transaction line. Fields are defined in the BIF file and stored in the collection for retrieval and searching. After defining synonym lists in the control file. When provided. Searching a zone is faster than field searching. When the zone filter is used. Budget versions are used to perform what-if analysis and comparisons of budget amounts before the user selects one version to submit as the Budget Center’s budget plan. The contents of a zone cannot be returned in the results list of an application. Verity Topics Verity applications can provide end users with predefined search criteria called topics. the Verity engine builds zone information into the collection's full-word index. PeopleSoft Budgeting-specific.<=. Verity Thesaurus The custom thesaurus consists of lists of synonyms defined in a synonym control file and can be used for synonym searching. you use the mksyd utility to create a custom thesaurus (a control file which has the .>.>=). Suspend Vesting must be selected for this rule to be applicable. Suspend Vesting must be selected for this rule to be applicable. topics can be shared by all users. Vest Deferral Grace Period The specified period of time within which an optionee must return from leave to avoid having the vesting differed. Only applicable if the Stock Action is LOA. Only applicable if the Stock Action is LOA. and can be returned on a results list. GLOSSARY 224 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . permits quick and efficient searches over zones. and can be returned on a results list. Verity Zones Zones are specific regions of a document to which searches can be limited.syd extension) that the search engine uses.GLOSSARY Verity Fields Verity fields are stored in the collection for retrieval and searching. enhanced with zone information. Vest Deferral Grace Period Service Rule If the company provides a vest deferral grace period. Version There can be up to five budget versions for each Budget Center level in a Budgeting Model. they may stipulate that only certain individuals are eligible for the grace period based on service with the company. It consists of words and phrases grouped together using the Verity query language in a tree-like structure. The index. Fields. Zones are defined in the DAT file. A topic is a named object that represents a concept. like date and numeric fields can be used with the comparison operators (<. or subject area and can be used for synonym searching. When this occurs.” Vesting The method by which a granted option becomes free of all restrictions and the Optionee has full rights to the shares. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 225 .” or simply “TV.” “Term Vested. The benefit is deferred until the participant reaches retirement age. The three types of views are working. the vesting of option shares accelerates upon termination of employment. you must modify the vesting schedule before you terminate the individual. Vested Shares Option shares that are free of any ownership restriction. Vesting Schedule (Template) A convenient way to set up the framework for a vesting schedule that can be uniformly applied to individual options. For PeopleSoft Budgeting see Budget View. vested exercised shares are fully owned by the optionee. and the number of employees and new hires in the last 12 months who are special disabled military veterans or Vietnam era military veterans. Vesting Service The service used to determine an employee’s vesting percentage. Some companies' plans provide that under certain circumstances. or upon a case by case scenario. Generally. you define a vesting schedule to determine the default-vesting schedule for the option. VETS–100 Federal Contractor Report This report is required of employers in the United States. Each view is associated with a unique view ID and includes information that defines the view and structure type. The employee is considered “Terminated Vested. It lists federal job classifications. View PeopleSoft Demand Planning. When you grant stock options. It also provides totals for each job classification of both veterans and non-veterans who hold these jobs. and dynamic.GLOSSARY Vest Immediately A stock option plan may provide that upon specific types of terminations. disbursement. free from restrictions and freely tradable. all unvested shares held by an individual can be made immediately vested as of a specific date. Rules for accruing vesting service may be different from rules for accruing other plan service credits. such as retirement. Vested Termination The termination of an employee who has a vested benefit.a multilevel forecast structure. data warehouse tools. such as in cases of RIF or administrative error on part of the agency.GLOSSARY Virtual Tasks In Time and Labor. on a case-by-case basis. and Data Mart definitions. Waivers are granted by OPM or an agency. Warning Exception A transaction that exceeds the available funds but is allowed to continue to be posted against the budget. you aren’t required to have a vision component on each strategy tree. W WA (Workforce Analytics) See PeopleSoft Workforce Analytics Waiver Of An OPM Qualification Standard Involves setting aside requirements in a published standard to place an employee in a particular position. Vision In PeopleSoft Balanced Scorecard. Warnings are informational only. and do not directly affect other positions in the organization. See also Strategy Tree Volume Total share volume traded in a stock during market hours. PeopleSoft CRM Warehouse. GLOSSARY 226 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . and PeopleSoft Supply Chain Warehouse. Extra training and/or skills development may be needed to help the employee adjust to the new position. By minimizing the physical storage of daily task data we provide enhanced performance without limiting its functionality. A single row of data is linked to multiple Earnings records for multiple employees. PeopleSoft HRMS Warehouse. Virtual task data is associated with a taskgroup profile that defines common characteristics for a given Taskgroup and Task Profile ID. It consists of predefined ETL maps. as appropriate. Warehouses A warehouse reporting and analysis solution that supports the specific PeopleSoft business application that warehouse is using. usually to avoid some kind of hardship to the employee. Usually the highest level on a strategy tree. the overall mission of an organization. Vision is optional. The warehouses are we deliver are: PeopleSoft Financials Warehouse. WFA (Workforce Analytics) See PeopleSoft Workforce Analytics WGI Due Date Identifies the date of an employee's next within grade increase. Weight and Volume pricing requires using estimated shipments. determining how the schedules score will be calculated. the board is known as Commission de la Santé et de la Sécurité du Travail (CSST). for a period of years or to perpetuity. Weighted Average Cost of Funds The projected principle payments for an instrument are used to derive a series of matched maturity funding rates. A warrant is usually issued as a sweetener. usually issued together with a bond or preferred stock.GLOSSARY Warrant A type of security. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 227 . WCB In Canadian provinces the Worker’s Compensation Board (WCB) operates as an independent board. For example. Weight In PeopleSoft Planning. Warrants are freely transferable and are traded on the major exchanges. WGI Non-Creditable Days Total number of days that cause the WGI due date to be adjusted forward. and thus would have different requirements in each province. a user-defined value for the constraints that can be violated. Violations that are more critical to your schedule merit a higher weight. in British Columbia the organization is called the Worker’s Compensation Board of British Columbia and in the Province of Quebec. which in turn are used to calculate the overall base PeopleSoft Funds Transfer Pricing (FTP) rate. Weight and Volume Pricing You can price shipments by weight or volume to create price prices. The Weighted Average Cost of Funds (WACF) method calculates a weighted average FTP rate where each of the funding rates is weighted by the principle payment amount and the term to maturity of the payment. usually higher than the market price at the time of issuance. Current policy is that the step increase is implemented on this date automatically unless prevented by the processing of an unsatisfactory performance appraisal. that entitles the holder to buy a proportionate amount of common stock at a specified price. to enhance the marketability of the accompanying fixed income securities. Inventory. Pull Ticket. with interest. you will receive a range of available values. you can only use Pull Tickets. Manual. by entering ‘2%’ in a six-character field. to an employee who is terminating. Windows Client Traditional PeopleSoft 32-bit client. and Kanban Card. the act of returning pension contributions. Windows clients connect to the application server domain (Tuxedo) using a port number (or connection string) specified in PeopleSoft Configuration Manager. WIP Replenishment Mode Determines how PeopleSoft Flow Production is triggered to generate a replenishment request for an item. GLOSSARY 228 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . With feeder line replenishment. For example. Withdrawal An election not to continue participation in a stock purchase plan. and Vendor.GLOSSARY Whole Calendar Month An instruction telling the system to use every day in each month for this time period. WIP Replenishment Method Designates how the PeopleSoft Flow Production request is communicated. repayment of contributions and interest typically reinstates the forfeited service. For a replenishment method of Inventory. Window Period The ten-day period. Wildcard You can replace the right-hand characters in a search field with a percent (%) wild card to query a range of values beginning with the remaining. left-hand characters. The system fills in the last day of the period according to the information you have entered. Withdrawal of Contributions In a pension plan. the Workflow. from the third to twelfth day after public release of a company's financial statement. such as 200000 through 299999 or 2aaaaa through 2zzzzz. WIP Replenishment Source Determines where you send your PeopleSoft Flow Production replenishment request and what source supplies your WIP location. Replenishment options include Backflush. and Pull List replenishment methods are available. If the employee is later rehired. Options include Feeder. An employee who withdraws contributions typically forfeits all service associated with those contributions. when insiders may exercise their stock-appreciation rights without violating Securities and Exchange Commission rules for short-term trading. Work Group In PeopleSoft Enterprise Performance Management. and the number of scheduled hours per work period. Medicare taxes. a feature for reviewing and working with exceptions created during the processing of forecasting and inventory data. federal social security. Until clock hour reporting is implemented. This includes individuals contracting business directly from the company or through an agency. Work Council (Comité d'Enterprise) In France it is mandatory for companies with more than 50 employees to elect a Work Council to represent the employees in negotiations with management. time working and time not working). workers are defined as anyone who performs functions for the organization. The initial Time and Labor product will apply the work period to a calendar day. Workers can be direct employees or independent contractors. the work group is a grouping of employees that share a similar activity profile. Worker In PeopleSoft Workforce Analytics. Work Period A Days On/Days Off template. Typical withholding taxes include federal income taxes. Within Grade Increase (WGI) A longevity-based increase in salary based on predetermined time in grade requirements and acceptable performance. Work Effort See Activity Type. and state and local income taxes. Work Schedules and Work Periods should not be confused with calendar days. and receives compensation from the organization's operating expense funds in return. the application does not care about the number of hours. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 229 . The work period can be any number of hours. the smallest unit of time that a business uses to communicate with their employees regarding when to be and/or not to be at work (that is. Work Schedule A template consisting of a sequence of work periods (days) on and off. Work Queue In PeopleSoft Demand Planning and Inventory Planning.GLOSSARY Withholding A deduction taken by employers out of taxable income of an individual. Jane’s long-term schedule assignment is Monday – Friday.GLOSSARY Worksheet A way of presenting data to the user through a BAM interface that enables users to do in-depth analysis using pivoting tables. charts.00.00 to 18. notes.00 on Thursday. she’ll see the revised schedule. Worker Workers can be defined as anyone who performs functions for the organization and receives compensation from the organization's operating expense funds in return. For instance. Workforce Monthly Report (Déclaration Mensuelle Obligatoire des Mouvements de Main D’oeuvre) In France. The report contains workforce information for a given establishment of a company. her manager needs to schedule her to work 7. Work Templates Work templates describe your employee’s work patterns. including GLOSSARY 230 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Workday A 24-hour period rounded by daybreaker with one or more associated shifts (see Scheduling) Workday Override A function that allows a Time Manager to override a Time Reporter’s schedule for a single workday. Due to an increase in production demand. Workflow The background process that creates a list of administrative actions based on your selection criteria and specifies the procedure associated with each action. Workflow The background process that creates a list of administrative actions based on your selection criteria and specifies the procedure associated with each action. For example. and history information. 8. 9 AM to 5 PM. Work templates could apply to individuals or entire organizations. 16 March 2000. Workers Compensation The days an employee is on LWOP due to sustaining an injury or illness while on the job. so when Jane checks her schedule for this week. companies that employ 50 or more employees are required to submit the Workforce Monthly Report to the Administrative Division of the Ministry of Work and Social Relations. Monday through Friday is a fairly standard working week in organizations. Workers can be direct employees or independent contractors (includes individuals contracting business directly from the company or through an agency). Her manager needs to be able to make this change to her schedule in the PeopleSoft Time and Labor system.00 to 17. A workgroup may be equivalent to all the employees in a business enterprise. Federal student-trainee programs are examples of such programs. education. and then return to the worklist for another item. the works councils for your company are internal committees elected by the employees that represent the interests of salaried and hourly paid employees. or a supplement to. and then return to the Worklist for another item. PEOPLESOFT PROPRIETARY AND CONFIDENTIAL GLOSSARY 231 . Worklist The automated "to do" list that Workflow creates. From the worklist you can directly access the pages you need to perform the next action.GLOSSARY the total number of employees and details of employees who have joined or left the establishment during the month. Work-Study Program Government or non-government programs supervised work experience related to a student's course of study and are a part of. all employees in a Paygroup. Works Councils (Betriebsrat) In Germany. other than management. Every work location in your company has it's works council (this would be the local works council) and the company as a whole has a central works council. or all employees who work at a specific work location. X Y Yearly Maximum Pensionable Earnings (YMPE) Amount set by the government upon which Canadian Pension Plan (CPP) contributions are made. Worklist The automated “to do” list which Workflow creates. From the Worklist you can directly access the panels you need to perform the next action. all employees belonging to the same Union or Union Local. Workgroup A user-defined group of employees who share identical compensation rules. PeopleSoft Budgeting-specific. Used to track taxable VAT activity where no actual VAT amount is charged. Zero-Rated VAT A VAT transaction with a VAT code that has a tax percent of zero. GLOSSARY 232 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . Zip Code The term for postal codes in the United States.GLOSSARY Z Zero-Based Budgeting A budgeting option that builds a budget from the ground up starting with zero values. This is in contrast to an incremental budget that is based upon using prior year actual or budget values as starting point. 2-76. 2-121. 2-122 atan 2-130 AT-END argument. NEXT-COLUMN command 2-171 # #DEBUG 2-55 #DEFINE 2-92. ON-BREAK argument 2-192 BEFORE-BOLD argument DECLARE-PRINTER command 2-79 BEFORE-BOLD argument PRINT command 2-180 BEFORE-PAGE argument DECLARE-PROCEDURE command 2-84 DECLARE-TOC command 2-87 USE-PROCEDURE command 2-233 BEFORE-REPORT argument DECLARE-PROCEDURE command 2-84 USE-PROCEDURE command 2-233 BEFORE-TOC argument. 2-118 #end-file 2-213 #ENDIF 2-102.Index ALTER-CONNECTION 2-4. 2-122 #ELSE 2-99. DECLARE-TOC command 2-87 BEGIN-DOCUMENT 2-20 BEGIN-FOOTING 2-24 BEGIN-HEADING 2-25 BEGIN-HEADING command see also Page Header 2-25 BEGIN-PROCEDURE 2-27 BEGIN-PROGRAM 2-30 A abs 2-129 absolute value abs 2-129 absolute value 2-129 acos 2-129 ADD 2-2 AFTER 2-21. ON-BREAK argument 2-192 AFTER-BOLD argument DECLARE-PRINTER command 2-80 AFTER-BOLD argument PRINT command 2-180 AFTER-PAGE argument DECLARE-PROCEDURE command 2-84 DECLARE-TOC command 2-88 USE-PROCEDURE command 2-233 AFTER-REPORT argument DECLARE-PROCEDURE command 2-84 USE-PROCEDURE command 2-233 AFTER-TOC argument DECLARE-TOC command 2-87 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INDEX 1 . 2-22 BEFORE qualifier. 2-122 #INCLUDE 2-122 : :#INCLUDE command 2-122 :BOX and SHADE 2-181 :-Cnn 2-31 :COMMIT command 2-48 :-DBdatabase 2-32 :-LOCK 2-32 :-NR 2-32 :ROLLBACK command 2-215 :-SORTnn 2-32 B BATCH-MODE. SHOW command 2-222 BEFORE 2-21. INPUT command 2-125 BEEP argument. 2-219 ALTER-LOCALE 2-6 ALTER-PRINTER 2-13. 2-22 AFTER qualifier. 2-115. 2-118 #END-IF 2-102 #IF 2-118 #IFDEF 2-121 #IFNDEF 2-118. 2-121. 2-82 ALTER-REPORT 2-15 arccosine 2-129 arcsine 2-130 arctangent 2-130 array 2-139 array elements 2-52 arrays ARRAY-ADD command 2-16 ARRAY-DIVIDE 2-16 ARRAY-DIVIDE command 2-16 ARRAY-MULTIPLY 2-16 ARRAY-MULTIPLY command 2-16 ARRAY-SUBTRACT command 2-16 maximums 2-52 ascii 2-139 asciic 2-139 asin 2-130 ASK 2-19. ALTER-LOCALE command 2-8 datetostr 2-142 DAY-OF-WEEK-CASE argument. 2-30 BEGIN-SETUP 2-34 BEGIN-SQL 2-35 bind variables 2-32 BLINK argument. DECLARE-LAYOUT command 2-73 CHECKSUM argument. PRINT-CHART command 2-204 DATA-ARRAY-ROW-COUNT argument. field changes 2-191 COMMAND 2-21. ALTERLOCALE command 2-9 DB2 2-48. 2-38 DEBUG 2-118 INDEX 2 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 2-171 COLUMNS argument.SQR FOR PEOPLESOFT LANGUAGE REFERENCE BEGIN-SELECT 2-21. ALTERLOCALE command 2-9 DAY-OF-WEEK-SHORT argument. 2-215 -DBconnectionstring argument. SHOW command 2222 CLOSE 2-46 -Cnn argument BEGIN-SELECT command 2-31 BEGIN-SQL command 2-37 CODE-PRINTER argument. BEGIN-SELECT 2-33. 2-121. POSITION command 2177 D data input 2-123 data types supported by INPUT command 2-123 DATA-ARRAY argument. PRINT-CHART command 2-204 DATA-ARRAY-COLUMN-LABELS argument. 2-217 cos 2-131 cosh 2-131 cosine 2-131 CREATE-ARRAY 2-51. PRINT-CHART command 2-204 DATA-ARRAY-COLUMN-COUNT argument. ALTERLOCALE command 2-9 DAY-OF-WEEK-FULL argument. PRINT command 2181 ALTER-COLOR-MAP ALTER-COLOR-MAP command 2-2 COLOR argument DECLARE-PRINTER command 2-78 DECLARE-COLOR-MAP DECLARE-COLOR-MAP command 2-65 GET-COLOR GET-COLOR command 2-113 SET-COLOR SET-COLOR command 2-217 columns 2-231 COLUMNS 2-47. PRINTCHART command 2-204 database cursors 2-50 DATE argument DECLARE-VARIABLE command 2-90 DISPLAY command 2-94 MOVE command 2-165 PRINT command 2-182 SHOW command 2-222 date edit format characters 2-187 dateadd 2-141 datediff 2-141 DATE-EDIT-MASK argument. 2-211 CREATE-COLOR-PALETTE 2-54 C CALL 2-40 CALL SYSTEM USING 2-40 CAPTION argument. ALTER-LOCALE command 2-8 datenow 2-141 DATE-SEPARATOR argument. 2-5. PRINT-BAR-CODE 2-199 ceil 2-130 CENTER argument. 2-22 COMMIT 2-48 compiler directive 2-118 compiler directives 2-99. 2-67. PRINT command 2-181 charts 2-201 CHART-SIZE 2-59 CHAR-WIDTH argument. 2-120. 2-113. SHOW command 2-222 CLEAR-SCREEN argument. 2-118. 2-102. EVALUATE command 2-104 break processing. 2-53 CLEAR-LINE argument. 2-235 CONNECT 2-50 CONNECTION 2-21 connection_name 2-3. PRINT-BAR-CODE 2199 chr 2-140 CLEAR-ARRAY 2-46. SHOW command 2-222 -Bnn BEGIN-SELECT command 2-31 BOLD argument PRINT command 2-180 SHOW command 2-222 BOTTOM-MARGIN argument DECLARE-LAYOUT command 2-72 BOX argument GRAPHIC command 2-116 PRINT command 2-181 BREAK 2-40 BREAK argument. 2122 CONCAT 2-49 concatenation 2-226 cond 2-140 conditional processing 2-104. DECLARE-TOC command 2-87 DSN 2-3. 2-4. 2-67 dynamic query variables 2-32 ELSE 2-100 ENCODE 2-100 END-DECLARE 2-65. ALTER-LOCALE command 2-9 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INDEX 3 . 2-122 DECIMAL argument. BEGIN-SELECT command 2-31 DIVIDE 2-97 DO 2-29. 2-202 DECLARE-CONNECTION 2-21. 2-98 DO argument. 2-67 DECLARE-IMAGE 2-68 DECLARE-LAYOUT 2-69 arguments with 2-72 DECLARE-PRINTER 2-58. DECLAREVARIABLE command 2-90 deg 2-131 delete 2-137 destination field 2-164 DISPLAY 2-93 DISTINCT argument. 2-37 EDIT-OPTION-BC argument. 2-30. 2-138 rename 2-138 files. 2-9. EXECUTE command 2-106 document marker 2-20. 2-103 Examples 2-4 EXECUTE (SYBASE and Microsoft SQL Server) 2-105 exists 2-138 EXIT-SELECT 2-108 exp 2-132 exponents 2-132 expressions 2-127 EXTENT argument. CREATE-ARRAY command 2-53 fieldsSee columns 2-53 file number 2-174 file-related functions delete 2-137 exists 2-137. LOAD-LOOKUP command 2-160 external source files 2-122 EXTRACT 2-109 F FIELD argument. ALTER-LOCALE command 2-9 EDIT-OPTION-NA argument. ALTER-LOCALE command 2-9 EDIT-OPTION-AM argument. 2-5. ALTERLOCALE command 2-8 DECLARE-CHART 2-56. ALTER-LOCALE command 2-8. DECLARE-VARIABLE command 2-90 DECIMAL-SEPARATOR argument. 2-180 DECLARE-PROCEDURE 2-83 DECLARE-REPORT 2-85 DECLARE-TOC 2-87 DECLARE-VARIABLE 2-89 default database 2-37 DEFAULT-NUMERIC argument DECLARE-VARIABLE command 2-90 DEFAULT-NUMERIC argument. 2-67. 2-101 END-DELCARE 2-67 END-DOCUMENT 2-101 END-EVALUATE 2-101 END-EXECUTE 2-21 END-FOOTING 2-101 END-HEADING 2-101 END-IF 2-102 ending a query 2-108 END-PROCEDURE 2-102 END-PROGRAM 2-102 END-SELECT 2-21. OPEN command 2-175 flagging SQR 1-5 FLOAT argument DECLARE-VARIABLE command 2-90 floor 2-132 FONT argument DECLARE-PRINTER command 2-79 fonts 2-82 HP Laser Jet 2-80 PostScript 2-80 E edit 2-142 EDIT argument PRINT command 2-182 SHOW command 2-222 edit masks case sensitivity 2-187 changing dynamically 2-188 uses 2-185 edit types 2-182 EDIT-OPTION-AD argument. 2-102 END-SETUP 2-102 END-SQL 2-102 END-WHILE 2-102 ERASE-PAGE argument NEXT-COLUMN command 2-171 EVALUATE 2-40. 2-76. ALTER-LOCALE command 2-8 EDIT-OPTION-PM argument. OPEN command 2-174 FIXED_NOLF argument. reading 2-212 FILL argument 2-190 FIND 2-110 FIXED argument. 2-65.SQR FOR PEOPLESOFT LANGUAGE REFERENCE -DEBUG 2-121. 2-66. 2-177 DOCUMENT paragraphs 7-3 DOT-LEADER argument. 2-215. DECLARE-PRINTER command 2-77 INOUT 2-21 INPUT 2-123 INTEGER argument. OPEN command 2-174 FORMFEED argument DECLARE-LAYOUT command 2-72 FOR-READING argument OPEN command 2-174 FOR-REPORTS argument DECLARE-PRINTER command 2-77 DECLARE-PROCEDURE command 2-84 DECLARE-TOC command 2-87 USE-PROCEDURE command 2-233 FOR-REPORTS. GRAPHIC command 2117 HPLASERJET 2-77 hyperbolic cosine 2-131 hyperbolic sine 2-135 hyperbolic tangent 2-136 I IF 2-120 IF nested within a WHILE loop 2-236 IFDEF 2-118 images 2-68 images printing 2-209 IMAGE-SIZE argument DECLARE-IMAGE command 2-69 PRINT-IMAGE command 2-210 IN 2-21 INDENTATION argument DECLARE-TOC command 2-87 Informix 2-48.SQR FOR PEOPLESOFT LANGUAGE REFERENCE Windows printers 2-81 FONT-TYPE argument DECLARE-PRINTER command 2-78 FOOTING 2-24 footings 2-24 FOR-APPEND argument. 2-22 getenv 2-142 GOTO 2-115 GOTO-TOP argument. EXECUTE command 2-107 isblank 2-144 isnull 2-144 G GET 2-111 GETDATA 2-21. miscellaneous array 2-138 ascii 2-139 asciic 2-139 character 2-140 cond 2-140 edit 2-142 get environment variable 2-142 isblank 2-144 isnull 2-144 substrb 2-151 substrp 2-152 to_char 2-153 to_multi_byte 2-153 to_number 2-153 to_single_byte 2-154 wrapdepth 2-155 H HEADING 2-26 headings 2-26 Hebrew language support 2-197 HEIGHT argument. -Cnn 2-31 BEGIN-SQL command. DECLARE-VARIABLE command 2-90 INTO argument. NEXT-COLUMN command 2-171 GRAPHIC VERTLINE 2-115 GRAPHICBOX 2-115 GRAPHICHORZLINE 2-115 K -KEEP 2-85 KEY argument. OPEN command 2174 FROM PARAMETER 2-22 FROM ROWSET 2-22 FROM ROWSETS 2-21 functions arguments 2-129 transcendental 2-137 functions. BEGIN-HEADING command 2-26 FOR-WRITING argument. -Cnn 2-37 -Cnn 2-31 COMMIT command 2-48 ROLLBACK command 2-215 INIT-STRING argument. LOAD-LOOKUP command 160 2- L labels 2-115 LAST-PAGE 2-126 INDEX 4 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . PRINT-BAR CODE command 2-199 HORZ-LINE argument. 2-225 Ingres 2-215 BEGIN-SELECT command. INPUT command 2-124 MAX-LINES argument. ALTER-LOCALE command 2-8 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INDEX 5 .SQR FOR PEOPLESOFT LANGUAGE REFERENCE LAYOUT argument. ALTER-LOCALE command 2-8 -LOCK BEGIN-SELECT command 2-32 BEGIN-SQL command 2-37 locking types defining 2-37 log 2-133 log base 10 2-133 log base e 2-133 log10 2-133 logical expressions 2-120 LOOKUP 2-159. ON-BREAK argument 2-192 LINE-HEIGHT argument. ALTERLOCALE command 2-8 MONTHS-CASE argument. DECLARE-REPORT command 2-85 LEFT-MARGIN argument DECLARE-LAYOUT command 2-72 length 2-144 lengthb 2-145 lengthp 2-145 lengtht 2-145 LEVEL argument. SHOW command 2-222 NOWAIT. ALTER-LOCALE command 2-9 MONTHS-SHORT argument. DECLARE-LAYOUT command 2-73 MBTOSBS 2-164 mod 2-133 MONEY argument DISPLAY command 2-94 MOVE command 2-165 PRINT command 2-191 SHOW command 2-222 MONEY-EDIT-MASK argument. INPUT command 2-125 NORMAL argument. CALL command 2-43 -NR argument BEGIN SQL command 2-37 BEGIN-SELECT command 2-32 NULL 2-21 NUMBER argument DISPLAY command 2-94 dst_any_var command 2-165 format_mask command 2-165 MOVE command 2-165 PRINT command 2-191 SHOW command 2-222 NUMBER-EDIT-MASK argument. NEXT-LISTING command 2173 nesting arguments 2-129 IF command 2-120 nesting levels #INCLUDE command 2-122 NEW-PAGE 2-169 NEW-REPORT 2-170 NEXT-COLUMN 2-47. TOC-ENTRY command 2-228 LEVEL qualifier. DECLARE-LAYOUT command 2-72 loading an internal table 2-159 LOAD-LOOKUP 2-158. NEXT-LISTING command 2-173 NO-DUPLICATE 2-5. 2-68 NOLINE argument DISPLAY command 2-95 SHOW command 2-222 -NOLIS 2-85 NOP argument. DECLARE-LAYOUT command 2-73 LINEPRINTER 2-77 LINE-WIDTH argument. BEGIN-SELECT command 233 lower 2-146 LOWERCASE 2-163 lpad 2-146 ltrim 2-146 MONEY-SIGN-LOCATION argument. ALTERLOCALE command 2-8 MONEY-SIGN argument. PRINT command 2-191 NOPROMPT arguments. 2-171 NEXT-LISTING 2-172 no recovery mode 2-37 NO-ADVANCE argument. PRINT command 2-190 MAX-COLUMNS argument. DECLARE-LAYOUT command 2-72 MAXLEN arguments. ALTER-LOCALE command 2-9 MONTHS-FULL argument. ALTERLOCALE command 2-8 numeric functions 2-129 10 raised to x power 2-132 M MATCH argument. ALTER-LOCALE command 2-9 MOVE 2-164 multiple reports 2-14 MULTIPLY 2-168 N NAME 2-4 NAME argument 2-46 CREATE-ARRAY command 2-52 LOAD-LOOKUP command 2-160 natural log base e raised to x power 2-132 NEED argument. 2-162 LOOPS argument. 2-162 local procedures 2-28 LOCALE argument. EXECUTE command 2-107 PARAMETER_LIST 2-22 PARAMETERS 2-5. OPEN command rename 2-138 2-174 INDEX 6 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . 2-37. ordering xv PITCH argument. 2-21. 2-225 P page numbering 2-126 page overflow 2-170 PAGE-DEPTH argument. 2-215 ORIENTATION argument DECLARE-LAYOUT command 2-72 OUTPUT argument. AFTER qualifier with 2-192 ON-BREAK. 2-67 PASSWORD 2-5. DECLARE-LAYOUT command 2-72 PAGE-NUMBER 2-176 PAPER-SIZE argument. 2-22 procedures running 2-98 USE-PROCEDURE command 2-233 prompt 2-123 PUT 2-210 Q QUIET argument LOAD-LOOKUP command 2-161 STOP command 2-216.SQR FOR PEOPLESOFT LANGUAGE REFERENCE absolute value 2-129 arccosine 2-129 arcsine 2-130 arctangent 2-130 cosine 2-131 degrees 2-131 hyperbolic cosine 2-131 hyperbolic sine 2-135 hyperbolic tangent 2-136 largest integer 2-132 log base 10 2-133 log base e 2-133 natural log base e raised to x power power 2-134 radians 2-134 round 2-134 sign 2-135 sine 2-135 square root 2-136 tangent 2-136 nvl 2-147 2-132 O ODBC 2-48. 2-200 PRINT-DIRECT 2-208 -PRINTER WP 2-81 PRINTER qualifier 2-208 printer type 2-232 PRINTER-TYPE argument DECLARE-REPORT command 2-86 PRINT-IMAGE definition 2-209 position 2-209 printing Hebrew 2-183 on Windows 2-82 PROCEDURE 2-21. BEFORE qualifier with 2-192 ON-ERROR 2-21 ON-ERROR argument 7-2 BEGIN-SELECT command 2-33 BEGIN-SQL command 2-39 CONNECT command 2-51 DIVIDE command 2-97 EXECUTE command 2-106 OPEN 2-174 open a new report 2-170 operands 2-127 operators 2-128 Oracle 2-31. DECLARE-PRINTER command 2-78 PL/SQL 2-36 POINT-SIZE argument DECLARE-PRINTER command 2-78 position PRINT-IMAGE 2-209 POSITION 2-177 POSTSCRIPT 2-77 power 2-134 precision 2-127 PRINT definition 2-178 format commands 2-178 PRINT qualifier. ON-BREAK argument 2-192 PRINT-BAR-CODE 2-197 PRINT-CHART 2-57. 2-67 PC 2-42 PeopleBooks printed. DECLARE-LAYOUT command 2-72 PARAMETER 2-21 R rad 2-134 range 2-148 READ 2-212 RECORD argument. 2-48. 2-215 ON-BREAK in PRINT command 2-191 SET qualifier 2-192 ON-BREAK . LOAD-LOOKUP command 2-160 REVERSE argument. ON-BREAK argument 2-192 SET-GENERATIONS 2-219 SET-LEVELS 2-219 SET-MEMBERS 2-220 SETUP 2-65. 2-225 roman 2-149 round 2-134 ROUND argument ADD command 2-2. CREATE-ARRAY command 252 SKIPLINES argument. DECLARE-LAYOUT command 2-72 ROLLBACK 2-215. 2-152 substrt 2-152 transform 2-154 translate 2-154 unicode 2-155 UNSTRING 2-229 upper 2-155 UPPERCASE 2-230 string values 2-138 strtodate 2-150 subroutines calling 2-42 writing 2-40 substitution variables #DEFINE command 2-92 2- PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INDEX 7 . 2-66 SETUP section 2-34 SHADE argument PRINT command 2-194 SHOW 2-220 sign 2-135 sin 2-135 sine 2-135 sinh 2-135 SIZE argument. SHOW command 2-222 reversed characters 2-197 RIGHT-MARGIN argument. LOAD-LOOKUP command 161 sort buffer size 2-37 SOURCE argument DECLARE-IMAGE command 2-69 PRINT-IMAGE command 2-210 source field 2-164 SQLBase 2-37 -Cnn 2-37 COMMIT command 2-48 -DBdatabase 2-37 -LOCK 2-37 -NR 2-37 ROLLBACK command 2-215 -SORTnn 2-37 SQR page buffer 2-208 sqrt 2-136 square root 2-136 STARTUP-FILE argument DECLARE-PRINTER command 2-78 STATUS 2-21 STATUS argument INPUT command 2-125 OPEN command 2-175 STOP 2-225 stored procedures Oracle 2-36 STRING 2-226 string functions extract 2-109 find 2-110 instr 2-143 instrb 2-143 length 2-144 lengthb 2-145 lengthp 2-145 lengtht 2-145 lower 2-146 lowercase 2-163 numeric position 2-143 substr 2-151 substring 2-151 substringb 2-151. FOR-READING 2-174 SET qualifier. NEXT-LISTING command 2-173 SKIPLINES qualifier. 2-169 SUBTRACT command 2-228 ROWS argument. DECLARE-PRINTER command 2-78 RETURN_VALUE argument.SQR FOR PEOPLESOFT LANGUAGE REFERENCE replace 2-149 report layout 2-70 reserved variables #sql-status 2-28 $sql-error 2-28 $username 2-50 RESET-STRING argument. 2-97. ON-BREAK argument 2192 -SORT argument BEGIN-SELECT command 2-32 BEGIN-SQL command 2-37 SORT argument. LOAD-LOOKUP command 2160 ROWSET 2-22 rpad 2-149 RSV 2-21 rtrim 2-150 S SAVE qualifier ON-BREAK argument 2-192 SBTOMBS 2-215 SCHEMA 2-21 screen I/O 2-220 SECURITY 2-216 sequential processing. EVALUATE command 2-104 WHEN-OTHER argument.C 2-156 UNDERLINE argument PRINT command 2-195 SHOW command 2-222 unicode 2-155 Unix 2-42. LOAD-LOOKUP command 2-160 WHILE 2-40. 2-229 substrt 2-152 SUBTRACT 2-227 SYBASE COMMIT command 2-48 ROLLBACK command 2-215 STOP command 2-225 USE command 2-230 SYBASE CT-Lib 2-31 SYBASE DB-Lib 2-32. 2-235 Windows CALL command 2-42 WITH RECOMPILE argument. 2-43 UNSTRING 2-229 upper 2-155 UPPERCASE 2-230 USE 2-230 USE-COLUMN 2-47. 2-210 INPUT command 2-125 PRINT-BAR-CODE 2-198 V value determination 2-104 values of STATUS argument 2-124 VARY argument. OPEN command 2-175 VERT-LINE argument. EVALUATE command 2-105 WHERE argument. EXECUTE command 2-106 -XP argument BEGIN-SELECT command 2-32 BEGIN-SQL command 2-37 INDEX 8 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL . EXECUTE command 2-107 WRAP argument ON 2-196 PRINT command 2-195 wrapdepth 2-155 WRITE 2-237 writing to a page 2-178 X -XC argument. 2-43 2- W WAIT. DECLARE-REPORT command 2-85 TOC-ENTRY 2-228 TOP-MARGIN argument DECLARE-LAYOUT command 2-72 transcendental functions 2-137 transform 2-154 translate 2-154 trunc 2-137 truncate 2-137 TYPE argument DECLARE-PRINTER command 2-77 TYPE argument DECLARE-IMAGE command 2-69. ALTERLOCALE command 2-8 TIME-SEPARATOR argument. CALL command 2-43 WHEN argument. 2-67 USE-REPORT 2-234 T TABLE argument. 2-5. 2-231 USE-PRINTER-TYPE 2-232 USE-PROCEDURE 2-232 USER 2-4. ALTER-LOCALE command 2-8 to_char 2-153 to_multi_byte 2-153 to_number 2-153 to_single_byte 2-154 TOC argument. 2-37 SYMBOL-SET argument DECLARE-PRINTER command 2-78 SYSTEM argument. LOAD-LOOKUP command 2160 tabular reports NEXT-LISTING command 2-172 ON-BREAK argument 2-191 tan 2-136 tangent 2-136 tanh 2-136 TEXT argument DECLARE-VARIABLE command 2-90 PRINT-BAR-CODE 2-199 TOC-ENTRY command 2-228 text edit format characters 2-182 THOUSAND-SEPARATOR argument.C 2-41 UFUNC. CALL command 2-43 U UCALL. GRAPHIC command 117 VMS 2-42.SQR FOR PEOPLESOFT LANGUAGE REFERENCE #IF command 2-118 #IFDEF command 2-121 #IFNDEF command 2-122 ASK command 2-19 substring 2-109. SQR FOR PEOPLESOFT LANGUAGE REFERENCE Z ZIP+4 Postnet 2-200 PEOPLESOFT PROPRIETARY AND CONFIDENTIAL INDEX 9 .