11898

CONTROL-M® Option for PeopleSoft® Administrator Guide

Version 2.0.02

September 30, 2001

Copyright © 2001 BMC Software, Inc. All rights reserved. BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks or trademarks of BMC Software, Inc. PeopleSoft is a registered trademark of PeopleSoft, Inc. All other registered trademarks or trademarks belong to their respective companies. MM-2002G-A0109A-PS8

Restricted Rights Legend U.S. GOVERNMENT RESTRICTED RIGHTS. UNPUBLISHED–RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in FAR Section 52.227-14 Alt. III (g)(3), FAR Section 52.227-19, DFARS 252.227-7014 (b), or DFARS 227.7202, as amended from time to time. Send any contract notices to Contractor/Manufacturer: BMC Software, Inc. 2101 CityWest Blvd. Houston TX 77042-2827 USA

Contacting BMC Software You can access the BMC Software Web site at http://www.bmc.com. From this Web site, you can obtain general information about the company, its products, special events, and career opportunities. For a complete list of all BMC Software offices and locations, go to http://www.bmc.com/corporate/offices.html.

USA and Canada

Outside USA and Canada

Address

Telephone

(01) 713 918 8800

Fax

(01) 713 918 8000

BMC Software, Inc. 2101 CityWest Blvd. Houston TX 77042-2827

Telephone

713 918 8800 or 800 841 2031

Fax

713 918 8000

Customer Support You can obtain technical support by using Response Online™ (support from the Web) or Response On Demand™. To expedite your inquiry, please see “Before Contacting BMC Software,” below.

Response Online You can obtain technical support from BMC Software 24 hours a day, seven days a week by accessing the technical support Web site at http://www.bmc.com/support.html. From this site, you can • • • • • • •

read overviews about support services and programs that BMC Software offers find the most current information about BMC Software products search a database for problems similar to yours and possible solutions order or download product documentation report a problem or ask a question subscribe to receive e-mail notices when new product versions are released find worldwide BMC Software support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers

Response On Demand In the USA and Canada, if you need technical support and do not have access to the Web, call 800 537 1813. Outside the USA and Canada, please contact your local support center or your local sales office for assistance.

Before Contacting BMC Software Before you contact BMC Software, have the following information available so that a technical support analyst can begin working on your problem immediately: •

product information — — —

•

product name product version (release number) license number and password (trial or permanent)

operating-system and environment information — — — — —

machine type operating system type, version, and service pack or program temporary fix (PTF) system hardware configuration serial numbers related software (database, application, and communication) including type, version, and service pack or PTF

•

sequence of events leading to the problem

•

commands and options that you used

•

messages received (and the time and date that you received them) — — —

product error messages messages from the operating system, such as file system full messages from related software

BMC Software, Inc., Confidential and Proprietary Information

iii

BMC Software, Inc., Confidential and Proprietary Information

iv

CONTROL-M Option for PeopleSoft Administrator Guide

Contents

Contents About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii Chapter 1

Overview

PeopleSoft 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 CONTROL-M/Option for PeopleSoft . . . . . . . . . . . . . . . . . . . . . . . . 1-3 CONTROL-M Business Integrated Scheduling . . . . . . . . . . . . . . . . 1-3 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Supported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 PeopleSoft Processes and Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Defining Jobs Using Enterprise Controlstation . . . . . . . . . . . . . . . . . 1-7 Chapter 2

Installation and Configuration

Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Java Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 PROCESSREQUESTBMC Component Interface (CI) . . . . . . . 2-3 PROCESSREQUESTBMC CI Security . . . . . . . . . . . . . . . . . . . 2-6 PeopleSoft APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 Test Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9 Environment File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 Environment File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12 config Utility – Environment File Configuration . . . . . . . . . . . . . . . 2-15 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15 Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16 Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18 BMC Software, Inc., Confidential and Proprietary Information

Contents

v

cpt Utility – Password Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . .2-22 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-22 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-22 Alternative Encryption Method . . . . . . . . . . . . . . . . . . . . . . . . . .2-23 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-23 Uninstalling CONTROL-M Option for PeopleSoft . . . . . . . . . . . . . .2-25 Chapter 3

Running PeopleSoft Jobs/Processes

API Aware Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-5 Completion Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-6 Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-6 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-7 Chapter 4

Verifying Process Execution

PeopleSoft Process Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-1 PeopleSoft Process Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3 Appendix A

Java Utilities

javac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1 jar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2

BMC Software, Inc., Confidential and Proprietary Information

vi

CONTROL-M Option for PeopleSoft Administrator Guide

Figures

Figures Figure 1-1 Figure 2-1 Figure 2-2 Figure 2-3 Figure 4-1 Figure 4-2 Figure 4-3 Figure 4-4

CONTROL-M Option for PeopleSoft Workflow . . . . . . . . . . . . 1-8 Component Interface Selection . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Build PeopleSoft API Bindings Dialog Box . . . . . . . . . . . . . . . . 2-5 Component Interface Tester Window . . . . . . . . . . . . . . . . . . . . . 2-7 Process Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Process Request Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Process Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Server Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

BMC Software, Inc., Confidential and Proprietary Information

Figures

vii

BMC Software, Inc., Confidential and Proprietary Information

viii

CONTROL-M Option for PeopleSoft Administrator Guide

Tables

Tables Table 2-1 Table 2-2 Table 2-3 Table 3-1 Table 3-2 Table 3-3 Table A-1 Table A-2

Environment File Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . OUTDESTFORMAT Values . . . . . . . . . . . . . . . . . . . . . . . . . . . OUTDESTTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . runjob Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Completion Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . Utility Completion Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . javac Utility Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . jar utility options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2-12 2-13 2-14 3-2 3-6 3-7 A-1 A-2

BMC Software, Inc., Confidential and Proprietary Information

Tables

ix

BMC Software, Inc., Confidential and Proprietary Information

x

CONTROL-M Option for PeopleSoft Administrator Guide

About . . .

About This Book This book describes CONTROL-M Option for PeopleSoft by BMC Software. This book is designed for administrators of PeopleSoft and CONTROL-M. It describes how to install and configure CONTROL-M Option for PeopleSoft and how to run and control PeopleSoft processes under CONTROL-M. This book is comprised of the following chapters: Chapter 1

Overview Describes key features and concepts of CONTROL-M Option for PeopleSoft

Chapter 2

Installation and Configuration Describes software requirements, Java Runtime Environment, PROCESSREQUESTBMC Component Interface, PeopleSoft APIs, Test environment, uninstalling the product, and the Environment file.

Chapter 3

Running PeopleSoft Jobs/Processes Describes the runjob utility. Operating instructions and examples are included.

Chapter 4

Verifying Process Execution Describes the operation of the PeopleSoft Monitor and PeopleSoft Process Scheduler.

Appendix A

Java Utilities Describes the javac and jar utilities.

Index

BMC Software, Inc., Confidential and Proprietary Information

About This Book

xi

Related Publications •

CONTROL-M/Server Administrator Guides are supplied for the various types of computers at each site’s data centers. Each guide describes installation, setup, security, and utilities that apply to CONTROL-M on a supported platform.

•

CONTROL-M/Agent Administrator Guides. Each guide describes installation and maintenance of CONTROL-M/Agent on a supported platform.

•

Enterprise Controlstation User Guide describes all Enterprise Controlstation concepts, features, facilities, and operating instructions.

•

Enterprise Controlstation Administrator Guide is designed for use by administrators of all types of Enterprise Controlstation workstations. This guide describes Enterprise Controlstation installation, customization, maintenance, security, and administrator responsibilities.

BMC Software, Inc., Confidential and Proprietary Information

xii

CONTROL-M Option for PeopleSoft Administrator Guide

Notational Conventions The following table describes conventions used in this guide.

When describing keystrokes, angle brackets are used to enclose the name of a key (for example, ). When two keys are joined with “+” as in <Shift>+, hold down <Shift> while pressing .

Menu => Option

This represents an option selection sequence. For example: Users and Groups=>Groups=>Add means that you first select Users and Groups from the menu bar; then select the Groups option from the submenu. Finally, select the Add option from the Groups submenu.

