User s Guide for PeopleSoft Access Method

Transcription

1 IBM Tioli Workload Scheduler for Applications User s Guide for PeopleSoft Access Method Version (Maintenance Release Noember 2003) SH

2

3 IBM Tioli Workload Scheduler for Applications User s Guide for PeopleSoft Access Method Version (Maintenance Release Noember 2003) SH

4 Note Before using this information and the product it supports, read the information in Notices on page 47. Refreshed Edition (Noember 2003) This edition applies to ersion 8, release 1, modification 1 of IBM Tioli Workload Scheduler for Applications for PeopleSoft (product number 5698-WSE) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation All rights resered. US Goernment Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Preface Maintenance Release Who Should Read This Guide Prerequisite and Related Documents..... What This Guide Contains Publications i Contacting Customer Support ii Conentions Used in This Book iii Chapter 1. Introduction Features Functional Oeriew PeopleSoft Process Scheduler Jobs PeopleSoft Job Tracking in Tioli Workload Scheduler Security The Options Editor Notes on PeopleSoft Version 8.x Support Chapter 2. Implementation Planning.. 5 PeopleSoft Version 7.5 or Earlier Host Requirements Software Requirements Windows User Setup Verifying the PeopleSoft Enironment Creating a Batch Processing ID in PeopleSoft..6 Installed Files PeopleSoft Version 8.x Host Requirements Software Requirements Creating a Batch Processing ID in PeopleSoft..7 Installed Files Chapter 3. Installation Installation Procedure Creating the Options File Creating the PeopleSoft Options File Connecting to More than One PeopleSoft Database Setting Up the PeopleSoft Enironment for Version 7.5 or earlier Customizing the Process Serer Setting Up the Client Running the Data Moer Script Setting Up the PeopleSoft Enironment for Version 8.x Customizing the Process Serer Setting Up the Client Chapter 4. Setting up the Extended Agent Creating a PeopleSoft Extended Agent Workstation 23 Composer Command Line Example Creating PeopleSoft Job Definitions in Tioli Workload Scheduler Composer Command Line Example Creating PeopleSoft Job Streams Composer Command Line Example Setting up Opens Dependencies 7.x Only Example Opens Dependencies IBM Tioli Workload Scheduler and PeopleSoft Job Status Mapping Uninstalling the Extended Agent Appendix A. User Setup for Windows 33 Appendix B. Manually Editing Options Files Example for PeopleSoft 7.x Example for PeopleSoft 8.x Appendix C. Using National Language Support Appendix D. Updates Aailable with the WSE-FP02 Patch New Features Configuration Special Considerations and Known Limitations..42 Troubleshooting Notices Trademarks Glossary Index Copyright IBM Corp iii

6 i IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

7 Preface The Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method proides task-oriented information on how to set up and use Tioli Workload Scheduler to control and execute PeopleSoft jobs in the Tioli Workload Scheduler job control enironment. Maintenance Release This is a maintenance refresh of the corresponding IBM Tioli Workload Scheduler for Applications Version manual, form number SH It contains updates for the APARS fixed with the Tioli Workload Scheduler patches WSE-FP01 and WSE-FP02. Throughout the book, the changed or new sections are marked by reision bars. The name of the fix pack or APAR causing the information change is also featured within the changed chapter, section, or paragraph. If your ersion of the product has not been fixed for a particular APAR, refer to the original ersion of the manual for the corresponding information. Who Should Read This Guide The target audience for this guide are system administrators and managers who set up and use Tioli Workload Scheduler to control PeopleSoft jobs. Users of the guide should hae some knowledge of: The Windows operating system PeopleSoft PeopleSoft Process Scheduler Tioli Workload Scheduler Prerequisite and Related Documents The following related documentation: Tioli Workload Scheduler Version 8.1 Reference Guide Tioli Workload Scheduler Version 8.1 Job Scheduling Console User s Guide What This Guide Contains The Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method contains the following sections: Chapter 1, Introduction, on page 1 Describes the features of the extended agent for PeopleSoft. Chapter 2, Implementation Planning, on page 5 Describes prerequisites for installation. Chapter 3, Installation, on page 9 Describes how to install the product. Chapter 4, Setting up the Extended Agent, on page 23 Describes how to configure an extended agent workstation, and set up PeopleSoft jobs and job streams in Tioli Workload Scheduler. Appendix A, User Setup for Windows, on page 33 Copyright IBM Corp. 2002

8 Describes user definition requirements. Appendix B, Manually Editing Options Files, on page 35 Proides examples of options files. Appendix C, Using National Language Support, on page 37 Describes the options for using NLS. Appendix D, Updates Aailable with the WSE-FP02 Patch, on page 39 Describes the updates aailable with the WSE-FP02 patch. Publications This section lists publications in the Tioli Workload Scheduler library and any other related documents. It also describes how to access Tioli publications online, how to order Tioli publications, and how to make comments on Tioli publications. IBM Tioli Workload Scheduler Publications This book is part of an extensie Tioli Workload Scheduler library. These books can help you use Tioli Workload Scheduler more effectiely: Table 1. List of Tioli Workload Scheduler Publications Task Planning and installing Tioli Workload Scheduler. Using the Tioli Workload Scheduler command line, understanding how extended and network agents work, and integrating Tioli Workload Scheduler with NetView and with Tioli Business Systems Manager. Interpreting Tioli Workload Scheduler error messages. Installing, configuring, and using Tioli Workload Scheduler fault-tolerant agents on AS/400. Setting up and using the Tioli Workload Scheduler Plus module. Tioli Workload Scheduler last minute information. Publication Tioli Workload Scheduler Planning and Installation Guide Tioli Workload Scheduler Reference Guide Tioli Workload Scheduler Error Messages Tioli Workload Scheduler AS/400 Limited FTA User s Guide Tioli Workload Scheduler Plus Module User s Guide Tioli Workload Scheduler Release Notes Order number SH SH SH SH SH GI Related Publications The following documents also proide useful information related to the product: Table 2. List of Related Publications Task Using the Jaa GUI to manage Tioli Workload Scheduler objects and run jobs. Publication Tioli Job Scheduling Console User s Guide Order number SH i IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

