PeopleSoft Administration Tools

PeopleTools 8.
42 Administration Tools PeopleSoft Administration Tools
November 2002
PeopleTools 8.42 Administration Tools PeopleSoft Administration Tools SKU TOOLS842ADM-B 1102 PeopleBooks Contributors: Teams from PeopleSoft Product Documentation and Development. Copyright 1988-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, PeopleTools, PS/nVision, PeopleCode, PeopleBooks, PeopleTalk, and Vantive are registered trademarks, and Pure Internet Architecture, Intelligent Context Manager, and The Real-Time Enterprise 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. Open Source Disclosure This product includes software developed by the Apache Software Foundation (http://www.apache.org/). Copyright (c) 1999-2000 The Apache Software Foundation. All rights reserved. THIS SOFTWARE IS PROVIDED AS IS AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. PeopleSoft takes no responsibility for its use or distribution of any open source or shareware software or documentation and disclaims any and all liability or damages resulting from use of said software or documentation.
Contents
General Preface About This PeopleBook ............................................................................. .. .. ... ..ix PeopleSoft Application Prerequisites........................................................................ . . . . . . . . .ix PeopleSoft Application Fundamentals....................................................................... . . . . . . . . .ix Related Documentation........................................................................................ ..........x Obtaining Documentation Updates.................................................................................x Ordering Printed Documentation...................................................................................x Typographical Conventions and Visual Cues............................................................... . . . . . . . . .xi Typographical Conventions................................................................................ . . . . . . . .xi Visual Cues...........................................................................................................xii Comments and Suggestions.................................................................................. . . . . . . . .xiii Common Elements in These PeopleBooks ................................................................ . . . . . . . .xiii
Preface Administration Tools Preface...................................................................... . . . . . . . .xv PeopleSoft Data Mover........................................................................................ . . . . . . . .xv PeopleSoft Configuration Manager.......................................................................... . . . . . . . .xv PeopleSoft Data Archive Manager........................................................................... ........xvi
Chapter 1 PeopleSoft Data Mover.............................................................................. ..........1 Understanding Data Mover.................................................................................... ..........1 Understanding the Data Mover Interface.................................................................... ..........2 Starting Data Mover..................................................................................................2 Operating Modes.....................................................................................................2 Signing On to the Development Environment....................................................................2 Understanding the Data Mover Window...........................................................................3 Understanding the Menu Options..................................................................................4 Understanding the Toolbar Options................................................................................4 Understanding Data Mover Scripts........................................................................... ..........4 Command Types......................................................................................................4 Syntax Rules..........................................................................................................5 Creating and Editing Scripts.........................................................................................6
PeopleSoft Proprietary and Confidential
iii
Contents
Preparing to Run Export Scripts....................................................................................7 Running Scripts.......................................................................................................7 Using Database Setup......................................................................................... ..........8 Accessing Database Setup..........................................................................................9 Using the Database Setup Screen.................................................................................9 Using the Select PeopleSoft Application Screen.................................................................9 Using the Database Parameters Screen................................................................. . . . . . . .10 Checking the Generated Script............................................................................ . . . . . . .11 Using the Data Mover Command Line Interface........................................................... . . . . . . . .11 Understanding the Data Mover Command Line Interface............................................. . . . . . . . .11 Getting Started (on UNIX).................................................................................. . . . . . . .12 Running a Data Mover Script from the Command Line.......... ..................................... . . . . . . . .12 Understanding the Command Line Parameters.. ....................................................... . . . . . . .13 Using a Parameter File..................................................................................... . . . . . . .14 Understanding Data Mover Commands..................................................................... . . . . . . . .14 Data Mover Commands.................................................................................... . . . . . . .14 SQL Commands............................................................................................. . . . . . . .15 Standard SQL Commands With DMS Scripts........................................................... . . . . . . .15 Standard SQL Commands with SQL Files............................................................... . . . . . . .16 Non-Standard SQL Commands........................................................................... . . . . . . .16 Command Matrix............................................................................................ . . . . . . .17 Data Mover Command Reference........................................................................... . . . . . . . .18 CHANGE_ACCESS_PASSWORD........................................................................ . . . . . . .18 CREATE_TEMP_TABLE................................................................................... . . . . . . .19 CREATE_TRIGGER........................................................................................ . . . . . . .19 ENCRYPT_PASSWORD................................................................................... . . . . . . .20 EXPORT...................................................................................................... . . . . . . .20 IMPORT....................................................................................................... . . . . . . .21 REM, REMARK, - - ......................................................................................... . . . . . . .23 RENAME...................................................................................................... . . . . . . .24 REPLACE_ALL.............................................................................................. . . . . . . .26 REPLACE_DATA............................................................................................ . . . . . . .26 REPLACE_VIEW............................................................................................ . . . . . . .27 RUN........................................................................................................... . . . . . . .27 SET............................................................................................................ . . . . . . .28 SWAP_BASE_LANGUAGE................................................................................ . . . . . . .28 SET IGNORE_ERRORS................................................................................... . . . . . . .29 SET BASE_LANGUAGE ................................................................................... . . . . . . .30 Data Mover Command Modifiers............................................................................. . . . . . . . .30 AS............................................................................................................ . . . . . . . .31
iv
Contents
IGNORE_DUPS............................................................................................. . . . . . . .32 WHERE....................................................................................................... . . . . . . .32 When Data Mover Issues COMMITs......................................................................... . . . . . . . .33 SET Parameter Reference.................................................................................... . . . . . . . .34 COMMIT...................................................................................................... . . . . . . .34 CREATE_INDEX_BEFORE_DATA........................................................................ . . . . . . .34 DBSPACE.................................................................................................... . . . . . . .35 DDL............................................................................................................ . . . . . . .36 EXECUTE_SQL............................................................................................. . . . . . . .37 EXTRACT.................................................................................................... . . . . . . .37 IGNORE_DUPS............................................................................................. . . . . . . .38 INPUT......................................................................................................... . . . . . . .38 INSERT_DATA_ONCE...................................................................................... . . . . . . .39 LOG........................................................................................................... . . . . . . .39 NO DATA..................................................................................................... . . . . . . .40 NO INDEX.................................................................................................... . . . . . . .41 NO RECORD................................................................................................. . . . . . . .41 NO SPACE................................................................................................... . . . . . . .41 NO TRACE................................................................................................... . . . . . . .42 NO VIEW..................................................................................................... . . . . . . .42 OUTPUT...................................................................................................... . . . . . . .43 SIZING_SET................................................................................................. . . . . . . .43 SPACE........................................................................................................ . . . . . . .44 START........................................................................................................ . . . . . . .44 STATISTICS.................................................................................................. . . . . . . .45 VERSION..................................................................................................... . . . . . . .45 Script Examples................................................................................................ . . . . . . . .46 Exporting a Database....................................................................................... . . . . . . .46 Building a Microsoft SQL Server Database.............................................................. . . . . . . .46 Recreating All Views........................................................................................ . . . . . . .47 Importing With REPLACE_ALL With a Commit Level.................................................. . . . . . . .47 Combining SQL Commands and IMPORT............................................................... . . . . . . .47
Chapter 2 PeopleSoft Configuration Manager............................................................... . . . . . . . .49 Understanding PeopleSoft Configuration Manager........................................................ . . . . . . . .49 Working with the Configuration Manager Interface........................................................ . . . . . . . .50 Startup........................................................................................................... . . . . . . . .51 Signon Defaults.............................................................................................. . . . . . . .51
Contents
Numeric Keypad - Enter Key Tabs to Next Field........................................................ . . . . . . .53 User Can Override........................................................................................... . . . . . . .53 Cache Files................................................................................................... . . . . . . .54 Display........................................................................................................... . . . . . . . .54 Language..................................................................................................... . . . . . . .55 Page Display................................................................................................. . . . . . . .55 Font............................................................................................................ . . . . . . .56 Business Process Display.................................................................................. . . . . . . .57 Crystal/Business Interlink ..................................................................................... . . . . . . . .57 Crystal Options............................................................................................... . . . . . . .58 Business Interlink Driver Options.......................................................................... . . . . . . .58 Trace ............................................................................................................ . . . . . . . .59 Workflow......................................................................................................... . . . . . . . .60 Remote Call/AE................................................................................................. . . . . . . . .61 Client Setup..................................................................................................... . . . . . . . .63 Shortcut Links................................................................................................ . . . . . . .64 ODBC Setup................................................................................................. . . . . . . .64 Install Workstation........................................................................................... . . . . . . .64 Import/Export ................................................................................................... . . . . . . . .65 Profile............................................................................................................ . . . . . . . .66 Database/Application Server............................................................................... . . . . . . .67 Process Scheduler.......................................................................................... . . . . . . .69 nVision ........................................................................................................ . . . . . . .72 Common Tab................................................................................................. . . . . . . .73 Command Line Options....................................................................................... . . . . . . . .74 Import File.................................................................................................... . . . . . . .75 Export File.................................................................................................... . . . . . . .75 Run Client Setup............................................................................................. . . . . . . .75 Run Client Setup Quietly.................................................................................. . . . . . . .75 Install ActiveX controls...................................................................................... . . . . . . .75 Install Crystal Runtime Files................................................................................ . . . . . . .75 Install MSS DSN............................................................................................. . . . . . . .75 Disable ODBC Driver Manager Installation.............................................................. . . . . . . .76 Disable PeopleSoft ODBC Driver Installation............................................................ . . . . . . .76 Uninstall Workstation........................................................................................ . . . . . . .76 Help............................................................................................................ . . . . . . .76 Setting Up the PeopleTools Development Environment................................................... . . . . . . . .76 Verify <PS_HOME> Access................................................................................ . . . . . . .77 Verify Connectivity........................................................................................... . . . . . . .77 Verify Supporting Applications............................................................................. . . . . . . .77
vi
Contents
Understanding the User Settings.......................................................................... . . . . . . .78 Running Client Setup........................................................................................ . . . . . . .78
Chapter 3 PeopleSoft Data Archive Manager................................................................ . . . . . . . .81 Understanding Data Archiving................................................................................ . . . . . . . .81 Choosing an Archiving Strategy.............................................................................. . . . . . . . .81 Determining an Archive Strategy.......................................................................... . . . . . . .82 Archiving to History Tables................................................................................. . . . . . . .82 Creating History Tables..................................................................................... . . . . . . .83 Archiving to Flat Files....................................................................................... . . . . . . .83 Creating an Archive Template................................................................................ . . . . . . . .84 Record Criteria Page........................................................................................ . . . . . . .84 Join Record Criteria Page.. ................................................................................ . . . . . . .85 SQL Designer Page......................................................................................... . . . . . . .86 Working With the Archives.................................................................................... . . . . . . . .88 Archive Security Page...................................................................................... . . . . . . .88 Archive Utilities Page........................................................................................ . . . . . . .89 Working With Data............................................................................................. . . . . . . . .89 Data Finder Page............................................................................................ . . . . . . .90 Data Transfer Input Page................................................................................... . . . . . . .90 Data Transfer Output Page................................................................................. . . . . . . .92 Running Data Archival Processes............................................................................ . . . . . . . .92 Archive Data Page........................................................................................... . . . . . . .92 Archive Online to Flat Files Page.......................................................................... . . . . . . .94 Export History to Flat Files Page.......................................................................... . . . . . . .95 Import From Flat Files Page................................................................................ . . . . . . .96 Running Data Archival Reports and Audits................................................................. . . . . . . . .97 Running an Archive Report................................................................................. . . . . . . .97 Creating an Audit Inquiry..... .............................................................................. . . . . . . .98 Audit Report Page........................................................................................... . . . . . . .99 Archiving Tips and Techniques ............................................................................... .......100 Understanding Business Requirements........................................................................100 Archiving from Online to History Table Process...............................................................100 Rolling Back History Table Data.................................................................................101 Archiving From History Table to a Flat File.....................................................................101 Restoring Archived Data From Flat Files.......................................................................101 Understanding Commits..........................................................................................102 Gaining Increased Performance.................................................................................102
vii
Contents
Modifying Indexes.................................................................................................102
Glossary of PeopleSoft Terms.............................................................................103
Index ............................................................................................................115
viii
About This PeopleBook

PeopleBooks provide you with the information that you need to implement and use PeopleSoft applications. This preface discusses: PeopleSoft application prerequisites. PeopleSoft application fundamentals. Related documentation. Typographical elements and visual cues. Comments and suggestions. Common elements in PeopleBooks. Note. PeopleBooks document only page elements that require additional explanation. If a page element is not documented with the process or task in which it is used, then either it requires no additional explanation or it is documented with common elements for the section, chapter, PeopleBook, or product line. Elements that are common to all PeopleSoft applications are defined in this preface.
PeopleSoft Application Prerequisites

To benefit fully from the information that is covered in these books, you should have a basic understanding of how to use PeopleSoft applications. See Using PeopleSoft Applications. You might also want to 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 comfortable using the World Wide Web and the Microsoft Windows or Windows NT graphical user interface. These books do not review navigation and other basics. They present the information that you need to use the system and implement your PeopleSoft applications most effectively.
PeopleSoft Application Fundamentals

Each application PeopleBook provides implementation and processing information for your PeopleSoft database. However, additional, essential information describing the setup and design of your system appears in a companion volume of documentation called the application fundamentals PeopleBook. Each PeopleSoft product line has its own version of this documentation.
ix
General Preface
The application fundamentals PeopleBook consists of important topics that apply to many or all PeopleSoft applications across a product line. Whether you are implementing a single application, some combination of applications within the product line, or the entire product line, you should be familiar with the contents of this central PeopleBook. It is the starting point for fundamentals, such as setting up control tables and administering security.
Related Documentation
This section discusses how to: Obtain documentation updates. Order printed documentation.
Obtaining Documentation Updates

You can find updates and additional documentation for this release, as well as previous releases, on the PeopleSoft Customer Connection Website. Through the Documentation section of PeopleSoft Customer Connection, you can download files to add to your PeopleBook Library. Youll find a variety of useful and timely materials, including updates to the full PeopleSoft documentation that is delivered on your PeopleBooks CD-ROM. Important! Before you upgrade, you must check PeopleSoft Customer Connection for updates to the upgrade instructions. PeopleSoft continually posts updates as the upgrade process is refined.
See Also
PeopleSoft Customer Connection Website, http://www.peoplesoft.com/corp/en/login.asp
Ordering Printed Documentation

You can order printed, bound volumes of the complete PeopleSoft documentation that is delivered on your PeopleBooks CD-ROM. PeopleSoft makes 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 these methods: Web Telephone Email
Web
From the Documentation section of the PeopleSoft Customer Connection Website, access the PeopleSoft Press Website under the Ordering PeopleBooks topic. The PeopleSoft Press Website is a joint venture between PeopleSoft and Consolidated Publications Incorporated (CPI), the book print vendor. Use a credit card, money order, cashiers check, or purchase order to place your order.
General Preface
Telephone
Contact CPI at 800 888 3559.
Email
Send email to CPI at psoftpress@cc.larwood.com.
See Also
PeopleSoft Customer Connection Website, http://www.peoplesoft.com/corp/en/login.asp
Typographical Conventions and Visual Cues

This section discusses: Typographical conventions. Visual cues.
Typographical Conventions
The following table contains the typographical conventions that are used in PeopleBooks:
Typographical Convention or Visual Cue Bold Description Indicates PeopleCode function names, method names, language constructs, and PeopleCode reserved words that must be included literally in the function call. Indicates field values, emphasis, and PeopleSoft or other book-length publication titles. In PeopleCode syntax, italic items are placeholders for arguments that your program must supply. 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. Indicates a PeopleCode program or other code example. Indicate chapter titles in cross-references and words that are used differently from their intended meanings.
Italics
Monospace font (quotation marks)
xi
General Preface
Typographical Convention or Visual Cue . . . (ellipses)
Description Indicate that the preceding item or series can be repeated any number of times in PeopleCode syntax. Indicate a choice between two options in PeopleCode syntax. Options are separated by a pipe ( | ). Indicate optional items in PeopleCode syntax. When placed before a parameter in PeopleCode syntax, an ampersand indicates that the parameter is an already instantiated object. Ampersands also precede all PeopleCode variables.
{ } (curly braces)
[ ] (square brackets) & (ampersand)
(ISO)
Information that applies to a specific country, to the U.S. federal government, or to the education and government market, is preceded by a three-letter code in parentheses. The code for the U.S. federal government is USF; the code for education and government is E&G, and the country codes from the International Standards Organization are used for specific countries. Here is an example: (GER) If youre administering German employees, German law requires you to indicate special nationality and citizenship information for German workers using nationality codes established by the German DEUEV Directive.
Cross-references
PeopleBooks provide cross-references either below the heading See Also or on a separate line preceded by the word See. Cross-references lead to other documentation that is pertinent to the immediately preceding documentation.
Visual Cues
PeopleBooks contain the following visual cues.
Notes
Notes indicate information that you should pay particular attention to as you work with the PeopleSoft system. Note. Example of a note. A note that is preceded by Important! is crucial and includes information that concerns what you must do for the system to function properly.
xii
General Preface
Important! Example of an important note.
Warnings
Warnings indicate crucial configuration considerations. Pay close attention to warning messages. Warning! Example of a warning.
Comments and Suggestions

Your comments are important to us. We encourage you to tell us what you like, or what you would like to see changed about PeopleBooks and other PeopleSoft reference and training materials. Please send your suggestions to: PeopleSoft Product Documentation Manager PeopleSoft, Inc. 4460 Hacienda Drive Pleasanton, CA 94588 Or send email comments to doc@peoplesoft.com. While we cannot guarantee to answer every email message, we will pay careful attention to your comments and suggestions.
Common Elements in These PeopleBooks

As of Date Business Unit The last date for which a report or process includes data. An ID that represents a high-level organization of business information. You can use a business unit to define regional or departmental units within a larger organization. Enter up to 30 characters of text. The date on which a table row becomes effective; the date that an action begins. For example, to close out a ledger on June 30, the effective date for the ledger closing would be July 1. This date also determines when you can view and change the information. Pages or panels and batch processes that use the information use the current row. Select Once to run the request the next time the batch process runs. After the batch process runs, the process frequency is automatically set to Dont Run. Select Always to run the request every time the batch process runs. Select Dont Run to ignore the request when the batch process runs.
Description Effective Date
Once, Always, and Dont Run
xiii
General Preface
Report Manager
Click to access the Report List page, where you can view report content, check the status of a report, and see content detail messages (which show you a description of the report and the distribution list). Click to access the Process List page, where you can view the status of submitted process requests. Click to access the Process Scheduler request page, where you can specify the location where a process or job runs and the process output format. An ID that represents a set of selection criteria for a report or process. An ID that represents the person who generates a transaction. An ID that represents a set of control table information, or TableSets. TableSets enable you to share control table information and processing options among business units. The goal is to minimize redundant data and system maintenance tasks. When you assign a setID to a record group in a business unit, you indicate that all of the tables in the record group are shared between that business unit and any other business unit that also assigns that setID to that record group. For example, you can define a group of common job codes that are shared between several business units. Each business unit that shares the job codes is assigned the same setID for that record group. Enter up to 15 characters of text.
Process Monitor Run Request ID User ID SetID
Short Description
See Also
Using PeopleSoft Applications PeopleSoft Process Scheduler
xiv
Administration Tools Preface

In this book well show you how to use the following Administration PeopleTools: Data Mover Configuration Manager Data Archive Manager Note. This PeopleBook documents only elements that require additional explanation. If a page element is not documented with the process or task in which it is used, then either it requires no additional explanation or it is documented with common elements for the section, chapter, PeopleBook, or product line.
PeopleSoft Data Mover

PeopleSoft Data Mover enables you to perform the following tasks: Transfer application data between PeopleSoft databases. Move PeopleSoft databases across operating systems and database platforms. Execute SQL statements against any PeopleSoft database, regardless of the underlying operating system or database platform. Control database security and access. Create, edit, and run scripts. These scripts may include any combination of SQL commands and Data Mover commands for exporting and importing data. See Chapter 1, PeopleSoft Data Mover, page 1.
PeopleSoft Configuration Manager

PeopleSoft Configuration Manager simplifies workstation administration by enabling you to adjust the PeopleSoft registry settings from one central location. It lets you set up one workstation to reflect the environment at your site, and to then export the configuration file, which can be shared among all the workstations at your site. See Chapter 2, PeopleSoft Configuration Manager, page 49.
xv
Preface
PeopleSoft Data Archive Manager

PeopleSoft Data Archive Manager enables you to select the rows of data you no longer need in your online system and move these rows in history/staging tables or in a flat file format. Keeping the data in the system in history/staging tables keeps the data available for queries and reporting. Using PeopleSoft Data Archive Manager you can: Remove the historical data from your online tables to improve overall performance Create an archive strategy Run archive reports and audits See Chapter 3, PeopleSoft Data Archive Manager, page 81.
xvi
CHAPTER 1

This chapter provides an overview of PeopleSoft Data Mover and discusses the following topics: Data Mover interface Using Data Mover Data Mover scripts Database Setup functionality Data Mover command line interface Data Mover commands Data Mover set parameters Sample Data Mover scripts
Understanding Data Mover

PeopleSoft Data Mover enables you to perform the following tasks: Transfer application data between PeopleSoft databases. Move PeopleSoft databases across operating systems and database platforms. Execute SQL statements against any PeopleSoft database, regardless of the underlying operating system or database platform. Control database security and access. Create, edit, and run scripts. These scripts may include any combination of SQL commands and Data Mover commands for exporting and importing data. The Data Mover development interface, or GUI, runs only on Windows. However, the Data Mover command line interface, which is mainly intended for UNIX servers, runs on Windows and UNIX operating systems. Warning! PeopleSoft Data Mover runs in two-tier mode only. You must sign on to the database directly, not through an application server. Throughout this chapter, we use the following typographical conventions to distinguish between different elements of the command statement syntax: italic Italic items are placeholders for arguments that your program must supply.
Chapter 1
...
Ellipses indicate that the preceding item or series can be repeated any number of times. Group of items, from which you must choose one item, are enclosed in curly brackets. Optional items are enclosed in square brackets. An upright slash separates item choices within curly and square brackets.
{} [] |
Understanding the Data Mover Interface

Before you begin using PeopleSoft Data Mover to create and run your database scripts, youll want to become familiar with the PeopleSoft Data Mover interface.
Starting Data Mover

There are two ways to start PeopleSoft Data Mover: Using the Data Mover short cut in your PeopleSoft program group, as in Start, Programs, <PeopleSoft Group>, Data Mover. This access method only applies to the Windows Development Environment. Using the command line interface. This executes PeopleSoft Data Mover in a console for Windows and a telnet session for UNIX. The command line interface is discussed in more detail later in this document.
Operating Modes
Operating modes refer to how you are connected to the database. You use PeopleSoft Data Mover in one of the following modes: regular or bootstrap. Regular Mode Most of the time you will sign onto PeopleSoft Data Mover in regular mode. To do this, you simply enter your PeopleSoft user ID and password at the signon screen. In regular mode, all commands are valid. At times, you need to signon on to PeopleSoft Data Mover in bootstrap mode, which means using the database access ID and password at the signon screen. Typically, using bootstrap mode is necessary for database loading because there are no PeopleSoft security tables established yet. Bootstrap mode is also used for running some security commands, such as, ENCRYPT_PASSWORD.
Bootstrap Mode
Note. In bootstrap mode, the following commands are not valid: EXPORT, RENAME, and REPLACE_VIEW.
Signing On to the Development Environment

To start Data Mover in the Development Environment: 1. Select Start, Programs, <PeopleSoft Group>, Data Mover.
Chapter 1
Where <PeopleSoft Group> refers to the program group containing your PeopleSoft programs. If you dont have a Data Mover short cut, you can add one to the desktop. The executable to launch is as follows: %PS_HOME%\bin\client\winx86\PSDMT.EXE. 2. Sign on using the appropriate ID and password. In regular mode, these would be your User ID and password. In bootstrap mode, you use the system access ID and access password, such as SYSADM.
Understanding the Data Mover Window

The PeopleSoft Data Mover interface is split horizontally into two panes: an input pane and an output pane. The input pane is on the top of the screen and the output pane is on the bottom. The status bar at the bottom of the screen reveals the following: Database Name. QEDMO, PT840HR, and so on. Database Type. Oracle, Sybase, and so on. Operating Mode. Regular or Bootstrap mode. Trace Status. On or off. The input pane (window) is where the script youve opened appears. This is where you view and edit PeopleSoft Data Mover scripts. The output window displays the results after running a script. If you encounter any errors, the output window shows where the script failed. In a multi-database environment, always check the information at the top of the output to ensure that youve run the script against the appropriate database. Specifically, refer to the "Database:" line. Note. The results shown in the output window are saved to the file DATAMOVE.LOG by default, which is written to the default log directory as specified in the Configuration Manager (Profile, Common tab). You can also specify your own file name. SQL Trace status appears in the far right portion of the status bar. PeopleSoft recommends using PeopleSoft Data Mover with tracing turned off. You can disable SQL Trace (for the Windows environment) before starting PeopleSoft Data Mover in a number of places: Configuration Manager PeopleTools Options Data Mover Command (NO TRACE) The operating mode display on the status bar lets you know if youre in regular mode or in bootstrap mode. If you are connected to the database in regular mode, the status shows a blank operating mode. The operating mode displays BootStrap if you signed on using the access ID and password. Note. Make sure you know the mode you are using. Most commands require regular mode to run successfully.
Chapter 1
See Also
PeopleSoft Server Tools Administration, PeopleTools Utilities, PeopleTools Options Chapter 1, PeopleSoft Data Mover, Operating Modes, page 2
Understanding the Menu Options

There are four menu bar items in the PeopleSoft Data Mover window: File, Edit, View, and Help. File Contains options to Create, Open, Save, and Run scripts. You also launch Database Setup from this menu. These options are discussed later in this document in the proper context. Contains menu items similar to those of most text editors: Undo, Cut, Copy, Paste, and Clear. Also, you will find Select All, Find, Replace, and Repeat. Using the View menu list, you can opt to hide the Toolbar and/or the Status Bar. Both appear by default. Contains the Standard PeopleSoft help options.
Edit View Help
Understanding the Toolbar Options

The toolbar offers the standard Microsoft Windows buttons to use in place of selecting menu options for the following actions: New, Open, Save, Cancel, Cut, Copy, Paste, and Help. The only button that is specific to PeopleSoft Data Mover is the Run Script button.
Understanding Data Mover Scripts

This section covers: Command types Syntax rules Creating and editing scripts
Command Types
A PeopleSoft Data Mover script can contain two types of commands: Data Mover commands. Used to export and import database information and to otherwise modify the database. Data Mover commands also control script execution, call other PeopleSoft Data Mover files, and enter comments. SQL commands. These include both standard and non-standard SQL commands used to modify the database.
Chapter 1
Syntax Rules
If you plan to create or edit Data Mover scripts, keep the following syntax rules in mind to make sure your commands run successfully.
Rule 1
With the exception of double-dash (--) comment statements, every command statement must be followed by a delimiter. Valid delimiters are: Semicolon (;). A semicolon can reside on the same line as the command itself, or by itself on the line immediately following a command statement. For example, the following two uses of the semicolon delimiter are valid:
SET OUTPUT c:\temp\abc.dat; SET LOG c:\temp\new.log ;
Forward slash (/). This delimiter can be used only on a line by itself, in column 1, on a line immediately following a command statement. For example:
IMPORT * /
Rule 2
With the exception of double-dash (--) comment statements, statements may span multiple lines. For example:
EXPORT absence_hist WHERE absence_type = A;
Rule 3
A double-dash (--) comment statement does not require a delimiter termination. However, each statement cant span more than one line. Also, make sure you add a space after the (--) before you start your comment. For example: Correct:
-- This script imports the information stored in -- the ABC.DAT file.
Incorrect:
--This script imports the information stored in the ABC.DAT file.
Rule 4
Command statements may contain any amount of white space between items.
Rule 5
Statement text is case insensitive. For example,
Chapter 1
IMPORT *
is equivalent to
import *
Note. In this chapter, we show commands in UPPERCASE to help set them apart from other statement text.
Rule 6
String constants are case-sensitive and must be surrounded by single quotes. For example, ABC is treated differently than Abc or abc.
Rule 7
In PeopleSoft Data Mover, when a record name needs to be specified as one of the elements in the command statement syntax, as in an IMPORT statement, you can specify either the record name or the corresponding table name. For example, the following IMPORT statements are equivalent: Correct:
IMPORT job;
Correct:
IMPORT ps_job;
However, when a table name is required for one of the elements in the command statement syntax, you must use the table namenot the record name. For example: Correct:
IMPORT job AS ps_process;
Incorrect:
IMPORT job AS process;
Creating and Editing Scripts

When you want to use PeopleSoft Data Mover to manipulate the information in your database, you can either write a new script, or open and edit an existing script that is similar to the one you want to create. The default file extension for scripts is DMS, which stands for Data Mover Script. To create a new script: 1. Select File, New. When you first launch Data Mover, this is the default mode; you dont need to select File, New. 2. Enter the script text (code) in the input (top) pane. Using proper Data Mover syntax, enter the command statements you want the script to execute. 3. Save the script.
Chapter 1
Select File, Save. On the Save As dialog box select the Save as Unicode checkbox (if appropriate) and click Save. To edit an existing Data Mover script 1. Select File, Open. 2. Choose the file you want and click OK. By default, you view only .DMS files. You can also choose All Files from the Files of type drop-down list and view all file types. After you open a script, it appears in the PeopleSoft Data Mover input pane. 3. Make the desired changes to the script. If the file you opened was not a .DMS type, be sure to check that it conforms to the required syntax rules and that it doesnt contain any unsupported SQL commands. 4. Save the script with a new name, if desired. Select File, Save As. On the Save As dialog, enter a File name, select the Save as Unicode checkbox if appropriate and click Save. If the script is edited in Unicode format, then the default save is Unicode. However, if the file is opened in ASCII format then the default will be ASCII.
Preparing to Run Export Scripts

Before running a PeopleSoft Data Mover export script, you must first prepare your database, by completing the following steps: To prepare for an export 1. Load DDL model information by running all DDL*.DMS files through PeopleSoft Data Mover. 2. If you need to change your DDL model information, use the DDL Model Defaults utility in PeopleTools Utilities. 3. Run the DDDAUDIT.SQR and fix any errors it finds. 4. Run the SYSAUDIT.SQR and fix any errors it finds. 5. Use Application Designer to SQL Alter all tables. Either let the files alter in place or run the script that it generates to alter any tables it finds out of sync. 6. Use Application Designer to SQL Create all records, using the If table exists... Never recreate option.
See Also
PeopleSoft Server Tools Administration, PeopleTools Utilities
Running Scripts
This section discusses running scripts with PeopleSoft Data Mover. Through PeopleSoft Data Mover, you can run DDL, DML, and SQL scripts created with the following tools: Data Mover (DMS scripts). Application Designers Build SQL functionality (SQL scripts).
Chapter 1
Platform-specific SQL utility (SQL scripts). Note. You can also schedule Data Mover scripts through Process Scheduler. This can be useful in scheduling audit routines or extracting data from the PS database. Additionally, logs and data files generated by Data Mover can be posted to the Process Scheduler Report Repository so that they can be viewed either through Process Monitor or Report Manager. When running scripts through Data Mover, keep the following items in mind: PeopleSoft strongly recommends running PeopleSoft Data Mover scripts when SQL Trace is set to Off. If SQL Trace is enabled, turn it off on the Trace tab in the Configuration Manager before you run the script. You can also enter the SET NO TRACE statement within your scripts whenever possible. This disables SQL Trace for the DMS script even if it is enabled in the Configuration Manager. Records defined using Data Mover EXPORT and IMPORT commands can have a maximum of 250 total columns and multiple long columns within the limitations for long columns set by your database platform. Check with your database vendor for restrictions on the number of long columns allowed for your platform. On DB2 platforms, locks can occur on system catalogs. In that case, you should not let PeopleSoft Data Mover sessions run unattended, and be sure to close your session as soon as all scripts complete. If you want to run a SQL script, you must open it using File, Open so that the SQL executes properly. Do not copy and paste SQL from another source into PeopleSoft Data Mover. Note. If you are planning on importing or exporting files greater than 2GB on UNIX, you will need to enable large file support at the operating system level. To run a script: 1. Select File, Open. 2. Choose one of the following types of script to run. PeopleSoft Data Mover Files (.DMS). These are the files created using PeopleSoft Data Mover. Query Files (.SQL). These are the files created using the Build SQL functionality menu in Application Designer or using an RDBMS-specific query tool, such as PL/SQL on Oracle. All Files. Enables you to view all available files in a directory. Only .DMS and .SQL files are valid file types for PeopleSoft Data Mover. SELECT commands are not supported. When performing upgrades, use the SQL utility for your platforms to run SQL scripts, not PeopleSoft Data Mover. 3. Select File, Run. You can monitor the scripts progress in PeopleSoft Data Movers output pane, which reveals any error messages and a message saying Script Completed when processing has ended.
Using Database Setup

Typically, Database Setup is used during PeopleSoft installations and upgrades, not necessarily on a daily basis. You use Database Setup to create PeopleSoft Data Mover import scripts that load data into your PeopleSoft database.
Chapter 1
In this section we discuss how to: Accessing Database Setup Using the Database Setup Wizard Note. If you are performing an installation, use the documentation included in your PeopleSoft Installation guide, which provide specific details regarding your applications, languages, and RDBMS. This section provides a general overview, not specific to the installation procedure.
Accessing Database Setup

To Access the Database Setup Utility: 1. Signon on to PeopleSoft Data Mover in bootstrap mode. Use the access ID and password rather than your PeopleSoft user ID and password. 2. Select File, Database Setup. Note. If you sign on to Data Move using the regular mode, not bootstrap mode, the Database Setup menu option is disabled.
Using the Database Setup Screen

The following controls are on the Database Setup screen. Select Target Database From the drop-down list, select the RDBMS you intend to run the database setup script against. For instance, if the database you are creating is to run on an Oracle server, select Oracle. PeopleSoft supports Non-Unicode (ANSI) and Unicode database types. Make sure you select the appropriate type for your system. For some RDBMS types, Unicode is not an option. Depending on what RDBMS you selected previously, the valid character sets appear in this drop-down list. Select the appropriate option for your system.
Database Type
Select Character Set
Using the Select PeopleSoft Application Screen

The following controls are on the PeopleSoft Application screen. PeopleSoft Application Only the applications that you have licensed appear. Select the applications for which you want to create PeopleSoft Data Mover scripts. To add applications selectively, use the Add button. To add all applications available, use the Add All button. The Add All button is enabled when multiple applications appear. You add the applications to the PeopleSoft Data Mover Scripts to Create edit box. Contains the applications you added from the PeopleSoft Application list box. Use the Remove button to remove a single application, and use the Remove All button to clear the list box if multiple applications appear. The Remove All button resets the PeopleSoft Application list.
Data Mover Scripts to Create
Chapter 1
Database Type
Specify what the result of running the script should be. There are two database codes: PT for PeopleTools and EP for PeopleSoft applications. Demo. For creating a demonstration database. System. For creating a system database. Add New Language. For adding support of new languages to and existing database. Add New Product. To add an new PeopleSoft product to the current system. With this option selected only non-PT Database Codes appear.
Using the Database Parameters Screen

The following controls are on the Database Parameters screen. Database Name Enter the name of the database against which you intend to run the script. Note that the database name that appears is the database for which you are currently signed on. If the script you are creating will be run against another database, make sure to specify the appropriate name here. If elect to generate a script for a database other than the current database, the system uses a default database using the following convention, XXDMO for demonstration databases, and XXSYS for system databases. The XX represents the product code, such as HR. This is used as the key to retrieve Access ID and access password. For initial installation set it equal to the Database Name. The PeopleSoft Access ID is the RDBMS ID with which PeopleSoft application(s) are ultimately connected to your database once the PeopleSoft System validates the User or Connect ID. It typically has all the RDBMS privileges necessary to access and manipulate data for an entire PeopleSoft application. The password associated with the access ID. The ID used for the initial connection to the database. Any two-tier connection requires a Connect ID. A Connect ID is a valid user ID that, when used during login, takes the place of PeopleSoft User IDs for the logon process. (DB2 for OS390) Populates the CREATOR field in the system catalog table SYSIBM.SYSTABLES. You determined the name of the table owner ID during the initial installation using the PeopleTools Installation Guide for your platform. (DB2 for OS390) The storage group where the index spaces will be created. (DB2 for OS390) The storage group for tablespaces. This value must be the same as that used in the XXDDL.SQL script when you created tablespaces during your installation.
Symbolic ID Access ID
Access Password Connect ID
Table Owner
Index Storage Group Table Space Storage Group
10
Chapter 1
Checking the Generated Script

After running Database Setup, check the output directory for the generated script if you are interested in viewing it. Notice that some commands are added that call other scripts and perform various functions. These commands are added to reduce the number of scripts and commands you need to run manually. For example, notice that the following commands appear at the end of the script: REPLACE_VIEW. Creates views for the new database. CREATE_TEMP_TABLE. Creates any necessary temporary table images. The number of temporary tables to create is determined by the value Temp Table Instances setting in PeopleTools Options (Utilities, Administration, PeopleTools Options) plus the number of Application Engine temporary table(s). SWAP_BASE_LANGUAGE. If you selected a base language other than English, this command modifies your system to recognize that language as the base language. The default PeopleTools language is English if PSSTATUS table is not available. RUN. This command executes the CURRXXX.DMS script, to load your system with the appropriate currency information, and this command executes MSGTLXXX.DMS to load your system with the appropriate PeopleTools messages (error and informational messages). Where XXX represents the language code, such as FRA for French. The system runs these scripts only if you have selected a base language other than English. Note. After each DDL create table, import data, and DDL create indexes, PeopleSoft Data Mover issues an UPDATE STATISTICS command (except on OS/390), which improves the performance of subsequent commands, such as the REPLACE_VIEW command.
See Also
Chapter 1, PeopleSoft Data Mover, CREATE_TEMP_TABLE, page 19 Chapter 1, PeopleSoft Data Mover, SWAP_BASE_LANGUAGE, page 28
Using the Data Mover Command Line Interface

The following section gives an overview of the command line feature and discusses: Running scripts from the command line. Command line parameters. Using a parameter file ("parm file").
Understanding the Data Mover Command Line Interface

The PeopleSoft Data Mover command line interface enables you to run PeopleSoft Data Mover scripts from the command line in UNIX and Windows environments. Keep in mind that the command line interface is designed only for running scripts, not creating and editing scripts. You create and edit scripts using the PeopleSoft Data Mover Development Environment, which is supported on Windows only. When using the command line interface the results of the script run appear in the command line window much like the contents of the output pane in the Windows GUI. The system also writes this information to the LOG file.
11
Chapter 1
PeopleSoft Data Mover supports $PS_HOME, for UNIX, and %PS_HOME%, for Windows NT. Note. The command line interface also runs on Windows machines, however, in most cases you would use the PeopleSoft Data Mover Windows GUI to run scripts on Windows machines. This documentation is geared towards UNIX.
Note. The PeopleSoft Data Mover command line on UNIX is intended to increase the performance with large database loads during installation. It is recommend that you use the PeopleSoft Data Mover Windows interface for other types of scripts.
Getting Started (on UNIX)

Before running the PeopleSoft Data Mover command line on UNIX, be aware of the following items: BEA Tuxedo is required for PeopleSoft Data Mover to run on UNIX, and it must be installed before you use the UNIX PeopleSoft Data Mover interface. Run psconfig.sh first to set the UNIX and PeopleTools environment variables before running PSDMTX. PeopleSoft supplies default UNIX environment variables for PeopleSoft Data Mover in the PSCONFIG.SH shell program. If you need to modify the default environment variables, you need to edit the PSCONFIG.SH or manually change the environment. For example, to change the PeopleSoft Data Mover environment variables modify the following: export PS_DM_DATA=<new data path> export PS_DM_SCRIPT=<new script path> export PS_DM_LOG=<new log path>
Configuration Setting $PS_DM_DATA Description Use this environment variable to specify the directory where PeopleSoft Data Mover should search for its input data files (.DAT). When running a PeopleSoft Data Mover script, if no explicit path is specified for the file named in the set input lines, then PeopleSoft Data Mover searches directories for the .DAT file in the following order. The default is $PS_HOME/data. Use this environment variable to specify the location of your PeopleSoft Data Mover scripts files. The default is $PS_HOME/scripts. Use this environment variable to specify the location of your PeopleSoft Data Mover log files. The default is $PS_HOME/log.
$PS_DM_SCRIPT
$PS_DM_LOG
Running a Data Mover Script from the Command Line

To run a script from the command line:
12
Chapter 1
1. Launch the command prompt. 2. Navigate to the %PS_HOME%\bin\client\winx86 directory for Windows and $PS_HOME/bin directory for UNIX. For example, Windows. %PS_HOME%\bin\client\winx86> UNIX. $PS_HOME/bin 3. Enter the name of the program to launch, which is PSDMTX. For example, Windows. %PS_HOME%\bin|client\winx86\psdmtx UNIX. $PS_HOME/bin/psdmtx 4. Enter all the appropriate command line arguments. To invoke PeopleSoft Data Mover to run a script from the command line, you need to specify the PeopleSoft Data Mover executable (PSDMTX.EXE) followed by the required parameters, as shown in the following example:
psdmtx -CT <dbtype> -CS <server> -CD <database name> -CO <user ID> -CP <password> - CI <connect ID> -CW <connect password> -FP <Filename>
See the following section for a complete description of all the command line parameters. 5. Press ENTER.
Understanding the Command Line Parameters

The following command line arguments are available to pass to PSDMTX.EXE for running PeopleSoft Data Mover Scripts. -CT Database type. Valid values are ORACLE, INFORMIX, SYBASE, MICROSFT, DB2, DB2ODBC, DB2UNIX. For example,
-CT ORACLE
-CS
Server name. The name of the database server for the database to which youre connecting. This setting is required for some database types. For example,
-CS pt-sun05
-CD
Database name. The name of the database to connect to, as you would enter at the PeopleSoft signon. For example,
-CD HR840DMO
-CO
The PeopleSoft user ID to use to login. For example,

-CO TOM2
-CP
The password for the specified user ID. For example,

-CP SAWYER2
13
Chapter 1
-CI
Connect ID. The ID used to connect to the database server. For example,
-CI HUCK
-FP
Filename. The name of the PeopleSoft Data Mover script to run. For example,
-FP $PS_HOME/scripts/test.dms
/help
Help. Shows the command line arguments and their description in your command prompt.
Using a Parameter File

Rather than submitting the arguments manually on the command line you can also have PeopleSoft Data Mover read a file that contains the appropriate parameters. PeopleSoft provides a sample parm file (parameter file) for you to use as a template, which you can find in $PS_HOME/setup directory. If you submit a filename to PeopleSoft Data Mover as the first parameter in the command line, PeopleSoft Data Mover reads the contents of the file and interprets the contents as if it were parameters entered on the command line. For example,
psdmtx $PS_HOME/setup/myparmfile.txt
Note. You must enter the full path to the parameter file.
Note. For security reasons, after PeopleSoft Data Mover interprets the contents of the parm file, it immediately deletes the parm file.
Understanding Data Mover Commands

In this section we briefly discuss each of the commands that you can use in a PeopleSoft Data Mover script and what you can expect them to accomplish. After reading this section, you will know all the valid PeopleSoft Data Mover commands and SQL commands that you can include in your PeopleSoft Data Mover scripts.
Data Mover Commands

PeopleSoft Data Mover commands are platform-independent and are unique to PeopleSoft Data Mover. You can use PeopleSoft Data Mover commands for importing, exporting, and other tasks, such as controlling the run environment, renaming fields and records, database security administration, and denoting comments. The following list presents the PeopleSoft Data Mover commands and methods to indicate comments: ENCRYPT_PASSWORD EXPORT Encrypts one or all users passwords (operator and access) defined in PSOPRDEFN for operators. Instructs PeopleSoft Data Mover to select record information and data from a record or records and places the result set in a file. You can use the export file generated as input for migrating to another platform. This file is portable between ASCII and EBCDIC character sets, and also supports double-byte characters.
14
Chapter 1
IMPORT
Inserts data into a table or tables using the information in an export file. If a tablespace or table does not exist, this command creates tablespace, table, and indexes for the record, using the information in the export file, and inserts the data. Use this to denote comment statements. Renames a PeopleSoft record, a field in one record, or a field in all records. A variation of the IMPORT command. If a table already exists, use this command to drop the table and its indexes from the database and create the table and indexes using the information in the export file. Then, it inserts data into the table using the information in the export file. A variation of the IMPORT command. Deletes data in existing table(s) and inserts the corresponding data from the export file. Recreates specified views found in the database. Executes a specified .DMS file from within a PeopleSoft Data Mover script. The file can not contain nested RUN commands. When followed by valid SET parameters, it forms statements that establish the conditions under which PeopleSoft Data Mover executes the PeopleSoft Data Mover and/or SQL commands that follow. Swaps all the language tables from PSRECDEFN. Optional. If the command is set then all errors during the swap base language will be ignore. Otherwise, it stops on error. Used to swap individual language tables. You should swap individual table only when there is an error with any of the table after the SWAP_BASE_LANGUAGE command.
REM, REMARK, -RENAME REPLACE_ALL
REPLACE_DATA REPLACE_VIEW RUN SET
SWAP_BASE_ LANGUAGE SET IGNORE_ERRORS SET BASE_LANGUAGE
SQL Commands
With PeopleSoft Data Mover, you can use supported SQL commands in scripts on any supported database platform. Except where noted otherwise (in the Standard SQL Commands topics), you can use all the supported SQL commands with the following PeopleSoft Data Mover SET statements: SET LOG SET NO COMMIT SET NO TRACE
Standard SQL Commands With DMS Scripts

PeopleSoft Data Mover supports the following standard SQL commands: ALTER COMMIT
15
Chapter 1
CREATE DELETE DROP Note. With DROP commands, any drop errors are ignored. The script continues, but the errors are reported in the log. GRANT INSERT Note. INSERT cannot be used with SET NO COMMIT or SET NO TRACE. ROLLBACK UPDATE Warning! PeopleSoft Data Mover does not support SELECT statements because they require a SQL FETCH function.
Standard SQL Commands with SQL Files

PeopleSoft Data Mover supports all SQL commands and other database specific function calls that are supported by the database engine. Note. PeopleSoft Data Mover only runs files with the extension .SQL.
Non-Standard SQL Commands

Also available for use with PeopleSoft Data Mover are some non-standard SQL commands created by PeopleSoftPSCOPY, STORE, and ERASE. Note. In previous versions of PeopleSoft, we supported a command called PSCOPY, which was an Oracle-specific command to support altering records that have a long field in an INSERT statement subquery. Now you should be running Oracle scripts generated by the Build feature in Application Designer through SQL*Plus.
STORE
To change COBOL SQL statements in PS_SQLSTMT_TBL, you use two non-standard, PeopleSoft SQL commands: STORE and ERASE. The STORE command first deletes the existing stored statement from PS_SQLSTMT_TBL, then inserts the new statement using the following syntax:
STORE progname_type_stmtname
For example:
STORE PTPEMAIN_S_MSGSEQ SELECT MAX (MESSAGE_SEQ), PROCESS_INSTANCE
16
Chapter 1
FROM PS_MESSAGE_LOG WHERE PROCESS_INSTANCE = :1 GROUP BY PROCESS_INSTANCE ;
ERASE
The ERASE command deletes one or all stored statements from PS_SQLSTMT_TBL. When deleting a single statement, you use the progname_type_stmtname format as shown for STORE, above. For example:
ERASE PTPEMAIN_S_MSGSEQ;
When deleting all SQL statements for a particular program, you include only the program name in the command line format. For example:
ERASE PTPEMAIN;
Command Matrix
The following table shows the relationship between SQL and PeopleSoft Data Mover commands. DDL refers to data definition commands, which define the structure of a database. DML refers to data manipulation commands which define the contents of a database.
Function Command Type Supported SQL Commands CREATE Data Mover Commands IMPORT, REPLACE_ ALL REPLACE_VIEW REPLACE_ALL None RENAME
Create tables, tablespaces, and indexes. Create views. Drop tables. Modify tables. Modify PeopleSoft records. Insert rows.
DDL
DDL DDL DDL DDL
CREATE DROP ALTER None
DML
INSERT, STORE*
IMPORT, REPLACE_ ALL, REPLACE_DATA
Delete rows. Update rows. Encrypt rows.
DML DML DML
DELETE, ERASE* UPDATE None
REPLACE_DATA None ENCRYPT_PASSWORD
17
Chapter 1
Function
Command Type
Supported SQL Commands None COMMIT, ROLLBACK
Data Mover Commands EXPORT SET (when used with COMMIT or NO COMMIT) SET, RUN
Select rows. Save/dont save changes.
Query Transaction
Control/execute other PeopleSoft Data Mover commands. Denote an explanatory statement.
Environment
None
Comment
None
REM, REMARK, --
* Non-standard SQL commands.
Data Mover Command Reference

This section provides the details of syntax and use for each of the PeopleSoft Data Mover commands. This section also discusses PeopleSoft Data Mover Command Modifiers such as AS, WHERE, and IGNORE_DUPS, which can be used to modify certain commands.
CHANGE_ACCESS_PASSWORD
The following topics contain information about syntax, SET parameters and the use of this command.
Syntax
The following is the proper syntax:
CHANGE_ACCESS_PASSWORD <SymbolicID> <newAccessPswd>
Valid SET Parameters

LOG, NO TRACE
Required SET Parameters

None.
Use
Security administrators should use the procedure outlined in this section to reset the Access Password and have it be transparent to users. The CHANGE_ACCESS_PASSWORD command performs the following operations:
18
Chapter 1
Selects the ACCESSPSWD field from PSACCESSPRFL for <SymbolicID>. Changes the Access IDs database password to <newAccessPswd> (Oracle, Sybase and Microsoft SQL Server only). Updates PSACCESSPRFL for <SymbolicID> with <newAccessPswd>.
CREATE_TEMP_TABLE
Syntax
CREATE_TEMP_TABLE {record | *}

None.

None.
Use
Creates temporary table images for use with Application Engine programs. To customize the number of temporary tables you need to modify the PeopleTools Options page or updated the PSOPTIONS table using the following SQL:
UPDATE PSOPTIONS SET TEMPTBLINSTANCE = <#>
You also need to review the number of temporary tables allotted for Application Engine programs. Note. This command is disabled for OS/390.DMS script generated by Database Setup due to security issues. See PeopleSoft Server Tools Administration, PeopleTools Utilities, PeopleTools Options.
CREATE_TRIGGER
Syntax
CREATE_TRIGGER {* | <RECNAME>

None.

None.
19
Chapter 1
Use
Creates database triggers on the specified table. Note. If using CREATE_TRIGGER in bootstrap mode, the system automatically activates SET IGNORE ERROR. This enables PeopleSoft Data Mover to continue processing until all of the view definitions have been processed and all errors have been written to the current .LOG file (or an error log file). This is similar to the REPLACE_VIEW behavior.
ENCRYPT_PASSWORD
Syntax
ENCRYPT_PASSWORD {userID | *};

LOG, NO COMMIT, NO TRACE

None
Use
Encrypts one or all user passwords (user passwords and access passwords). When encrypting a single users password, that user ID must be present in PSOPRDEFN. You can use an asterisk instead of a name to encrypt all passwords in PSOPRDEFN. Heres an example of how to encrypt a single user password (FS) already listed in PSOPRDEFN:
ENCRYPT_PASSWORD FS;
To encrypt all user passwords in PSOPRDEFN, enter:

ENCRYPT_PASSWORD *;
EXPORT
Syntax
EXPORT {record | *} [WHERE condition(s)];

LOG, NO COMMIT, NO DATA, NO TRACE, NO VIEW, OUTPUT
20
Chapter 1
Note. SET NO VIEW is only valid with EXPORT *.

None. Note. If SET OUTPUT is not used, PeopleSoft Data Mover writes to the default file name, DATAMOVE.DAT.
Use
Creates a single export file containing the database contents specifieda result set that can contain any of the following: a single PeopleSoft record, a group of records, or the entire database. You can use the export file as input for PeopleSoft Data Movers IMPORT command if you want to migrate the data within the platform, or to another platform. Note. This command is not available in Bootstrap mode. Records exported using EXPORT can have a maximum of 250 total columns and multiple long columns within the limitations for long columns set by your database platform. Check with your database vendor for restrictions on the number of long columns allowed for your platform. When you export all records using EXPORT*, PeopleSoft Data Mover orders them alphabetically, with the exception of PSLOCK; it is the last record exported. After each record, PeopleSoft Data Mover indicates how many records remain. After all the tables are exported, then the views are exported. To export a single record, use an EXPORT command for that specific record. For example:
EXPORT PS_JOB;
Note. When specifying a particular record in the EXPORT command (as shown in the previous example), the specified record must be a table, not a view. To export all PeopleSoft recordsincluding viewstype:
EXPORT *;
IMPORT
The following topics contain information about syntax, SET parameters and the use of this command. Note. The system will not allow the use of the Data Mover command IMPORT X AS Y where X table contains a trigger definition. This command is valid for tables without trigger definitions. See PeopleSoft Application Designer, Building SQL Tables and Views
Syntax
IMPORT {record | *} [IGNORE_DUPS] [AS new_table_name];
21
Chapter 1

All except OUTPUT Note. IGNORE_DUPS is only valid in Bootstrap mode.

INPUT
Use
IMPORT creates database spaces, creates non-existing records and indexes, and appends non-duplicate rows to records. It will also create the views if the export file was created using EXPORT * and imported using IMPORT *. Warning! All duplicate row checking depends on the existence of a unique index. If no unique indexes are created before loading the data, there is a potential for duplicate data. In the IMPORT statement, the AS clause is only valid if you specify a particular record; it is not valid and should not be used with IMPORT*. Also, the table name that you specify after the just after the AS command modifier must not exceed 18 characters (including the ps_ prefix). If you do specify a table_name that exceeds 18 characters the following error will appear: Error: Unable to process create statement. Records defined using IMPORT can have a maximum of 250 total columns and multiple long columns within the limitations for long columns set by your database platform. Check with your database vendor for restrictions on the number of long columns allowed for your platform. There are also two variations of IMPORT that you can useREPLACE_ALL and REPLACE_DATA. To import a single record from an export file, use an IMPORT command for that record. For example:
SET INPUT file_name; IMPORT PS_JOB;
To import all PeopleSoft records from an export file, including views, type:
SET INPUT file_name; IMPORT *;
Globalization Considerations
In previous releases, PeopleSoft Data Mover required multiple .DAT files for base and non-base languages. PeopleSoft Data Mover now offers a base-language-independent method for moving application data between databases. PeopleSoft Data Mover loads a single DAT file, detects the target database base language, and inserts the data into the correct base or related language table. This means that if PeopleSoft provides a software fix, you dont need to swap the base language before importing it into a database with a different base language. For example, suppose a fix is sent with the base language being English (ENG) and a related language of Japanese (JAP). In this case, you can import this file directly into a database where the base language is JAP and the related language is ENG. Upon EXPORT, the system adds the LANGUAGE_CD (Language Code) to the generated DAT file. For example,
22
Chapter 1
SET DAM_VERSION 8.4:1:0 SET BASE_LANGUAGE {ENG, FRA, }
Then, when you use the IMPORT command to import the generated DAT file, the system detects the LANGUAGE_CD in the DAT file and automatically resolves the base language/related language issues. Keep the following items in mind when running the IMPORT command. This feature is not optional; its enabled whenever you import a DAT file. There may be some unavoidable performance impact when running the IMPORT command. See Chapter 1, PeopleSoft Data Mover, REPLACE_ALL, page 26 and Chapter 1, PeopleSoft Data Mover, REPLACE_DATA, page 26.
REM, REMARK, - The following topics contain information about syntax, SET parameters and the use of this command.
Syntax
REM Comments; REMARK Comments; -- Comments

Not applicable

Not applicable
Use
Each of these three command variations denotes explanatory text in a PeopleSoft Data Mover script. Here are three examples explaining the use of each:
REM This example demonstrates the use of the REM command to set off script comments. These statements can span multiple lines and must be terminated with a valid delimiter; REMARK The REMARK command variation has the same restrictions as REM / -- This example demonstrates the use of two dashes to denote script -- comments. No delimiters are required, but statements can not -- exceed one line without using another double-dash.
When using a double-dash (--) in the third example, you need at least one space after the double-dashbefore the start of the actual text of the comment. Otherwise you will receive a syntax error.
23
Chapter 1
When used in conjunction with a comment prefixed by REM or REMARK, the forward-slash delimiter (/) should be by itself on the last line of that comment. In such cases: instead of using a forward-slash (/), you can also use a semi-colon (;) by itself on this last line. The forward-slash (/) can also be used by itself without a REM or REMARK statement, in lieu of blank lines, which are also allowed in a script.
RENAME
Syntax
RENAME {RECORD record | FIELD {field | record.field}} AS new_name;

LOG, NO COMMIT, NO TRACE

None
Use
Renames a PeopleSoft record, a field in one record, or a field in all records. Note. This command is not available in BootStrap mode. Warning! Using RENAME only modifies an object in the PeopleSoft tables. To write the change to the system tables you must either use Application Designer to Alter the affected tables (for record and field renames), or you must run TLSCOPY.SQR (for recfield renames.) To rename a recfield, you must qualify the original name of the field with the record name. If you dont qualify the record name, PeopleSoft Data Mover will try to globally change the field name in all records. Heres an example of how to rename a record:
RENAME RECORD absence_hist AS absent_hist;
Heres an example of how to globally rename a field:

RENAME FIELD effdt AS currdate;
Heres an example of how to rename a recfield:

RENAME FIELD course_tbl.duration_days AS duration_d;
Renaming a record field is only possible through PeopleSoft Data Mover, and you must complete the following steps for the rename to be complete. To rename a record field: 1. Perform the rename in PeopleSoft Data Mover.
24
Chapter 1
For example,
RENAME FIELD RECORD.FIELD AS NEWFIELD; COMMIT;
2. In Application Designer create a project which contains the record that contains the field that you renamed, and save the project. In the case of a subrecord field rename, the subrecord along with all tables which contain that subrecord must be inserted into the project. 3. Select Build, Settings. Select the Alter tab. Check Adds and Renames. Deselect Changes and Deletes. Drop Column and Change Column Length do not apply so it doesnt matter what is selected. Select the Scripts tab and select desired output settings. Specify an output file and click OK. 4. Select Build, Project. Select Alter Tables (Create Indexes will automatically be checked). Click Build. Click Yes to continue the build process. 5. Run the generated SQL script using your query tool. This adds the new field to the table(s) within the project. To remove the old field from the table(s): 1. In Application Designer, open the project you created the previous steps. Select Build, Settings. Select the Alter tab. Select Drop column if data present. Check Deletes. Deselect Adds and Renames. Select the Scripts tab. Give the output file a different name and click OK. 2. Select Build, Project. Check Alter Tables (Create Indexes will automatically be checked). Click Build. Click Yes to continue the build process. 3. Run the generated SQL script using your query tool. The old field should no longer appear on the table(s) included in the project.
25
Chapter 1
REPLACE_ALL
Syntax
REPLACE_ALL {record | *} [AS new_table_name];

All except IGNORE_DUPS, OUTPUT

INPUT
Use
A variation of the IMPORT command. If a table already exists, drops the table and its indexes from the database and creates the tables and indexes using the information in the export file. Then, the command inserts data into the table using the information in the export file. In the REPLACE_ALL statement, the AS clause is only valid if you specify a particular record. It is not valid and should not be used with REPLACE_ALL *. The table_name you specify after the AS command modifier should not have more than 18 characters (including the ps_ prefix). Specifying a table_name that is greater than 18 characters will invoke the following Error message: Error: Unable to process create statement. Note. Records defined using REPLACE_ALL can have a maximum of 250 total columns and multiple long columns within the limitations for long columns set by your database platform. Check with your database vendor for restrictions on the number of long columns allowed for your platform.
REPLACE_DATA
Syntax
REPLACE_DATA {record | *};

COMMIT, EXECUTE_SQL, EXTRACT, INPUT, INSERT_DATA_ONCE, LOG, NO COMMIT, NO TRACE, NO VIEW, SIZING_SET, SPACE, START, VERSION

INPUT
26
Chapter 1
Use
A variation of the IMPORT command. Deletes data in existing table(s) and inserts the corresponding data from the export file.
REPLACE_VIEW
Syntax
REPLACE_VIEW {view | *};

LOG, NO COMMIT, NO TRACE, START

None Note. If using REPLACE_VIEW in bootstrap mode, the system automatically activates SET IGNORE ERROR. This enables PeopleSoft Data Mover to continue processing until all of the view definitions have been processed and all errors have been written to the current .LOG file.
Use
Recreates one or all specified views in the database.
RUN
Syntax
RUN dms_file_name;

Not applicable

Not applicable
Use
Executes a DMS file from within a script. The specified file can contain any supported SQL commands, PeopleSoft Data Mover commands, or SET statements, but it can not contain any RUN commands.
27
Chapter 1
The RUN command cannot contain a directory path. The RUN command uses the same directory as the current PeopleSoft Data Mover script in which RUN is being used.
SET
Syntax
SET parameter_1; SET parameter_2; ... SET parameter_n;

Not applicable

Not applicable
Use
The SET command, when combined with valid SET parameters, creates statements that establish the conditions under which PeopleSoft Data Mover executes a script. A SET statement controls the processing environment for the commands in a script until another SET statement intervenes between commands. At that point, all SET parameters are reset to their default values. For example:
SET LOG c:\temp\new.log SET OUTPUT c:\temp\new.dat; / EXPORT absence_hist; EXPORT employee_tbl / SET NO DATA / REMARK All other SET parameters will be reset to their default values at this point ; EXPORT bank_branch_tbl;
In the above script, the specified log and output files (NEW.LOG and NEW.DAT) are used for the first two EXPORTs. Then, because SET NO DATA interrupts the script commands, all other SET parameters are reset to their default values. So, for the third EXPORT and any subsequent PeopleSoft Data Mover or SQL commands, the log file used is the default log file, DATAMOVE.LOG, and the output file used is the default output file, DATAMOVE.DAT.
SWAP_BASE_LANGUAGE
28
Chapter 1
Syntax
SWAP_BASE_LANGUAGE <NEW LANGUAGE_CD>; SWAP_BASE_LANGUAGE <RECNAME>;

Not applicable

Not applicable
Use
Use this command when you want to install any language other than English. For instance, if you wanted to swap English for Canadian French, enter the following:
SWAP_BASE_LANGUAGE CFR
Where CFR is the new language code (LANGUAGE_CD). The command swaps all the language tables from PSRECDEFN. Gets all table names that contain related table, swaps one table at a time. Copies base table into the relate table, updates related record into the base table, and then deletes related record from the related table. If successful it will update the PSOPTIONS SET LANGUAGE_CD = new base language. Note. Run the command SWAP_BASE_LANGUAGE <NEW LANGUAGE_CD> before you attempt to swap the individual record names.
Note. During the initial installation, Database Setup generates a script that automatically swaps the base language if while in the Database Setup interface you selected a base language other than English.
SET IGNORE_ERRORS
Syntax
SET IGNORE_ERRORS; SWAP_BASE_LANGUAGE <LANGUAGE_CD>;

Not applicable

Not applicable
29
Chapter 1
Use
Used in conjunction with the SWAP_BASE_LANGUAGE command. Heres an example of how to swap one table, without the SET IGNORE_ERRORS command, it will stop on error.
SWAP_BASE_LANGUAGE <LANGUAGE_CD>;
Heres an example of how to ignore all errors and swap all tables.
SET IGNORE_ERRORS; SWAP_BASE_LANGUAGE <LANGUAGE_CD>;
When the SWAP_BASE_LANGUAGE command is run after SET IGNORE_ERRORS, the PSOPTIONS SET LANGUAGE_CD will automatically be updated with new base language even if errors were recorded. When the command has run, you should then examine the log, and swap the individual record names that failed using SWAP_BASE_LANGUAGE <RECNAME> command.
SET BASE_LANGUAGE
Syntax
SWAP_BASE_LANGUAGE <NEW LANGUAGE_CD>; SET BASE_LANGUAGE <CURRENT LANGUAGE_CD>; SWAP_BASE_LANGUAGE <RECNAME>;

Not applicable

Not applicable
Use
Swap individual table is used only when there is an error with any of the table after the SWAP_BASE_LANGUAGE <NEW LANGUAGE_CD>. Note. Never run SET BASE_LANGUAGE <CURRENT LANGUAGE_CD>, SWAP_BASE_LANGUAGE <RECNAME> commands before SWAP_BASE_LANGUAGE <NEW LANGUAGE_CD>.
Data Mover Command Modifiers

The following commands allow you to modify a PeopleSoft Data Mover command to either limit its scope, rename the item being processed, or control error messaging.
30
Chapter 1
AS
The following topics contain information about syntax and use of this command modifier.
Syntax
{IMPORT | REPLACE_ALL} record AS table_name;
Valid Data Mover Commands

IMPORT, REPLACE_ALL
Use
Changes the name of a record, then imports it. When using this modifier, keep the following items in mind: If used with an IMPORT, the record will not be imported if the table_name specified in the IMPORT command) already exists in the database. When using the AS command modifier, you can specify either the record or table_name for the record/table specified preceding the AS. However, you must always specify the table_name (not the record_name) for the record/table specified following the AS. The name specified following the AS is the actual name that will be used for the table to be created. This modifier is not supported for records containing trigger definitions. All other records with no trigger definition are allowed. The following example imports a new record/table originally named PS_JOB and creates it as PS_PROCESS:
IMPORT job AS ps_process;
Also Correct:
IMPORT ps_job AS ps_process;
Incorrect:
IMPORT ps_job AS process;
Incorrect:
IMPORT job AS process;
The incorrect examples are wrong because process is specified, instead of ps_process. This means that the table created will be named PROCESS, when it should be named PS_PROCESS to comply with the convention that all non-PeopleTools tables should be prefixed with PS_. Therefore, ps_processnot processshould have been specified in the last two examples above.
31
Chapter 1
The table_name you specify following the AS command modifier should not have more than 18 characters (including the ps_ prefix). Specifying a table_name that is greater than 18 characters will invoke the following Error message: Error: Unable to process create statement. When you import a record in this way, it is only created in the system tables, not in the PeopleSoft tables. So, you must also create it in the PeopleSoft tables, such as PSRECDEFN, by completing the following steps. To create a table after running the IMPORT command: 1. Launch Application Designer 2. Create, or clone, the new record. Using the Job/Process example from the previous discussion: open JOB and then select File/Save As and rename the record to PROCESS. Note. The PS_ does not appear in the Application Designer. 3. Select Build, Current Object. 4. On the Build dialog, select Create Tables under Build Options. You may also want to make sure that all the appropriate options are set in the Build Settings tabs.
IGNORE_DUPS
Syntax
SET IGNORE_DUPS; IMPORT {record | *};

IMPORT
Use
Ignores duplicate row error messages from the database, which means that the IMPORT process will continue despite any duplicate rows errors displayed in the output window and log file. When IGNORE_DUPS is set, bulk loadingthe ability to load more than one row at a timeis turned off. By default, bulk loading is on and inserts many (100) rows into a table at a time. Because turning off bulk loading slows performance, we suggest that you use this feature only when required. Note. SET IGNORE_DUPS is only valid in Bootstrap mode.
WHERE
32
Chapter 1
Syntax
EXPORT {record | *} WHERE condition(s)[;var#1_type,_var#1_value,var#2_type,var#2_value,... var#n_type,var#n_value];
Warning! In an EXPORT statement, the WHERE modifier must be on the same line as the EXPORT command.

EXPORT
Use: Exports
Exports a partial set of rows from a record. The syntax and conditions of a Data Mover WHERE clause in an EXPORT are similar to a WHERE clause in SQL. You can write the WHERE clause with comparison operands inline or as bind variables. You can also use sub-SELECTs. Heres an example of a WHERE clause using both an inline operand and bind variables in an EXPORT script:
EXPORT JOB WHERE EFFDT > :1 AND HOURLY_RT > :2 AND GRADE = ADV;DATE,1994-01-01,NUMBER,100;
Note that there are no single or double quotation marks around the bind data, as they are not necessary, and notice that dates are formatted as YYYY-MM-DD. The valid data types for binding are CHAR, NUMBER, DATE, TIME, DATETIME, LONG, and IMAGE. Not all database platforms support LONG or IMAGE data types in the WHERE clause, so you should not use WHERE clauses with these data types. The following operators are supported in an Import WHERE clause: =, < >, <, >,< =, > =, and simple uses of AND and OR. For example, in the following formula, if A, B, and C are true, or if D is true, or if E is true, then the whole statement is true:
WHERE A = :1 AND B = :2 AND C = :3 OR D = :4 OR E = :5;NUMBER,10,NUMBER,20,NUMBER,30,NUMBER,0,NUMBER,1;
When Data Mover Issues COMMITs

PeopleSoft Data Mover issues COMMIT statements after most successful SQL commands, except for EXPORT * and IMPORT *. For EXPORT * and IMPORT *, PeopleSoft Data Mover issues a COMMIT after each record. With IMPORT *, there is a SET COMMIT n command that performs a COMMIT after the system inserts every n rows.
33
Chapter 1
If you are executing native SQL in PeopleSoft Data Mover and no COMMITs exist in the SQL script, PeopleSoft Data Mover issues a COMMIT after each successful SQL statement. For example, if you run a PeopleSoft Data Mover script that contains three update commands and the third command fails, the first and second update commands are committed, but the third command is not.
SET Parameter Reference

The following parameters can be appended to a SET command to create a valid SET statement.
COMMIT
The following topics contain information about syntax and use of this parameter.
Syntax
SET COMMIT #of_rows;

IMPORT, REPLACE_ALL, REPLACE_DATA
Valid SQL Commands

None
Use
Sets the commit level only for inserting rows and not for DDL statements. If the level is set to 0, commits will only be done when all rows for a record are inserted. Due to the expense of recompiling and rebinding after a commit, the default is 0.
CREATE_INDEX_BEFORE_DATA
Syntax
SET CREATE_INDEX_BEFORE_DATA;

IMPORT, REPLACE_ALL
Valid SQL Commands

None
34
Chapter 1
Use
Creates the index before inserting rows into a record. The default method is to insert rows into a record and then create the index.
DBSPACE
Syntax
SET DBSPACE {<old dbname>.<old spcname>} AS {<new_dbname>.<new spcname>};

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
The DBSPACE command is similar to the SPACE command in use, but it is designed to handle the combination of DBNAME.DDLSPACENAME. On DB2, the DBNAME or DDLSPACENAME alone is not necessarily unique. However, the combination of the two (DBNAME.DDLSPACENAME) provides a unique relationship. For example, DBSPACE would be needed in the following scenario: Note. This command is supported only on DB2 for OS/390. You use this command in place of the SPACE command used on other platforms.
PSFSDMO.HRAPP PSHRDMO.HRAPP PSPTDMO.HRAPP
The wild card (*) character is permitted for the <dbname> and <spc name> parameters to apply to all values being processed for the specific parameter in which the wild card character is used. The following are examples of using this command to achieve one of the following: To change a specific DBNAME/DDLSPACENAME combination to a single new combination:
SET DBSPACE <old dbname>.<old spcname> AS <new dbname>.<new spcname>
To keep the current DBNAMEs the same but change the specific DDLSPACENAME to a new name:
SET DBSPACE <*>.<old spcname> AS <*>.<new spcname>
To keep the current DDLSPACENAMEs the same, but change the specific DBNAME to a new name:
SET DBSPACE <old dbname>.<*> AS <new dbname>.<*>
35
Chapter 1
Warning! Because of the large number of objects delivered in the PeopleSoft logical databases, we strongly advise that you do not override all old dbname or spcname values to a single new dbname or spcname value when building a SYS or DMO database. The functionality to do so, is delivered, however, and may be useful in working with smaller data files that contain a smaller number of objects. For large databases, the following commands are not recommended:
SET DBSPACE <*>.<*> AS <new dbname>.<new spcname> SET DBSPACE <*>. <*> AS <*>.<new spcname> SET DBSPACE <*>.<*> AS <new dbname>.<*>
You can use multiple SET DBSPACE statements to override the DDLSPACENAME in the .DAT file. This enables you to override multiple databases in the same section of the script. For example,
SET SET SET SET DBSPACE DBSPACE DBSPACE DBSPACE PSFSDMO.* AS MYFSDMO1.*; PSFSDMOF.* AS MYFSDMO2.*; PSFSDMOD.* AS MYFSDMO3.*; PSFSDMOM.* AS MYFSDMO4;
DDL
Syntax
SET DDL {RECORD | INDEX | UNIQUE INDEX | SPACE} {object_name | *} INPUT parm AS value;

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Substitutes values for the parameters specified in the DDL template commands. Substitutes the parm and value placeholders for an actual parameter and its value. If an asterisk is used instead of an object name, a SQL update on PSDDLDEFPARMS is performed on the parameter and value upon successful completion of the IMPORT or REPLACE_ALL command that corresponds to the SET DDL statement. Below are some examples of DDL template SET commands from a DB2 import script:
SET DDL RECORD SET DDL INDEX SET DDL SPACE * * * INPUT dbname INPUT stogroup INPUT stogroup AS pt750dg0; AS wps04sg; AS wps04sg;
36
Chapter 1
EXECUTE_SQL
Syntax
SET EXECUTE_SQL [AFTER] sql_statement;

Valid SQL Commands

None
Use
Executes the sql_statement specified at the beginning of a transaction. Typically, this command is used to setup a specific cursor environment before PeopleSoft Data Mover begins processing. For example, in DB2, use this command to set the current SetID, or for Oracle, use this command to designate a specific rollback segment. This command doesnt execute for DDL SQL statements. For example, in DB2, you cannot set the current SetID before creating spaces, tables, indexes, or views.
EXTRACT
Syntax
SET EXTRACT {COMMAND | DDL | INPUT | SPACE | OUTPUT file_name};

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Extracts various types of information from an export file (the .DAT file specified in the corresponding SET INPUT command that precedes the IMPORT or REPLACE ALL command) and writes this information to the user defined output file specified in the SET EXTRACT OUTPUT file_name statement. Note. You must use SET EXTRACT OUPUT before issuing any other SET EXTRACT statements.
37
Chapter 1
EXTRACT INPUT writes out any statements from the .DAT file that are associated with the table(s) being imported. EXTRACT DDL writes out any CREATE TABLE, CREATE INDEX, or CREATE UNIQUE INDEX statements from the .DAT file. EXTRACT COMMAND writes out the EXPORT statements from the .DAT file. When EXTRACT statements are issued, no SQL CREATE or INSERT statements will be executed. The associated IMPORT or REPLACE_ALL command is not actually executed, so no import is performed.
IGNORE_DUPS
Syntax
SET IGNORE_DUPS;

IMPORT Note. The command SET IGNORE_DUPS is only valid in Bootstrap mode. This prevents the lost of data during a PeopleSoft Data Mover import of a language table in user mode.
Valid SQL Commands

None
Use
Ignores duplicate row error messages from the database; the IMPORT process will continue despite any duplicate row errors displayed in the output window and log file. You can set this command for the entire import script or by record, using IGNORE_DUPS as a command modifier. When IGNORE_DUPS is set, bulk loadingthe ability to load more than one row at a timeis turned off (to allow checking for duplicates, so that duplicate rows can be ignored/bypassed). By default, bulk loading is on and inserts many (100) rows into a table at a time. Because turning off bulk loading slows performance, we suggest that you use this feature only when required and/or by record. See Chapter 1, PeopleSoft Data Mover, IMPORT, page 21 and Chapter 1, PeopleSoft Data Mover, IGNORE_DUPS, page 32.
INPUT
Syntax
SET INPUT file;
38
Chapter 1

Valid SQL Commands

None
Use
Specifies the name of the exported file to import; typically this file will have a .DAT extension, though this is not a requirement. Because this statement is required to do an import, there is no default file. If you dont specify a path for this file, PeopleSoft Data Mover searches for the file in the following locations in the order presented: The Data Mover Input Directory as defined in the Configuration Manager on the Common tab. If the Input Directory is set to blank (not set) on the Common tab, PeopleSoft Data Mover will search the C:\TEMP directory.
INSERT_DATA_ONCE
Syntax
SET INSERT_DATA_ONCE record;

Valid SQL Commands

None
Use
Instructs PeopleSoft Data Mover to skip (bypass importing) the specified record if there is already one or more rows in the table corresponding to that record. If the table is empty, only a single row will be inserted.
LOG
Syntax
SET LOG file;
39
Chapter 1
Note. You must specify a file name for the SET LOG statement or else a log file will not be created. If you do not want to specify a log file name, you should omit the SET LOG statement completely.

All
Valid SQL Commands

All
Use
Allows you to specify a user-defined filename for the log file that will be created when running a PeopleSoft Data Mover script or command. If the SET LOG statement is omitted completely, a default log file will be created with the name DATAMOVE.LOG. Data Mover will write this DATAMOVE.LOG file to the default log directory, which is determined as follows: The PeopleSoft Data Mover log directory specified on the Common tab in the Configuration Manager. If the previous setting is blank, the log file will be written to C:\TEMP. Note. If you use the SET LOG statement but do not specify a filename and path, PeopleSoft Data Mover will write the user-defined log file to the default log directory according to the same rule defined above. When checking the DATAMOVE.LOG file in a multi-database environment, always make sure you are examining the correct log file. At the top of the output file, check the date and the database name to confirm.
Logging status in C:\TEMP\datamove.log Started: Fri Mar 17 13:47:15 2001 Data Mover Release: 8.4 Database: HR702U40 . Ended: Fri Mar 17 13:47:20 2001 Successful completion
NO DATA
Syntax
SET NO DATA;

EXPORT, IMPORT, REPLACE_ALL
Valid SQL Commands

None
40
Chapter 1
Use
During an export, the NO DATA command prevents data from being exported. In an import, this command prevents data from being inserted.
NO INDEX
Syntax
SET NO INDEX;

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Prevents indexes from being created during an IMPORT or a REPLACE_ALL command.
NO RECORD
Syntax
SET NO RECORD;

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Prevents records from being created during an import.
NO SPACE
Syntax
41
Chapter 1
SET NO SPACE;

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Prevents tablespaces from being created. This is the default setting. You can use this statement to reset the default after executing a SET SPACE statement.
NO TRACE
Syntax
SET NO TRACE;

All
Valid SQL Commands

All except INSERT
Use
Sets the PeopleSoft trace flag (TraceSQL) in the Configuration Manager to off for the commands that follow, until the next SET statement. This is the recommended method of executing commands. This means that if SET NO TRACE is specified, then no trace file will be created, even if you specify a Trace File in the is Configuration Manager on the Trace tab. Commands that you run without specifying SET NO TRACE, will trace SQL if SQL tracing is enabled in the Configuration Manager. Note. This statement cannot be used with an INSERT command.
NO VIEW
Syntax
SET NO VIEW;
42
Chapter 1

EXPORT * only, IMPORT * only, REPLACE_ALL * only, REPLACE_DATA * only
Valid SQL Commands

None
Use
Prevents views from being created.
OUTPUT
Syntax
SET OUTPUT file;
Note. You must specify a file name for the SET OUTPUT statement or else a log file will not be created. If you do not want to specify a log file name, you should omit the SET OUTPUT statement completely.

EXPORT
Valid SQL Commands

None
Use
Allows you to specify a user-defined filename for the output file that will be created by the corresponding EXPORT statement. If the SET OUTPUT statement is omitted completely, a default output file with the name DATAMOVE.DAT will be created. The location that the output file is created is determined by the following: The PeopleSoft Data Mover Output Directory specified on the Common tab in the Configuration Manager. If the previous setting is blank, the output file will be generated to the C:\TEMP directory. Note. If you use the SET OUTPUT statement but do not specify a filename and path, PeopleSoft Data Mover will write the user-defined log file to the default log directory according to the same rule defined above.
SIZING_SET
Syntax
SET SIZING_SET n;
43
Chapter 1

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Specifies the Sizing Set numberas defined in the DDL Model Defaults page. Default is 0. To use this parameter, the specified sizing set must be defined in the export file. See PeopleSoft Server Tools Administration, PeopleTools Utilities, DDL Model Defaults.
SPACE
Syntax
SET SPACE old spcname AS new_spcname;

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Used for all operating systems other than OS/390. Renames the default space names to customized space names. To name all record default space names to a single space name, substitute * for a space name. For example:
SET SPACE * AS PS;
START
Syntax
SET START [AFTER] record;

IMPORT, REPLACE_ALL, REPLACE_DATA, REPLACE_VIEW
44
Chapter 1
Valid SQL Commands

None
Use
Designates where in the export file to start the import process. The default is to start at the beginning of the file. If you want to start immediately after a particular PeopleSoft record in the file, use SET START AFTER. This SET statement is useful for restarting a script after an error. If the AFTER parameter is omitted, the import process starts at the record thats specified in the SET START statement. If the AFTER parameter is specified, the import process starts after the record thats specified in the SET START statement. Note. If the same record name appears multiple times in the same .DAT file, the SET START AFTER command begins after the last occurrence of the record name in the .DAT file. When using the SET START command with REPLACE_VIEW and no .DAT file specified, this designates what view in the database to start at or after. Views are created in alphabetical order.
STATISTICS
Syntax
SET STATISTICS { ON | OFF };

IMPORT, REPLACE_ALL
Valid SQL Commands

None
Use
Turns UPDATE STATISTICS on or off. The default value is on. Turns value to off, if you do not want to update statistics after an IMPORT. This command works only in bootstrap mode.
VERSION
Syntax
SET VERSION sql_table.column condition;
45
Chapter 1

Valid SQL Commands

None
Use
Verifies the version of the database for importing. For example, if you state the following:
SET VERSION PSLOCK.TOOLSREL=8.4
PeopleSoft Data Mover verifies that the TOOLSREL column in PSLOCK equals 8.4. This avoids importing an export file into the wrong database. Use the SQL table name to indicate which PeopleSoft record to check.
Script Examples
This section shows you several example script files. Review these scripts to see how you can use Data Mover to accomplish different tasks.
Exporting a Database
For example,
SET OUTPUT c:\temp\pt.dat; SET LOG c:\temp\pt.log; EXPORT *;
Building a Microsoft SQL Server Database

For example,
set log c:\temp\hcengd.log; set input c:\HRDMO\data\hcengd.db; set no view; set no space; set no trace; import *; update PSLOCK set OWNERID = ownerid; update PSOPRDEFN set ACCESSID = accessid, ACCESSPSWD = accesspw, OPERPSWD = 0000000000000000 where OPRTYPE = 0; update PSACCESSPRFL set ACCESSID = accessid, ACCESSPSWD = accesspw, VERSION = 0, ENCRYPTED = 0; set log c:\temp\grant.log; encrypt_password *;
46
Chapter 1
Recreating All Views

For example,
SET LOG c:\temp\view.log; REPLACE_VIEW *;
Importing With REPLACE_ALL With a Commit Level

For example,
SET INPUT c:\ptdvl\bin\exp2.dat; SET LOG c:\ptdvl\bin\exp2.log; SET COMMIT 2; REPLACE_ALL employee_review; REPLACE_ALL course_tbl WHERE days_duration = :1 AND course_type > :2;number,1,char,C; REPLACE_ALL absence_hist WHERE return_dt > :1;date,1988-01-01;
Combining SQL Commands and IMPORT

For example,
SET INPUT c:\ptdvl\bin\exp2.dat; SET COMMIT 10; SET START AFTER course_tbl; SET IGNORE_DUPS; DELETE FROM ps_absence_hist WHERE emplid = 8001; IMPORT *;
47
Chapter 1
48
CHAPTER 2

This chapter describes what PeopleSoft Configuration Manager is and how to use it. Configuration Manager interface. Startup page. Display page. Crystal/Business Interlink page. Trace page. Workflow page. Remote Call page. Client Setup page. Import/Export page. Profile page. Command line options. Set up the development environment.
Understanding PeopleSoft Configuration Manager

PeopleSoft Configuration Manager simplifies workstation administration by enabling you to adjust the PeopleSoft registry settings from one central location. It lets you set up one workstation to reflect the environment at your site, and to then export the configuration file, which can be shared among all the workstations at your site. The Configuration Manager contains a variety of controls that let you set up your workstations for connecting to the database, using workflow, and so on. It allows you to define separate "profiles" for connecting to different PeopleSoft databases. The following sections describe each tab in the Configuration Managers interface and explain the environment settings you can specify.
49
Chapter 2
Working with the Configuration Manager Interface

Configuration Manager allows you to access PeopleSoft-specific registry settings from a central locationsaving you from hunting through the registry on your own. Its also easy to use due to its familiar interfacea Windows dialog box consisting of multiple tabs.
Configuration Manager
You can start Configuration Manager by double-clicking the Configuration Manager shortcut in your PeopleSoft program group. You can also start the program online by selecting Edit, Preferences, Configuration from within a PeopleSoft Windows application. The various PeopleSoft configuration parameters are grouped on the dialog tabs according to the function, feature, or PeopleTools application that they control. The label on the tab identifies the kind of parameters you can expect to find there. The following buttons appear for each folder tab. OK Cancel Apply Saves your settings and exits Configuration Manager. Closes Configuration Manager without saving any changes you have made. Saves your changes without exiting.
50
Chapter 2
Note. The changes you make within Configuration Manager do not take effect until the next time you start PeopleSoft.
Startup
The options on the Startup tab enable you to customize the default values that appear on the signon screen. Users do not need to change any values unless they do not want to accept the defaults.
Startup Tab
Signon Defaults
These options let you customize the defaults shown on the signon screen. Users only need to change the values if they do not want the defaults. They will, of course, need to be authorized to make any changes to the signon defaults. As an example, heres a PeopleSoft Signon dialog containing the values from the previous Startup tab.
51
Chapter 2
PeopleSoft Signon Dialog
Database Type
This is where you select the name of the databaseMicrosoft SQL Server, Oracle, Informix, and so onthat you want to appear as a default on the PeopleSoft Signon window. You can also choose Application Server to log on to an application server instead of a database. For a list of the possible choices, view the drop-down list. To allow users to change their Database Type selection in the signon dialog, you must select the Database Type option in the User Can Override group.
Note. When you select Application Server from the Database Type drop-down list, the Server Name and Database Name controls are disabled. The system obtains these values from the application server. Application Server Name If you selected Application Server from the Database Type drop-down list, you need to specify the application servers name in this field. You must have already configured your application server and registered it on the Profile tab. Enter the name of the default database server in the Server Name field. This parameter is only enabled for Informix, Sybase, and Microsoft SQL Server, and refers to the instance to which the user connects. Informix. The Server Name must be entered in lowercase. Microsoft SQL Server. The Server Name value is used to automatically create your ODBC data source name. Database Name Enter a default database name. You can choose any valid PeopleSoft database name. As with Database Type, you must select the appropriate option in the User Can Override group to allow users to override the default database name selection at signon.
Server Name
52
Chapter 2
User ID
The User ID parameter lets you specify the default user ID that will be used to log on to PeopleSoft. This parameterlike all the Startup parametersis optional. You can use the User ID parameter in conjunction with a PSUSER module containing a user-defined logon process. The PSUSER code, if present, can evaluate and modify the User ID value before you attempt to log on to the selected database.
Connect ID and Connect Password
PeopleSoft uses the Connect ID for the initial connection to the database. Use the Connect Password field to define a default connect ID password.
See PeopleTools Security, Understanding PeopleSoft Security. Note. The Connect ID edit box must contain a value or the user cant sign on to the system in a two-tier environment. See PeopleTools 8.42 Installation Guide for Your Database Platform
Numeric Keypad - Enter Key Tabs to Next Field

In Microsoft Windows applications, pressing the ENTER key in a dialog box selects the default action button. For example, in the PeopleSoft Signon dialog box, pressing ENTER is the same as clicking the OK button. Selecting the Numeric keypad...check box overrides this default behavior for the ENTER key on the numeric keypad: instead of selecting the action button, pressing the ENTER key moves the cursor to the next field in the dialog box. Note. This check box affects the ENTER key on the numeric keypad, but not the ENTER key on the main keyboard.
User Can Override

Some PeopleSoft sites use multiple database types and names. Using the check boxes in the User Can Override group, you can enable users to enter a database type, database name, or user ID other than the default provided at logon. Of course, in most cases, you will use these controls to prevent users from attempting to signon onto any database other than the default. The settings in this group work as follows: Database Type If you select Database Type users can choose a database other than the default. Selecting this option selects the Database Name and User ID options automatically. You cannot deselect Database Name or User ID without first deselecting Database Type. When configuring a workstation to connect in both two-tier and three-tier, you must select this option. The user will need to specify a two-tier or three-tier connection from the PeopleSoft Signon dialog. If you just select Database Name, the User ID check box is selected by default. However, you can deselect User ID by clicking on it. To disable Database Name, you must deselect the Database Type check box. If you want to let users override only the User ID submitted at logon, just select User ID. You cannot disable User ID if Database Type is selected.
Database Name
User ID
53
Chapter 2
Cache Files
Enter the parent directory that holds your cache file directories. For example:
C:\PS\CACHE
Note. Cache files store database object information locally and are automatically downloaded the first time you open a PeopleSoft database object. They are also downloaded automatically if the master copy of the object on the database server is changed. There is one cache file directory that stores the cache files for each PeopleSoft database that you use. Clicking Purge Cache Directories, brings up a dialog with your existing cache file directories.
Purge Cache Directories Dialog
You can select a single directory and press Delete, or you can press Delete All to remove all the directories. If a cache file directory is missing (after you delete it), the system will automatically rebuild it the next time cache files are downloaded. After you delete the appropriate cache directory, press Close to return to the Startup tab.
Display
The Display tab allows you to customize the appearance of your PeopleSoft Graphical User Interface (GUI). For instance, you can adjust the width and height of your pages to fit in with the other elements on your desktop.
54
Chapter 2
Display Tab
Language
In the Language drop-down list, specify which language you want to display on your PeopleSoft pages. The default setting is US English. Note. The Language drop-down list lets you choose from the languages that PeopleSoft delivers. However, you are not limited to those choices, and can customize your applications to appear in another language. However, you cannot switch to such languages via the Configuration Manager. You instead have to switch to them by manually changing the registry setting.
Page Display
You can customize the way PeopleSoft pages appear on the screen. You can adjust the entire display size or just the page height and width. Display Size, Width, and Height You specify the Display Size (in pixels) of your screen. This affects the default size of the PeopleSoft windowas displayed in the corresponding Width and Height fields. The drop-down list provides four options: 640 X 480 (Window size defaults to 640 x 448) 800 X 600 (Window size defaults to 800 x 576)
55
Chapter 2
1024 X 768 (Window size defaults to 1024 x 744) Custom (You can manually set default window size by specifying Width and Height values) Note. Changing these parameters does not affect any open windows. And, if either value is either blank or zero, the values will be reset to the 640 X 480 display size. Page Sizing You can specify the way pages are displayed if they were designed for a different size window than is opened. You have the following two options: CLIP. Page controls are always displayed in their normal size. If a page is too large for the window, the page information will be clipped along the right and bottom edges of the window, but window scroll bars will let you view the remainder of the page. SCALE. Pages are scaled to fit the window as necessary. For example, if your Display Size is set to 640 X 480 and you open a page designed to display in an 800 X 600 window, the page controls will be scaled down so that all page information appears. Conversely, if you open a 640 x 480 page in a larger window, the page controls will be scaled to fill the window completely. Show Page in Navigator Highlight Popup Menu Fields Select this check box if you want to see the navigator tree view and the page view at the same time. This check box lets you specify whether fields with associated popup menus are highlighted. By default, this option is disabled. In most cases, its a good idea to indicate which fields contain popup menus. The visual cue that denotes a popup menu is a black rectangle surrounding the perimeter of a page control.
See PeopleCode Developers Guide, Understanding PeopleCode and Events. Show Database Name The Show Database Name check box is especially useful if you are running multiple instances of PeopleTools. When you have a PeopleSoft page open and Show Database Name is selected, the name of the database to which you are connected appears in the Status bar at the bottom of the page, in addition to the current page name and the activity that normally appear. For example, the Status bar might read PTDMO, Job Data 1, Addin that order.
Note. The database name may be abbreviated to fit on the screen.
Font
The Font options enable you to customize the way the PeopleSoft text appears on the screen. You specify the font by clicking on the Font button to bring up a standard font selection pop-up menu. Select the font you want from that menu.
56
Chapter 2
Font dialog box
Business Process Display

There are three options for Business Process Display: On. The Navigator will appear with each menu group you open. Off. The Navigator will not be displayed. The user will have to launch it manually. First. The Navigator will only appear on the very first instance of PeopleSoft. Subsequent instances will not display the Navigator.
Crystal/Business Interlink
The Crystal/Business Interlink tab contains the necessary settings for Crystal Reports in the PeopleSoft environment and for Business Interlinks.
57
Chapter 2
Crystal/Business Interlink Tab
Crystal Options
If you have Crystal installed locally on the workstation, the Crystal EXEs Path is populated automatically. But, if you have Crystal installed on a network drive, you should set this parameter to reflect the location of the Crystal Reports executables. For example:
n:\hr840\bin\client\winx86\crystal
You can create customized reports with Crystal, and the Default Crystal Reports option lets you specify the default location of such reports. If this option does not apply to your sites Crystal implementation, leave this parameter blank. When you select Use Trace during execution, Crystal writes the trace statements to a log file that you specify in the Trace File field.
Business Interlink Driver Options

In the Business Interlink Directory box, enter the complete path to the directory that contains the drivers Business Interlinks use to communicate with external systems.
58
Chapter 2
Trace
The Trace tab lets you select the tracing options for various parts of the PeopleTools systemsuch as SQL statements, PeopleCode, and Application Engine. If you work on tuning your PeopleSoft system and improving online performance, you should familiarize yourself with this tab. You can also set these trace options through the PeopleTools Utilities page. Note that when you update the Trace tab in the Configuration Manager, the new settings only take effect the next time you launch PeopleTools. Note. The Trace tab in Configuration Manager only traces Windows client (two-tier) interactions. Only use this option when you require tracing on the client. See PeopleSoft Server Tools Administration, PeopleTools Utilities, Debug Utilities.
Trace Tab
PeopleTools Trace File

The default filename for the PeopleTools Trace File is DBG1.TMP. The system writes the file to the following directories: On Windows: %TEMP% directory. On UNIX: $PS_HOME/log/dbname.
59
Chapter 2
To specify a different PeopleTools Trace File 1. From the Trace tab in Configuration Manager, click the button on the right side of the PeopleTools Trace File edit box; a standard Open dialog appears. 2. Navigate to and select the new trace file. 3. Click Open. The PeopleTools Trace Filefield will now display the path and filename.
Workflow
The Workflow tab is where you specify the options and locations related to the Workflow implementation at your site. Electronic Workflow allows you to keep track of and assign tasks within business processes automatically.
Workflow Tab
Mail Protocol
If you want to incorporate email into your Workflow scheme, and most likely you do, the Mail Protocol group lets you specify which mail protocol your site uses. PeopleSoft supports the following protocols:
60
Chapter 2
MAPI, or Mail API, is a programming interface that allows you to send and receive mail over the Microsoft Mail messaging system. If your site uses this mail protocol , select this option to configure your client to perform PeopleSoft Workflow email generation. VIM, or Vendor Independent Messaging Interface, is a programming interface that enables you to send and receive email over a VIM-compliant messaging system, such as cc:Mail. If your site uses this mail protocol, select this option to configure your client to perform PeopleSoft Workflow email generation. Mail DLL Path After you have specified what Mail Protocol your site uses, enter the location of the mail DLL. For example:
C:\Windows\System
Detach Directory
This is where you specify the directory into which PSNOTES.EXE detaches any file attachments on the forms it receives. This is also where PSNOTES.EXE places any files that it does not deliver to the Message Agent. To set limits on the number of worklist instances or entries that will display when viewing worklists, use the Maximum Worklist Instances control. The default value is 250. If you do not want any rows returned, leave the edit box blank.
Maximum Worklist Instances
See Also
PeopleSoft Workflow, Defining Worklist Records
Remote Call/AE
Some of PeopleSofts applications make use of Tuxedos Remote Call feature, which invokes data-intensive transactions on a remote server. This helps to alleviate heavy processing on the client.
61
Chapter 2
Remote Call/AE Tab
Timeout
Timeout is the amount of time after which Remote Call will terminate the child COBOL process. The default is 50 seconds. Set an appropriate time for your site. You have the following Remote Call debugging options: Redirect Outputlets you specify whether the stdout/stderr of the child COBOL process should be directed to a file. The default is deselected. Support COBOL Animationallows you save the COBOL input file so that you can reuse it with COBOL animator. The default is deselected.
Debugging Options
Show Window State
This option lets you specify how the window state of the child COBOL process appears on the desktop. You can choose the following: Normal. Appears like a DOS window on the desktop. Minimized. Appears as an icon on the task bar. Hidden. Runs unseen in the background.
62
Chapter 2
Shared Flags
Specify whether or not to disable the DB Stats feature, which is the %UpdateStats meta SQL construct. This setting applies to Application Engine programs. See PeopleTools PeopleBooks: PeopleSoft Application Engine, Using Meta SQL and PeopleCode, %UpdateStats
Client Setup
As part of the PeopleSoft installation process you need to configure the developer workstations (also called the PeopleTools Development Environment) to run successfully with your PeopleSoft system. The Client Setup tab is where you select many of the options that will affect developer workstations and invoke the Client Setup process. For example, here you choose which shortcuts will appear on a developer workstation desktop. This is not the only tab that contains essential values for the PeopleTools Development Environment. All of the Configuration Manager tabs should reflect the correct values for your siteespecially the Startup tab and the Process Scheduler tab for the Default profile.
Client Setup Tab
63
Chapter 2
Shortcut Links
Here are the various shortcut links: Application Designer Configuration Manager Data Mover Uninstall Workstation PeopleTools RPT Converter Adds a shortcut for the main PeopleTools development environment. Adds a shortcut for the PeopleSoft Configuration Manager, which allows you to edit registry settings relevant to PeopleSoft. Adds a shortcut that will launch Data Mover. Adds a shortcut for Uninstall Workstation, which uninstalls the most recent Client Setup. Adds a shortcut to a stand-alone program that converts your RPT files from the format PeopleSoft used in previous releases to the PeopleTools 8 format. You only need to run this program if you are upgrading from previous versions of PeopleTools. Adds an nVision menu item to the PeopleSoft 8 menu group in the Windows Start menu.
nVISION
Note. We recommend that you back up your previous RPT files before you run the converter program, which significantly alters them.
ODBC Setup
You need to specify one or both of the ODBC Setup options to run PeopleSoft Open Query. Install ODBC Driver Manager 3.5. This option installs the Microsoft ODBC drivers that you need to run in conjunction with the PeopleSoft ODBC Driver to enable PeopleSoft Open Query. If you already have the Microsoft ODBC drivers installed on your client, this is an optional component. Install PeopleSoft ODBC Driver. You need to install this driver to enable PeopleSoft Open Query. Note. If you already have the Microsoft ODBC drivers installed, you will overwrite your current driver. Client Setup installs the ODBC Driver Manager version 3.510.3711. Any preceding versions of the ODBC driver will be overwritten, and any versions higher than 3.510.3711 will not be overwritten.
Install Workstation
You must have the Install Workstation check box enabled to engage the Client Setup function. Only select the check box after specifying all the appropriate selections on all Configuration Manager tabs. If you do not check this option, Client Setup will not run. After you click the check box, click either OK or Apply.
64
Chapter 2
Import/Export
The Import/Export tab allows you to export, or save to file, the specified environment settings, and to import previously exported settings. This feature is useful when you plan to configure multiple workstations to have similar settings.
Import/Export Tab
Export to a File
Export to a File will write current configuration settings to a file. This feature is useful when you want to set up multiple workstations with similar or identical environment settings. When you click Export to a File , a regular Save dialog appears. Make note of the file name you give the configuration file.
Note. Always make sure to click Apply before you export a file. This ensures that the exported configuration file reflects the current settings in case you have made any changes. Import from a File Import from a File is the opposite ofExport to a File. Export to a File allows you to save your current configuration settings to a file; Import from a File allows you to import previously saved configurations on other workstation. Importing a previously saved configuration file overrides all the current environment settings on the machine you import to.
65
Chapter 2
When you click Import From a File a normal Open dialog appears. Navigate to the directory containing the appropriate configuration file, select the proper file, and click Open.
Profile
The Profile tab lets you define one or more user profiles, each of which specifies connection parameters and file location information for a PeopleSoft installation. Many PeopleSoft installations include multiple databases. For example, there may be one database for tracking financial information such as expense reports and another database for HR processes such as benefits enrollment. Each of these databases has its own set of supporting filesSQR reports, COBOL processes, and so on. PeopleTools locates these files by referring to the Windows registry. By defining multiple profiles, you can tell PeopleTools to use different directory paths depending on which database the user is connecting to.
Profile Tab
When you first open the Configuration Manager, the Profile tab displays a single profile named Default. To set the parameters for this profile, make sure its highlighted and click the Edit button. The Edit Profile dialog box appears. The sections that follow describe each tab of this dialog box.
66
Chapter 2
Each workstation must have a default profile, which is used when the user signs on to a database or application server that isnt listed in any profile. If the workstation requires only one set of profile settings, you can just use the default profile. You can also set up multiple Configuration Manager profiles. Profiles give you a way of configuring a workstation to access multiple PeopleSoft 8 applications. The profiles are set for the Windows workstation, and are shared by all workstation users. Note. The Profiles feature lets you easily switch between applications.
Database/Application Server
The Database/Application Servers tab is where you specify the configured databases and application servers associated with this profile. When a user enters one of these databases or application servers in the PeopleSoft Signon dialog box, PeopleTools uses the registry settings associated with this profile. Note. You can assign multiple databases and application servers to a single profile. However, each database and application server must be assigned to only one profile. If you try to add a database to a second profile, Configuration Manager asks you if you want to remove it from the previous profile and add it to the current one.
Database/Application Server Tab
Note. Before you enter a database or application server on this tab, you should have already installed and configured it as documented in the PeopleSoft Installation book for your database platform.
67
Chapter 2
Application Server Name

Enter a name for an application server that you have configured. This is the name that will appear in the drop-down list on the PeopleSoft Signon screen. We recommend that you choose a name thats intuitive for your site. Note. Application server names must not exceed 24 characters.
Machine Name or IP Address

Enter the IP Address or the resolvable server name of the application server you specified in the Application Server Name field. You specified the IP Address in the [Workstation Listener] section of your PSAPPSRV.CFG file when you installed your PeopleSoft application server. For example, you could enter:
207.135.65.20
or
sp-hp32
Port Number
Enter the Port Number for the application server you specified in the Application Server Name field. You specified the port number when you installed and configured the application server using PSADMIN. A port number is an arbitrary number between 0 and 9999 that is determined by site specifications.
TUXEDO Connect String

The TUXEDO Connect String is designed for advanced configuration to support dynamic load balancing. You can specify a free-form connect string that allows a client to connect to another application server in case another is either down or being used to full capacity. The following sections describe the connect string options. Note. The Tuxedo Connect String can not exceed 1000 characters. Round Robin Load Balance This option specifies multiple application servers to which the client will arbitrarily connectthe odds being that each application server will receive an equal number of connections. To specify the round robin, use the following syntax (where ip = IP Address and port = port number):
(//ip1:port1|//ip2:port2|//ipn:portn)
You can specify the IP Address using either dotted notation or by using the servers DNS name. Either way, the slashes (//) preceding the IP Address are required. If the selected application server is unavailable, your connection attempt will fail and the system will not try to connect you to the other application servers defined within the parentheses. Spaces are not allowed in any part of the connection string. PeopleSoft will automatically remove embedded spaces before storing the value in the registry.
68
Chapter 2
Round Robin with Failover
Like Round Robin Load Balance, this option allows you to define a failover connection string. Use the following syntax (where ip = IP Address and port = port number):
(//ip1:port1|//ip2:port2),(//ip3:port3)
If the application server selected from the first group of parentheses (ip1 and ip2) is unavailable, the system automatically attempts to connect to an application server defined in the second group (ip3). If that application server fails, the system attempts to connect to the next group to the right, sequentially. If multiple application servers are defined within any group, the system will round-robin between them. If the selected application server fails, the system will attempt to connect to the next application server to the right, if any. The following are three separate examples, showing a range usage:
(//sp-ibm01:8000|//sp-ibm02:8000),(//sp-nt01:8000) (//208.136.78.88:8000|//208.136.78.88:8050|//208.136.78.88: 8080) (//sp-sun01:8000),(//sp-sun02:8000),(//sp-sun03:8000)
Set and Delete Buttons

When you click Set, your application server information is displayed in the grid at the top of the dialog. At this point you can enter a new application server name and set up a different server if you like. Note. The settings in the grid are not saved until you press Apply or OK. If you press Cancel without first pressing Apply or OK, you will lose all the information in the grid. To remove an application server configuration, select its Application Server Name in the grid and click Delete.
Process Scheduler
The Process Scheduler tab lets you specify all of the directories that are associated with your Process Scheduler jobs, such as your SQR and COBOL directories.
69
Chapter 2
Process Scheduler Tab
General
The General group contains the following controls. PeopleSoft Home Directory Crystal Reports Output Directory Log Directory Temp Directory Database Drivers Word Executables Directory Redirect Output The value of your high-level PeopleSoft directory, such as: N:\HR840 The path to \CRWRTPATH where Crystal sends your reports. Optional directory used with the Output Destination field when scheduling a Process Scheduler request. The directory for SQR, COBOL, and Process Scheduler log files. The path to your temporary directoryfor example: C:\TEMP. This is where you will find log files and other output files. The path to the directory where your database drivers reside. The directory containing your Microsoft Word executablesfor example: N:\Apps\Office2000\Office This check box allows you to redirect the onscreen COBOL DISPLAY statements to a log file. (If you leave the check box deselected you will just see the onscreen messages.) Sending the messages to a log
70
Chapter 2
file is useful for debugging purposes. The log file will be created in %TEMP%\PS_HOME\DBNAME directory. In addition to the output generated by COBOL DISPLAY statements, the log file will contain any errors generated by the COBOL Run Time System. Note. To use the Application Engine debug feature, you must deselect the Redirect Output check box.
Application Engine
The Application Engine group includes the following controls. Debug Disable Restart Select this check box to enable the Application Engine command-line debugger. Select this check box to disable the Application Engine restart feature, which lets you restart an abnormally terminated Application Engine program. With Disable Restart selected, Application Engine programs start from the beginning. The Disable Restart option is useful during debugging. It should not be selected in a production environment.
Warning! Select the Debug check box only when you are testing and troubleshooting client-side processes. If you select Debug and submit a process request to the server, the process will hang, waiting for a user command.
SQR
The following controls apply to the SQR group. SQR Executables SQR Flags Enter the path to the directory where your SQR executables reside. Enter the SQR flags that Process Scheduler should pass on the command line to the SQR executables. The following SQR flags are required for launching SQR reports: -i specifies the path to SQC files. -m specifies the path to the ALLMAXES.MAX file. -f specifies the output path. -o directs log messages to the specified file. -ZIF sets full path to the and name of the SQR initialization file, SQR.INI. SQR Report Search Enter the directory paths the SQR executable should use to locate SQR reports. SQR Report Search 1 will be searched first, followed by SQR Report Search 2, and so on.
COBOL
The COBOL group includes the following control. COBOL Executables Enter the path to \CBLBINwhere your COBOL executables reside.
71
Chapter 2
nVision
PeopleSoft nVision refers to a number of registry settings to determine where it should look for files and how it should operate. PeopleSoft Query Link, the feature that enables you to send PeopleSoft Query output to a spreadsheet, also refers to these settings.
nVision Tab
Space between Query Columns

This parameter sets the number of blank Excel characters that PeopleSoft Query Link places between query output columns. To eliminate column spacing, set Space between Query Columns to 0 (zero).
Directory Paths
These fields let you specify the locations of the directories associated with your nVision jobs. Customization Macros Report Layouts Drilldown Layouts Specifies the directory containing macros for PeopleSoft nVision and Query Link. It is usually <PS_HOME>\EXCEL. Specifies the location of your PeopleSoft nVision layout fields. Specifies the location of your PeopleSoft nVision Drilldown files, usually C:\USER\NVISION\LAYOUT\DRILLDN.
72
Chapter 2
Report Instance Query Templates Style Sheets
Specifies the directory in which nVision places report instancesfor example: C:\USER\NVISION\INSTANCE. Specifies where to look for the QUERY.XLT file, which defines the Excel styles used to format your output. The default is the <PS_HOME>\EXCEL folder. Specifies where the NVSUSER Style Wizard locates nPlosion style sheets.
Common Tab
The common tab enables you to set various system settings.
Common Tab
Sybase Packet Size

This option allows you to specify a TCP Packet Size. The minimum value is 512 and the maximum value is 65538. The default packet size is 512. If you change the packet size, make sure to make the corresponding changes to the Sybase server. Your Sybase reference manuals and Sybase Tuning and Administration under RDBMS Tuning and Administration on Customer Connection contain more information about TCP packet sizes.
73
Chapter 2
Application Designer Image Conversion

When you upgrade to newer version of PeopleTools, youll need to convert images to a new format, which may require more storage space. If the images exceed the record size limit of your platform, you can shrink the images to conform to this limit. When doing so, you have the following options: Convert and Shrink Images This option both converts and shrinks images to fit your selected database to Platform Limit. platform limit, as shown in the Image Size Limit field. Convert and Shrink Images This option applies of you are upgrading to a different database platform. to Image Size Limit. Select this option and specify the correct value in the Image Size Limit field. Dont Convert, but Shrink This option is useful for images that have already been converted, but Images to Image Size Limit. need to be converted so they meet the platform size limits.
Data Mover Directories

There are several Data Mover settings that you can control through Configuration Manager. Input Directory Use this field to specify the directory where Data Mover should search for its input data (.DB) files. If no explicit path is specified for the file named in the set input lines when running a Data Mover script, Data Mover will search directories for the database file in the following order. 1. Specified output directory. 2. C:\TEMP Output Directory Specifies the directory where your Data Mover scripts will be created. The default is <PS_HOME>\DATA. Log Directory This parameter specifies the location of your Data Mover log files. The default is <PS_HOME>\DATA.
See Also
Chapter 1, PeopleSoft Data Mover, page 1
Command Line Options

In addition to its GUI interface, the Configuration Manager offers the command line options described in this section. They may be useful for implementing your PeopleSoft system and for everyday tasks such as signon. The syntax for the Configuration Manager command line options is as follows:
pscfg -<command>
For example,
pscfg -import:n:\config\hr840.cfg
74
Chapter 2
Import File
To import configuration settings from a named file, enter:
-import:<filename>
Export File
To export the current configuration settings, enter:
-export:<filename>
Run Client Setup

To run Client Setup, enter:
-setup
Note. You must use the -setup command in conjunction with the -import switch if you are setting up a new workstation.
Run Client Setup Quietly

To run Client Setup quietly, without displaying any messages or dialog boxes, enter:
-quiet
Note. All of the output messages will be written to a log file: %temp%\PSINSTAL.LOG.
Install ActiveX controls

To register ActiveX controls, enter:
-activex
Note. ActiveX controls are registered during Client Setup. activex allows you to register the ActiveX controls without running the entire Client Setup.
Install Crystal Runtime Files

To install Crystal runtime files, enter:
-crystal
Install MSS DSN

To install MSS DSN, enter:
-dsn
75
Chapter 2
Disable ODBC Driver Manager Installation

This command is only valid when used in conjunction with the -setup command. It disables the installation of the ODBC Drivers during the Client Setup process. Use this command when you do not want to install the ODBC drivers on the client workstation when using the -setup command.
-noodbc
Disable PeopleSoft ODBC Driver Installation

This command is only valid when used in conjunction with the -setup command. It disables the installation of the PeopleSoft ODBC Driver during the Client Setup process. Use this command when you do not want to install the PeopleSoft ODBC driver on the client workstation when using the -setup command.
-nopsodbc
Uninstall Workstation
To clear the PeopleSoft settings from the registry or uninstall the PeopleSoft workstation, enter:
-clean
The -clean command removes the following items from the workstation: PeopleSoft registry settings. All cache files from the current \CACHE directory. Shortcut links. PeopleSoft program group. Make sure that removing all of these items is acceptable before issuing the -clean command.
Help
To view the Configuration Managers command line options online, enter:
-help
or
-?
Setting Up the PeopleTools Development Environment

Most end users use workstations equipped with supported web browsers, but with no special PeopleSoft software installed. At the same time, the traditional Windows clientnow called the PeopleTools Development Environmentis still supported, and is primarily used as a development environment.
76
Chapter 2
The PeopleTools Development Environment runs on Windows NT 4.0, Windows 2000, and Windows XP. This chapter describes how to configure these Windows-based clients using Configuration Manager. As before, such clients can connect to the PeopleSoft database directly using client connectivity software (a two-tier connection), or through a PeopleSoft application server (a three-tier connection).
Verify <PS_HOME> Access

The workstation must have access to the file server <PS_HOME> directory (that is, the high-level directory to which the PeopleSoft client executables were installed) and have a drive mapped to the directory. The workstation user(s) must have read access to the <PS_HOME> directory.
Verify Connectivity
As mentioned, database connectivity is required on all Windows-based clients that will be making a two-tier connection to the database. A two-tier connection is required if any of the following is true: The user will be signing on to the application in two-tier. The user will be running Data Mover scripts. The user will be running COBOL and SQR batch processes on the client.
Verify Supporting Applications

PeopleSoft requires that a number of supporting applications be installed on any Windows-based client on which batch processes will be run locally.
SQR
On Windows-based clients, you can install SQR locally, or you can map to a copy installed on the file server. Because SQR does not require any local registry settings, you can execute SQR from any Windows-based client once SQR has been installed to a shared directory. Installing SQR locally will result in improved performance; over a slow network connection the improvement will be significant.
Crystal Reports
Optionally install Crystal Reports on Windows-based two-tier clients. As with SQR, you can install Crystal locally, or you can map to a copy installed on the file server. Because Crystal does not require any local registry settings, you can execute Crystal from any two-tier client once it has been installed to a shared directory. Installing Crystal locally will result in improved performance; over a slow network connection the improvement will be significant. Crystal Reports requires that you install the PeopleSoft ODBC driver on the workstation where Crystal processes are executed.
Microsoft Office
Install Microsoft Office on any two-tier client that will be running nVision or Microsoft Word batch processes. Microsoft Office must be installed locally, because it requires registry settings.
77
Chapter 2
Understanding the User Settings

Configuration Manager includes the following tabs for setting options for each workstation user. If multiple users will be signing on to the workstation, you may need to set these options once for each user using the Profile feature. Startup. Controls the default values that appear in the PeopleSoft signon screen, as well as the location of the PeopleSoft cache on the client. Display. Controls your language preference and other display options. Note. The language setting in Configuration Manager determines your language preference for your PeopleTools Development Environment, regardless of the operator language preference. Crystal/Business Interlink. Specifies the locations of Crystal Reports executables and default location for Crystal Reports generated via PeopleSoft Query; the latter must be a directory to which the user has write access. This tab also specifies the location of Business Interlink drivers. Trace. Controls SQL, PeopleCode, Application Engine, Message Agent, and PeopleSoft API trace options.
Running Client Setup

Before running Client Setup, you should create all the profiles you need. The Client Setup tab does the following: Installs a PeopleSoft program group on the workstation. Sets up a Microsoft SQL Server system data source name using the server and database name information from the Startup tab. Installs the PeopleSoft ODBC driver required for Open Query and Crystal Reports. Installs Crystal Reports DLLs on the workstation. Configures a PeopleSoft ODBC data source name. These Client Setup functions are performed when you press OK or Apply from Configuration Manager only if the Install Workstation check box on the Client Setup tab is selected. Note. Any files installed by Client Setup on the workstation from the file server, including ODBC driver files, use the paths specified in the default profile. To run Client Setup 1. Select the Client Setuptab. 2. In the Group Title text box enter the name of the program group for the icons you want on the client workstation. You can call the program group anything you want, but we will refer to it by its default name, PeopleSoft 8. 3. Select check boxes to create shortcut links for any PeopleSoft applications you want to access from the workstation.
78
Chapter 2
When you run Client Setup, it will uninstall any existing shortcuts in the PeopleSoft 8 program group, and install shortcuts for the applications you have selected. If you later want to install or uninstall shortcuts, you can always re-run Client Setup. 4. Select the Install PeopleSoft ODBC Driver check box if you want to install the PeopleSoft ODBC driver and set up a user ODBC data source name required by PeopleSoft Open Query and by Crystal Reports. 5. Select the Install Workstation check box. This check box determines whether Client Setup runs when you click Apply or OK in Configuration Manager. If it is not selected, Client Setup will create or update settings in the registry, but it wont set up the PeopleSoft 8 program group, or install local DLLs. 6. Click Apply to run Client Setup and apply the other Configuration Manager settings. You can press ODBC Administrator to directly access the Microsoft ODBC Administrator to verify the installation and configuration of the ODBC DSN. If you install the ODBC Driver Manager 3.5, reboot the workstation after running Client Setup. 7. To view a list of the files installed and actions taken by Client Setup, you can open the psinstal.log file in your Temp directory.
79
Chapter 2
80
CHAPTER 3

This chapter provides an overview of the PeopleTools Data Archive Manager and discusses how to: Create an archive template. Work with archived data. Run archive processes. Run archive reports and audits. Use archiving tips and techniques.
Understanding Data Archiving

PeopleSoft applications create and maintain data. Often the data in your online tables is no longer required, but you dont want to simply delete the data just to make room for new data. Managing this historical data is a time-consuming challenge for many database administrators. However, unless you create an archiving strategy, databases increase to unmanageable sizes. Also, removing the historical data from your online tables can improve overall performance. PeopleSoft Data Archive Manager enables you to select the rows of data you no longer need in your online system and move these rows in history/staging tables or in a flat file format. Keeping the data in the system in history/staging tables keeps the data available for queries and reporting. Also, you have the option to archive data directly to a flat file for long-term storage if the historical data is no longer needed for reporting. You may consider exporting the data to flat files and delete it completely from the system. Warning! The Data Archive Manager is a powerful tool. Improper use may result in data loss or corruption of the database. It is strongly recommended that only those who are trained for and familiar with the archiving process should use the Data Archive Manager.
Choosing an Archiving Strategy

This section discusses: Determining an archive strategy Archiving to history tables
81
Chapter 3
Archiving to flat files
Determining an Archive Strategy

Determining an archiving strategy is essential for using Data Archive Manager efficiently. This strategy strongly depends on how the archived data will be utilized. The table below highlights the aspects of the two available archiving strategies.
Archiving to History Table Strategy Utilizes history tables for storing archived data. Allows reporting & queries from history tables. Requires secondary step to delete archived data from online tables. Requires additional database space. Archiving to Flat File Strategy Archives data straight to a flat file. Deletes the archived data directly from the online tables. Efficient one-step archiving process. No additional database storage space required.
The two strategies offer different approaches to archiving. If you are archiving to history tables you must first create the history tables for temporary storage. If you are archiving to flat files, you can accomplish the task in one simple step. The system is designed to provide as much flexibility as possible. By reviewing your business requirements, you will be able to decide on which strategy best fits your business needs. Note. Before deciding which archiving strategy to use, please review this entire document so that you are familiar with all of the archiving features.
Archiving to History Tables

Archiving to history tables involves the use of tables that your create for the sole purpose of storing archived data. It is up to you to determine whether this archived data should be stored in these history tables temporarily or for long-term. By definition, history tables are identical copies of the online tables with the exception of an additional column: PSARCH_ID. The system uses this key field to denote when a piece of data was archived and to uniquely identify it. Some PeopleSoft applications deliver history tables pre-built for use in common archiving processes. If you design a custom archiving scheme, youll need to create the history tables using Application Designer. 1. In step 1, data is moved into the history tables. This is known as the selection process. This will allow you to query the selected data for information and delete them from the online tables. 2. If you accidentally delete the data from the online tables, there is a process to restore the data back from the history tables. Step 2 shows this rollback process. 3. When you no longer need to reference the data from the history tables, you can move them to flat files and delete them completely from the system. Step 3 shows this export process. 4. If necessary, you can return the archived data back into the system using staging tables. Staging tables are identical to online tables. This import process is shown as step 4 in the preceding diagram.
History Table Considerations

When archiving to history tables, it is important to consider the following:
82
Chapter 3
History tables may reside on the same database as the online tables, or they may also reside in separate databases. If the history tables reside in a separate database, you need to setup database links using the proprietary methods for your RDBMS. After the archive process moves the data into the history table, the data resides in both the online tables and in the history table. You then have two options: deleting the archived data from the online tables, or leaving the archived rows in the online tables such that the data exists in parallel.
Staging Table Considerations

Staging tables are used in the archiving process as a holding area for data. When using staging tables, consider the following: Staging tables are exact duplicates of the online tables. They do not contain the PSARCH_ID column. Staging tables are often used for reporting purposes.
Creating History Tables

Before you run the archiving process, you must create/ build the history tables first. You are required to build one history table for each table to be archived. The history table must be identical to the archive table, with an extra column PSARCH_ID. The following example uses the record JRNL_HEADER. To build a history table: 1. Open PeopleSoft Application Designer. 2. Open the JRNL_HEADER table. 3. Select File, Save As and name the history table your custom name, such as JRNL_HEADER_HST. 4. When prompted to copy the PeopleCode associated to the table, click No. 5. Click Insert > Field and insert the PSARCH_ID field. 6. Save the Record. 7. Build the table by using the Build, Current Object option. Select the following Build Options: Create Tables and Create Indexes. Select the following Build Execute Options: Execute and Build script. Click Build.
Archiving to Flat Files

You can also archive data directly from online tables to flat files. When you are ready to archive your data and you no longer need to reference them from the online tables, you can extract them to flat files. The data is stored in the Comma Separated Values (CSV) format, which enables a portable representation of the online tables and data. 1. Export the selected online rows to a CSV file.
83
Chapter 3
2. If you need to access your archived data in the future, you can restore the data into staging tables. Step 2 shows this import process. Note. The data is deleted from the online tables as the data is being archived.
Creating an Archive Template

The Archive Designer page is used to create and maintain your archive template. When you create a new archive template, you identify it using the archive ID. This archive ID is then used in the various archive processes discussed later. The following section covers the interface that you use to design archive templates, or projects. It explains how to use the following pages: Record Criteria page Join Record Criteria page SQL Designer page
Record Criteria Page

The process of archiving data begins with the creation of an archiving template, which logically groups all of the online tables that are to be archived into a single entity. You associate the online table with its history table counterpart, and you select the fields to archive and the criteria by which to archive. Select PeopleTools, Archive Data, Archive Designer, Record Criteria.
Record Criteria page
84
Chapter 3
Archive ID Description Archive to Flat File Copy Archive ID Archiving Record History Record Copy Table Go to Request Page Go to Report Page FieldName
An Archive ID is used to identify a group of transactions as an archive definition during the archiving process. Use up to 30 characters to describe the archive. Enables the user to archive the project directly to a flat file without having to create history tables. Allows the current archive project to be copied to a new archive ID. All tables, criteria, and other criteria are copied to the new archive ID. Select the online tables to be archived. You can archive multiple online tables within one archive ID. History tables are copies of the online table with the additional PSARCH_ID field. This is where the archived data will be stored. Copies all criteria to a new row in the existing archive ID. Useful if you are dealing with multiple tables. Transfers you to the Archiving Process page. Transfers you to the Report Request page. Columns in the online tables to specify archive criteria. Specifying the fields and adding the conditions is comparable to the WHERE clause in a SQL statement. =, <>, <, >, <=, >=, LIKE, NOT LIKE Column value to match against, as in 07/01/1999 or $75,000. You can also use special parameter markers in the format of %PSPARMnn% where nn can be any number. For example, valid parameter markers could be %PSPARM1% or %PSPARM18%. When the system generates the SQL statement, %PSPARMnn% is embedded in to the SQL statement and substituted with values entered using the run control pages. One example of implementing this is to create an archive project based on a business unit and then enter the actual business unit at run time. Note. Parameter markers are currently not implemented with DATE fields.
Operator Value to Match
A/O
Toggle between AND and OR. This button is only visible if you have added multiple lines to the field list.
Join Record Criteria Page

If there are dependencies from other tables in the archiving template, such as parent/child relationships or joining against reference tables, you must insert the criteria into this page. This can also be done by selecting the Copy Parent Record check box. For this to work correctly, the parent table criteria must already exist on the Record Criteria page. You can specify multiple levels, such as grand parent-to-parent, grand parent-to-parent-to child, and so on. Select PeopleTools, Archive Data, Archive Designer, Join Record Criteria.
85
Chapter 3
Join Record Criteria
Archiving Record Copy Parent Record
The table to be archived. Allows the criteria that exist in the parent record on the Record Criteria page to be copied to the Join Record Criteria page. When you click this, an edit box appears to the right that you use to select the parent table. Select the name of the table to be joined. You can request multiple table joins per archiving table. The two tables must share common keys. Select the columns in the online tables to add to the archive criteria. =, <>, <, >, <=, >=, LIKE, NOT LIKE. Enter a column value to match. See Record Criteria discussion for description of using parameter markers. Change And to Or, and vice versa.
Record Name Field Name Operator Value to Match A/O
SQL Designer Page

The SQL Designer page is useful for generating and editing the SQL that will be used to perform the archive process. In addition, you can count the number of rows that will be affected by the current archive process and check for duplicate rows that the SQL is affecting. To access this page, you must have entered basic information on the Record Criteria and Join Record Criteria pages. Note. The buttons that appear on this page depend on what your security access privileges are and what the current archive is. To set security access to the page, select the Archive Security page. Select PeopleTools, Archive Data, Archive Designer, SQL Designer.
86
Chapter 3
SQL Designer page
Generate Project SQL Generate Record SQL
Creates all SQL statements for the entire archive template. Produces the SQL statements for the current record. The following types of SQL are created: Delete from the online tables (Archive Delete). Remove data from history tables (Remove from History). Rollback (Archive Rollback). The SELECT that moves rows from the online table to the history table (Archive Selection).
Archive Process Count Rows Chk Dup Rows (check duplicate rows) Edit SQL
Describes the processes that have been selected on the Archive Data page. Returns the row count of what the generated SQL will affect. Checks to see if an incorrect join will cause duplicate rows to be archived. Allows you to modify the generated SQL. If you edit and save the SQL, a flag will be used to identify that the SQL is user modified and is not system generated. When you modify the SQL and save it, the text above the edit box indicates that the SQL has been altered from the original, system-generated SQL. Enables you to execute the generated SQL. Typically, this button used by the archive developer during the development and testing of
Run SQL
87
Chapter 3
the archive. After the archive template is developed, an Application Engine program executes the SQL in batch.
Working With the Archives

This section covers: Archive Security Archive Utilities
Archive Security Page

This page enables you to grant access rights to the permission lists that use Data Archive Manager. The permission lists you add need to exist already in PeopleTools Security. The permission list must be the primary permission list for the user profile in order for the user to have access to the command button. Select PeopleTools, Archive Data, Archive Security.
Archive Security page
Permission List Can Generate SQL? Can Edit SQL? Can Run SQL? Can Purge Audit?
Select the permission lists to which you want to grant archive data access. Allows the user to generate SQL on the SQL Designer pages by making the Generate SQL button active. Allows the user to edit the SQL on the SQL Designer page. Allows the user to execute SQL on the SQL Designer page. Allows the user to purge the audit history on the Archiving Audit page.
Note. PeopleTools delivers a process group ARCHALL that should be added to the appropriate permission list using PeopleTools Security. You will not be allowed to run any archive processes until this group is added to the permissions list.
88
Chapter 3
Archive Utilities Page

The Archive Utilities page allows quick archive project administration. These operations include copying, renaming, deleting, exporting and importing. Select PeopleTools, Archive Data, Archive Utilities.
Archive Utilities page
Select the action you want to perform. The instructions for each action appears in the text box to the right. Copy Archive Project Rename Archive ID Delete Archive ID Generate DM Script Creates a copy of the archive template that you specify in the Archive ID field and gives it the name you enter in the New Archive ID field. Renames the archive according to the values you enter in the Archive ID and New Archive ID fields. Deletes the archive that you specify in the Archive ID field. Once an archive is deleted, you can no longer access it. Generates both the import and the export PeopleSoft Data Mover scripts for the archive you specify. You can also choose to export all projects by selecting that check box.
Working With Data

The following sections cover the following: Data Finder page. Data Input page. Data Output page.
89
Chapter 3
Data Finder Page

This page enables you to find data in your online system that meets your criteria. Once you have located the data, you can then immediately create a new archive project. Select PeopleTools, Archive Data, Find Data.
Find Data page
Field Name Match Type Value to Match Find Data Record Row Count Key Build Build Archive Project
Enter the name of the field that you want to find a match for. Specify whether the match between the field value and the match value should be equal or like. The options are = and LIKE. Enter the value for the system to search for within the specified field name. After you have entered the desired criteria, click Find Data for the system to begin searching your online data. Shows the record containing the rows that meet the criteria. Shows the number of rows in the record that meet the criteria. Signifies if the field is a key field in the record. Click this checkbox to include this record in the generated archiving project. This box is checked automatically if the field is a key field. Select this check box to create a new archive project. After entering the name and description of the project select Go to display the Archive Designer pages that enable you to create your new archive.
Data Transfer Input Page

The Data Transfer Input page enables you to search for specific fields in your database and create a Data Mover export and import scripts to move the data between databases. For example, this can be used to generate Data Mover scripts that can export data from your production database into a training or test database.
90
Chapter 3
Select PeopleTools, Archive Data, Transfer Data, Transfer Input.
Data Transfer Input page
Field Name Match Type Value to Match Find Data Record Row Count Key? Build? Create Data Mover Export Script Data Mover File Path Data Mover Export File Name Data Mover Import File Name Delete Before Import
Enter the name of the field you want to find a match for. Specify whether the match between the field value and the match value should be equal to or like. The options are = and LIKE. Enter the value for the system to search for within the specified field name. Click this button to search for the values that youve specified. Shows the record containing the rows that meet the criteria. The number of rows in the record that meet the criteria. Signifies if the field is a key field in the record. Click this checkbox to include this record in the generated script. This box is checked automatically if the field is a key field. Check this checkbox to enable the system to create a Data Mover Export script. Defines the file path of the Data Mover files in the generated script. Defines the export file name in the generated script. Defines the import file name in the generated script. If this check box is selected, the generated script includes a DELETE statement for the user-specified criteria in the WHERE clause. The DELETE statement appears before the Data Mover IMPORT statement.
Note. The generated Data Mover script appears in a text box on the Data Transfer Output page.
91
Chapter 3
Data Transfer Output Page

Enables you to view and edit the Data Mover script you created using the Data Transfer Input page. Select PeopleTools, Archive Data, Transfer Data, Transfer Output.
Data Transfer Output page
The Data Transfer Output page contains two Data Mover scripts: one to export the data and one to import the data. To run the script using Data Mover, you need to copy the generated script to a text editor (Notepad, for example) and then save it as a DMS file.
Running Data Archival Processes

This section discusses the options and processes related to building archives. It explains how to use the: Archive Data page Archive Online to Flat Files page Export History to Flat Files page
Archive Data Page

Once you have created an archive template, you can begin the archiving process. This is when the system moves the selected data from your online tables. Select PeopleTools, Archive Data, Archive Data.
92
Chapter 3
Archive Data page
Archive ID Auto Fill Records Go to Project Page Archive Process
Select an existing archive ID. Once youve selected an archive ID, click this button to display all the tables to be included in the archive project. Transfers you to the Archive Designer interface. Select which archive process you want to run: Selection copies the data from the online tables to the history tables. Rollback copies the data from the history tables to the online tables. Delete removes the data from the online tables, only when they have already been copied to the history tables. Remove from History deletes the data from the history tables.
Commit Processing
Select the check box to enable the Commit After option, which specifies how many rows of data the system processes before issuing a database commit. Otherwise, the system issues a commit after each record has been processed. If you have any custom Application Engine programs that you want to run against your data either before or after archiving, specify the appropriate program here. Pre AE. Select an existing Application Engine program to run before the archiving process.
Pre/Post AE Processing
93
Chapter 3
Post AE. Select an existing Application Engine program to run after the archiving process. Do Table Names History Tables Run Time Parameters Check box indicating if the table should be processed at run time The tables containing the data to be archived. The tables where the system stores the archived data. If your archive template contains runtime parameters (%PSPARMnn%), specify a value that the system should substitute into the SQL statement at run time.
Archive Online to Flat Files Page

This page enables you to export data from online tables to flat files. Select PeopleTools, Archive Data, Archive Online to Flat Files.
Archive Online to Flat Files page
Note. This archive process deletes the data from the online tables immediately after the system has exported it to the flat files. Run Archive ID Directory to store flat files Exports the data to the flat files. Select an existing archive ID. Enter the path for the directory in which you want to store the resulting flat files. When you click Auto Fill Records the directory is added as a prefix to each of the resulting file names.
94
Chapter 3
Auto Fill Records
Once youve selected an archive ID, click this button to display the table names associated with the archive. In addition, the user needs to specify the path where the data will be exported. Transfers you to the Archive Designer pages. If you have any custom Application Engine programs that you want to run against your data either before or after archiving, specify the appropriate program here. Pre AE. Select an existing Application Engine program to run before the archiving process. Post AE. Select an existing Application Engine program to run after the archiving process.
Go to Project Page Pre/Post AE Processing
Do File Path
Specify whether to process this table or not by selecting the check box. The path and file names to which the data for each table will be written are populated by the system. If necessary, you can type over the file path so that a table can have unique filename and destination. If your archive process contains the runtime parameter markers (%PSPARMnn%), specify a value that the system should substitute into the SQL statement at run time.
Run Time Parameters
Export History to Flat Files Page

This page enables you to export the data from history tables to flat files. Select PeopleTools, Archive Data, Export History to Flat Files
95
Chapter 3
Export History to Flat Files page
Run Archive ID Directory to store flat files
Exports the data in the history table to the designated flat file. Select an existing archive ID. Enter the path for the directory in which you want to store the resulting flat files. When you click Auto Fill Records the path is added as a prefix to each of the resulting the file names. Once youve selected an archive ID, click this button to display the table names. In addition, you must specify the path where the data will be exported to. Name of the table that will be processed. This field is populated by clicking the Auto Fill Records button. The path and file names to which the data for each table will be written are populated by the system. If necessary, you can type over the file path so that a table can have unique filename and destination.
Auto Fill Records Table Name File Path
Import From Flat Files Page

Use this page to restore archived data back to your system using staging tables. Select PeopleTools, Archive Data, Import From Flat Files.
96
Chapter 3
Import From Flat Files page
Run Number of rows to be processed before commit to DB File Path Table Name
Imports the data from the flat file into the designated staging table. Enter the number of rows you want the program to process before the program issues a COMMIT. Specify the path and the name of the file containing the flat file you want to import into the database. Enter the staging table name where the program is to insert the data from the import file.
Running Data Archival Reports and Audits

In this section, we explain how to: Run archive reports Run audit reports View audit results
Running an Archive Report

Before running the archive process, PeopleSoft recommends that you generate reports to verify the data you are archiving before deleting it from the online tables. This report lists the archive ID definitions, which consist of the following: Archiving tables. Selection criteria.
97
Chapter 3
Dependency criteria (criteria from other tables). SQL that will run each of the archiving processes. These definitions also help you create your own reports through PeopleSoft Query. The Audit Report page generates report for a specific archive ID and places the file in the destination that you provide. Select PeopleTools, Archive Data, Audit Report.
Archive Report page
Archive ID Go to Project Page File Path
Select the archive ID to audit. Displays the Archive Designer pages. Specify where the generated report is to be saved on the batch server.
Creating an Audit Inquiry

The Archiving Audit page is useful for online viewing of all processes that have been executed in the Data Archiving Tool without waiting for the output from the batch process. In addition, you can delete the audit if you have the necessary access privileges. Select PeopleTools, Archive Data, Archive Report.
Audit Inquire page
Add your criteria in the provided edit boxes, click View Audit, and view the results arranged by column. User ID Select which user to audit.
98
Chapter 3
Archive ID Event From Date To View Audit Purge Audit File Path Detail
Select an existing archive ID. Select an archiving event from the list. You can select from all processes that have been executed by the Data Archiving Manager. Select a start date for the audit Select an ending date for the audit. Click this button to have the system create the audit report and display the appropriate fields on the page. If you have the correct security permission set up on the Audit Security page, you may purge an audit by clicking this button. Specify where the generated report is to be saved on the batch server. Click this button to show the details related to the audit events . For example, if you edited the SQL using the SQL Designer page, the Details page will show the original SQL as well as the modified SQL.
Audit Report Page

The Archiving Report page creates a batch output file showing all processes that have been executed in the Data Archiving Tool. In addition, you can print the resulting SQL. PeopleTools, Archive Data, Audit Report
Audit Report page
Add your criteria in the provided edit boxes, click View Audit, and view the results arranged by column. For a description of the fields, see the Audit Inquire page. Archive Operator Class Select which user ID to audit.
99
Chapter 3
Archive ID Event From Date To Print SQL?
Select an existing archive ID. Select an archiving event from the list. You can select from all processes that have been executed by the Data Archiving Manager. Select a start date for the audit Select an ending date for the audit. Select this checkbox if you want the SQL statements for each of the archiving processes printed in the report
Archiving Tips and Techniques

The following sections provide additional information to help you get started using the archiving features.
Understanding Business Requirements

It is very important to devise a business strategy before archiving the data. First, you must identify the tables you want to archive. This includes identifying all of the parent/child tables associated to these tables. Failing to identify all of the related tables can cause corruption to the database. Next, you must know exactly which data you want to archive. It is important to recognize which rows are safe to be removed from the online tables. A factor to remember when doing an archive is to remove only the data that are not required to maintain the day-to-day business and reporting. Lets use General Ledger (GL) for an example. GL contains the greatest amount of data to be archived since it is the module where the majority of reporting is required. There are two sets of data types that need to be maintained: balance information, and transactional information. Balance information is retained in the ledger records. You may require balance information for online and reporting purposes to be available for a three-year period. On the other hand, transactional data is maintained in the journal header and line tables. Perhaps you may require one year of transactional data to be retained in the system for online purposes and three years to be retained for reporting purposes. Any data beyond the above time frames for balances and transactions can be archived and will only be accessed through reports. The data can be archived to history tables, or as flat files to secondary storage devices. If data were to be archived into history tables, the data would still be available online for reporting purposes. However, it could not be viewed through pages without customizations. In addition, reports would need to be modified to access the data in history tables. Archiving to secondary storage devices is generally used for long-term data retention. This option is preferred for data that are rarely retrieved, and is usually performed to satisfy legal requirements.
Archiving from Online to History Table Process

This process copies the data from the online table to the history tables using the selection process and then removes the data from the online tables using the delete process. To complete the online to history table process: 1. Create an Archive Project. Create a project (with a unique Archive ID) that identifies the tables/rows that are to be archived.
100
Chapter 3
2. Run archiving reports. Print an archive project definition report to help you verify the data you have selected to archive. 3. Run Archive Data with the Archive Process Selection. Based on the Archive ID, run the selection process. This copies the data rows for archiving to the history tables. 4. Run Archive Data with the Archive Process Delete. This removes the data from the online tables. Do this only when you are confident that the archived data has been successfully stored in the history tables.
Rolling Back History Table Data

To roll back history table data: 1. Run Archive Data with the Archive Process Rollback. This copies the data back from the history tables to the online tables. You use this when the data was accidentally deleted from the online tables, and it has already been archived to the history tables. 2. Run Archive Data with the Archive Process Remove from History. If the Archive Selection has been run, and it you selected the wrong set of data to be copied to history tables, run the Remove from History process to remove the misplaced data. This returns you to the state where you started prior to the archive selection process.
Archiving From History Table to a Flat File

To archive from history table to a flat file: 1. Run Export History to Flat Files. This process copies the data to the flat files. 2. Run Archive Data with the Archive Process Remove from History. This deletes the data from the history tables. Only run this process after you have verified that the data has been successfully archived to flat files.
Restoring Archived Data From Flat Files

To restore archived data from flat files: 1. Run Archive Audit Report for the Batch History Process. This report lists the definition of the history tables at the time the data was archived. This report provides the names of the flat files that contain the data. 2. Create Staging Tables. The staging table is a clone of the online table. The Import process imports the data from the flat files into staging tables. 3. Run Import for Flat Files Process. 4. Run the programs to populate the tables from the flat files.
101
Chapter 3
Understanding Commits
For both batch and online execution, the Archive Selection, Remove from History, Rollback, and Delete Processes issue commits after each record has been processed unless a commit level has been specified otherwise.
Gaining Increased Performance

For better performance and increased speed during archiving processes, try dropping the indexes before inserting data from online tables into history tables.
Modifying Indexes
Your database platform may have a limitation to the number of columns an index can contain. Some have a restriction of 16 columns for an index. If the table that you want to archive already has 16 keys, then you cannot add another key (PSARCH_ID) to the corresponding history table. The first option for solving this situation is to use the Flat File Archiving Strategy. The second option for solving this situation is to create the history table with the PSARCH_ID as a non-key field. For this situation, it is recommended that you either have different history tables for different archiving projects, or you have a strategy of purging the history tables prior to executing the selection process of another archiving project.
102
Glossary of PeopleSoft Terms

absence entitlement This element defines 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. This element defines the conditions that must be met before a payee is entitled to take paid time off. You use an account code to record and summarize financial transactions as expenditures, revenues, assets, or liabilities balances. The use of this delivered PeopleSoft ChartField is typically defined when you implement PeopleSoft General Ledger. In PeopleSoft Enterprise Performance Management, the accounting class defines how a resource is treated for generally accepted accounting practices. The Inventory class indicates whether a resource becomes part of a balance sheet account, such as inventory or fixed assets, while the Non-inventory class indicates that the resource is treated as an expense of the period during which it occurs. The accounting date indicates when a transaction is recognized, as opposed to the date the transaction actually occurred. The accounting date and transaction date can be the same. The accounting date determines the period in the general ledger to which the transaction is to be posted. You 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. 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 equal credits). Accounting entries are created to record accruals, payments, payment cancellations, manual closures, project activities in the general ledger, and so forth, depending on the application. The accounting split method indicates how expenses are allocated or divided among one or more sets of accounting ChartFields. You use an accumulator to store cumulative values of defined items as they are processed. You can accumulate a single value over time or multiple values over time. 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. The reason an employees 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 pay group to anotherand a reason for that action. Action reasons are used by PeopleSoft Human Resources, PeopleSoft Benefits Administration, PeopleSoft Stock Administration, and the COBRA Administration feature of the Base Benefits business process. In PeopleSoft Enterprise Learning Management, an instance of a catalog item delivery methodit may also be called a class. The activity defines such things as meeting times and locations, instructors, reserved equipment and materials, and detailed costs that are associated with the offering, enrollment limits and deadlines, and waitlisting capacities. In PeopleSoft Enterprise Incentive Management, an expression within compensation plans that enables the system to assign transactions to nodes and participants. During transaction allocation, the allocation engine traverses the compensation structure
absence take account
accounting class
accounting date
accounting entry
accounting split accumulator
action reason
activity
allocation rule
103
Glossary
from the current node to the root node, checking each node for plans that contain allocation rules. alternate account A feature in PeopleSoft General Ledger that enables you to create a statutory chart of accounts and enter statutory account transactions at the detail transaction level, as required for recording and reporting by some national governments. An application agent is an online agent that is loaded into memory with a PeopleSoft page. It detects when a business rule has been triggered and determines the appropriate action. An asset group used for reporting purposes. It can be used in conjunction with the asset category to refine asset classification. In PeopleSoft Enterprise Learning Management, nonsystem-defined electronic material that supplements a learning resource, such as an equipment items user handbook or the site map of a large facility. In PeopleSoft, background processes are executed through process-specific COBOL programs and run outside the Windows environment. In PeopleSoft Workforce Analytics, a benchmark job is a job code for which there is corresponding salary survey data from published, third-party sources. A tree node that rolls up to nodes above it in the hierarchy, as defined in PeopleSoft Tree Manager. An account used by the system only and not by users; this type of account does not accept transactions. You can only budget with this account. Formerly called system-maintained account. In commitment control, the processing of source transactions against control budget ledgers, to see if they pass, fail, or pass with a warning. In commitment control, budget control ensures that commitments and expenditures dont exceed budgets. It enables you to track transactions against corresponding budgets and terminate a documents cycle if the defined budget conditions are not met. For example, you can prevent a purchase order from being dispatched to a vendor if there are insufficient funds in the related budget to support it. The interval of time (such as 12 months or 4 quarters) into which a period is divided for budgetary and reporting purposes. The ChartField allows maximum flexibility to define operational accounting time periods without restriction to only one calendar. In PeopleSoft Sales Incentive Management, an original business transaction or activity that may justify the creation of a PeopleSoft Enterprise Incentive Management event (a sale, for example). In PeopleSoft Enterprise Learning Management, a specific topic that a learner can study and have tracked. For example, Introduction to Microsoft Word. A catalog item contains general information about the topic and includes a course code, description, categorization, keywords, and delivery methods. In PeopleSoft Enterprise Learning Management, a way to classify catalog items so that users can easily browse and search relevant entries in the learning catalog. Categories can be hierarchical. A field that stores a chart of accounts, resources, and so on, depending on the PeopleSoft application. ChartField values represent individual account numbers, department codes, and so forth. You can require specific ChartFields to match up (balance) on the debit and the credit side of a transaction.
application agent
asset class attachment
background process benchmark job branch budgetary account only
budget check budget control
budget period
business event
catalog item
category
ChartField
ChartField balancing
104
Glossary
ChartField combination edit ChartKey child
The process of editing journal lines for valid ChartField combinations based on user-defined rules. One or more fields that uniquely identify each row in a table. Some tables contain only one field as the key, while others require a combination. In PeopleSoft Tree Manager trees, a child is a node or detail on a tree linked to another, higher-level node (referred to as the parent). Child nodes can be rolled up into the parent. A node can be a child and a parent at the same time depending on its location within the tree. A ChartField value that identifies a unique appropriation budget key when you combine it with a fund, department ID, and program code, as well as a budget period. Formerly called sub-classification. In PeopleCode, to make a unique copy. In contrast, to copy may mean making a new reference to an object, so if the underlying object is changed, both the copy and the original change. To make a set of documents available for searching in Verity, you must first create at least one collection. 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 that match search criteria. A collection is a set of statistics and pointers to the source documents, stored in a proprietary format on a file server. Because a collection can only store information for a single location, PeopleSoft maintains a set of collections (one per language code) for each search index object. In PeopleSoft Enterprise Incentive Management, a node within a compensation structure. Compensation objects are the building blocks that make up a compensation structures hierarchical representation. In PeopleSoft Enterprise Incentive Management, a hierarchical relationship of compensation objects that represents the compensation-related relationship between the objects. Used to configure an external system with PeopleSoft. For example, a configuration parameter catalog might set up configuration and communication parameters for an external server. In PeopleSoft Enterprise Incentive Management, configuration plans hold allocation information for common variables (not incentive rules) and are attached to a node without a participant. Configuration plans are not processed by transactions. Content references are pointers to content registered in the portal registry. These are typically either URLs or iScripts. Content references fall into three categories: target content, templates, and template pagelets. In PeopleSoft Enterprise Incentive Management, a mechanism that is used to determine the scope of a processing run. PeopleSoft Enterprise Incentive Management uses three types of context: plan, period, and run-level. Equivalent to the Account ChartField. Distinguishes between the chart of accounts typically used to record and report financial information for management, stockholders, and the general public, as opposed to a chart of statutory (alternate) accounts required by a regulatory authority for recording and reporting financial information. A combination of a receipt cost method, a cost flow, and a deplete cost method. A profile is associated with a cost book and determines how items in that book are valued, as well as how the material movement of the item is valued for the book. A cost transaction and amount for a set of ChartFields.
Class ChartField
clone
collection
compensation object
compensation structure
configuration parameter catalog configuration plan
content reference
context
corporate account
cost profile
cost row
105
Glossary
data acquisition
In PeopleSoft Enterprise Incentive Management, the process during which raw business transactions are acquired from external source systems and fed into the operational data store (ODS). Data elements, at their simplest level, define a subset of data and the rules by which to group them. For Workforce Analytics, data elements are rules that tell the system what measures to retrieve about your workforce groups.
data elements
data row data validation DAT file delivery method delivery method type
Contains the entries for each field in a table. To identify each data row uniquely, PeopleSoft applications use a key consisting of one or more fields in the table. In PeopleSoft Enterprise Incentive Management, a process of validating and cleansing the feed data to resolve conflicts and make the data processable. This text file, used with the Verity search engine, contains all of the information from documents that are searchable but not returned in the results list. In PeopleSoft Enterprise Learning Management, identifies a learning activitys delivery method type. An activity can have one or more delivery methods. In PeopleSoft Enterprise Learning Management, specifies a method that your organization uses to deliver learning activities, for example, scheduled or self-paced learning. The process of assigning values to ChartFields. A distribution is a string of ChartField values assigned to items, payments, and budget amounts. If youre working with Japanese or other Asian employees, you can enter the employees name using double-byte characters. The standard double byte character set name format in PeopleSoft applications is: [last name] space [first name]. A tree that takes its detail valuesdynamic detailsdirectly from a table in the database, rather than from a range of values entered by the user. A table in the database that has its own record definition, such as the Department table. As fields are entered into a PeopleSoft application, they can be validated against an edit table to ensure data integrity throughout the system. A method of dating information in PeopleSoft applications. You can predate information to add historical data to your system, or postdate information in order to enter it before it actually goes into effect. By using effective dates, you dont delete values; you enter a new value with a current effective date. Abbreviation for Enterprise Incentive Management job. In PeopleSoft Enterprise Incentive Management, a collection of job steps that corresponds to the steps in an organizations compensation-related business process. An EIM job can be stopped to allow manual changes or corrections to be applied between steps, and then resumed from where it left off, continuing with the next step. A run can also be restarted or rolled back. Abbreviation for Enterprise Incentive Management ledger. In PeopleSoft Enterprise Incentive Management, an object to handle incremental result gathering within the scope of a participant. The ledger captures a result set with all of the appropriate traces to the data origin and to the processing steps of which it is a result. In PeopleSoft Enterprise Learning Management, resource items that can be assigned to a training facility, to a specific training room, or directly to an activity session. Equipment items are generally items that are used (sometimes for a fee) and returned after the activity is complete.
distribution double byte character
dynamic tree edit table
effective date
EIM job
EIM ledger
equipment
106
Glossary
event
Events are predefined points either in the application processor flow or in the program flow. As each point is encountered, the event activates each component, triggering any PeopleCode program associated with that component and that event. Examples of events are FieldChange, SavePreChange, and OnRouteSubscription. In PeopleSoft Human Resources, event also refers to incidents that affect benefits eligibility. In PeopleSoft Sales Incentive Management, a process that determines, through logic, the propagation of an original PeopleSoft Enterprise Incentive Management event and creates a derivative (duplicate) of the original event to be processed by other objects. Sales Incentive Management uses this mechanism to implement splits, roll-ups, and so on. Event propagation determines who receives the credit. In PeopleSoft, any system that is not directly compiled with PeopleTools servers. In PeopleSoft applications, facts are numeric data values from fields from a source database as well as an analytic application. A fact can be anything you want to measure your business by, for example, revenue, actual, budget data, or sales numbers. A fact is stored on a fact table. In PeopleSoft applications, a filter creates a subset of information. Filters are used in templates to limit your information from a pick list of attribute values. In PeopleSoft Process Scheduler, process types are identified by a generic process type. For example, the generic process type SQR includes all SQR process types, such as SQR process and SQR report. Any set of records associated under a single name or variable in order to run calculations in PeopleSoft business processes. In PeopleSoft Time and Labor, for example, employees are placed in groups for time reporting purposes. Users can personalize the homepage, or the page that first appears when they access the portal. In PeopleSoft Enterprise Incentive Management, the incentive-related objects that define and support the PeopleSoft Enterprise Incentive Management calculation process and results, such as plan templates, plans, results data, user interaction objects, and so on. In PeopleSoft Sales Incentive Management, the commands that act on transactions and turn them into compensation. A rule is one part in the process of turning a transaction into compensation. One or more fields that uniquely identify each row in a table. Some tables contain only one field as the key, while others require a combination. In PeopleSoft Enterprise Learning Management, a group of learners within the same learning environment that share the same attributes, such as department or job code. See activity. In PeopleSoft Enterprise Learning Management, a self-service repository for all of a learners completed learning activities. In PeopleSoft Enterprise Learning Management, a self-service repository for all of a learners planned and in-progress learning activities. You use ledger mapping to relate expense data from general ledger accounts to resource objects. Multiple ledger line items can be mapped to one or more resource IDs. 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, or a budgeted amount that can be used to calculate the capacity rates as well as budgeted model results. In PeopleSoft Enterprise Warehouse, you can map general ledger accounts to the EW Ledger table.
event propagation process
external system fact
filter generic process type
group
homepage incentive object
incentive rule
key learner group learning activity learning history learning plan ledger mapping
107
Glossary
level library section
A section of a tree that organizes groups of nodes. In PeopleSoft Enterprise Incentive Management, a section that is defined in a plan (or template) and that is available for other plans to share. Changes to a library section are reflected in all plans that use it. In PeopleSoft Enterprise Incentive Management, a section that is defined in a plan template but appears in a plan. Changes to linked sections propagate to plans using that section. In PeopleSoft Enterprise Incentive Management, a variable that is defined and maintained in a plan template and that also appears in a plan. Changes to linked variables propagate to plans using that variable. The feature that initiates a process to automatically load information into a PeopleSoft applicationfor example, populating the PeopleSoft Benefits database with plan-level election information. In PeopleSoft HRMS, the set of information that is available for a specific country. You can access this information when you click the appropriate country flag in the global window, or when you access it by a local country menu. Locations enable you to indicate the different types of addressesfor a company, for example, one address to receive bills, another for shipping, a third for postal deliveries, and a separate street address. Each address has a different location number. The primary locationindicated by a 1is the address you use most often and may be different from the main address. In PeopleSoft Enterprise Incentive Management, additional functionality that is specific to a given market or industry and is built on top of a product category. In PeopleSoft Enterprise Learning Management, a resource item that can be assigned to the sessions of an activity. Material items are generally consumed during the duration of an activity and not returned, and they may have an associated cost. An object definition specified in PeopleSoft Application Designer that contains message information for PeopleSoft Application Messaging. Meta-SQL constructs expand into platform-specific SQL substrings. They are used in functions that pass SQL strings, such as in SQL objects, the SQLExec function, and PeopleSoft Application Engine programs. 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. Processes in PeopleSoft applications that can create both application entries and general ledgers denominated in more than one currency. The ability to process transactions in a currency other than the business units base currency. In PeopleSoft Enterprise Learning Management, an individuals learning goal. An example of a learning goal is a competency gap. In PeopleSoft Enterprise Incentive Management, the ability to make a change to a plan that applies to only one plan context. Each block of content on the homepage is called a pagelet. These pagelets display summary information within a small rectangular area on the page. The pagelet provide users with a snapshot of their most relevant PeopleSoft and non-PeopleSoft content.
linked section
linked variable
load
local functionality
location
market template material
message definition meta-SQL
metastring
multibook multicurrency objective override pagelet
108
Glossary
parent node participant participant object
A tree node linked to lower-level nodes or details that roll up into it. A node can be a parent and a child at the same time, depending on its location within the tree. In PeopleSoft Enterprise Incentive Management, participants are recipients of the incentive compensation calculation process. Each participant object may be related to one or more compensation objects. See also participant object.
payout PeopleCode
In PeopleSoft Enterprise Incentive Management, the resulting incentive plan computation that is provided to payroll. PeopleCode is a proprietary language, executed by the PeopleSoft application processor. PeopleCode generates results based upon existing data or user actions. By using business interlink objects, external services are available to all PeopleSoft applications wherever PeopleCode can be executed. An action that a user takes upon an object, usually a record field, that is referenced within a PeopleSoft page. The fundamental architecture on which PeopleSoft 8 applications are constructed, consisting of an RDBMS, an application server, a Web server, and a browser. In PeopleSoft Enterprise Incentive Management, a variable used to store data (similar to an aggregator, but without a predefined formula) within the scope of an incentive plan. Performance measures are associated with a plan calendar, territory, and participant. Performance measurements are used for quota calculation and reporting. In PeopleSoft Enterprise Incentive Management, because a participant typically uses the same compensation plan for multiple periods, the period context associates a plan context with a specific calendar period and fiscal year. The period context references the associated plan context, thus forming a chain. Each plan context has a corresponding set of period contexts. In PeopleSoft Enterprise Learning Management, the cost per learner, based on the total activity costs divided by either minimum attendees or maximum attendees. Organizations use this cost to price PeopleSoft Enterprise Learning Management activities. In PeopleSoft Sales Incentive Management, a collection of allocation rules, variables, steps, sections, and incentive rules that instruct the PeopleSoft Enterprise Incentive Management engine in how to process transactions. In PeopleSoft Enterprise Incentive Management, correlates a participant with the compensation plan and node to which the participant is assigned, enabling the PeopleSoft Enterprise Incentive Management system to find anything that is associated with the node and that is required to perform compensation processing. Each participant, node, and plan combination represents a unique plan contextif three participants are on a compensation structure, each has a different plan context. Configuration plans are identified by plan contexts and are associated with the participants that refer to them. In PeopleSoft Enterprise Incentive Management, a segment of a plan that handles a specific type of event processing. In PeopleSoft Enterprise Incentive Management, the base from which a plan is created. A plan template contains common sections and variables that are inherited by all plans that are created from the template. A template may contain steps and sections that are not visible in the plan definition. In PeopleSoft applications, the portal registry is a tree-like structure in which content references are organized, classified, and registered. It is a central repository that
PeopleCode event PeopleSoft Internet Architecture performance measurement
period context
per seat cost
plan
plan context
plan section plan template
portal registry
109
Glossary
defines both the structure and content of a portal through a hierarchical, tree-like structure of folders useful for organizing and securing content references. private view process process definition process instance A user-defined view that is available only to the user who created it. See Batch Processes. Process definitions define each run request. 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. You can link process definitions into a job request and process each request serially or in parallel. You can also initiate subsequent processes based on the return code from each prior request. A single run request, such as an SQR, a COBOL program, or a Crystal report that you run through PeopleSoft Process Scheduler. A PeopleTools variable used to retain PeopleSoft Process Scheduler values needed at runtime for all requests that reference a run control ID. Do not confuse these 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. In PeopleSoft Enterprise Incentive Management, indicates an application in the Enterprise Incentive Management suite of products. Each transaction in the PeopleSoft Enterprise Incentive Management system is associated with a product category. In PeopleSoft Enterprise Incentive Management, a stage in processing that makes incentive-related results available to participants. A logical grouping of data elements. A field within a record definition. A set of logically and functionally related control tables and views. Record groups help enable TableSet sharing, which eliminates redundant data entry. Record groups ensure that TableSet sharing is applied consistently across all related tables and views. Abbreviation for record input value-added tax flag. Within PeopleSoft Purchasing, Payables, and General Ledger, this flag indicates that you are recording input VAT on the transaction. This flag, in conjunction with the record output VAT flag, is used to determine the accounting entries created for a transaction and to determine how a transaction is reported on the VAT return. For all cases within Purchasing and Payables where VAT information is tracked on a transaction, this flag is set to Yes. This flag is not used in PeopleSoft Order Management, Billing, or Receivables, where it is assumed that you are always recording only output VAT, or in PeopleSoft Expenses, where it is assumed that you are always recording only input VAT. Abbreviation for record output value-added tax flag. See record input VAT flag. reference data reference object In PeopleSoft Sales Incentive Management, system objects that represent the sales organization, such as territories, participants, products, customers, channels, and so on. In PeopleSoft Enterprise Incentive Management, this dimension-type object further defines the business. Reference objects can have their own hierarchy (for example, product tree, customer tree, industry tree, and geography tree). In commitment control, a reference transaction is a source transaction that is referenced by a higher-level (and usually later) source transaction, in order to
process job
process request process run control
product category
publishing record definition record field record group
record input VAT flag
record output VAT flag
reference transaction
110
Glossary
automatically reverse all or part of the referenced transactions budget-checked amount. This avoids duplicate postings during the sequential entry of the transaction at different commitment levels. For example, the amount of an encumbrance transaction (such as a purchase order) will, when checked and recorded against a budget, cause the system to concurrently reference and relieve all or part of the amount of a corresponding pre-encumbrance transaction, such as a purchase requisition. relationship object In PeopleSoft Enterprise Incentive Management, these objects further define a compensation structure to resolve transactions by establishing associations between compensation objects and business objects. In PeopleSoft Sales Incentive Management, the process during which compensation administrators may review processing results, manually change transactions, process draws, update and review payouts, process approvals, and accumulate and push payments to the EIM ledger. A PeopleSoft Workflow user. A persons role user ID serves much the same purpose as a user ID does in other parts of the system. PeopleSoft Workflow uses role user IDs to determine how to route worklist items to users (through an email address, for example) and to track the roles that users play in the workflow. Role users do not need PeopleSoft user IDs. Describes how people fit into PeopleSoft Workflow. A role is a class of users who perform the same type of work, such as clerks or managers. Your business rules typically specify what user role needs to do an activity. In a tree, to roll up is to total sums based on the information hierarchy. Connects activities in PeopleSoft Workflow. Routings specify where the information goes and what form it takesemail message, electronic form, or worklist entry. A run control is a type of online page that is used to begin a process, such as the batch processing of a payroll run. Run control pages generally start a program that manipulates data. A unique ID to associate each user with his or her own run control table entries. In PeopleSoft Enterprise Incentive Management, associates a particular run (and batch ID) with a period context and plan context. Every plan context that participates in a run has a separate run-level context. Because a run cannot span periods, only one run-level context is associated with each plan context. You use this set of objects to pass a query string and operators to the search engine. The search index returns a set of matching results with keys to the source documents. In PeopleSoft Enterprise Incentive Management, a collection of incentive rules that operate on transactions of a specific type. Sections enable plans to be segmented to process logical events in different sections. In commitment control, security events trigger security authorization checking, such as budget entries, transfers, and adjustments; exception overrides and notifications; and inquiries. Self-service refers to PeopleSoft applications that are accessed by end users with a browser. In PeopleSoft Enterprise Learning Management, a single meeting day of an activity (that is, the period of time between start and finish times within a day). The session stores the specific date, location, meeting time, and instructor. Sessions are used for scheduled training. In PeopleSoft Enterprise Learning Management, enables you to set up common activity characteristics that may be reused while scheduling a PeopleSoft Enterprise
results management process
role user
role
roll up routing run control
run control ID run-level context
search query section
security event
self-service application session
session template
111
Glossary
Learning Management activitycharacteristics such as days of the week, start and end times, facility and room assignments, instructors, and equipment. A session pattern template can be attached to an activity that is being scheduled. Attaching a template to an activity causes all of the default template information to populate the activity session pattern. setup relationship sibling In PeopleSoft Enterprise Incentive Management, a relationship object type that associates a configuration plan with any structure node. A tree node at the same level as another node, where both roll up into the same parent. A node can be a sibling, parent, and child all at the same time, depending on its location in the tree. With single signon, users can, after being authenticated by a PeopleSoft application server, access a second PeopleSoft application server without entering a user ID or password. In commitment control, any transaction generated in a PeopleSoft or third-party application that is integrated with commitment control and which can be checked against commitment control budgets. For example, a pre-encumbrance, encumbrance, expenditure, recognized revenue, or collected revenue transaction. A user-defined shorthand key that designates several ChartKeys to be used for voucher entry. Percentages can optionally be related to each ChartKey in a SpeedChart definition. A code representing a combination of ChartField values. SpeedTypes simplify the entry of ChartFields commonly used together. See Structured Query Report (SQR). Account required by a regulatory authority for recording and reporting financial results. In PeopleSoft, this is equivalent to the Alternate Account (ALTACCT) ChartField. In PeopleSoft Sales Incentive Management, a collection of sections in a plan. Each step corresponds to a step in the job run.
single signon
source transaction
SpeedChart
SpeedType SQR statutory account
step
Structured Query Report (SQR) A type of printed or displayed report generated from data extracted from a PeopleSoft SQL-based relational database. PeopleSoft applications provide a variety of standard SQRs that summarize table information and data. You can use these reports as is, customize them, or create your own. Summary ChartField You use summary ChartFields to create summary ledgers that roll up detail amounts based on specific detail values or on selected tree nodes. When detail values are summarized using tree nodes, summary ChartFields must be used in the summary ledger data record to accommodate the maximum length of a node name (20 characters). An accounting feature used primarily in allocations, inquiries, and PS/nVision reporting to store combined account balances from detail ledgers. Summary ledgers increase speed and efficiency of reporting by eliminating the need to summarize detail ledger balances each time a report is requested. Instead, detail balances are summarized in a background process according to user-specified criteria and stored on summary ledgers. The summary ledgers are then accessed directly for reporting. A tree used to roll up accounts for each type of report in summary ledgers. Summary trees enable you to define trees on trees. In a summary tree, the detail values are really nodes on a detail tree or another summary tree (known as the basis tree). A summary tree structure specifies the details on which the summary trees are to be built.
summary ledger
summary tree
112
Glossary
table TableSet sharing target currency template
The underlying PeopleSoft data format, in which data is stored by columns (fields) and rows (records, or instances). Specifies control table data for each business unit so that redundancy is eliminated. The value of the entry currency or currencies converted to a single currency for budget viewing and inquiry purposes. A template is HTML code associated with a Web page. It defines the layout of the page and also where to get HTML for each part of the page. In PeopleSoft, you use templates to build a page by combining HTML from a number of sources. For a PeopleSoft portal, all templates must be registered in the portal registry, and each content reference must be assigned a template. In PeopleSoft Sales Incentive Management, hierarchical relationships of business objects, including regions, products, customers, industries, and participants. A relative period, such as year-to-date or current period, that can be used in various PeopleSoft General Ledger functions and reports when a rolling time frame, rather than a specific date, is required. TimeSpans can also be used with flexible formulas in PeopleSoft Projects. In PeopleSoft Enterprise Incentive Management, the process of identifying the owner of a transaction. When a raw transaction from a batch is allocated to a plan context, the transaction is duplicated in the PeopleSoft Enterprise Incentive Management transaction tables. In PeopleSoft Enterprise Incentive Management, the process during which transactions are loaded into Sales Incentive Management. During loading, the source currency is converted to the business unit currency while retaining the source currency code. At the completion of this stage, the transaction is in the first state. In PeopleSoft Enterprise Incentive Management, a value assigned by an incentive rule to a transaction. Transaction states enable sections to process only transactions that are at a specific stage in system processing. After being successfully processed, transactions may be promoted to the next transaction state and picked up by a different section for further processing. In PeopleSoft Enterprise Incentive Management, a way to categorize transactions to identify specific transaction types (for example, shipment, order, opportunity, and so on). Plan sections process only one type of transaction type. Transaction types can be defined based on a companys specific processes model. A system edit table that stores codes and translate values for the miscellaneous fields in the database that do not warrant individual edit tables of their own. The graphical hierarchy in PeopleSoft systems that displays the relationship between all accounting units (for example, corporate divisions, projects, reporting groups, account numbers) and determines roll-up hierarchies. In PeopleSoft Enterprise Incentive Management, a transaction that is not claimed by a node or participant after the allocation process has completed, usually due to missing or incomplete data. Unclaimed transactions may be manually assigned to the appropriate node or participant by a compensation administrator.
territory TimeSpan
transaction allocation
transaction loading process
transaction state
transaction type
Translate table tree
unclaimed transaction
uniform resource locator (URL) In PeopleSoft, the term URL refers to the entire query string. The following is an example of a URL: http://serverx/InternetClient /InternetClientServlet?ICType=Script&ICScriptProgramName=WEBLIB_BEN_ 401k.PAGES.FieldFormula.iScript_Home401k universal navigation header Every PeopleSoft portal includes the universal navigation header, intended to appear at the top of every page as long as the user is signed on to the portal. In addition to
113
Glossary
providing access to the standard navigation buttons (like Home, Favorites, and signoff) the universal navigation header can also display a welcome message for each user. URL user interaction object See uniform resource locator (URL). In PeopleSoft Sales Incentive Management, used to define the reporting components and reports that a participant can access in his or her context. All Sales Incentive Management user interface objects and reports are registered as user interaction objects. User interaction objects can be linked to a compensation structure node through a compensation relationship object (individually or as groups). In PeopleSoft Sales Incentive Management, the intermediate results of calculations. Variables hold the calculation results and are then inputs to other calculations. Variables can be plan variables that persist beyond the run of an engine or local variables that exist only during the processing of a section. A PeopleSoft data warehouse that consists of predefined ETL maps, data warehouse tools, and DataMart definitions. A way of presenting data through a PeopleSoft Business Analysis Modeler interface that enables users to do in-depth analysis using pivoting tables, charts, notes, and history information. The background process that creates a list of administrative actions based on selection criteria and specifies the procedure associated with each action. The automated to-do list that PeopleSoft Workflow creates. From the worklist, you can directly access the pages you need to perform the next action, and then return to the worklist for another item. Abbreviation for zero-rated value-added tax. A VAT transaction with a VAT code that has a tax percent of zero. Used to track taxable VAT activity where no actual VAT amount is charged.
variable
warehouse worksheet
workflow worklist
zero-rated VAT
114
Index
A
additional documentation x application fundamentals ix Application Server failover 68 high availability 68 Tuxedo connect string 68 workstation settings 67 Archive Data 81 See Also See Data Archiving Archives working with 88 Archiving data 81 techniques 100 AS 31 Audits data archiving 97 Configuration workstation 49 Configuration Manager 49 Application Servers tab 67 Client Setup tab 63 command line options 74 Crystal tab 57 display settings 54 Display tab 54 folder tabs 50 Import/Export tab 65 interface 50 nVision tab 72 Other tab 66 Process Scheduler tab 69 Remote Call/AE tab 61 running Client Setup 78 shortcuts 64 signon defaults 51 starting 50 Startup tab 51 Trace tab 59 user settings 78 Workflow tab 60 Connect ID default 53 Connectivity verifying 77 Consolidated Publications Incorporated (CPI) x contact information xiii country-specific documentation xii CREATE_INDEX_BEFORE_DATA 34 CREATE_TEMP_TABLE 19 CREATE_TRIGGER 19 cross-references xii Customer Connection Website x
B
Bootstrap mode in Data Mover 2
C
Cache Files workstation settings 54 CHANGE_ACCESS_PASSWORD 18 Client Setup running in Configuration Manager 78 Command Line Configuration Manager 74 Data Mover 11 UNIX 12 Data Mover parameters 13 Data Mover scripts 12 Command modifiers Data Mover 30 Commands Data Mover 14, 1718 SQL supported by Data Mover 15 comments, submitting xiii COMMIT 34 Data Mover 33 common elements xiii
D
Data exporting 95 importing flat files 96 Data Archiving 81 archive process 92 audits 97
115
Index
defining criteria 84 designer 84 exporting history data 95 finding data 90 history tables 82 importing flat files 96 join records 85 processes 92 reports 97 security 88 SQL 86 strategy 82 techniques 100 to flat files 83, 94 to tables 82 transferring data 90 understanding 81 utilities 89 working with archives 88 working with data 89 Data Base Setup Data Mover using 8 Data Mover bootstrap mode 2 command line interface 11 command line parameters 13 command modifiers 30 AS 31 IGNORE_DUPS 32 WHERE 32 command overview 14 command types 4 commands 14, 1718 ENCRYPT_PASSWORD 20 EXPORT 20 IMPORT 21 REM 23 REMARK 23 RENAME 24 REPLACE_ALL 26 REPLACE_DATA 26 REPLACE_VIEW 27 RUN 27 SET 28 COMMIT 33 creating scripts 6 database setup 8 editing scripts 6 ERASE 17
example script files 46 export script 21 exporting a database 21 generated scripts 11 icon setup 2 IMPORT command 21 interface 2 menu options 4 migrating a database 1 operating modes 2 overview 1 parameter file 14 preparing for an export 7 running scripts 7 running scripts from command line 12 scripts 1, 4 SET parameters 34 COMMIT 34 CREATE_INDEX_BEFORE_ DATA 34 DDL 36 EXECUTE_SQL 37 EXTRACT 37 IGNORE_DUPS 38 INPUT 38 INSERT_DATA_ONCE 39 LOG 39 NO DATA 40 NO INDEX 41 NO RECORD 41 NO SPACE 41 NO TRACE 42 NO VIEW 42 OUTPUT 43 SIZING_SET 43 SPACE 44 START 4445 VERSION 45 SQL files 16 SQL trace 3 starting 2 STORE 16 supported SQL commands 1516 syntax rules 5 toolbar options 4 UNIX interface 12 window 3 workstation settings 74 Database Data Mover 1
116
Index
migrating 1 Database Name displaying 56 Database Setup accessing 9 choosing applications 9 parameters 10 scripts 11 using 8 Database Type default 52 DBSPACE 35 DDL 36 definition of 17 Detach Directory 61 Development Environment setting up 76 Display defaults 54 font 56 pages 55 DML definition of 17 documentation country-specific xii printed x related x updates x
L
Language preference workstation settings 55 LOG 39
N
Navigator enabling 57 NO DATA 40 NO INDEX 41 NO RECORD 41 NO SPACE 41 NO TRACE 42 NO VIEW 42 notes xii nVision workstation settings 72
O
Operator overrides 53 signon 51 OUTPUT 43
P
Pages displaying 56 displaying in Navigator 56 Parm file 14 PeopleBooks ordering x PeopleCode, typographical conventions xi PeopleSoft registry settings 49 PeopleSoft application fundamentals ix PeopleSoft Open Query workstation settings 64 Popup menus highlighting 56 prerequisites ix printed documentation x Process Scheduler workstation settings 69 Processes data archives 92 PS_HOME Access verifying 77 PSARCH_ID 83
E
ENCRYPT_PASSWORD ERASE 17 EXECUTE_SQL 37 Export Data Mover preparation 7 EXPORT 14, 20 EXTRACT 37 14, 20
G
glossary 103
I
IGNORE_DUPS 38 IMPORT 15, 21 INPUT 38 Installation development environment workstations 64
76
117
Index
Q
Quality Server workstation settings 66
R
Registry PeopleSoft settings 49 Regular mode in Data Mover 2 related documentation x REM 23 REMARK 23 RENAME 15, 24 REPLACE_ALL 15, 26 REPLACE_DATA 15, 26 REPLACE_VIEW 15, 27 Reports data archiving 97 RUN 15, 27
data archives 86 SQL trace in Data Mover 3 START 4445 STORE 16 suggestions, submitting xiii Supporting Applications verifying 77 SWAP_BASE_LANGUAGE 15, 28 Syntax Data Mover scripts 5
T
terms 103 Three-Tier workstation settings 67 Trace PeopleCode trace settings 59 SQL trace settings 59 trace settings 59 typographical conventions xi
S
Scripts Data Mover 4 creating 6 editing 6 examples 46 running 7 Database Setup 11 Security data archives 88 SET 15, 28 SET BASE_LANGUAGE 15, 30 SET IGNORE_ERRORS 15, 29 SET parameters Data Mover 34 Shortcuts creating 64 Signon connect ID 53 default application server 52 default database name 52 default database server 52 default operator ID 53 operator overrides 53 setting defaults 51 Signon Defaults 51 SIZING_SET 43 SPACE 44 SQL
U
UNIX Data Mover command line Upgrade image conversion 74 User ID default 53 12
V
VERSION 45 visual cues xii
W
warnings xiii WHERE 32 Workstations exporting settings 65 importing settings 65 installing 63 setting up 49
118

PeopleSoft Administration Tools

Uploaded by

Copyright:

Available Formats

PeopleSoft Administration Tools

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PeopleSoft Administration Tools

Uploaded by

Copyright:

Available Formats

PeopleTools 8.

42 Administration Tools PeopleSoft Administration Tools

PeopleSoft Proprietary and Confidential

PeopleSoft Proprietary and Confidential

PeopleSoft Proprietary and Confidential

PeopleSoft Proprietary and Confidential

Understanding the User Settings.......................................................................... . . . . . . .78 Running Client Setup........................................................................................ . . . . . . .78

PeopleSoft Proprietary and Confidential

Glossary of PeopleSoft Terms.............................................................................103

PeopleSoft Proprietary and Confidential

About This PeopleBook

PeopleSoft Application Prerequisites

PeopleSoft Application Fundamentals

PeopleSoft Proprietary and Confidential

Obtaining Documentation Updates

Ordering Printed Documentation

PeopleSoft Proprietary and Confidential

Typographical Conventions and Visual Cues

Monospace font (quotation marks)

PeopleSoft Proprietary and Confidential

Typographical Convention or Visual Cue . . . (ellipses)

[ ] (square brackets) & (ampersand)

PeopleSoft Proprietary and Confidential

Important! Example of an important note.

Comments and Suggestions

Common Elements in These PeopleBooks

Description Effective Date

Once, Always, and Dont Run

PeopleSoft Proprietary and Confidential

Process Monitor Run Request ID User ID SetID

PeopleSoft Proprietary and Confidential

Administration Tools Preface

PeopleSoft Data Mover

PeopleSoft Configuration Manager

PeopleSoft Proprietary and Confidential

PeopleSoft Data Archive Manager

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover

Understanding Data Mover

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover

Understanding the Data Mover Interface

Starting Data Mover

Signing On to the Development Environment

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover

Understanding the Data Mover Window

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover

Understanding the Menu Options

Edit View Help

Understanding the Toolbar Options

Understanding Data Mover Scripts

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover

Creating and Editing Scripts

PeopleSoft Proprietary and Confidential

PeopleSoft Data Mover