{Option A|Option B}

The vertical bar is used to separate choices. For example: {AND|OR} means that you specify either AND or OR.

[Option]

Square brackets are used to enclose parameters that are optional.



In commands and parameters, angle brackets are used to enclose variable information. For example, the command: cd means that you specify cd followed by the path of CONTROL-M.

Wildcards or Mask Characters

Certain utilities and parameters support wild cards. These are also sometimes referred to as mask characters. A mask is a string value containing wild cards. The following wild card characters are supported: ?

Indicates any one character.

*

Indicates any number of characters.

Note: Values containing mask characters must be enclosed in single or double quotes.

BMC Software, Inc., Confidential and Proprietary Information

About This Book

xiii

BMC Software, Inc., Confidential and Proprietary Information

xiv

CONTROL-M Option for PeopleSoft Administrator Guide

1

Overview

1

This version of CONTROL-M Option for PeopleSoft is designed for support of PeopleSoft 8.

PeopleSoft 8 PeopleSoft 8 provides a server-based architecture that is designed for eBusiness solutions in an Internet environment. PeopleSoft 8 has four major components: • • • •

web server application server database server process scheduler server

PeopleSoft provides state-of-the-art Enterprise Resource Planning (ERP) business application packages. Users can customize and add new functionality to PeopleSoft systems. PeopleSoft applications can be integrated with other user applications. The PeopleTools Process Scheduler is a built-in feature of the PeopleSoft system. This Process Scheduler enables the user to define and submit PeopleSoft processes and jobs.

BMC Software, Inc., Confidential and Proprietary Information

Overview

1-1

In practice, PeopleSoft jobs and processes often require scheduling capabilities that go beyond those of the PeopleTools Process Scheduler. Requirements such as complex dependencies or comprehensive scheduling criteria cause PeopleTools users to use a more sophisticated scheduling solution such as CONTROL-M Option for PeopleSoft. Note

A PeopleSoft “process” is a single task, program, or routine (such as an SQR report) that can run in a Server or Client environment. A PeopleSoft “job” consists of one or more processes that are submitted as a unit and can run only in the Server environment. In PeopleSoft 8, processes and jobs run on the Server. The PeopleTools Concurrent Process Scheduler can only run and monitor jobs and processes in the PeopleTools environment. Jobs that run on other platforms cannot be controlled by the PeopleTools Concurrent Request Manager. This is the point at which the built-in scheduling facility of PeopleTools reaches its limits and integration with a robust enterprise production management solution becomes essential. PeopleTools is an application development environment that enables users to quickly and easily customize, maintain, and implement PeopleSoft applications without changing the source code. All PeopleSoft applications are handled using PeopleTools. The PeopleTools Process Scheduler is a centralized tool that enables application developers, system administrators, and application users to manage PeopleSoft batch processes. This Process Scheduler enables users to schedule recurring processes and create jobs (groups of processes). The PeopleTools Application Engine enables application developers to create user-defined applications that perform background SQL processing of relevant data.

BMC Software, Inc., Confidential and Proprietary Information

1-2

CONTROL-M Option for PeopleSoft Administrator Guide

CONTROL-M/Option for PeopleSoft CONTROL-M Option for PeopleSoft has two major components: • •

BMC-specific process request component interface Job submission/tracking application

CONTROL-M Option for PeopleSoft is a platform-independent program that is external to PeopleSoft’s Java-based application. CONTROL-M Option for PeopleSoft supports PeopleSoft via application program interfaces (APIs). CONTROL-M Option for PeopleSoft is database independent and uses PeopleSoft’s middle-tier Tuxedo Application Server for database access. CONTROL-M Option for PeopleSoft provides a solution for PeopleTools users with the following advantages: •

The ability to use a sophisticated scheduling tool for PeopleSoft internal processing.

•

The ability to integrate PeopleSoft and non-PeopleSoft production processing (for example, OS/390 jobs and Unix shell scripts) into a single homogeneous production environment.

•

The ability to maximize the effectiveness of PeopleSoft 8 in an Internet environment.

CONTROL-M Business Integrated Scheduling When fully implemented, CONTROL-M automates normal operations and provides “management by exception” capability for total job scheduling in the data center. Operator or user intervention is required only for unforeseen circumstances and for scheduling special purpose (“one time”) jobs. Two types of CONTROL-M implementation are used for various platforms: BMC Software, Inc., Confidential and Proprietary Information

Overview

1-3

•

CONTROL-M version 2.1x CONTROL-M schedules, submits, and tracks jobs which execute on the platform on which CONTROL-M is installed.

•

CONTROL-M Server/Agent Technology CONTROL-M/Server schedules, submits and tracks the execution of jobs on a heterogeneous collection of platforms (referred to as Agent platforms) across a network. Each CONTROL-M/Server maintains its own database of scheduling information for both the Server platform and Agent platforms.

Note

When using CONTROL-M Server/Agent technology, you must install CONTROL-M/Agent on the same platform as CONTROL-M Option for PeopleSoft. The implementation of CONTROL-M used in a specific data center depends on the type of platform used to run CONTROL-M and the version of CONTROL-M currently installed. Depending upon the implementation used, the CONTROL-M Business Integrated Scheduling Solution is comprised of a two- or three-tier architecture. •

The first tier contains Enterprise Controlstation, the GUI (graphical user interface) that provides a common focus for all CONTROL-M implementations. Enterprise Controlstation provides a consolidated view of scheduling information and task status, manages cross-platform dependencies, and handles execution exceptions for all production jobs in the data center.

•

The second tier provides CONTROL-M version 2.1.x or CONTROL-M Server/Agent technology. It can be operated with or without the Enterprise Controlstation GUI.

•

The optional third tier consists of CONTROL-M Control Modules which can facilitate access to a variety of commercial applications and databases. BMC Software, Inc., Confidential and Proprietary Information

1-4

CONTROL-M Option for PeopleSoft Administrator Guide

Supported Platforms CONTROL-M Option for PeopleSoft can be installed on all CONTROL-M/Agent-supported operating systems that have Java Runtime Environment (JRE 1.2.2 or later) installed. For more information about JRE, see the Java website http://java.sun.com/

Supported Databases CONTROL-M Option for PeopleSoft is supported on all Relational Database Management Systems (RDBMS) that are supported by PeopleSoft 8.x. For more information about supported RDBMSs, visit the PeopleSoft web site http://www.peoplesoft.com or (requires login) http://www4.peoplesoft.com/psdb.nsf/ccabout?ReadForm

Supported Features The following capabilities are provided by CONTROL-M Option for PeopleSoft: • • • • • • • • • • • • •

Submit PeopleSoft processes Submit with existing ProcessName Submit with existing ProcessType Submit with existing RunControlID Submit with specified OutDest Submit with specified OutDestFormat Submit with specified OutDestType Submit with specified RunLocation Submit with specified TimeZone Submit with specified RunRecurrence Track PeopleSoft processes Provide job sysout when the job ends Provide job statistics when the job ends

BMC Software, Inc., Confidential and Proprietary Information

Overview

1-5

Note

The following capabilities are not provided in this version of CONTROL-M Option for PeopleSoft: Job extraction JCL viewing and editing Shout (notification) capability

PeopleSoft Processes and Jobs CONTROL-M Option for PeopleSoft enables CONTROL-M to handle PeopleSoft processes as if they were regular batch jobs. •

A PeopleSoft process is a single task, program, or routine (such as an SQR report) that runs on the client or on a server.

•

A PeopleSoft job consists of one or more API aware processes that are submitted as a unit. These processes can run sequentially or in parallel in a PeopleSoft server environment.

•

When scheduled by CONTROL-M Option for PeopleSoft, these processes are submitted by the runjob utility and run sequentially. CONTROL-M monitors these processes and displays their status in the Process Monitor window. If a process fails, the next scheduled process is executed.

All PeopleSoft process types are supported. For data about process types, see “Process Types” in the PeopleTools 8.x documentation. Processes