9 Table 2. List of Related Publications (continued) Task Using the Jaa GUI - Last minute changes Publication Tioli Job Scheduling Console Release Notes Order number GI Accessing Publications Online Publications in the product libraries are included in PDF or HTML formats, or both, on the product CD. To access the publications using a Web browser, open the infocenter.html file, which is located in the appropriate publications directory on the product CD. When IBM publishes an updated ersion of one or more online or hardcopy publications, they are posted to the Tioli Information Center. You can access updated publications in the Tioli Information Center from the following Customer Support Web site: The Tioli Information Center contains the most recent ersion of the books in the product library in PDF or HTML formats, or both. Translated documents are also aailable for some products. Note: If you print PDF documents on other than letter-sized paper, select the Fit to page check box in the Adobe Acrobat Print dialog (which is aailable when you click File --> Print) to ensure that the full dimensions of a letter-sized page are printed on the paper that you are using. Ordering Publications You can order many Tioli publications online at the following Web site: You can also order by telephone by calling one of these numbers: In the United States: In Canada: In other countries, for a list of telephone numbers, see the following Web site: Proiding Feedback about Publications If you hae comments or suggestions about Tioli products and documentation, send an to pubs@tioli.com or complete the customer feedback surey at the following Web site: Contacting Customer Support If you hae a problem with any Tioli product, you can contact Customer Support for Tioli products. See the Customer Support Handbook at the following Web site: The handbook proides information about how to contact Customer Support, depending on the seerity of your problem, and the following information: Preface ii

10 Registration and eligibility Telephone numbers and addresses, depending on the country in which you are located What information you should gather before contacting Customer Support Conentions Used in This Book This book uses seeral conentions for special terms and actions, operating system-dependent commands and paths, and margin graphics. Typeface Conentions The following typeface conentions are used in this book: Bold Italic Monospace Lowercase and mixed-case commands, command options, and flags that appear within text appear like this, in bold type. Graphical user interface elements (except for titles of windows and dialogs) and names of keys also appear like this, in bold type. Variables, alues you must proide, new terms, and words and phrases that are emphasized appear like this, in italic type. Commands, command options, and flags that appear on a separate line, code examples, output, and message text appear like this, in monospace type. Names of files and directories, text strings you must type, when they appear within text, names of Jaa methods and classes, and HTML and XML tags also appear like this, in monospace type. iii IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

11 Chapter 1. Introduction IBM Tioli Workload Scheduler for Applications for PeopleSoft enables you to execute and monitor PeopleSoft jobs from the IBM Tioli Workload Scheduler enironment. These jobs can be executed as part of a schedule or submitted for ad-hoc job processing. PeopleSoft extended agent jobs can hae all of the same dependencies, and recoery options as other IBM Tioli Workload Scheduler jobs. PeopleSoft jobs must be documented in Tioli Workload Scheduler to be executed and controlled in the Tioli Workload Scheduler enironment. Features The extended agent for ersions 7.0, 7.5 and 8.0 of PeopleSoft has been certified by PeopleSoft on Windows NT 4.0 with Serice Pack 6 and on Windows PeopleSoft 8.x support. Use Tioli Workload Scheduler standard job dependencies on PeopleSoft jobs. Schedule PeopleSoft jobs to run on specified days, times, and in a prescribed order. Define inter-dependencies between PeopleSoft jobs and Tioli Workload Scheduler jobs that run on different applications such as R/3 and Oracle. Define inter-dependencies between PeopleSoft jobs and jobs that run on different platforms, including Windows, z/os, HPUX, and UNIX. Functional Oeriew Tioli Workload Scheduler can launch and monitor jobs in the PeopleSoft process scheduler using a PeopleSoft extended agent workstation. The PeopleSoft extended agent is defined in a standard Tioli Workload Scheduler workstation definition. This definition is a logical workstation name and specifies the access method as psagent. The access method is used to communicate job requests to the PeopleSoft process scheduler. To launch a PeopleSoft job, Tioli Workload Scheduler executes the psagent method, passing it information about the job. An options file proides the method with path, executable and other information about the PeopleSoft process scheduler used to launch the job. The extended agent can then access the PeopleSoft process request table and make an entry in the table to launch the job. Job progress and status information are written to the job s standard list file. PeopleSoft Process Scheduler Jobs The PeopleSoft process scheduler uses entries in the Process Request table (PSPRCSRQST) to drie its work decisions. These entries describe the processes which the Process Scheduler serer agent will launch. They also contain the information required to determine the status of the process. The IBM Tioli Workload Scheduler for Applications for PeopleSoft software can insert entries, inquire against the contents and modify the status information within this table (PSPRCSRQST). Copyright IBM Corp