In the runjob utility, PeopleSoft processes are specified in the -JOBNAME parameter without a prefix. For example: java -jar ctmpsft.jar -jobname AEMINITEST -prcstype “Application Engine”...

BMC Software, Inc., Confidential and Proprietary Information

1-6

CONTROL-M Option for PeopleSoft Administrator Guide

Jobs

In the runjob utility, PeopleSoft jobs are specified in the -JOBNAME parameter prefixed with a + sign. For example: java -jar ctmpsft.jar -jobname +3CBL -prcstype “COBOL SQL” ...

For more information about using the -JOBNAME parameter, see JOBNAME in Table 3-1, “runjob Parameters,” on page 3-2. Creating a PeopleSoft Process Instance Using a Process Name and Type

You can create a new PeopleSoft process instance in the PeopleTools Process Scheduler using an existing process name and process type. The new PeopleSoft process instance is executed under CONTROL-M/Agent by the runjob utility. The execution status is recorded in the PeopleSoft database. For information about the runjob utility, see Chapter 3, “Running PeopleSoft Jobs/Processes”.

Defining Jobs Using Enterprise Controlstation All CONTROL-M capabilities are available to PeopleSoft jobs and processes, including: • • • • •

advanced scheduling criteria complex dependencies Quantitative resources Control resources AutoEdit variables

When the scheduling criteria of the request are satisfied, CONTROL-M calls the interface module. The interface module uses the Environment file to communicate with PeopleSoft, and then executes the PeopleSoft job or process. See Figure 1-1 on page 1-8.

BMC Software, Inc., Confidential and Proprietary Information

Overview

1-7

CONTROL-M Option for PeopleSoft enables you to schedule jobs from Enterprise Controlstation by running the runjob utility with -jobname, -prcstype, and -runcntlid qualifiers. This utility uses PeopleSoft APIs to submit the CONTROL-M job to the PeopleSoft Application Server. The utility creates a new PeopleSoft process instance. For information about how to do this in a Windows or Unix environment, see “Example 1 – Run an existing Process under Microsoft Windows” on page 3-3. Figure 1-1

CONTROL-M Option for PeopleSoft Workflow

BMC Software, Inc., Confidential and Proprietary Information

1-8

CONTROL-M Option for PeopleSoft Administrator Guide

2

Installation and Configuration

2

Software Requirements CONTROL-M Option for PeopleSoft requires the following: •

CONTROL-M/Agent and Java Runtime Environment (JRE) version 1.2.2 or later installed on the same computer. Note

This product has been tested with CONTROL-M/Agent version 2.2.4 and CONTROL-M/Agent version 6.0.03. •

The PeopleSoft 8.x Application Designer (which will be used to import the PROCESSREQUESTBMC Component Interface).

•

PeopleSoft-generated APIs that have been exported, compiled, and JARed as generated.jar. For your convenience, psjoa.jar and generated.jar files are provided for PeopleSoft versions 8.12.01 and 8.13. Note

If you are not using PeopleSoft version 8.12.01 or 8.13, use the original psjoa.jar provided by PeopleSoft in the /web/PSJOA directory (instead of the files provided with CONTROL-M Option for PeopleSoft).

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-1

•

PeopleSoft Application Server version 8.x. and PeopleTools Client version 8.x. The PeopleTools Client and the Application Server must have the same version number.

•

A PeopleSoft database (for example, a Human Resources database).

•

Working connections to the CONTROL-M/Server and the Database server.

A working connection to Enterprise Controlstation is recommended but not required. Note

Ensure that your PeopleTools and database versions are compatible before installing CONTROL-M Option for PeopleSoft. Incompatibilities can cause CONTROL-M Option for PeopleSoft to not run properly. For information about the compatibility of PeopleTools and database versions, see the PeopleSoft website http://www.peoplesoft.com

Java Runtime Environment JRE consists of the Java virtual machine, Java platform core classes, and supporting files. JRE 1.2.2 or later must be installed. For information about Java 2 Standard Edition, see the Java website: http://java.sun.com/j2se/ For information about Java technology ported to other platforms, see: http://java.sun.com/cgi-bin/java-ports.cgi

BMC Software, Inc., Confidential and Proprietary Information

2-2

CONTROL-M Option for PeopleSoft Administrator Guide

Installation The installation process is described under the following topics: • • • • •

Importing the PROCESSREQUESTBMC Component Interface (see below) PROCESSREQUESTBMC Component Interface Security (on page 2-6) PeopleSoft APIs (on page 2-8) Test Environment (on page 2-9) Environment File Parameters (on page 2-12)

PROCESSREQUESTBMC Component Interface (CI) The PROCESSREQUESTBMC CI is not provided with the standard PeopleSoft 8.x installation and must be imported from the PeopleSoft 8.x Application Designer. To import the PROCESSREQUESTBMC CI: 1. From the PeopleSoft 8.x Application Designer, while logged in 2-tier mode • •

choose File => Copy Project from File => select PROCESSREQUESTBMC

-or•

select PROCESSREQUESTBMC from the Most Recently Used list.

2. Navigate to the PROCESSREQUESTBMC CI by expanding the CI and selecting PROCESSREQUESTBMC Component Interface. In Figure 2-1, PROCESSREQUESTBMC has been selected on the top line.

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-3

Figure 2-1

Component Interface Selection

3. Build PROCESSREQUESTBMC CI PeopleSoft APIs with these steps: A. B. C. D. E.

Build => PeopleSoft APIs... (see Figure 2-2 on page 2-5) Clear the COM Type Library checkbox Clear the C Header Files checkbox Select the Java Classes checkbox Set the directory containing the PeopleSoft package to the PeopleSoft directory.

These steps will export the Java source code to two directories: C:\psft8\PepleSoft\Generated\PeopleSoft C:\psft8\PeopleSoft\Generated\CompIntfc

BMC Software, Inc., Confidential and Proprietary Information

2-4

CONTROL-M Option for PeopleSoft Administrator Guide

Figure 2-2

Build PeopleSoft API Bindings Dialog Box

4. Click OK. 5. Close the Application Designer. Note

If an error occurs while performing these steps, the most probable cause is that the PeopleTools Client and Application Server versions are not compatible. For more information, see the PeopleSoft web site at http://www.peoplesoft.com/. If necessary, contact your PeopleSoft administrator to obtain a patch or new version. BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-5

PROCESSREQUESTBMC CI Security To configure the security environment for the CI: 1. From the PeopleSoft 8.x Application Designer, while logged in 3-tier mode, choose Go => PeopleTools => Maintain Security => Use => Permission Lists => Component Interfaces => Update/display 2. Choose the permission list allowed to execute this CI. 3. Select the path Application Designer=>File=>Open. 4. Make the following selections: • •

Object type = Component interface Name = PROCESSREQUESTBMC

5. Right click PROCESSREQUESTBMC in the Application Designer screen as shown in Figure 2-1 on page 2-4. 6. Select Test Component Interface to test the selected Component Interface. The Component Interface Tester window is displayed (see Figure 2-3). If the CI contains errors, error messages are displayed in the Error Message Log at the bottom of the window. Figure 2-3 illustrates an unsuccessful attempt to specify a value for a read-only PROCESSINSTANCE property.

BMC Software, Inc., Confidential and Proprietary Information

2-6

CONTROL-M Option for PeopleSoft Administrator Guide

Figure 2-3

Component Interface Tester Window

7. If PROCESSREQUESTBMC has not been added (to a Security List), add it to a Security List compliant with your enterprise security policy by choosing: Go => PeopleTools => Maintain Security => Use => Permission Lists => <select a Permission List> => Component Interfaces => Add => <select PROCESSREQUESTBMC> 8. In the Maintain Security –Use –Permission Lists Window, select the path PROCESSREQUESTBMC Edit => Full Access (All) 9. Click OK to exit the Maintain Security facility. BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-7

Note

If an error occurs while performing these steps, the most probable cause is that the PeopleTools Client and the Application Server versions are not compatible. For more information, see the PeopleSoft web site at http://www.peoplesoft.com/. If necessary, contact your PeopleSoft administrator to obtain a patch or new version.