12 When documenting a PeopleSoft job in IBM Tioli Workload Scheduler, the user is actually defining a process request to be inserted in the Process Request table (PSPRCSRQST). A process request from IBM Tioli Workload Scheduler must contain three alid pieces of data: A process definition haing two parts: Process Type Process Name ( not required on execution on PeopleSoft 8) An operator ID A run control ID All of these items are required for a PeopleSoft job to execute. Note that the process scheduler runs on UNIX and on supported Windows FTA workstations, whereas the extended agent method runs on Windows NT or Windows 2000 only. PeopleSoft Job Tracking in Tioli Workload Scheduler A job in PeopleSoft is a collection of processes that run together as a single unit. Tioli Workload Scheduler jobs can be defined: as PeopleSoft jobs, that is, as a collection of PeopleSoft processes. In this case, the status of the PeopleSoft job is tracked, not the status of the indiidual processes within the job. or as PeopleSoft processes. In this case, the status of the indiidual process is tracked and IBM Tioli Workload Scheduler schedules can be defined to create complex inter-dependencies and recoery options between PeopleSoft processes. Security Security for the PeopleSoft jobs is handled by standard Tioli Workload Scheduler security. The Options Editor You should restrict access to the options editor executable. If you hae multiple installations of the extended agent, you can enhance security by maintaining only one copy of the options editor (on the master workstation for example). Using FTP you can manage all your encrypted options files from one location. Notes on PeopleSoft Version 8.x Support PeopleTools 8.x support has some changes that you should know before you plan to use the x-agent method in your enironment. The -operator keyword used in Tioli Workload Scheduler job specification and its corresponding parameter is currently ignored by the psagent method at runtime, therefore jobs will be submitted and will run with the same PS operator ID that is used for connection with PeopleSoft. You can still use your Tioli Workload Scheduler jobs definitions unchanged from PeopleTools 7.x into PeopleTools 8.x enironments. The difference will be that all jobs submitted to a PeopleSoft 8.x x-agent will execute under the same ID, the ID is specified in the <CPUNAME_> psagent.opts file. There is no need to install Database connectiity on FTAs hosting PeopleSoft x-agents because the method currently uses the PeopleSoft 3-tier architecture. You will hae to configure at least one PeopleSoft Application Serer for the 2 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

13 x-agent to work. The application Serer must be actie in order to successfully submit jobs to the PeopleSoft process scheduler. The method requires the installation of PeopleSoft External Api support on the FTA that is hosting the x-agent method, the installation directory of the External API need to be used during the x-agent installation and during configuration time when you are required to specify the PSHome directory or the Cobol root directory. To install the external API use the setup.exe executable located in your PeopleSoft 8.x fileserer directory named: %PS_HOME%\setup\PsExtAPI. Installation of PeopleSoft External API needs to be performed before the installation of Tioli Workload Scheduler for Applications. Verify your External API installation as directed by the instructions in PeopleSoft: using the jnitest.exe tool located in the PS External API installation directory. You will need to reboot your workstation before you can use the PsExtAPI installation successfully. If you fail to reboot you will see a popup window from TVPUPSFT.exe saying: The application failed to initialize properly (0xc ). Click on OK to terminate the application. You will not need to load TVPUPSFT.dms into the PeopleSoft 8.x Database when working in three-tier mode. Chapter 1. Introduction 3

14 4 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

15 Chapter 2. Implementation Planning PeopleSoft Version 7.5 or Earlier This section describes implementation planning for the extended agent with PeopleSoft 7.5 or earlier. Host Requirements The workstation hosting the extended agent has the following requirements: It must be a Tioli Workload Scheduler fault-tolerant agent (FTA) running on a supported Windows ersion. It must hae network access to the PeopleSoft database. It must be capable of being a PeopleSoft workstation. It must hae access to the PeopleSoft and COBOL support libraries. COBOL support must be compatible with the compiler used for your NT process scheduler enironment. Software Requirements IBM Tioli Workload Scheduler for Applications for PeopleSoft has the following software requirements: Windows NT 4.0 with Serice Pack 6 or Windows 2000 with serice pack 2. IBM Tioli Workload Scheduler ersion 7.0, 8.1 PeopleSoft ersion 7.0, 7.5 PeopleSoft COBOL Compiler Notes: 1. The extended agent for ersions 7.0 and 7.5 of PeopleSoft is aailable with MicroFocus NetExpress 2.1 and MicroFocus NetExpress The extended agent for PeopleSoft ersion 7.0 was also compiled on Micro Focus COBOL workbench Compiler ersion For PeopleSoft ersions 7.x, you are required to recompile your Windows PeopleSoft process scheduler if you will be using it for jobs managed with Tioli Workload Scheduler. Windows User Setup Create a local or domain User ID with authority to access both PeopleSoft and IBM Tioli Workload Scheduler software or set up an existing TWSuser to allow access to the PeopleSoft software. See Appendix A, User Setup for Windows, on page 33 for details. Log on as the new user. Connect to the appropriate dries for PeopleSoft. Be sure to select Reconnect at Logon. The drie letter should be the same as the one you hae specified as PSDRIVE in psagent.opts. Perform a PeopleSoft setup. Follow the instructions supplied with your PeopleSoft software. Copyright IBM Corp

16 Verifying the PeopleSoft Enironment Make sure that your PeopleSoft enironment is properly configured and that PeopleSoft jobs can be executed successfully by the process scheduler. Notes: 1. Verify database connectiity to PeopleSoft database using the Windows User ID created earlier. The connection can be checked by running a database command using any ODBC utility. 2. Verify access to the PeopleSoft file serer or aailability of local copy of executables. Creating a Batch Processing ID in PeopleSoft You should create an operator ID in PeopleSoft dedicated to batch scheduling. All the jobs submitted by Tioli Workload Scheduler should use this operator ID. Installed Files The following files are installed in Tioli Workload Scheduler and PeopleSoft directories during the installation of IBM Tioli Workload Scheduler for Applications for PeopleSoft: Destination Files Owner TWShome\PeopleSoft\7 TVPUPSFT.dms PTCUDCOP.cbl TWShome\methods psagent.exe psoption.exe enigma.exe PSDRIVE PSVER\cblbin TVPUPSFT.exe TVPUPSFT.gnt IBM Tioli Workload Scheduler User IBM Tioli Workload Scheduler User Owner of PTPUPRCS.exe PeopleSoft Version 8.x Note: TWShome stands for the name of the directory where you installed Tioli Workload Scheduler. This section describes implementation planning for the extended agent with PeopleSoft ersion 8.x. Host Requirements The workstation hosting the extended agent must be an IBM Tioli Workload Scheduler fault-tolerant agent in a supported Windows platform. Software Requirements IBM Tioli Workload Scheduler for Applications for PeopleSoft has the following software requirements: Windows NT 4.0 with Serice Pack 6 or Windows 2000 with serice pack 2. IBM Tioli Workload Scheduler ersion 7.0, 8.1, 8.2. PeopleSoft ersion 8.x PeopleTools External APIs ersion 8.x 6 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