PeopleSoft APIs To export and build PeopleSoft APIs: 1. Copy the psjoa.jar file from the installation CD to the C:\psft8 directory. 2. Use the following command to compile the PeopleSoft\Generated\PeopleSoft java source code: C:\psft8>javac -classpath .\psjoa.jar -sourcepath PeopleSoft\Generated\PeopleSoft\*.java

For more data about the javac utility, see “javac” on page A-1. 3. Use the following command to compile the PeopleSoft\Generated\CompIntfc java source code: C:\psft8>javac -classpath .\psjoa.jar -sourcepath PeopleSoft\Generated\CompIntfc\*.java

4. If a redefinition error occurs in PeopleSoft\Generated\CompIntfc, ensure that you remove or rename the java source code files that caused it. For example: C:\psft8\PeopleSoft\Generated\CompIntfc>ren PvReqApprCommCollection.java PvReqApprCommCollection.jav

BMC Software, Inc., Confidential and Proprietary Information

2-8

CONTROL-M Option for PeopleSoft Administrator Guide

5. Repeat steps 2, 3, and 4 until the PeopleSoft APIs compile without error. Note

The Java System Development Kit (Java SDK or JDK) includes JRE plus the javac and jar utilities. Although JRE is sufficient for normal operation of this product, JDK is required for upgrading and rebuilding APIs.

Test Environment To build a test environment and use it to test the system components. 1. Use the following commands to remove or move all java source code files from the PeopleSoft\Generated path: C:\psft8>del PeopleSoft\Generated\PeopleSoft\*.java C:\psft8>del PeopleSoft\Generated\CompIntfc\*.jav?

2. Use the jar utility to bundle the compiled java bitcode files located in PeopleSoft\Generated\* in a generated.jar Java archive without a manifest: C:\psft8>jar cvfM generated.jar PeopleSoft\Generated

For more information about the jar utility, see “jar” on page A-2. Note

Ensure that generated.jar and psjoa.jar are based on the same version and release of PeopleSoft 8.x. 3. Using FTP in binary (not ASCII) mode, transfer the psjoa.jar, generated.jar, ctmpsft.jar, and ctmpsft.env java archive (*.jar) files to a computer that has CONTROL-M/Agent and the Java Runtime Environment (JRE version 1.2.2 or later) installed.

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-9

4. Ensure that the psjoa.jar, generated.jar, ctmpsft.jar, and ctmpsft.env files reside in the same working directory. For example, on AIX: /usr/home/ctmag/ctm/exe_AIX/ 5. Test the environment by executing the command: java -jar ctmpsft.jar

If ctmpsft.jar functions properly, the test is successful. Skip the remaining steps. Otherwise, a manifest-related problem has occurred. Perform Step 6 through Step 9 to solve the problem and retest the environment. 6. Extract the psjoa.jar java files into directory psft/pt8/joa/ by executing the following command from the directory in which the .jar files are located. jar xvf psjoa.jar

7. Extract generated.jar java files by executing the following command: jar xvf generated.jar

These files will be exported to the following directories: PeopleSoft/Generated/PeopleSoft/ PeopleSoft/Generated/CompIntfc/

8. Extract the ctmpsft.jar java files with the manifest file METAINF/MANIFEST.MF into directory ctmpsft/ by executing the following command. jar xvf ctmpsft.jar

9. Test the environment by executing the command: java -cp ctmpsft.jar ctmpsft/runjob.class

BMC Software, Inc., Confidential and Proprietary Information

2-10

CONTROL-M Option for PeopleSoft Administrator Guide

Environment File CONTROL-M Option for PeopleSoft uses a command line interface to provide the parameters needed to execute PeopleSoft processes in the PeopleSoft database. To simplify the command line interface, an Environment file is created during installation. Command line arguments supersede the default values in the Environment file. The Environment file is configured automatically during CONTROL-M Option for PeopleSoft installation. The Environment file is in text file format and has an .env extension. The following default Environment file, ctmpsft.env, is provided with the installation package: PRCSTYPE=Application Engine HOSTNAME=opisaix3 DBGLVL=1 USER=PS PASSWORD=PS PORT=9000 MONITOR_SLEEP_INTERVAL=1 MONITOR_USE_MAX_RETRY=NO MONITOR_MAX_RETRY=48 MONITOR_WRITE_STATUS=NO OUTDEST=c:\\temp OUTDESTFORMAT=Default OUTDESTTYPE=Default RUNLOCATION=PSUNX PROCLOG=e:\\temp\\ Note

Parameter values in the Environment file can be modified with a text editor. However, we strongly recommend using the config utility for this purpose. For information about the config utility, see “config Utility – Environment File Configuration” on page 2-15.

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-11

Environment File Parameters Table 2-1

Environment File Parameters

Parameter

Description

PRCSTYPE

Process type (for example, SQR Report).

HOSTNAME

Name of the host machine on which the Application Server is running.

PORT

Application Server JSL port number.

USER

PeopleSoft Operator ID

PASSWORD

Encrypted PeopleSoft operator ID password (128 characters).

RUNLOCATION

Name of the Process Scheduler Server. See “RUNLOCATION” on page 2-13.

OUTDEST

Process output location.

OUTDESTFORMAT

Process output format. See “OUTDESTFORMAT” on page 2-13.

OUTDESTTYPE

Process output type. See “OUTDESTTYPE” on page 2-14

PROCLOG

PROCLOG directory path. If parameter DBGLVL (below) is not set to 0, PROCLOG should be specified. If PROCLOG is not specified in the Environment file or the command line, DBGLVL is reset to 0. Note: The specified value must end with a directory separator.

DBGLVL

Debug level. Valid values: 0 – 4. Set to 0 for production mode (debug messages are not generated). For more information about debug levels, see the CONTROL-M/Server Administrator Guide.

MONITOR_SLEEP_ INTERVAL

Sleep interval (in minutes) for job monitoring.

MONITOR_USE_ MAX_RETRY

Y/N (Yes/No) flag that indicates whether to use the MONITOR_MAX_RETRY parameter.

MONITOR_MAX_ RETRY

Maximum hours to monitor a job before returning a NOTOK status.

MONITOR_WRITE_ STATUS

Y/N (Yes/No) flag that indicates whether to write the status of the monitored job to the standard output file.

BMC Software, Inc., Confidential and Proprietary Information

2-12

CONTROL-M Option for PeopleSoft Administrator Guide

Note

The MONITOR_SLEEP_INTERVAL, MONITOR_USE_MAX_RETRY, MONITOR_MAX_RETRY, MONITOR_WRITE_STATUS and DBGLVL parameters cannot be specified on the command line.The other parameters in Table 2-1 can be specified when invoking the runjob utility. For more information about this utility, see Chapter 3, “Running PeopleSoft Jobs/Processes”. RUNLOCATION

PeopleSoft provides the following standard Process Scheduler Server names as RUNLOCATION values: • • •

PSNT runs on Windows NT PSUNX runs on Unix PSOS390 runs on OS390

These names can be modified (for example, PSNT1, PSNT2, PSTNTH, PSTNTL, PSUNXSOL, PSUNXHP) to avoid Process Scheduler Server name conflicts. For more information, choose: PeopleTools > Process Scheduler Manager > Use > Server Definitions OUTDESTFORMAT

Supported values are described in alphabetical order in Table 2-2. If an invalid value is specified, the default value defined for the specified process in PeopleSoft Tools is used. Table 2-2

OUTDESTFORMAT Values

Supported Values (Xlatshortname)

Description (Xlatlongname)

(None)

(None)

Any

Any

CSV

Comma delimited (*.csv)

Default

Default

DOC

Microsoft Word (*.doc)

HP

HP Format (*.lis)

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-13

Table 2-2

OUTDESTFORMAT Values

Supported Values (Xlatshortname)

Description (Xlatlongname)

HTM

HTML Documents (*.htm)

LP

Line Printer Format (*.lis)

OTHER

Other (*.lis)

PDF

Acrobat (*.pdf)

PS

Postscript (*.lis)

RPT

Crystal Report (*.rpt)

RTF

Rich Text File (*.rtf)

SPF

SQR Portable Format (*.spf)

TXT

Text Files (*.txt)

WKS

Lotus 1-2-3 Files (*.wks)

XLS

Microsoft Excel Files (*.xls)

OUTDESTTYPE

Supported values are described in alphabetical order in Table 2-3. Table 2-3

OUTDESTTYPE Values

Supported Values (Xlatshortname)

Xlatlongname

Any

Any

DEFAULT

Default

EMAIL

Email

FILE

File

NONE

(None)

PRINTER

Printer

WEB

Web

WINDOW

Window

BMC Software, Inc., Confidential and Proprietary Information

2-14

CONTROL-M Option for PeopleSoft Administrator Guide

config Utility – Environment File Configuration Usage The config utility enables you to modify parameters in the Environment file. Modes

This utility works in two modes: • •

Silent – adds or modifies one parameter at a time Interactive – adds, deletes, or modifies any or all of the parameters in an existing Environment file

-ENVFILE Parameter

If the -ENVFILE parameter is specified, the utility looks for the specified file. If the -ENVFILE parameter is not specified, the utility looks in the current directory for the default ctmpsft.env file. If the file is found, the specified parameter is added (if not already in the file) or updated and the Environment file is automatically saved. Name/Value Pairs

If the Environment file is found, the utility reads the name/value parameter pairs. Each pair is separated by an equal sign (=) or colon (:). One name/value parameter pair is allowed on each line. The config utility uses a hash table to determine the sequential order of parameter/value lines. Therefore, the sequential order of the lines is not fixed. However, name/value pairs are kept intact. Comments

Comment characters are # and !. The header of the Environment file is a comment line with the most recent date and time an add or update was performed. For example: #Wed Sep 05 16:05:33 PDT 2001 BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-15

Special Characters

Parameter names/values with non-alphanumeric characters can be stored. Some special characters are represented by ASCII escape sequences. For example, Tab is represented by \t, Return by \r, New Line by \n, Space by \<space_character>, Double-quote by \", Single-quote by \’, Colon by \:, and Back-slash by \\. Special characters can also be represented using UNICODE notation \uxxxx. For example: CTRL-A ASCII(1) can be represented as \u0001. -HELP Parameter and Usage Format

If the -HELP parameter is specified, the usage format is displayed: java -cp ctmpsft.jar ctmpsft/config -HELP USAGE: java -cp ctmpsft.jar ctmpsft/config [-ENVFILE ] [-NAME -VALUE ] [-HELP]

Silent Mode The config utility is invoked in silent mode by including on the command line: • •

the -NAME parameter (name of the Environment parameter to be added or modified) the -VALUE parameter (value to which the specified Environment parameter should be set)

If the -NAME and -VALUE parameters are not specified, the utility is invoked in interactive mode.

BMC Software, Inc., Confidential and Proprietary Information

2-16

CONTROL-M Option for PeopleSoft Administrator Guide

Syntax java -cp ctmpsft.jar ctmpsft/config [-ENVFILE ] -NAME -VALUE [-HELP]

is not case-sensitive. is case-sensitive. For example, parameter RuNLoCaTioN can successfully update existing parameter RUNLOCATION. However, values psNT and PSNT are not identical. Examples

The first example adds the RUNLOCATION parameter and value. The second example updates the value of the RUNLOCATION parameter. Example 1

Add a new parameter, RUNLOCATION, with the value PNST. J:\be_psft>java -cp ctmpsft.jar ctmpsft/config -NAME RUNLOCATION -VALUE PSNT

The following Silent Mode add message is generated: CONTROL-M Option for PeopleSoft config utility Silent Mode Validating default env file ’ctmpsft.env’... OK ’J:\be_psft\ctmpsft.env’ (14 keys found) Adding ’RUNLOCATION = PSNT’ ... OK Saving ’ctmpsft.env’ file ... OK Example 2

Update the value of the existing RUNLOCATION parameter. java -cp ctmpsft.jar ctmpsft/config -NAME RuNLoCaTiOn -VALUE PSUNX

The following Silent Mode update message is generated:

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-17

CONTROL-M Option for PeopleSoft config utility Silent Mode Validating default env file ’ctmpsft.env’... OK ’J:\be_psft\ctmpsft.env’ (15 keys found) Identical key ’RUNLOCATION’ already exists in ’ctmpsft.env’ Updating ’RUNLOCATION = PSUNX’ ... OK Saving ’ctmpsft.env’ file ... OK

The Environment file is not updated if the specified (case insensitive) parameter name and (case sensitive) value are identical to the ones in the Environment file. For example: Where Specified and Result

Parameter Name

Parameter Value

command line

RuNLoCaTioN

PSNT

in Environment file

RUNLOCATION

PSNT

result

The file is not updated.

command line

RUNLOCATION

PSNT

in Environment file

RUNLOCATION

psNT

result

The file is updated.

Interactive Mode The config utility is invoked in Interactive mode if the -NAME and VALUE parameters are not included in the command line. Use the Interactive mode when creating a new Environment file or substantially changing an existing Environment file. Syntax J:\be_psft>java -cp ctmpsft.jar ctmpsft/config

BMC Software, Inc., Confidential and Proprietary Information

2-18

CONTROL-M Option for PeopleSoft Administrator Guide

Screen Display

The Interactive Mode displays the current parameter name/value pairs and a menu listing the available options: Interactive Mode Validating default env file ’ctmpsft.env’... OK ’J:\be_psft\ctmpsft.env’ -----------------------------------------------CONTROL-M Option for PeopleSoft config utility - (15 keys found) -----------------------------------------------DBGLVL = 4 MONITOR_MAX_RETRY = 8 MONITOR_WRITE_STATUS = N PROCLoG = c:\temp\ HOSTNAME = opisaix3 OUTDESTFORMAT = Default OUTDEST = c:\temp USER = PS RUNLoCaTiOn = PSNT PORT = 9000 OUTDESTTYPE = Default PASSWORD = 565b3b3e312631343429492b2e2339273f2a3932314e3d37383421272d2f2b2a433b2f3f22383 c2029332d5522343224203b36302820533a33243d3b3630282f MONITOR_SLEEP_INTERVAL = 3 PRCSTYPE = Application Engine MONITOR_USE_MAX_RETRY = N Enter Key Name to edit, 1 to Add a Key, 2 to Delete a Key, 3 to Save file, 4 to Save file & Quit, 5 to Quit Enter:

Examples Enter Key Name to edit

To modify the value of an existing parameter, type the first few characters that uniquely identify the parameter you want to change. For example, if you type d after the Enter: prompt, the DBGLVL parameter with its current value of 4 is displayed for editing, as follows: DBGLVL [4] =

If you enter a new value of 1, the following message is displayed: Updating: ’DBGLVL = 1’ ... OK

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-19

Because no other parameters begin with d (in this case), typing dBGLvL, DbgLV, dBGl, dBg, or db produces the same result. To change the MONITOR_MAX_RETRY parameter, type at least MONITOR_M because MONITOR_MAX_RETRY, MONITOR_WRITE_STATUS, MONITOR_SLEEP_INTERVAL, and MONITOR_USE_MAX_RETRY also exist. To Add a Key

To add a new parameter and value, type 1 after the Enter: prompt. When you press <Enter>, the Add a Key: prompt is displayed. Following the Add a Key: prompt, type the name of the parameter you want to add. For example: Add a Key: DBGLVL

If the DBGLVL parameter already exists, you are prompted to re-enter the parameter name. Enter a parameter that does not exist, for example: Add a Key: MYKEY

When you enter the name of a new parameter, you are prompted for its value. If the new parameter is MYKEY, this prompt is displayed: MYKEY =

Type in the value for the parameter and press <Enter>. MYKEY = myvalue

The following message is displayed: Adding ’MYKEY = myvalue’ ... OK

and control returns to the Interactive mode of the config utility. To Delete a Key