17 Creating a Batch Processing ID in PeopleSoft You should create an operator ID in PeopleSoft dedicated to batch scheduling. All the jobs submitted by Tioli Workload Scheduler should use this operator ID. Installed Files The following files are installed in Tioli Workload Scheduler and PeopleSoft directories during the installation of IBM Tioli Workload Scheduler for Applications for PeopleSoft: Destination Files Owner TWShome\methods psagent.exe psoption.exe enigma.exe IBM Tioli Workload Scheduler User PSAPI_dir TVPUPSFT.exe IBM Tioli Workload Scheduler User Note: TWShome stands for the name of the directory where you installed Tioli Workload Scheduler. Chapter 2. Implementation Planning 7

18 8 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

19 Chapter 3. Installation Installation Procedure If you intend to run Tioli Workload Scheduler for Applications for PeopleSoft with a PeopleTools 8.x enironment, you hae to install PeopleSoft External API support on the Tioli Workload Scheduler workstation that will host the extended agent. You must do this before the installation of Tioli Workload Scheduler for Applications for PeopleSoft. See Setting Up the Client on page 20 for details. There are no pre-installation steps if you intend to run Tioli Workload Scheduler for Applications for PeopleSoft with a PeopleSoft 7.x enironment. To install IBM Tioli Workload Scheduler for Applications for PeopleSoft from CD-ROM, perform the following steps: 1. Shut down Tioli Workload Scheduler before proceeding. See the IBM Tioli Workload Scheduler documentation to learn how to do it. 2. Log on with administrator priileges. 3. Stop the PeopleSoft process serer if it runs in the Windows enironment. 4. Insert the product CD in your CD-ROM drie. 5. From the Start menu, select Run and execute the following command: cd_drie\psagent\i386nt\setup.exe This starts the install program which prompts you for installation information. The Welcome window is displayed. It proides information about installing the PeopleSoft extended agent software. Figure 1. Welcome Window. 6. Click Next to continue: A window that reminds you to stop all Tioli Workload Scheduler processes is displayed. If you did not do it in step 1, do it now before proceeding with installation. Copyright IBM Corp

20 Figure 2. Warning Window. 7. Click Next to continue: A window where you must select an aailable Tioli Workload Scheduler user is displayed. Figure 3. Tioli Workload Scheduler User s Window. 8. Select a Tioli Workload Scheduler user from the display field. Click Next: An information window is displayed. 9. Click Next to proceed: A window asking for the PeopleTools ersion is displayed. 10 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

21 Figure 4. PeopleTools Version Selection Window. 10. Select the ersion of PeopleTools that you will be working with. Note: Multiple ersions of PeopleTools will require multiple installations of the product. 11. Click Next: A window is displayed asking for the path for the COBOL directory for PeopleSoft 7.x or the External APIs directory for PeopleSoft 8.x. Note: If you mismatch the Cobol Runtime ersion used in your enironment, the psagent.exe will pop-up a window during its execution on the NT workstation hosting the Xagent, saying: The procedure entry point CBL_MBCS_CHAR_LEN could not be located in the dynamic link library cblrtss.dll. The jobs will appear as launched from the TWS console, but they will neer terminate. They will abend when you close the pop-up window. Ensure that you selected the correct runtime ersion of TVPUPSFT executables. Figure 5. PeopleSoft 7.x COBOL or PeopleSoft 8.x External API Directory. Chapter 3. Installation 11