To delete a parameter, type 2 after the Enter: prompt. The Delete a Key: prompt is displayed. Type the complete name (case insensitive) of the parameter you want to delete. For example: BMC Software, Inc., Confidential and Proprietary Information

2-20

CONTROL-M Option for PeopleSoft Administrator Guide

Delete a Key: MYKEY

If the specified parameter exists, the following message is displayed: Deleting ’MYKEY = myval’ ... OK

and control returns to the Interactive mode of the config utility. To Save file

To save the configuration file, type 3 after the Enter: prompt. When you press <Enter>, the current version of the Environment file is saved. A message similar to this one is displayed: Save file Saving ’ctmpsft.env’ file ... OK (15 keys found)

and control returns to the Interactive mode of the config utility. To Save file and quit

To save the configuration file and exit the config utility, type 4 after the Enter: prompt. When you press <Enter>, the current version of the Environment file is saved and control returns to the command line prompt. A message similar to this one is displayed: Save file and Quit Saving ’ctmpsft.env’ file ... OK J:\be_psft> To Quit

To exit the config utility without saving the Configuration file, type 5 after the Enter: prompt. When you press <Enter>, control returns to the command line prompt without saving changes after the last Save that was performed. A message similar to this one is displayed: Quit J:\be_psft>

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-21

cpt Utility – Password Encryption Usage The cpt utility encrypts passwords based on the CONTROL-M/Agent algorithm. Any length password produces a fixed-length 128-character encrypted value. When using the cpt utility for verification, both the -USER <user> and -PASSWORD <password> parameters are required. Also, both parameters are required to update the -ENVFILE <env file>. If the -PASSWORD <password> parameter is specified without a -USER <user> parameter, the <encrypted_password> is displayed but the Environment file is not updated. Note

For previous users of CONTROL-M Option for PeopleSoft version 1.2: This encryption mechanism differs from the encryption mechanism of CONTROL-M Option for PeopleSoft 1.2. A separate <user>_passwd.dat file containing the <encrypted_password> is not created. Instead, two entries are made in the CONTROL-M Option for PeopleSoft Environment file, as shown in “Example 3: User, Password, and Environment file parameters” on page 2-24: USER=<user> PASSWORD=<encrypted_password> There is no protection mechanism to prevent a user from modifying the <user> and <encrypted_password> values by using the config utility or any text editing tool (such as vi or notepad). However, such modifications may prevent access to the runjob utility based on authentication failure by the Application Server.

Format java -cp ctmpsft.jar ctmpsft/cpt -PASSWORD <password> [-USER <user> [-ENVFILE ]] BMC Software, Inc., Confidential and Proprietary Information

2-22

CONTROL-M Option for PeopleSoft Administrator Guide

Alternative Encryption Method Using a password encrypted by this cpt utility may not work (decrypt) properly in CONTROL-M/Agent configuration files. However, passwords encrypted by the CONTROL-M/Agent ctmcpt utility are decrypted properly by this cpt utility. You can produce an encrypted password using CONTROL-M/Agent utility ctmcpt. That encrypted password can be copied and pasted in the CONTROL-M Option for PeopleSoft Environment file.

Examples Example 1: Password parameter only

If the cpt utility is invoked with a password but without a user parameter: J:\be_psft>java -cp ctmpsft.jar ctmpsft/cpt -PASSWORD ps

the following message is displayed: Please copy/paste in an env file of your choice the following: PASSWORD=767b3b3e312631343429492b2e2339273f2a3932314e3d37383421272d2f2b2a433b 2f3f22383c2029332d5522343224203b36302820533a33243d3b3630282f

Example 2: No Parameters

If the cpt utility is invoked with neither a password nor a user parameter: J:\be_psft>java -cp ctmpsft.jar ctmpsft/cpt

the following message and usage format are displayed: Incorrect number of parameters: 0 USAGE: java -cp ctmpsft.jar ctmpsft/cpt -PASSWORD <password> [-USER <user> [-ENVFILE ]] BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-23

Example 3: User, Password, and Environment file parameters

If the cpt utility is invoked with user, password, and Environment file parameters, but the specified Environment file does not exist: J:\be_psft>java -cp ctmpsft.jar ctmpsft/cpt -USER ps -PASSWORD ps -ENVFILE my.env

The following messages are displayed: Validating cmdline-submitted env file ’my.env’... OK The ’my.env’ file was empty! Adding ’USER’ ... OK Encrypting and adding ’PASSWORD’ ... OK Saving ’my.env’ file ... OK my.env -----#Wed Sep 05 23:53:40 PDT 2001 USER=ps PASSWORD=767b3b3e312631343429492b2e2339273f2a3932314e3d37383421272d2f2b2a433b 2f3f22383c2029332d5522343224203b36302820533a33243d3b3630282f

BMC Software, Inc., Confidential and Proprietary Information

2-24

CONTROL-M Option for PeopleSoft Administrator Guide

Uninstalling CONTROL-M Option for PeopleSoft To uninstall CONTROL-M Option for PeopleSoft, remove the ctmpsft.jar, generated.jar, psjoa.jar, and ctmpsft.env files from the working directory.

BMC Software, Inc., Confidential and Proprietary Information

Installation and Configuration

2-25

BMC Software, Inc., Confidential and Proprietary Information

2-26

CONTROL-M Option for PeopleSoft Administrator Guide

3

Running PeopleSoft Jobs/Processes3 The runjob utility submits and tracks PeopleSoft jobs and processes. This utility uses the following input: • • •

PeopleSoft environment file parameters. Name of the program to execute. Program input parameters.

Completion codes are described in “Completion Codes” on page 3-6. This utility can update the Process Request table with execution status information. For more data, see “API Aware Processes” on page 3-5. You can execute this utility with the following command line parameters: java -jar ctmpsft.jar -JOBNAME <+Job_Name | Process_Name> -PRCSTYPE <Job_Type | Process_Type> -RUNCNTLID -HOSTNAME <Application_Server_Name> -PORT <Application_Server_Port_Number> -USER -PASSWORD [-RUNLOCATION ] [-OUTDEST ] [-OUTDESTFORMAT ] [-OUTDESTTYPE ] [-PROCLOG ] [-ENVFILE <Env_file>]

BMC Software, Inc., Confidential and Proprietary Information

Running PeopleSoft Jobs/Processes

3-1

The parameters of this utility are described in Table 3-1. Table 3-1

runjob Parameters

Parameter

Description

JOBNAME

PeopleSoft job or process name. Mandatory (if not specified in the Environment fiile). PeopleSoft process names are specified “as is”. PeopleSoft job names are given a + sign prefix.

PRCSTYPE

Existing global PeopleSoft process type under which related process definitions are grouped. Mandatory (if not specified in the Environment file.) PRCSTYPE lets you maintain process definitions that share common parameters (for example, SQR Report). You can display valid PRCSTYPE values by executing the query:

SQL> select distinct PRCSTYPE from PS_PRCSTYPEDEFN; Note: Because PeopleSoft jobs do not use PRCSTYPE, you can specify "" or the default Environment file. The runjob converts the PeopleSoft job PRCSTYPE to "" regardless of the value specified. RUNCNTLID

Run control ID. A unique ID which associates each operator with that operator’s run control table entries. Mandatory (if not specified in the Environment file.)

HOSTNAME

Name of platform on which the Application Server runs. Mandatory (if not specified in the Environment file.)

PORT

Application Server JSL port number. Mandatory (if not specified in the Environment file.)

USER

PeopleSoft operator ID. Mandatory (if not specified in the Environment file.)

PASSWORD

PeopleSoft operator ID password. Mandatory (if not specified in the Environment file.)

RUNLOCATION

Name of the platform on which the Process Scheduler Server is running. Optional. You can display the RUNLOCATION values of all up-and-running Process Scheduler Servers by executing the query:

SQL> select SERVERNAME from PSSERVERSTAT; For more data, see “RUNLOCATION” on page 2-13. OUTDEST

Process output location. Optional.

BMC Software, Inc., Confidential and Proprietary Information

3-2

CONTROL-M Option for PeopleSoft Administrator Guide

Table 3-1

runjob Parameters

Parameter

Description

OUTDESTFORMAT

Process output format. Optional. You can display all OUTDESTFORMAT values by executing the query: SQL> select XLATSHORTNAME from XLATTABLE where FIELDNAME=’outdestformat’; See “OUTDESTFORMAT” on page 2-13

OUTDESTTYPE

Process output type. Optional. You can display all valid OUTDESTTYPE values by executing the query:

SQL> select XLATSHORTNAME from XLATTABLE where FIELDNAME=’OUTDESTTYPE’; For more data, see “OUTDESTTYPE” on page 2-14 PROCLOG

PROCLOG directory path. If Environment parameter DBGLVL is not set to 0, PROCLOG should be specified. If PROCLOG is not specified, DBGLVL is reset to 0. Note: The specified value must end with a directory separator.

ENVFILE

Full path and name for the Environment file. Mandatory. Format: <path/filename>.env

Note

Both of the following commands produce the same result: C:\CTMAG\EXE>java -jar ctmpsft.jar C:\CTMAG\EXE>java -cp ctmpsft.jar ctmpsft/runjob

Example 1 – Run an existing Process under Microsoft Windows

Run an existing PeopleSoft process in CONTROL-M under a Microsoft Windows environment. C:\CTMAG\EXE>java -jar ctmpsft.jar -JOBNAME XRFWIN -PRCSTYPE "SQR Report" -RUNCNTLID 1 -ENVFILE ctmpsft.env Example 2 – Run an existing Process under HP Unix

Run an existing PeopleSoft process in CONTROL-M under an HP Unix 10.20 environment. BMC Software, Inc., Confidential and Proprietary Information

Running PeopleSoft Jobs/Processes

3-3

/usr/home/ctmag/ctm/exe_HP-UX% java -jar ctmpsft.jar -JOBNAME XRFWIN -PRCSTYPE "SQR Report" -RUNCNTLID 1 -ENVFILE ctmpsft.env Example 3 – Using quotation marks on a Unix command line

This example illustrates how to use quotation marks in command line syntax on a Unix computer. ag224@chef:/home/ag224/ctm/exe_Solaris> ctmcreate -tasktype command -jobname aeminitest -nodegrp chef -owner ag224 -cmdline ’java -jar /home/ag224/ctm/exe_Solaris/ctmpsft.jar -jobname AEMINITEST -prcstype "Application Engine" -runcntlid 1 -envfile /home/ag224/ctm/exe_Solaris/ctmpsft.env’ Note

If double quotes are required anywhere in the CONTROL-M Option for PeopleSoft command line (as in -prcstype "Application Engine" in “Example 3 – Using quotation marks on a Unix command line” above), the entire -cmdline value for the ctmcreate utility should be enclosed in single quotes.

BMC Software, Inc., Confidential and Proprietary Information

3-4

CONTROL-M Option for PeopleSoft Administrator Guide

Example 4 – Quote marks on a Microsoft Windows command line

This example illustrates how to use quotation marks in command line syntax on a Microsoft Windows computer. D:\Program Files\BMC Software\CONTROL-M Agent\Exe> ctmcreate -tasktype command -cmdline "java -jar \"D:\Program Files\BMC Software\CONTROL-M Agent\Exe\ ctmpsft.jar\" -jobname AEMINITEST -runcntlid 1 -envfile \"D:\Program Files\BMC Software\ CONTROL-M Agent\Exe\ctmpsft.env\"" -jobname job1 Note

You can disregard the warning java.lang.NullPointerException: PSProperties not loaded from file because it is not relevant to the PeopleSoft process submission.

API Aware Processes Only an API Aware application process can correctly update the Process Request table with execution status information. When running an API UnAware process, it is the responsibility of the user to check the result. The user cannot rely on the execution status. For more information about API Aware, see your PeopleSoft documentation. Examples

•

SQR Report is an API Aware process. The execution status of this process can be properly updated in the PeopleSoft database.

•

WINWORD is not an API Aware process. Therefore, its execution status may be updated as “SUCCESS” even if its execution did not end successfully.

BMC Software, Inc., Confidential and Proprietary Information

Running PeopleSoft Jobs/Processes

3-5

Completion Codes Processes CONTROL-M Option for PeopleSoft utilizes the following completion codes for PeopleSoft process execution: Table 3-2

Process Completion Codes

Request Status

Description

1

CANCEL

Process canceled by user.

2

DELETE

Process marked for deletion by user.

3

ERROR

Process status was not updated.

4

HOLD

Process held by user.

5

QUEUED

Process waiting to be launched by scheduler.

6

INITIATED

Process launched by scheduler.

7

PROCESSING

Process executing.

8

CANCELLED

Process canceled by scheduler.

9

SUCCESS

Process completed successfully.

NOT SUCCESS

Process not completed successfully.

Code

10

BMC Software, Inc., Confidential and Proprietary Information

3-6

CONTROL-M Option for PeopleSoft Administrator Guide

Utilities Each run of a CONTROL-M Option for PeopleSoft utility ends with one of the completion codes described in Table 3-3. Table 3-3

Code

Utility Completion Codes

Request Status

Description

0

SUCCESSFUL

Process ended successfully.

3

ERROR

Process ended with errors.

8

CANCELLED

Process canceled.

10

UNSUCCESSFUL

Process ended unsuccessfully.

99

UNKNOWN ERROR

Process ended Not OK; error type could not be determined.

98

ANALYZE ERROR

Process status in the PeopleSoft database could not be analyzed.

BMC Software, Inc., Confidential and Proprietary Information

Running PeopleSoft Jobs/Processes

3-7

BMC Software, Inc., Confidential and Proprietary Information

3-8

CONTROL-M Option for PeopleSoft Administrator Guide

4

Verifying Process Execution

4

PeopleSoft Process Monitor The PeopleSoft Process Monitor displays all processes in the active environment. The description for each process shows the Process name, Operator, Server, Instance, Run Date and Time, Run Status, and Details. To navigate to the PeopleSoft Process Monitor, choose PeopleTools => Process Monitor => Inquire => Process Requests. Figure 4-1

Process Monitor

BMC Software, Inc., Confidential and Proprietary Information

Verifying Process Execution

4-1

To view the details of a specific job, click the Details hyperlink of the selected process. The Process Request Detail is displayed. Figure 4-2

Process Request Detail

BMC Software, Inc., Confidential and Proprietary Information

4-2

CONTROL-M Option for PeopleSoft Administrator Guide

PeopleSoft Process Scheduler CONTROL-M Option for PeopleSoft jobs are executed by the Process Scheduler server. To navigate to the Process Scheduler, choose PeopleTools => Process Monitor => Inquire => Process Requests, and then select the Server List tab. Figure 4-3

Process Scheduler

BMC Software, Inc., Confidential and Proprietary Information

Verifying Process Execution

4-3

Each server definition (Description, Sleep Time, Max API Aware, Operating System, Process Types run on this Server) can be altered by navigating to Server Definitions. Choose PeopleTools => Process Scheduler Manager => Use => Server Definitions. Figure 4-4

Server Definitions

The Process Scheduler Server Agent can be configured to run on Microsoft Windows, Unix, OS390, or a Client. To Add a Process Type, click + (plus). To Remove a Process Type, click – (minus). Complete the Server Definitions fields and click Save.

BMC Software, Inc., Confidential and Proprietary Information

4-4

CONTROL-M Option for PeopleSoft Administrator Guide

A

Java Utilities

A

javac This utility compiles java source code files. It is invoked with the format: javac <source files> are listed in Table A-1. <source file> is the file to compile. Table A-1

javac Utility Options

Option <source file>

Description

-g

Generate all debugging info.

-g:none

Generate no debugging info.

-g:{lines,vars,source}

Generate only some debugging info.

-O

Optimize. May hinder debug or enlarge class file.

-nowarn

Generate no warnings.

-verbose

Generate messages about the compiler’s activities.

-deprecation