22 12. Enter the path according to your PeopleSoft ersion. The installation process will copy some of the product files in this directory. For PeopleSoft 7.x, the directory must be the COBOL directory (refer to Setting Up the PeopleSoft Enironment for Version 7.5 or earlier on page 15). You must hae write access to this directory on the PeopleSoft file serer. For PeopleSoft 8.x the directory must be where the PeopleSoft external APIs are installed (refer to Setting Up the PeopleSoft Enironment for Version 8.x on page 20). 13. Click Next to iew a summary information window. 14. If the information is correct, click Next. If the information is not correct, click Back to re-enter the data. A bar graph is displayed showing the installation progress. Click Cancel if you want to interrupt the installation. If any problem happens during installation, reiew the installation log in TWShome\methods\psxainst.log 15. Click Finish when the process has completed and moe on to the following section. For PeopleTools 8.4x there is no longer a separate installation of of PeopleSoft External APIs, that are deliered as part of the standard Windows client; they are accessed ia the PeopleSoft file serer under the directory PS_HOME\bin\client\winx86. In reference to PeopleSoft Resolution ID , you must also be able to access the directory PS_HOME\class (it must contain the file psjoa.jar) and hae access to a alid Jaa Virtual Machine. Method psagent.exe will take care of defining/updating enironment ariables CLASSPATH and PS_HOME if they are not already defined in the enironment where the job is launched. If your system path enironment already contains a alid access to jm.dll, then you do not need additional enironment setup. If not, you will need to specify new option in the psagent.opts file using a text editor, so that psagent.exe can update the Path according to the needed jm. You will hae to add to the options file the following line: TWSXA_PT84_JVMPATH=<path to jm.dll> Valid JVMs are already proided by PeopleSoft with the application serers that support the PIA architecture, like BEA WebLogic Serer (under subdirectory jdk131\jre\bin\classic) or IBM WebSphere Application Serer (under subdirectiry For instance: TWSXA_PT84_JVMPATH=D:\Program Files\IBM\Jaa13\jre\bin\classic or TWSXA_PT84_JVMPATH=D:\bea\jdk131\jre\bin\classic If you don t hae this keyword or if you don t hae a alid system path to the jm.dll, you will get message AWS E Exception caught in file TVPUPSFT.cpp(#) during function Main or AWS E The problem encountered may be related to the enironment settings: please erify the following: 1. your path contains a alid Jaa Virtual Machine directory or options file contains TWSXA_PT84_JVMPATH; 2. your CLASSPATH enironment ariable contains a alid path to psjoa.jar; 3. your target Application Serer is up and running; 4. you hae defined PS_HOME enironment ariable. 12 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

23 Creating the Options File The PeopleSoft extended agent options file specifies which database user the method uses to connect to the PeopleSoft database, and is used to specify the polling rate to the PeopleSoft module for checking job status. This file must reside on the host computer for the extended agent in the TWShome\methods directory. Creating the PeopleSoft Options File The options file editor is used to create and modify the extended agent options file. You can hae more than one options file. To create the options file: 1. Use the following command to start the Options Editor: TWShome\methods\psoptions.exe 2. Open an existing file or create a new options file. The name of the options file you are editing is displayed in the top left corner of the editor window. 3. Enter the parameter alues specific to your site. The following figure shows the Options Editor: Figure 6. The Options Editor Window. Chapter 3. Installation 13

24 The following table describes the fields of the Options Editor window: Parameter Launch Job User Modify Job User Check File User Status Check Interal Seconds Trace Execution PeopleSoft Drie Letter PeopleSoft Home Directory PeopleSoft Runtime Directory Description Enter the Windows user ID which launches the IBM Tioli Workload Scheduler jobs. This Windows user must be a alid Tioli Workload Scheduler user on the host workstation. Enter your Windows user ID which executes a job modify. The default alue is to match the Launch Job User. Enter your Windows user ID which executes a check file. The default alue is to match the Launch Job User. Enter the time interal between status checks when monitoring a process request. The default alue is 2 minutes. Select the seconds checkbox to change from minutes to seconds. Check this box to specify the Status Check Interal in seconds rather than minutes. Check this box to enable trace execution. Enter the Windows drie letter for the PeopleSoft files (for example, N:). Enter the home directory to the PeopleSoft files (for example, \PT7.5 or \PT8). PeopleSoft 7.x: Enter the path to the base directory for the Micro Focus COBOL libraries (for example, N:\PT7.5). Connection Type Database Serer Name Database Name/AppSerer Operator ID Password PeopleSoft 8.x: Enter the path to the base directory for the PeopleSoft External APIs. It is the same as the PeopleSoft Home Directory. Enter the RDBMS system type. Choose one of the following: APPSERV (PeopleSoft 8.x only) ORACLE MICROSFT (Microsoft SQL Serer) DB2 (DB2 for MVS ) DB2UNIX SQLBASE DB2ODBC DB2400 INFORMIX SYBASE DB2MDI Enter the Database Serer Name. This is for Informix and Sybase only. Not used for 8.x Enter the name of the PeopleSoft database you want to connect to. Enter the operator ID used to connect to the PeopleSoft database. For PeopleSoft ersion 7x, all jobs will not be run as this ID. For PeopleSoft ersion 8x, all jobs will run as this ID. Enter the Password for the operator ID Default Process Serer Enter the default process serer that executes jobs in PeopleSoft. 4. Using the File->Sae option in the editor s action bar, sae the file as psagent.opts in the TWShome\methods directory. 14 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

25 5. Exit the options editor. See Appendix B, Manually Editing Options Files, on page 35 for details on editing options files without using the Options Editor. Connecting to More than One PeopleSoft Database It may be necessary for the psagent method to connect to more than one PeopleSoft database. For example, a single installation of PeopleSoft may hae a TEST, DEMO, and PRODUCTION enironment, each with a separate database. This requires that the psagent method use a separate connect string for each database. In order to support this, you can setup multiple PeopleSoft extended agent workstations that connect to the same method but use different option files. When a workstation starts the method, it first looks for the options file with extended agent workstation name prepended to psagent.opts. For example, a PeopleSoft extended agent named jupiter would hae the following options file: jupiter_psagent.opts The psagent method searches first for an options file with the extended agent workstation name, and then for the default psagent.opts file. This allows the user to set up an extended agent for each PeopleSoft database. To connect to only one database, use the default name for the options file, psagent.opts. Setting Up the PeopleSoft Enironment for Version 7.5 or earlier The following section explains how to set up the PeopleSoft enironment if you will use the extended agent with PeopleSoft ersion 7.5 or earlier. Customizing the Process Serer Regardless of the type of operating system where you will be scheduling Tioli Workload Scheduler jobs, you are required to customize the corresponding process serer executable using the COBOL source PTCUDCOP.cbl proided by IBM. You must replace the PTCUDCOP.cbl file proided by PeopleSoft with the equialent file proided by IBM and recompe your process scheduler. Complete directions on how to recompile your process scheduler may be found in PeopleSoft installation manuals. When receiing patches from PeopleSoft, you may hae to repeat the process serer customization process, if the PTCUDCOP.cbl file is oerwritten during patch installation. Following are the explanations of how to run the customization steps on Windows and on UNIX. Customizing on Windows If the PeopleSoft process scheduler runs on Windows, refer to the section Setting Up the Batch Enironment on Windows NT/2000 in the PeopleSoft installation manual for up to date information. You should hae installed a COBOL compiler on your batch serer and you should be carrying out the compile from that location. The computer doing the compilation must hae a COBOL compiler installed and must hae write access to the file serer. Chapter 3. Installation 15

26 To build the process serer on a Windows machine: 1. Open a DOS command prompt window. 2. Set up two enironment ariables, PS_HOME and COBROOT, on the machine from which you plan to compile COBOL. Use these commands: set PS_HOME=n:\PS750 set COBROOT=c:\netexpress\base 3. Make sure the compilation directory c:\temp\compile exists; it may already exist if you hae run CBLBLD.BAT. If it does exist, remoe any files residing there, just as a safeguard. If it doesn t exist, you need to create it with the following command: mkdir c:\temp\compile Note: Make sure you hae write permission to the compilation directory as the compilation process will take place in that location. 4. Change to the <PS_HOME>\setup directory. 5. Execute the following command to copy all the COBOL source files from the <PS_HOME> directory to the compilation directory: cblsrc <source directory> <compilation directory> where <source directory> is the drie and directory where the source resides (it should be the same as <PS_HOME>), and <compilation directory> is the drie and directory to which the source files will be copied. For example, the following command will take the COBOL source from <PS_HOME> and copy all the necessary files to the location where the compilation process will take place. cblsrc <PS_HOME> c:\temp\compile 6. Copy the file PTCUDCOP.cbl proided by IBM to the compilation directory with the following command: copy <TWS_HOME>\PeopleSoft\PTCUDCOP.cbl c:\temp\compile 7. After CBLSRC completes, change the current directory to the compilation directory with the following command: cd c:\temp\compile 8. Compile with the following command: CBLMAKE.BAT PTPUPRCS EXE LIST If there are compilation problems, reiew the PTPUPRCS.lis file for details and retry the command after addressing the problems. 9. After CBLMAKE.BAT completes, copy the EXE, GNT, or INT files to the <PS_HOME>\cblbin directory with the following commands: copy PTPUPRCS.exe <PS_HOME>\cblbin copy PTPUPRCS.gnt <PS_HOME>\cblbin Customizing on UNIX If the PeopleSoft process scheduler runs on UNIX, refer to the section Setting Up the Batch Enironment on UNIX in the PeopleSoft installation manual for up to date information. You should hae installed a COBOL compiler on your batch serer and you should be carrying out the compile from that location. The computer doing the compilation must hae a COBOL compiler installed and must hae write access to the <PS_HOME>/cblbin directory. To build the process serer on a UNIX machine: 16 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

27 1. Log onto the UNIX serer. 2. Change the current directory to the PeopleSoft home directory. 3. Run the psconfig.sh script. 4. Change directories to the $PS_HOME/src/cbl directory. 5. Rename the PTCUDCOP.cbl to PTCUDCOP.old using the following command: m PTCUDCOP.cbl PTCUDCOP.old 6. Copy PTCUDCOP.cbl from the extended agent (twshome/peoplesoft) using FTP. 7. Execute the following commands: cd../../install pscbl.mak PTPUPRCS LIST 8. After the script has completed, check the destination directories for the newly created files in <PS_HOME>/src/cbl/int <PS_HOME>/src/cbl/lst <PS_HOME>/cblbin They should hae a length greater than zero as well as a current date and time stamp. If there are problems with the compilation reiew the PTPUPRCS.lis file for errors, correct them and retry the compilation step. Setting Up the Client To run the PeopleSoft access method for a PeopleTools 7.x enironment, you hae to run in a two-tier PeopleSoft Enironment, using a workstation with proper connectiity for your database. You hae to install the client software for your database of choice on the workstation hosting the extended agent and you hae to configure it for proper ODBC communications. Test your connection using the ODBC testing tools proided with your client software (for example ODBC 32bit test for Oracle). You also need access to the PeopleSoft Fileserer. Map the fileserer share to a network drie on your Windows workstation. For a workstation installation in your PeopleSoft 7.x enironment: 1. Access \\<fileserer>\<share> as shared drie <d>: on your computer. 2. Set PS_HOME to the proper directory on the new shared drie with this command: set PS_HOME=<d>:\PS Run the PeopleTools Configuration Manager: %PS_HOME%\bin\CLIENT\WINX86\pscfg.exe A configuration window, like that shown in Figure 7 on page 18, is displayed. 4. Select the Client Setup tab and fill the required alues ensuring that you select the Install PeopleSoft ODBC Drier check box. If you run SQL Serer, you must also select the Install ODBC Drier Manager 3.0 check box. Note: The Install PeopleSoft ODBC Drier flag installs a user data source name. If you need to access the data source from another user profile you will need either to create a corresponding System data source, using Control Panel -> Data Source (ODBC) customization on your WinNT/2000 machine, or to rerun the customization step for all the Chapter 3. Installation 17

28 other users that you want to use to submit Tioli Workload Scheduler extended agent jobs. Figure 7. Configuration Manager 7.5 Window. After you are finished, you should hae in your Start/Programs menu a new item labelled PeopleSoft 7.5. Running the Data Moer Script After the installation sequence is complete the PeopleSoft Data Moer is used to moe the stored procedures for the PeopleSoft extended agent into place. For more information on the Data Moer script consult your PeopleSoft documentation. 1. Click on the DataMoer icon in the PeopleSoft group. The PeopleSoft Signon window is displayed. 18 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

29 Figure 8. PeopleSoft Signon Window. 2. Select the appropriate database, and click OK. The PeopleSoft logon window is displayed. 3. Fill in the logon fields, and click OK. The Data Moer window is displayed. 4. From the File menu on the Data Moer window, select the Open command. Open the following file in the Data Moer window: TWShome\PeopleSoft\TVPUPSFT.dms 5. Once you hae loaded the scripts in the Data Moer window, run the scripts. The Data Moer window is separated into two parts. The upper section shows the Data Moer script statements. The lower part shows the status of the script statements as they execute. 6. Verify that the script runs successfully. Figure 9. DataMoer Window Chapter 3. Installation 19

30 If statements fail, check the startup window alues for correct Database Name, Login ID, and Password, then repeat this process. If the Data Moer script continues to fail, see your DBA to determine if there is a problem in your database. Note: The Data Moer script must be run on each database the extended agent for PeopleSoft will use. To run the scripts on another database, change the database name and/or RDBMS in the login sequence. Setting Up the PeopleSoft Enironment for Version 8.x The following section explains how to set up the PeopleSoft enironment if you will use the extended agent with PeopleSoft ersion 8.x. Customizing the Process Serer The access method supporting PeopleTools 8.17 can only work in conjunction with a PeopleSoft 3-tier architecture. This implies that you need to deploy a PeopleSoft 3-tier architecture according with PeopleSoft instructions. While requiring a complete deployment of PeopleSoft architecture with at least one PeopleSoft application serer and one process serer, this will reduce software requirements and dependencies on your extended agent workstation. There is no need for installing database connectiity on the workstation hosting the extended agent. Moreoer, there are no customization requirements for the process serer, as it was with PeopleTools ersion 7.x, and there will be no need for running additional data moer scripts for database customization. The application serer must be actie in order to successfully submit jobs to the PeopleSoft process scheduler. To properly configure the access method, you will need to obtain the following information from your PeopleSoft Administrator: Name (or IP address) of the application serer Application serer Jolt port (typically 9000) Process serer name Setting Up the Client To run the extended agent with a PeopleTools 8.x enironment, you hae to install PeopleSoft External API support on the Tioli Workload Scheduler workstation hosting the extended agent. Installation of PeopleSoft External API must be performed before the installation of Tioli Workload Scheduler for Applications for PeopleSoft. The PeopleSoft installation manuals contain information about this installation step. Refer to the proper PeopleSoft documentation for up to date instructions, depending on your actual PeopleSoft ersion. For PeopleTools 8.17 you will hae to inoke the setup.exe executable located in your PeopleSoft 8 fileserer directory named %PS_HOME%\setup\PsExtAPI. Make note of the directory where you install the External API, because you will need it during installation of the extended agent and during configuration when you are prompted for the PSHome directory, or when you are asked for the Cobol root directory. Before using the External API, erify your installation as directed by PeopleSoft instructions, using the jnitest.exe tool located in the External API directory. The 20 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

31 jnitest.exe tool erifies that you hae the MicroSoft Jaa Virtual Machine for Jaa 3.2 ersion or higher. If jnitest.exe finds an acceptable ersion, the MicroSoft Jaa Virtual Machine can be loaded. Otherwise, you may hae difficulties loading it properly. The External API will not function unless you hae the right ersion of the MicroSoft Jaa Virtual Machine. You will also need to reboot the workstation before you can use the PeopleSoft External API installation successfully. If you fail to do this, wheneer a PeopleSoft job is submitted through ITWS, you will be shown a popup window from TVPUPSFT.exe saying: "The application failed to initialize properly (0xc ). Click on OK to terminate the application." Chapter 3. Installation 21

32 22 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

33 Chapter 4. Setting up the Extended Agent This chapter describes how to create an extended agent for PeopleSoft workstation definition in IBM Tioli Workload Scheduler, and how to create jobs and job streams using the extended agent for PeopleSoft. Creating a PeopleSoft Extended Agent Workstation Extended agent workstation definitions are required to run jobs controlled by Tioli Workload Scheduler in PeopleSoft. These workstations are defined the same as standard Tioli Workload Scheduler workstations with the difference that they include the name of the extended agent s host workstation and the access method name, psagent. The following figures show a workstation definition window for a PeopleSoft extended agent workstation. Figure 10. Properties - Workstation in Database Window. To define a extended agent for PeopleSoft workstation: 1. Logon to the Job Scheduling Console. 2. Right-click the Tioli Workload Scheduler engine. 3. From the pop-up window, click New Workstation. The Properties-Workstation in Database window is displayed. 4. In the Name field, specify a name for this workstation. The workstation name can hae up to 8 alphanumeric characters for unexpanded database or 16 alphanumeric characters for expanded database. The name can include a dash and underscore, but must begin with a letter. 5. In the Node field, specify the node name or the IP address of the workstation running the process scheduler. Fully qualified domain names are accepted. This is a required field. 6. In the TCP Port field, enter a numeric alue other then For Operating System, select OTHER. Copyright IBM Corp

34 8. In the Domain field, enter the domain name of the host workstation. The extended agent and the host workstation must be in the same domain. 9. In the Time Zone field, enter the time zone of the extended agent workstation. This option is only alid if time zones are turned on in your Tioli Workload Scheduler network. 10. In the Description field, enter a description for the extended agent workstation. This field is an optional text description of the workstation (up to 40 characters). 11. In the Workstation Type field, select Extended Agent. 12. In the Access Method field, enter the name of the PeopleSoft access method, psagent. This file is executed by the Tioli Workload Scheduler host to connect to an instance of PeopleSoft. 13. In the Host field, enter the name of the extended agent s host workstation. This is the master, domain manager, or fault-tolerant agent that hosts the extended agent for PeopleSoft workstation definition. Click the... button to select a workstation from the list. 14. Click OK to sae the workstation definition in the database. Note: The new workstation will not be aailable in the current Plan until the next run of Jnextday, howeer, the new workstation can be used in the Database iew in order to begin creating new Jobs and Jobstreams immediately. Composer Command Line Example PeopleSoft extended agent workstation definitions can also be entered using the Tioli Workload Scheduler Composer command line. The workstation definition shown in the preious example would be entered as follows: cpuname PT81X node twspsoft.mydomain.com os other description "PeopleSoft XAgent on PSOFT81 (817) tcpaddr domain masterdm for maestro host FTAPSOFT access psagent end For information about using Composer to create a workstation definition, refer to the IBM Tioli Workload Scheduler Reference Guide. Creating PeopleSoft Job Definitions in Tioli Workload Scheduler Tioli Workload Scheduler job definitions are required for each PeopleSoft job you intend to control. PeopleSoft jobs are defined in Tioli Workload Scheduler like other jobs and include: Workstation name (extended agent) Job name Login Script file specifications Recoery options 24 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

35 To define a PeopleSoft job in Tioli Workload Scheduler: 1. Log into the Job Scheduling Console. 2. Right-click the Tioli Workload Scheduler engine. 3. From the pop-up window, click New Job Definition. The Select a Task Type window is displayed. 4. In the Task Type scrolling list, select Extended Agent Task. The General page of the Properties - Job Definition window is displayed. Figure 11. The General Page of the Properties-Job Definition Window. 5. In the Name field, enter a name for this job. The job name can hae up to 8 alphanumeric characters for unexpanded database or 40 alphanumeric characters for expanded database. The name can include a dash and underscore, but must begin with a letter. 6. In the Workstation field, enter the name of the PeopleSoft extended agent workstation, or click the ellipsis (...) for a list of aailable workstations. 7. In the Description field, enter a description for the job. The description can be up to 64 characters. 8. In the Login field, enter the user/account that will launch the TWS Job within Tioli Workload Scheduler. The specific account that will run the Job in the PeopleSoft enironment is defined in the Task section. Note: Recoery Options are optional. For information on Recoery Options and other Job control features refer to the IBM Tioli Workload Scheduler Reference Guide. 9. Click the Task tab to display the Task page of the job definition window. Chapter 4. Setting up the Extended Agent 25

36 Figure 12. The Task Page of the Properties-Job Definition Window. 10. In the Task field, enter the specifications for the PeopleSoft job file. There are four required job keywords with their corresponding alues: -operator opid -process procname -type proctype -runcontrol runcontrol_id where: opid The PeopleSoft operator ID who launches the job. This parameter is not applicable for PeopleSoft 8.x procname The Process name for the PeopleSoft job. proctype The Process type for the PeopleSoft job. This entry must be enclosed in single quotes. runcontrol_id The runcontrol ID for the PeopleSoft job. For PeopleTools 8.1x and 8.4x three new keywords are recognized in the job definition to better exploit output capabilities of jobs run under PeopleSoft Process Scheduler, and a new one to allow balancing of the workload among different Process Serers. The new keywords are: outputtype Accepts PeopleSoft keywords: i.e. FILE, WEB, ... outputformat Accepts PeopleSoft keywords: i.e. PDF, HTML... outputdest Accepts PeopleSoft recognized destinations corresponding to the output type. 26 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method

37 runlocationdescr Accepts a PeopleSoft Process Scheduler in charge of processing the current PeopleSoft job. For PeopleTools 8.4x a new keyword is recognized in the job definition to better exploit output capabilities of jobs run under PeopleSoft Process scheduler. The new keyword is: foldername Accepts the name of the report folder to use for the job item as a string. No syntax check is performed on the alues proided. If the alues are not recognized, defaults are used. 11. Click OK to sae the job definition in the database. Composer Command Line Example Jobs can also be defined with the Tioli Workload Scheduler composer command line. The following example documents a Tioli Workload Scheduler job named PS_JOB that runs on a PeopleSoft extended agent workstation named PS_CPU. If recoery is needed, Tioli Workload Scheduler will run job RECOV2 and then continue processing. PS_CPU#PS_JOB STREAMLOGON TWSLOGON SCRIPTNAME "-OPERATOR OPID -PROCESS PROCNAME -TYPE PROCTYPE -RUNCONTROL RUNCONTROL_ID" DESCRIPTION "PEOPLESOFT JOB" RECOVERY CONTINUE AFTER RECOV2 For information about using the command line to create job definitions, refer to the IBM Tioli Workload Scheduler Reference Guide. Creating PeopleSoft Job Streams PeopleSoft job streams are created in the same manner as other Tioli Workload Scheduler job streams and can include dependencies and other controls. The following figure shows a Job Stream Editor window in the Job Scheduling Console for a job stream that includes extended agent for PeopleSoft jobs. To define a job stream using PeopleSoft jobs: 1. Logon to the Job Scheduling Console. 2. Right-click the Tioli Workload Scheduler engine. 3. From the pop-up window, select New Job Stream. The Properties - Job Stream window is displayed in the Job Stream Editor. 4. In the Name field, specify the name of the job stream. You can enter up to 8 alphanumeric characters for unexpanded database or 16 alphanumeric characters for expanded database. 5. In the Workstation field, specify the extended agent for PeopleSoft workstation. 6. In the Description field, enter a description of the job stream. 7. Click OK to sae and close the Properties - Job Stream window. If you need to, you can later reopen this window to add time restrictions, resource dependencies, files dependencies, or prompts to the job stream. Chapter 4. Setting up the Extended Agent 27

38 The Job Stream Editor is now displayed. Figure 13. Job Stream Editor Window 8. Add the PeopleSoft jobs to the job stream. For eery job that you will add to the job stream, do the following: a. Click the Add Job Definition button on the toolbar. The Properties - Job window is displayed. b. Use the search button to search for and select a TWS job definition of a PeopleSoft job to be added to the jobstream. Once you hae selected a job, the workstation field is automatically filled in. c. You can now optionally add time restrictions, resource dependencies, files dependencies, or prompts to the job. For more information, refer to the IBM Tioli Job Scheduling Console User s Guide. d. After you hae completed all the fields, click OK. The job is added to the job stream. 9. If you added two or more jobs, you can create a follow dependency between the jobs. a. Ensure that the jobs are displayed in the Graph View of the Job Stream Editor. b. Click the Add Link button on the toolbar and then click the predecessor job icon and drag the link to the successor job icon. An arrow is drawn between the two jobs. This arrow represents a follows dependency between the two jobs. 10. Create run cycles that determine the days that this job stream will execute. Create run cycles using the Run Cycle iew of the Job Stream Editor. For more information, refer to the IBM Tioli Job Scheduling Console User s Guide. 11. Compare run times of the job stream and the jobs and adjust them as necessary. 12. Sae the job stream. Note: When creating job streams using PeopleSoft extended agent jobs, you can use Tioli Workload Scheduler standard dependencies and other controls. For more information about using these features refer to the IBM Tioli Job Scheduling Console User s Guide. 28 IBM Tioli Workload Scheduler for Applications: User s Guide for PeopleSoft Access Method