Indicate where deprecated APIs are in the source.

-classpath <path>

Specify where to find user class files.

-sourcepath <path>

Specify where to find input source files.

-bootclasspath <path>

Override the location of bootstrap class files.

-extdirs

Override the location of installed extensions.

-d

Specify where to place generated class files.

-encoding

Specify type of encoding used by source files.

-target

Generate class files for the specified VM version.

BMC Software, Inc., Confidential and Proprietary Information

Java Utilities

A-1

jar This utility bundles compiled java files in a .jar (Java archive) file. It is invoked with the format: jar {c|t|x|u}[vfm0M] [archive_file] [manifest_file] [-C ]

Specify only one of the c/t/x/u options. You can specify any of the remaining options. These options are described in Table A-2. For more information, see http://developer.java.sun.com/developer/online Training/Programming/BasicJava2/jar.html Table A-2

jar utility options

option

description

-c

Create a new archive.

-t

List table of contents for an archive.

-x

Extract named (or all) files from an archive.

-u

Update an existing archive.

-v

Generate verbose output on the standard output device.

-f

Specify the archive file name.

-m

Include manifest information from the specified manifest file.

-0

Store only. Do not use ZIP compression.

-M

Do not create a manifest file for the entries.

-i

Generate index information for the specified .jar files.

-C

Change to the specified directory and include the specified file.

If a specified file is a directory or subdirectory, each file contained in the (sub)directory is processed. The names of the archive and manifest files must be specified in the same order that options f and m are specified.

BMC Software, Inc., Confidential and Proprietary Information

A-2

CONTROL-M Option for PeopleSoft Administrator Guide

Example 1 – Archive two class files into a java archive

Archive two class files into a java archive called classes.jar: jar cvf classes.jar Foo.class Bar.class Example 2 – Archive all files in a directory into a java archive

Using manifest file: mymanifest, archive all the files in the foo/ directory into classes.jar: jar cvfm classes.jar mymanifest -C foo/

BMC Software, Inc., Confidential and Proprietary Information

Java Utilities

A-3

BMC Software, Inc., Confidential and Proprietary Information

A-4

CONTROL-M Option for PeopleSoft Administrator Guide

Index

Index A Agent technology, overview 1-4 ANALYZE ERROR request status 3-7 API building 2-8 generated.jar 2-1 PeopleSoft-generated 2-1 API Aware processes 3-5 Application Designer screen 2-6 Application Program Interface See API

C CANCELLED request status 3-7 codes See completion codes comment character, config utility 2-16 compatibility PeopleTools and database versions 2-2 PeopleTools Client and Application Server 2-5, 2-8 completion codes jobs 3-6 utilities 3-7 Component Interface security 2-6 selecting 2-3

component interface PROCESSREQUESTBMC 2-1, 2-3, 2-6 Component Interface Tester window 2-7 config utility adding parameters 2-20 comment character 2-16 deleting parameters 2-20 description 2-15 examples 2-17, 2-19 interactive mode 2-18 saving 2-21 silent mode 2-16 special characters 2-16 syntax 2-17, 2-18 Configuration file 2-21 configuring, Environment file 2-15 CONTROL-M Interface Environment file 2-11 CONTROL-M Option for PeopleSoft limitations 1-6 cpt utility examples 2-23 password encryption 2-22 ctmcpt utility, password encryption 2-23 ctmpsft.env file SERVERNAME parameter 4-3

BMC Software, Inc., Confidential and Proprietary Information

Index

5

D

H

Database server software requirements 2-2 DBGLVL parameter Environment file 2-12 default values Environment file 2-11 defining jobs Enterprise Controlstation 1-7

HOSTNAME parameter Environment file 2-12 runjob utility 3-2 HP Unix 10.20 environment running a PeopleSoft process 3-4

E

I importing PROCESSREQUESTBMC Component Interface 2-3 installation Java Runtime Environment 2-2 interactive mode config utility 2-18

editing JCL not available 1-6 encryption cpt utility 2-22 Enterprise Controlstation defining jobs 1-7 overview 1-4 ENVFILE parameter config utility 2-15 runjob utility 3-3 Environment file configuration 2-15 default 2-11 description 2-11 parameters 2-12 updating 2-18 ERROR request status 3-7 execution status API aware 3-5

Java Runtime Environment installation 2-2 website 1-5 java source code, removal 2-9 JCL editing, not available 1-6 JCL viewing, not available 1-6 job scheduling, runjob utility 1-8 JOBNAME parameter runjob utility 1-8, 3-2 JRE See Java Runtime Environment JRE software requirements 2-1

G

L

generated.jar file PeopleSoft-generated APIs 2-1

limitations CONTROL-M Option for PeopleSoft 1-6

J

BMC Software, Inc., Confidential and Proprietary Information

6

CONTROL-M Option for PeopleSoft Administrator Guide

M Microsoft Windows environment 3-3 MONITOR_MAX_ RETRY parameter 2-12 MONITOR_SLEEP_ INTERVAL parameter Environment file 2-12 MONITOR_USE_ MAX_RETRY parameter, Environment file 2-12 MONITOR_WRITE_ STATUS parameter Environment file 2-12

N NAME parameter, config utility 2-16

O OUTDEST FORMAT parameter runjob utility 3-3 OUTDEST parameter Environment file 2-12 runjob utility 3-2 OUTDESTFORMAT parameter Environment file 2-12 values 2-13 OUTDESTTYPE parameter Environment file 2-12, 2-14 runjob utility 3-3 values 2-14

P parameters Environment file 2-12 runjob utility 3-2 password encryption alternative method 2-23 cpt utility 2-22

PASSWORD parameter Environment file 2-12 runjob utility 3-2 password verification, cpt utility 2-22 PeopleSoft Application Designer 2-1 building APIs 2-8 database 2-2 description 1-1 HP Unix 10.20 environment 3-4 Process monitor 4-1 PeopleTools application development 1-2 Application Engine 1-2 Process Scheduler 1-2 software requirements 2-2 PORT parameter Environment file 2-12 runjob utility 3-2 PRCSTYPE parameter Environment file 2-12 runjob utility 1-8, 3-2 Process monitor 4-1 Process Request Detail window 4-2 Process Request table, API aware 3-5 Process Scheduler overview 1-2 PeopleSoft 4-3 process, PeopleSoft 1-2 PROCESSINSTANCE variable PROCESSREQUESTBMC Component Interface 2-6 PROCESSREQUESTBMC Component Interface importing 2-3 security 2-6 software requirements 2-1 PROCLOG parameter Environment file 2-12 PS_SERVERDEFN table 4-3

BMC Software, Inc., Confidential and Proprietary Information

Index

7

R

T

RDBMS website 1-5 removing java source code 2-9 request status, completion codes 3-6 restrictions CONTROL-M Option for PeopleSoft 1-6 return codes See completion codes RUNCNTLID parameter runjob utility 1-8, 3-2 runjob utility completion codes 3-7 examples 3-3 job scheduling 1-8 parameters 3-2 RUNLOCATION parameter config utiltiy 2-17 Environment file 2-12 runjob utility 3-2

test environment, building 2-9

U UNKNOWN ERROR request status 3-7 UNSUCCESSFUL request status 3-7 USER parameter Environment file 2-12 runjob utility 3-2 utilities See also individual utilities by name completion codes 3-7

V viewing JCL, not available 1-6

S security Component Interface 2-6 PROCESSREQUESTBMC Component Interface 2-6 Server Definitions, PeopleSoft 4-4 Server List tab PeopleSoft Process Scheduler 4-3 SERVERNAME ctmpsft.env file 4-3 PS_SERVERDEFN table 4-3 Shout capability, not available 1-6 silent mode, config utility 2-16 software requirements 2-1 special characters, config utility 2-16 SUCCESSFUL request status 3-7 syntax, runjob utility 3-1 BMC Software, Inc., Confidential and Proprietary Information

8

CONTROL-M Option for PeopleSoft Administrator Guide

Notes

*100039505* *100039505* *100039505* *100039505* *100039505*