Cm peoplesoft admin

www.bmc.com
Control-M for PeopleSoft
8.0.00
Administrator Guide
November 2012

2
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain
information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada
Address BMC SOFTWARE INC
2101 CITYWEST BLVD
HOUSTON TX
77042-2827
USA
Telephone  713 918 8800
 800 841 2031
Fax 713 918 8000
09/04/2013
Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
© Copyright 2013 BMC Software, Inc.
BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are
registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other
countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in
the U.S. or in other countries. All other trademarks or registered trademarks are the property of their
respective owners. IT Infrastructure Library® is a registered trademark of the Office of Government
Commerce and is used here by BMC Software, Inc., under license from and with the permission of OGC.
ITIL® is a registered trademark, and a registered community trademark of the Office of Government
Commerce, and is registered in the U.S. Patent and Trademark Office, and is used here by BMC Software,
Inc., under license from and with the permission of OGC.
Linux is the registered trademark of Linus Torvalds.
Oracle is a registered trademark of Oracle Corporation.
UNIX is the registered trademark of The Open Group in the US and other countries.
BMC Software considers information included in this documentation to be proprietary and confidential. Your
use of this information is subject to the terms and conditions of the applicable End User License Agreement
for the product and the proprietary and restricted rights notices included in this documentation.
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE
COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer
software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14,
DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended
from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD, HOUSTON TX
77042-2827, USA. Any contract notices should be sent to this address.

3
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting
Customer Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at
http://www.bmc.com/support. From this website, you can:
 read overviews about support services and programs that BMC offers
 find the most current information about BMC products
 search a database for issues similar to yours and possible solutions
 order or download product documentation
 download products and maintenance
 report an issue or ask a question
 subscribe to receive proactive e-mail alerts when new product notices are released
 find worldwide BMC support center locations and contact information, including e-mail addresses, fax
numbers, and telephone numbers
Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call 800
537 1813 or send an e-mail message to customer_support@bmc.com emailto:customer_support@bmc.com.
(In the subject line, enter SupID:<yourSupportContractID>, such as SupID:12345). Outside the United
States and Canada, contact your local support center for assistance.
Before contacting BMC
Have the following information available so that Customer Support can begin working on your issue
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 other maintenance level such as PUT or PTF
• system hardware configuration
• serial numbers
• related software (database, application, and communication) including type, version, and service
pack or maintenance level

4
 sequence of events leading to the issue
 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
License key and password information
If you have questions about your license key or password, contact BMC as follows:
 (USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail
message to ContractsPasswordAdministration@bmc.com
 (Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20
354 8702, or send an e-mail message to password@bmc.com
 (Asia-Pacific) Contact your BMC sales representative or your local BMC office.

5
Contents
Introduction to Control-M for PeopleSoft ..........................................................................7
Administrative roles........................................................................................................................7
Control-M for PeopleSoft Installation................................................................................9
Setting environment variables in UNIX.............................................................................................9
Installing Control-M for PeopleSoft on Control-M/Agent on UNIX .....................................................10
Installing Control-M for PeopleSoft on Control-M/Agent on Windows ...............................................11
Installation on Control-M/EM.........................................................................................................12
Installing the Control-M for PeopleSoft client plug-in.......................................................................12
Installing Control-M for PeopleSoft server plug-in on Control-M/EM (UNIX) ......................................13
Installing Control-M for PeopleSoft server plug-in on Control-M/EM (Windows) ................................13
Control-M for PeopleSoft Component Interface...............................................................................14
Importing the CI ..........................................................................................................................14
Setting security authorizations for the CI (PeopleTools v8.1x or 8.2x)..............................................15
Setting security authorizations for the CI (PeopleTools v8.4x or 8.5x)..............................................16
Testing the CI ..............................................................................................................................16
Control-M for PeopleSoft Uninstall .................................................................................................17
Uninstalling Control-M for PeopleSoft from UNIX ............................................................................17
Uninstalling Control-M for PeopleSoft from Windows.......................................................................18
Performing an automatic uninstall from Windows ...........................................................................18
CCM administration ...................................................................................................... 18
Connection profile management....................................................................................................19
Creating a connection profile.........................................................................................................19
Control-M for PeopleSoft connection profile parameters..................................................................20
Editing a connection profile...........................................................................................................20
Deleting a connection profile.........................................................................................................21
Testing a connection profile ..........................................................................................................21
Copying a connection profile .........................................................................................................22
Exporting a connection profile.......................................................................................................22
Configuring Control-M for PeopleSoft settings ................................................................................23
Configuration parameters .............................................................................................................23
Control-M for PeopleSoft psftcm utility ........................................................................... 24
Testing the connection profile through the psftcm diag utility..........................................................25

6
Testing the status of Control-M for PeopleSoft through the psftcm ping utility..................................25
Changing the connection profile password through the psftcm passwd utility ...................................25
Control-M for PeopleSoft Job extraction .........................................................................................26
Building a rule File........................................................................................................................26
Rule file for extracting current executing job or process..................................................................26
Rule file for extracting job or process definitions ............................................................................27
Extracting an executing job or process...........................................................................................29
Extracting job or process definitions ..............................................................................................30
Shutting down Control-M for PeopleSoft ........................................................................................30
Control-M for PeopleSoft job definition ........................................................................... 31
Accessing the PeopleSoft form ......................................................................................................31
Defining a Control-M for PeopleSoft job .........................................................................................31
Specifying and sharing data ..........................................................................................................32
Monitoring a PeopleSoft process or job ..........................................................................................33
Control-M for PeopleSoft Parameters .............................................................................................34
Connection profile ........................................................................................................................35
Email subject ...............................................................................................................................36
Email text ....................................................................................................................................36
Email web report..........................................................................................................................37
Email with log ..............................................................................................................................37
Format ........................................................................................................................................37
Process name (I)..........................................................................................................................38
Process name (II) ........................................................................................................................38
Process type ................................................................................................................................39
Rerun from step ...........................................................................................................................39
Run control ID .............................................................................................................................40
Server name ................................................................................................................................40
Type............................................................................................................................................41
User ID........................................................................................................................................41
Userdef1-20.................................................................................................................................42
Conversion of PeopleSoft option jobs to Control-M for PeopleSoft jobs.................................i
Converting PeopleSoft Option Jobs to Control-M for PeopleSoft Jobs ..................................................i

7
1Chapter
1
Introduction to Control-M for PeopleSoft
Control-M for PeopleSoft is a control module that brings Control-M enhanced scheduling and job handling
capabilities to your PeopleSoft environment. It serves as an interface between Control-M and PeopleSoft and
enables Control-M to manage PeopleSoft jobs and processes.
Control-M for PeopleSoft is a Java-based server that handles Control-M/Agent requests. It uses TCP/IP to
communicate between Control-M/Agent and PeopleSoft Component Interface. Configuration parameters
control the number of concurrent connections to PeopleSoft.
An in-built feature of the PeopleSoft environment is the PeopleTools Process Scheduler, which enables you
to define and submit PeopleSoft processes and jobs. PeopleSoft jobs and processes often require scheduling
capabilities that extend beyond those of the PeopleTools Process Scheduler. Complex dependencies or
comprehensive scheduling criteria require PeopleSoft users to seek a more sophisticated scheduling solution,
such as Control-M for PeopleSoft.
Control-M for PeopleSoft enables you to do the following:
 Use job processing definitions to submit Control-M for PeopleSoft jobs and processes, as described in
Control-M for PeopleSoft job definition (on page 31)
 Integrate PeopleSoft jobs with other Control-M jobs into a single scheduling environment, as described
in the Control-M User Guide.
 Monitor and manage PeopleSoft jobs and processes that are submitted by Control-M.
 Introduce all Control-M functionalities to PeopleSoft, including advanced scheduling criteria, complex
dependencies, quantitative and control resources, and variables, as described in the Control-M User
Guide.
 Use a rule based utility to locate and monitor current running PeopleSoft jobs and processes, which
enables Control-M to track their status and to make post-processing actions dependent on completion
codes.
Chapter
Administrative roles
Certain Control-M for PeopleSoft tasks might need to be performed by different professionals in your
organization, as follows:
 System Administrator: Responsible for reviewing the system requirements and performing the
installation process.
 Control-M Administrator: Responsible for the administration of all Control-M processes.
 Control-M Production Controller: Responsible for defining and/or monitoring Control-M jobs.
The following table lists the tasks performed when working with the Control-M for PeopleSoft and the role of
the professional who is responsible for its administration.

Control-M for PeopleSoft Administrator Guide
8
Tasks Roles
Install Control-M for PeopleSoft on a Control-M/Agent on
UNIX, as described in Installing Control-M for PeopleSoft on
Control-M/Agent on UNIX (on page 10) and on Windows, as
described in Installing Control-M for PeopleSoft on
Control-M/Agent on Windows (on page 11).
 System Administrator
 Control-M Administrator
Install Control-M for PeopleSoft on a Control-M/Enterprise
Manager (Control-M/EM) client and server, as described in
Installation on Control-M/EM (on page 12).
 System Administrator
Manage Control-M for PeopleSoft connection profiles, as
described in CCM administration.
Define Control-M for PeopleSoft jobs, as described in
Control-M for PeopleSoft job definition.
 Control-M Production
Controller

9
2Chapter
2
Control-M for PeopleSoft Installation
Control-M for PeopleSoft can be installed on a Windows Control-M/Agent or on an UNIX Control-M/Agent.
The Control-M Configuration Manager (CCM) client plug-in must be installed on a Control-M/EM client.
The following procedures describe how to install Control-M for PeopleSoft:
 Setting environment variables in UNIX (on page 9): Describes how to set environment variables in UNIX
 Installing Control-M for PeopleSoft on Control-M/Agent on UNIX (on page 10): Describes how to install
Control-M for PeopleSoft on Control-M/Agent on UNIX via an interactive and automatic installation
 Installing Control-M for PeopleSoft on Control-M/Agent on Windows (on page 11): Describes how to
install Control-M for PeopleSoft on Control-M/Agent on Windows via an interactive and automatic
installation
 Installation on Control-M/EM (on page 12): Describes how to install Control-M for PeopleSoft on a
Control-M/EM client
 Installing Control-M for PeopleSoft server plug-in on Control-M/EM (UNIX) (on page 13): Describes how
to install Control-M for PeopleSoft server plug-in on Control-M/EM on UNIX
 Installing Control-M for PeopleSoft server plug-in on Control-M/EM (Windows) (on page 13): Describes
how to install Control-M for PeopleSoft server plug-in on Control-M/EM on Windows
Setting environment variables in UNIX
This procedure describes how to set environment variables in UNIX, which enables you to see messages from
the console.
 To set environment variables in UNIX:
 Do one of the following:
• If you use csh or tcsh, use the following syntax:
setenv <envVar> <value>
Example: setenv DISPLAY myhost:0.0
• If you use sh or ksh, use the following syntax:
<envVar>=<value>
export <envVar>
Example: DISPLAY=myhost:0.0
export DISPLAY
<envVar> is the name of the environment variable.
<value> is the value assigned to the environment variable.

10
Installing Control-M for PeopleSoft on Control-M/Agent on
UNIX
This procedure describes how to install Control-M for PeopleSoft on Control-M/Agent on UNIX interactively or
automatically.
If you want to install multiple instances of Control-M for PeopleSoft on several computers using the same
configuration, use the automatic installation, as described in this procedure.
NOTE: The default installation is interactive and uses a GUI display. XServer must be running and configured
using the DISPLAY environment variable. If you do not have XServer available, BMC recommends that you
continue with the console installation or perform an automatic installation.
Before You Begin
Verify that all jobs running on Control-M/Agent have ended.
 To install on UNIX:
1. Log in as the Control-M/Agent user, and stop the Control-M/Agent by typing the following command:
$CONTROLM/scripts/shut-ag -u <agentUser> -p all
NOTE: If the Control-M/Agent was installed with user root, then log in as user root every time you start
up or shut down the Control-M/Agent throughout this procedure.
If you are using an AIX operating system, you must remove unused libraries from memory, by typing the
following command as a root user:
/usr/sbin/slibclean
2. Do one of the following:
• Mount the installation DVD.
• Extract the files from the temporary directory that you created when obtaining the installation files
via EPD (see Control-M for PeopleSoft Release Notes).
3. Use one of the following modes:
• Display: If you install using GUI (or XServer), set your DISPLAY environment variable, as described
in Setting environment variables in UNIX (on page 9).
• Console: It is not necessary to set DISPLAY.
4. From the installation DVD or from the installation files via EPD, activate the installation script with the
following command:
<source_path>/setup.sh
• Interactive install: Continue with the on-screen instructions until the installation is complete.
• Automatic install: Do the following:
a. Continue with the on-screen instructions until the Summary window.
b. Click Generate and select the location to create the XML parameter file.

11
c. Click Yes.
d. Copy the automatic installation parameters file to a network location that is accessible to all
computers where you want to perform an automatic installation.
e. To run the installation script, type the following command:
<source_path>/setup.sh -silent <filename.xml>
The installation logs can be found at the following location:
$HOME/BMCINSTALL/log/cmpsft/BMC_Control-M_For_PeopleSoft_Install_<date-time>.
log
6. Log out of the Control-M/Agent account.
7. Start the Control-M/Agent by running the following command:
$CONTROLM/scripts/start-ag -u <agentUser> -p all
8. To use the Control-M for PeopleSoft utilities in the CCM, run the ctmgetcm utility in the
Control-M/Server. For more information, see the Control-M Administrator Guide.
9. Continue with Installation on Control-M/EM (on page 12).
Installing Control-M for PeopleSoft on Control-M/Agent on
Windows
This procedure describes how to install Control-M for PeopleSoft on Control-M/Agent on Windows.
If you want to install multiple instances of Control-M for PeopleSoft on several computers using the same
configuration, use the automatic installation, as described in this procedure.
Before You Begin
Verify that all jobs running on Control-M/Agent have ended.
 To install on Windows:
1. Log in to the computer as a user who has Administrator authorization.
• From the installation DVD, double-click the Setup.exe file.
• From a command prompt window, type <source_path>Setup.exe.
• Interactive install: Continue with the on-screen instructions until the installation is complete.
• Automatic install: Do the following:
a. Continue with the on-screen instructions until the Summary window.
b. Click Generate and select the location to create the XML parameter file.
c. Click Yes.

12
d. The automatic installation XML parameters file that is created (<filename>.xml) is relevant only
for computers with the same agent instance name. Otherwise, a separate <filename>.xml file
must be created for each computer, or modified manually for each computer.
e. Copy the automatic installation parameters file to a network location that is accessible to all
computers where you want to perform an automatic installation.
f. Run the installation script, as follows:
<installation_path>Setup.exe -silent <silent.xml>
The installation log can be found at the following location:
BMCINSTALLlogcmpsftBMC_Control-M_For_PeopleSoft_Install_<timestamp>.log
To use the Control-M for PeopleSoft utilities in the CCM, you must run the ctmgetcm utility in the
Control-M/Server. For more information, see the Control-M Administrator Guide.
4. Continue with Installation on Control-M/EM (on page 12).
Installation on Control-M/EM
After you have installed Control-M for PeopleSoft on Control-M/Agent, you must install the Control-M for
PeopleSoft CCM plug-in on the Control-M/EM client computer and on the server. This procedure must be
performed on every computer that has Control-M/EM client components installed.
The following procedures describe how to install the Control-M for PeopleSoft client plug-in and server
plug-in:
 Installing the Control-M for PeopleSoft client plug-in (on page 12)
 Installing Control-M for PeopleSoft server plug-in on Control-M/EM (UNIX) (on page 13)
 Installing Control-M for PeopleSoft server plug-in on Control-M/EM (Windows) (on page 13)
Installing the Control-M for PeopleSoft client plug-in
This procedure describes how to install Control-M for PeopleSoft on the Control-M/EM client, which installs
the CCM plug-in, imports the PeopleSoft form and enables Find and Update support.
NOTE: If you download the Control-M for PeopleSoft 8.0.00 zip file from the BMC EPD site for a Windows
installation, you need to extract the EM.exe file. This plug-in can only be installed on Windows.
Before you begin
Ensure that you have met the following requirements:
 Control-M for PeopleSoft LPPMC.8.0.00 DVD is mounted or accessible through your network.
 Control-M/EM client applications are closed.
 To install on Control-M/EM client:
1. Log in as a user with administrator authorization on the specific Control-M/EM computer.
2. Navigate to the following directory:
<dvd_path>EM

13
3. Copy or map the EM directory to your local disk.
4. Navigate to the mapped or copied directory:
<mapped/copied_location>EMClient
5. Click Install_EM_Client_PSFT_Plugin.cmd
NOTE: The plug-in is installed on the CCM. The PeopleSoft form is automatically imported on the
Control-M/EM client.
To use the Control-M for PeopleSoft utilities in the CCM, you must ensure that the ctmgetcm utility has
run in Control-M/Server. For more information, see the Control-M Administrator Guide.
Installing Control-M for PeopleSoft server plug-in on Control-M/EM
(UNIX)
This procedure describes how to install Control-M for PeopleSoft plug-in on Control-M/EM UNIX computer,
which enables you to manage PeopleSoft utilities and enables Find and Update support.
Before you begin
Ensure that the Control-M/EM GUI server is shut down.
 To install the plug-in on the Control-M/EM:
1. Log in to the account where Control-M/EM is installed.
2. Navigate to the LPPMC.8.0.00 DVD/EM/Server/UNIX directory.
3. Type the following command and follow the installation instructions provided:
Install_EM_Server_PSFT_Plugin.sh
4. Type the following commands to restart Control-M Configuration Server:
• stop_cms
• start_cms
5. From the Control-M Configuration Manager, restart the Control-M/EM GUI server.
The plug-in is installed.
Installing Control-M for PeopleSoft server plug-in on Control-M/EM
(Windows)
This procedure describes how to install Control-M for PeopleSoft plug-in on Control-M/EM Windows
computer, which enables you to manage PeopleSoft utilities and enables Find and Update support.
Before you begin
Ensure that the Control-M/EM GUI server is shut down.
 To install the plug-in on the Control-M/EM:
1. Log in as a user with administrator authorization on the specific Control-M/EM computer.

14
<dvd_path>EM
3. Copy or map the EM directory to your local disk.
4. Navigate to the mapped or copied directory:
<mapped/copied_location>EMServerWINDOWS
5. Click Install_EM_Server_PSFT_Plugin.cmd
6. Restart the Control-M Configuration Server.
7. From the Control-M Configuration Manager, restart the Control-M/EM GUI server.
The plug-in is installed.
Control-M for PeopleSoft Component Interface
The Component Interface (CI) enables Control-M for PeopleSoft to interact with the PeopleSoft application
server to submit and monitor PeopleSoft jobs.
The following procedure describes how to import the Control-M for PeopleSoft CI, which must be
implemented in the following order:
 Importing the CI (on page 14): Describes how to import the CI Project from the PeopleSoft 8.x
Application Designer
 Setting security authorizations for the CI (PeopleTools v8.1x or 8.2x) (on page 15): Enables you to grant
full access to the CI by setting security authorizations for PeopleTools Version 8.1x or 8.2x
 Setting security authorizations for the CI (PeopleTools v8.4x or 8.5x) (on page 16): Enables you to grant
full access to the CI by setting security authorizations for PeopleTools Version 8.4x or 8.5x
 Testing the CI (on page 16): Enables you to test the CI to ensure that it works
Importing the CI
This procedure describes how to import the CI into PeopleSoft. The CI, which is located in the installation
DVD, must be imported from the PeopleSoft 8.x Application Designer. The Application Designer requires
write permissions for all projects.
Before you Begin
From the installation DVD, select the ci/8.1 (version 8.1x, 8.2x), ci/8.4 (version 8.4x), or ci/8.5 (version 8.5x)
directory and copy it to the hard drive of a computer running Microsoft Windows that has PeopleTools
Application Designer installed.
 To import the CI:
1. From the ci/8.1, ci/8.4, or ci/8.5 directory, right click and select Properties. Uncheck the Read Only
attribute for this directory and all its files.
2. The location of the project files is dependent upon your version of PeopleTools.
• PeopleTools 8.1x, 8.2x: Ensure that the Application Designer is in two-tier mode, then select File
> Copy Project From File.
• PeopleTools 8.4x, 8.5x: Select Tools > Copy Project > From File.

15
3. Ensure that the Import Directory is set to the CONTROLM directory on your hard drive.
• PeopleTools 8.1x, 8.2x: Select CONTROLM project, and click Copy.
• PeopleTools 8.4x, 8.5x: Select CONTROLM.ini file, and click Copy.
The Copy Screen dialog appears.
5. Click Select All Objects and click Copy.
The project is loaded into the Application Designer.
Setting security authorizations for the CI (PeopleTools v8.1x or 8.2x)
This procedure describes how to set security authorizations for CI (PeopleTools v8.1x or 8.2x). You must
grant the CI full access from PeopleSoft. This procedure must be repeated for each PeopleSoft environment.
 To set security authorizations for the CI:
1. From the Application Designer, select Go > PeopleTools > Maintain Security.
The Maintain Security dialog box appears.
2. Select Use > Permission Lists > Component Interface > Update/Display.
The Update/Display dialog box appears.
3. Select a Permission List.
NOTE: The Permission List must be associated with a specific PeopleSoft user that Control-M for
PeopleSoft uses to establish a connection to the PeopleSoft environment.
4. Click OK.
The Component Interface tab appears.
5. Click the row labeled, Click on this row to enter data, and from the dropdown list select the imported
Component Interface.
6. Click Edit.
The Component Interface Permissions dialog box appears.
7. Click Full Access (All).
The Method Access attribute for all the displayed methods changes to Full Access.
8. Click OK, and then click Save.
The permission list changes are saved.

16
Setting security authorizations for the CI (PeopleTools v8.4x or 8.5x)
This procedure describes how to set security authorizations for the CI (PeopleTools v8.4x or 8.5x). You must
grant the CI full access from PeopleSoft. This procedure must be repeated for each PeopleSoft environment.
 To set security authorizations for the CI:
1. From the PeopleSoft web interface, select PeopleTools > Security > Permissions and Roles >
Permissions Lists.
The names of available permissions list appears.
2. Click the required permission list.
The specified permission list page appears.
3. Click Component Interfaces.
The Component Interfaces list appears.
4. At the bottom of the displayed list, click .
An empty field appears.
5. Type CONTROLM in the empty field, and click Edit.
6. Click Full Access (All).
7. Click Save.
Testing the CI
This procedure describes how to test the CI. After setting security authorizations, you should test the CI
before using it. This enables you to discover problems with a component or the CI.
 To Test the CI:
1. In the Application Designer, expand the CI section in CONTROLM project, and double-click
CONTROLM CI to display the CI definition.
2. Select Tools >Test Component Interface.
The Component Interface Tester dialog box appears.
NOTE: If this fails, verify that the authorizations are set correctly in Setting security authorizations for
the CI (PeopleTools v8.1x or 8.2x) (on page 15) or Setting security authorizations for the CI (PeopleTools
v8.4x or 8.5x) (on page 16).
3. Click Get Existing.
The Live Component View dialog box appears.
4. Right click the CI name, and select the Test method.
A confirmation dialog box appears. The PeopleTools version is displayed as a return value, which
indicates successful installation of the CI.

17
Control-M for PeopleSoft Uninstall
The following procedures describe how to uninstall Control-M for PeopleSoft from UNIX and Microsoft
Windows:
 Uninstalling Control-M for PeopleSoft from UNIX (on page 17)
 Uninstalling Control-M for PeopleSoft from Windows (on page 18)
 Performing an automatic uninstall from Windows (on page 18)
Uninstalling Control-M for PeopleSoft from UNIX
This procedure describes how to uninstall Control-M for PeopleSoft from UNIX.
Before You Begin
Ensure that all jobs have ended.
 To uninstall from UNIX:
1. From a Control-M/Agent computer, log in as a Control-M/Agent user, and type the following command to
shut down Control-M/Agent:
$CONTROLM/scripts/shut-ag -u <agentUser> -p all
NOTE: If the Control-M/Agent was installed with user root, then log in as user root every time you start
up or shut down the Control-M/Agent throughout this procedure.
2. If you use an AIX operating system, you must remove unused libraries from memory, by typing the
following command:
/usr/sbin/slibclean
3. Set your DISPLAY environment variable according to the computer name, as described in Setting
environment variables in UNIX (on page 9).
$HOME/BMCINSTALL/uninstall/DRPMC.8.0.00
5. Type one of the following commands:
• Interactive: ./uninstall.sh
• Automatic: /uninstall.sh -silent
Control-M for PeopleSoft has been successfully removed from your computer.
6. To restart Control-M/Agent, type the following command:
$CONTROLM/scripts/start-ag -u <agentUser> -p all

18
Uninstalling Control-M for PeopleSoft from Windows
This procedure describes how to uninstall Control-M for PeopleSoft from Windows.
Before You Begin
Verify that all jobs have ended.
 To uninstall from Windows:
1. From the Start menu, select Settings > Control Panel.
2. Double-click Add/Remove Programs.
3. Select Control-M for PeopleSoft <Agent Name>, and click Add/Remove.
4. Click OK to continue.
Control-M for PeopleSoft is successfully removed from your computer.
Performing an automatic uninstall from Windows
This procedure describes how to perform an automatic uninstall from Windows.
Before You Begin
Ensure that all jobs have ended.
 To perform an automatic uninstall from Windows:
1. Log in to the computer using a user ID that has Administrator privileges.
<Agent Install Path>BMCINSTALLuninstallDRPMC.8.0.00
3. Type the following command:
Uninstall.exe -silent
Control-M for PeopleSoft has been successfully removed from your computer.
Chapter
CCM administration
Control-M for PeopleSoft is a Java-based server that handles Control-M/Agent requests. It uses TCP/IP to
communicate between Control-M/Agent and PeopleSoft Component Interface. Configuration parameters
control the number of concurrent connections to PeopleSoft.
Control-M for PeopleSoft enables you to perform the following configuration and administrative tasks in the
CCM:
 Create, update, delete, test, copy, and export connection profiles, as described in Connection profile
management (on page 19).
 Configure Control-M for PeopleSoft settings, as described in Configuring Control-M for PeopleSoft
settings (on page 23).

19
Connection profile management
Before you can define a Control-M for PeopleSoft job in Control-M/Desktop, you need to create a connection
profile in the CCM, which enables you to connect to the required PeopleSoft application server.
A connection profile contains the connection parameters to a specified PeopleSoft application server, such as
hostname, port, username, and password. By adding a connection profile to the CCM, you enable Control-M
for PeopleSoft users to connect to the required PeopleSoft application server with only the connection profile
name. Users can then run a job without having to provide authentication details every time they connect to
the PeopleSoft application server.
The following procedures describe how to create, edit, delete, test, copy, and export a connection profile in
the CCM:
 Creating a connection profile (on page 19)
 Editing a connection profile (on page 20)
 Deleting a connection profile (on page 21)
 Testing a connection profile (on page 21)
 Copying a connection profile (on page 22)
 Exporting a connection profile (on page 22)
Creating a connection profile
This procedure describes how to create a PeopleSoft connection profile in the CCM, which enables you to
define a PeopleSoft job in Control-M/Desktop.
 To create a connection profile:
1. From the CCM, select CM (PS8), right-click and select Connection Profile Management.
The Control-M for PeopleSoft Connection Profile Management dialog box appears.
2. Click the icon.
The Add Connection Profile dialog box appears.
3. In the Connection Profile Name field, type the name of the connection profile that you want to add
(the connection profile name must be without any blanks or special characters).
4. For each field, type the required value, as described in Control-M for PeopleSoft connection profile
parameters (on page 20).
5. In the Application Servers field, click the icon.
The Add PeopleSoft Application Server dialog box appears.
6. In the Application Server field, type the name of the application server.
7. In the Jolt Port field, type the port number of the application server.
8. Click OK.
9. Review the connection profile details and click Test (optional).

20
If the test completes successfully, you can now define a PeopleSoft job, as described in Defining a
Control-M for PeopleSoft job (on page 31). If the test fails, review the error message and test it again.
10. Click Finish.
The connection profile is added to the Control-M for PeopleSoft Connection Profile Management
dialog box.
11. Copy the psjoa.jar file from the PeopleTools client machine at
<peopletools>/web/psjoa/psjoa.jar to the <ctmagent>/ctm/cm/PS8/java/<PeopleTools
release> directory.
Control-M for PeopleSoft connection profile parameters
The following table lists the connection detail parameters to add a connection profile.
Field Description
Connection Profile
Name
Defines the name of the connection profile
PeopleTools Version Defines your PeopleTools version
Valid Value for People Tools version should be in the format of
<major.minor>, such as 8.48, or 8.52. The exact version should be
provided by the PeopleSoft administrator.
User Name Defines the username for the PeopleSoft server
Password Defines the password for the PeopleSoft server
Confirm Password Confirms the password for the PeopleSoft server
Domain Password Defines the password for PeopleSoft domain (for PeopleTools Version
8.51 or later)
Confirm Domain
Password
Confirms the password for PeopleSoft domain (for PeopleTools Version
8.51 or later)
Application Server Defines the name of the PeopleSoft application server
Jolt Port Defines the jolt port number of the PeopleSoft application server
Editing a connection profile
This procedure describes how to edit a connection profile in the CCM.

21
 To edit a connection profile:
2. Select a connection profile that you want to edit and click the icon.
The Update Connection Profile <connection profile> dialog box appears.
3. For each field, type the required value, as described in Control-M for PeopleSoft connection profile
parameters (on page 20).
4. Review the connection profile details and click Test (optional).
5. Click OK.
The connection profile is updated in the Control-M for PeopleSoft Connection Profile
Management dialog box.
Deleting a connection profile
This procedure describes how to delete a connection profile from the CCM.
 To delete a connection profile:
2. Select a connection profile that you want to delete and click the icon.
A confirmation message appears.
3. Click Yes.
The connection profile is deleted.
Testing a connection profile
This procedure describes how to test a connection profile and to validate the connection parameters in the
CCM.
 To test a connection profile:
2. Select a connection profile that you want to test and click the icon.

22
Copying a connection profile
This procedure describes how to copy a connection profile in the CCM, which enables you to create an
additional connection profile using the parameters of an existing connection profile.
 To copy a connection profile:
2. Select a connection profile that you want to copy and click the icon.
The Copy Connection Profile <connection profile> dialog box appears.
3. In the Connection Profile Name field, type a name for the new connection profile and click OK.
If you want to change parameters to this connection profile, see Editing a connection profile (on page
20).
4. Click Test (optional).
5. Click OK.
Exporting a connection profile
This procedure describes how to export a connection profile from one Control-M/Agent to another
Control-M/Agent, where Control-M for PeopleSoft is installed.
 To export a Connection Profile:
2. Select a Connection Profile that you want to export and click the icon.
The Export Connection Profile dialog box appears.
3. From the Control-M/Server Name dropdown list, select the Control-M/Server that contains the
Control-M/Agent, where you want to export the connection profile.
4. From the Control-M for PeopleSoft Host dropdown list, select the Control-M/Agent that you want to
export the Connection Profile to.
5. Click OK.
The Export Connection Profile <connection profile> dialog box appears.
6. In the Connection Profile Name field, type a name for the exported connection profile and click OK.
NOTE: To change parameters for this Connection Profile, see Editing a connection profile (on page 20).
7. Click Test (optional).

23
8. Click OK.
Configuring Control-M for PeopleSoft settings
This procedure describes how to configure the Control-M for PeopleSoft settings through the configuration
management utility.
 To configure the Control-M for PeopleSoft settings:
1. From the CCM, select CM (PS8), right-click and select Configuration Management.
The Control-M for PeopleSoft Configuration Management dialog box appears.
2. Change the configuration parameters as required, which are described in Configuration parameters (on
page 23).
3. Select Debug Tracing, if debugging needs to be traced.
4. Select Validate Run Control, if you require run control to exist during job submission.
5. Click OK.
6. If any of the parameters change, you may be prompted to recycle Control-M for PeopleSoft. If so, a
Configuration Management dialog box appears.
NOTE: If you do not recycle at this stage, you need to shut down manually, as described in Shutting
down Control-M for PeopleSoft (on page 30).
7. Click Yes.
A Control-M for PeopleSoft dialog box appears, which confirms that the recycle request completed
successfully.
Configuration parameters
Configuration Management parameters in Control-M for PeopleSoft enable you to set values for variables, as
described in Configuring Control-M for PeopleSoft settings (on page 23).
The following table describes the parameters for Control-M for PeopleSoft.
Parameter Description
Port Defines the port number of Control-M for PeopleSoft
Valid values: 1024-65535
Concurrent Request
Limit
Defines the maximum number of requests that are allowed at one time
Valid values: 1-300
Concurrent
Connections Limit
Defines that maximum number of connections that are allowed at one
time
Valid values: 1-50

24
Connection Restore
Retries
Defines the number of times that the application tries to reconnect if
connection fails
Valid values: 1-600
Java Path UNIX only: Defines the path to Java used by Control-M for PeopleSoft
Valid Values: 1-500 characters
Debug Tracing Defines whether debug messages are recorded in the log
Validate Run Control Defines whether the existence of Run Control (which is specified in
Defining a Control-M for PeopleSoft job (on page 31)) should be
checked before the job is submitted. If Run Control is not defined and
the option is checked, the job fails.
Chapter
Control-M for PeopleSoft psftcm utility
This Section describes the Control-M for PeopleSoft psftcm utility in UNIX and Windows. To access the psftcm
utility in UNIX, you need to log in as Control-M/Agent user. In Windows, you need to open a MS-DOS window.
NOTE: Microsoft Windows: If more than one Control-M/Agent is installed, you should type the full path to
the psftcm utility, <Control-M/Agent installation path>CMPS8javapsftcm.bat
You can use the psftcm utility to do the following:
 Test the connection profile through the psftcm diag utility, as described in Testing the connection profile
through the psftcm diag utility (on page 25).
 Test the status of Control-M for PeopleSoft through the psftcm ping utility, as described in Testing the
status of Control-M for PeopleSoft through the psftcm ping utility (on page 25).
 Change the connection profile password through the psftcm password utility, as described in Changing
the connection profile password through the psftcm passwd utility (on page 25).
 Extract a job through the psftcm extract utility, which enables you to monitor and control a current
executing job or process by extracting information about the job and/or to create a new job. The utility
also enables you to build a Control-M job definition based on the original and form folders, as described
in Control-M for PeopleSoft Job extraction (on page 26).
 Shut down Control-M for PeopleSoft through the psftcm shut utility, as described in Shutting down
Control-M for PeopleSoft (on page 30).

25
Testing the connection profile through the psftcm diag utility
This procedure describes how to test the Connection Profile through the psftcm diag utility. This utility
enables you to make a comprehensive assessment of the connection profile. It is possible to run the utility
through batch mode.
 To Test the Connection Profile through the psftcm diag utility:
1. Type psftcm diag.
The psftcm diag box appears.
NOTE: To run the utility in batch mode, type psftcm diag <connection profile>.
2. Select the Connection Profile to test.
The diagnostic utility screen appears.
NOTE: If the port is busy, but Control-M for PeopleSoft is not running, a message appears asking to
change port.
3. Type q to quit.
Testing the status of Control-M for PeopleSoft through the
psftcm ping utility
This procedure describes how to test the status of Control-M for PeopleSoft through the ping utility. This
utility enables you to see if Control-M for PeopleSoft is running.
 To Test the status of Control-M for PeopleSoft through the psftcm ping utility:
1. Type psftcm ping.
The psftcm ping output appears.
Changing the connection profile password through the
psftcm passwd utility
This procedure describes how to change the Connection Profile password through the psftcm passwd utility.
 To change the Connection Profile password through the psftcm passwd utility:
1. From the command line, type psftcm passwd <profile name> <old password> <new
password>.
2. Recycle Control-M for PeopleSoft as described in Shutting down Control-M for PeopleSoft (on page 30).
The connection profile password has successfully changed.

26
Control-M for PeopleSoft Job extraction
The Control-M for PeopleSoft psftcm extract utility enables you to monitor and control a current executing
job or process by extracting information about the job and/or to create a new job in Control-M. See:
Extracting an executing job or process (on page 29)
The extract utility can also extract job or process definitions from PeopleSoft to Control-M, which enables you
to build a Control-M job definition based on the original and form tables using these definitions. See:
Extracting job or process definitions (on page 30).
Before performing either of the above procedures, you must build a Rule File. See Building a rule File (on
page 26).
NOTE: When a Control-M for PeopleSoft job executes with matching criteria specified in the rule file, no
duplicate image is created, unless Control-M for PeopleSoft stops and restarts.
If the Extract utility runs twice in 24 hours, extracted jobs cannot extract again.
Building a rule File
This procedure describes how to build a rule file with the psftcm extract utility. Rule files are used as an input
for the utility.
 To build a rule file:
1. Open a new file with an editing tool application, such as Notepad.
2. Depending on your requirements, select one of the following:
• Extract a current executing job or process, as described in: Rule file for extracting current executing
job or process (on page 26)
• Extract a job or process definition, as described in: Rule file for extracting job or process definitions
(on page 27)
Rule file for extracting current executing job or process
The following XML rule file structure describes the information, which extracts from the current executing
PeopleSoft job or process.
<rules>
<action>execution</action>
<profile>profile</profile>
<filter>
<jobname>jobname</jobname>
<prcsname>processname</prcsname>
<jobinstance>number</jobinstance>
<prcsinstance>number</prcsinstance>
<userid>id</userid>

27
</filter>
<outcondition>
<request>ADD/DEL</request>
<name>condname</name>
<odate>orderdate</odate>
</outcondition>
<nodegrp>nodegroup</nodegrp>
</rules>
The following table describes the rule file parameters for extracting a current executing job or process.
Rule File
Parameters
Description
profile Defines the name of the connection profile, which must be defined in
Connection Profile management in the CCM
jobname Defines the name of the job
prcsname Defines the name of the process
jobinstance Defines the instance number of the executing job
prcsinstance Defines the instance number of the executing process
userid Defines PeopleSoft user ID
NOTE: When extracting an executing job or process, Control-M for PeopleSoft uses default values for these
parameters (where applicable).
Rule file for extracting job or process definitions
The following XML rule file structure describes the information, which extracts from PeopleSoft job or process
definitions.
<rules>
<action>definition</action>
<profile>profile</profile>
<userid>id</userid>
<filter>
<jobname>jobname</jobname>
<prcsname>processname</prcsname>
<userid>userid</userid>
</filter>

28
<table>table</table>
<application>application</application>
<group>group</group>
<nodegrp>nodegroup</nodegrp>
<runcntlid>runcontrolid</runcntlid>
<runlocation>runlocation</runlocation>
<outdestformat>output destination format</outdestformat>
<outdesttype>output destination type</outdesttype>
<outdest>output destination format</outdest>
<incondition>
<request>and/or</request>
</incondition>
<outcondition>
<request>add/del</request>
</outcondition>
</rules>
The following table describes the rule file parameters for extracting job or process definitions.
Rule File
Parameter
Description
table Defines the Scheduling Table
application Defines the name of the application where the job's group belongs. This
determines the position of the job in the Application/Group hierarchy
group Defines the name of the group where the job belongs. This determines
the position of the job in the Application/Group hierarchy
nodegrp This is the logical name of the note group that processes the job. When
you select the Application Node group, it determines the values for the
Application Type, Application Version, and Control Module version
parameters.
If the parameter has no value, the Control-M/Agent's computer host
name is used.

29
userid Defines the name of the PeopleSoft user who runs the job
runcntlid Defines the Run control ID
runlocation Defines the location of the job
outdestformat Defines the Output destination format
outdesttype Defines the Output destination type
outdest Defines Output destination
request Defines the outcondition or incondition sub-parameters
The outcondition version sub-parameter, indicates whether to add or
delete a post processing condition.
Valid values: ADD or DEL
The incondition version sub-parameter, specifies the preprocessing
condition.
Valid values: AND or OR
name Defines the name of the specified condition
odate Defines the original scheduling date of the job. For More information
see the Control-M Parameters Guide
NOTE: When you extract a definition, the following parameters are mandatory:
 table
 application
 group
 runcntlid
 userid
 See Rule file for extracting current executing job or process (on page 26) for further parameters.
Extracting an executing job or process
This procedure describes how to monitor PeopleSoft jobs or processes that are running and perform
post-processing activities according to the job process status upon completion.
Before you begin
Ensure that you have completed the steps, as described in Building a rule File (on page 26).
 To extract an executing job or process:

30
psftcm extract <rule_file_name> <output_file_name> [-agent <agent name>]
NOTE: <output_file_name> refers to a file created by this utility, which contains a ctmcreate
command for each extracted job or process. In case -agent is not specified, the ctmcreate command is
executed by the default Control-M/Agent. For more information about ctmcreate commands, see the
Control-M Utilities Guide.
In Microsoft Windows, the output file must have a .bat extension.
2. Open the output file and verify that the results are identical to your specifications in the rule file.
3. You can edit the output file manually.
4. Run the output as a script by typing one of the following commands:
• UNIX: sh <output file name>
• Microsoft Windows: <output file name.bat> and click Enter.
Extracting job or process definitions
The procedure describes how to extract jobs or process definitions from PeopleSoft to Control-M and enables
you to build Control-M job definitions based on the original PeopleSoft definitions and from Scheduling tables
using these definitions.
Before you begin
Ensure that you have completed the steps, as described in Building a rule File (on page 26).
 To extract job or process definitions:
psftcm extract <rule_file_name> <output_file_name> [-agent <agent name>]
NOTE: <output_file_name> refers to a file created by this utility, which contains a ctmdefine
command for each extracted job or process. In case -agent is not specified, the ctmdefine command is
executed by the default Control-M/Agent. For more information about ctmdefine commands, see the
Control-M Utilities Guide.
Microsoft Windows: The output file must have a .bat extension.
2. Open the output file and verify that the results are identical to your specifications in the rule file.
3. You can edit the output file manually.
4. Run the output as a script by typing one of the following commands:
• UNIX: sh <output file name>
• Microsoft Windows: <output file name.bat> and click Enter.
Shutting down Control-M for PeopleSoft
This procedure describes how to shut down Control-M for PeopleSoft by using the psftcm shut utility.
 To shut down Control-M for PeopleSoft:
1. From the command line, type psftcm shut.

31
2. Control-M for PeopleSoft shuts down.
Control-M for PeopleSoft starts automatically on the next Control-M/Agent request.
Chapter
Control-M for PeopleSoft job definition
Control-M for PeopleSoft is a control module that enables the definition of scheduling criteria for PeopleSoft
jobs and processes and the monitoring of these jobs while they execute in the PeopleSoft environment. It
enables you to define jobs, as described in Defining a Control-M for PeopleSoft job (on page 31).
Control-M for PeopleSoft jobs are integrated with other Control-M jobs into a single scheduling environment.
Control-M capabilities are available for Control-M for PeopleSoft, including advanced scheduling criteria,
complex dependencies, quantitative and control resources.
To access the PeopleSoft form, see Accessing the PeopleSoft form (on page 31).
Job definition parameters in Control-M for PeopleSoft enable you to apply values for variables, as described
in the Control-M User Guide. For a list of Control-M for PeopleSoft parameters, see Control-M for PeopleSoft
Parameters (on page 34).
Accessing the PeopleSoft form
This procedure describes how to access the PeopleSoft form, which enables you to define a PeopleSoft job.
 To access the PeopleSoft form:
1. Log in to Control-M/Desktop, as described in the Control-M User Guide.
2. From the Edit menu, select New > Job.
3. From the Job Type dropdown list, select PeopleSoft.
4. Click the PeopleSoft tab.
The PeopleSoft form appears.
Defining a Control-M for PeopleSoft job
This procedure describes how to define a Control-M for PeopleSoft job, which enables you to run PeopleSoft
jobs on a PeopleSoft server.
Before You Begin
Ensure that you have met the following requirements:
 A configured PeopleSoft connection profile, as described in CCM administration.
 Successful completion of Accessing the PeopleSoft form (on page 31).
 To define a PeopleSoft job:
1. In the Connection Profile field, type the required connection profile or click Select.
2. In the User ID field, type a PeopleSoft user ID that exists in the PeopleSoft Environment.

32
3. In the Run Control ID field, type the required Run Control ID or click Search.
4. In the Server Name field, type a server name to run the PeopleSoft job or process or click Select.
5. In the Process Type field, type the process type for the job type that you are authorized to perform or
click Search.
6. In the Process Name field, type the process name for the available job names that you are authorized
to perform or click Select and Edit.
7. To edit the job or process click Edit Current Process.
The Process dialog box appears.
NOTE: Select and Edit enables you to load and edit the job or process. Edit Current Process
enables you to edit without loading the job or process. Both options allow you to edit PeopleSoft
parameters, such as output type, format, destination and distribution methods. For more information,
see PeopleSoft documentation.
8. To view the output report through a PeopleSoft web interface, from the Process dialog box, do the
following:
• Set the Type field to Web.
• In the Output Destination field, (optional) enter one of the following:
o User: <username>
o Role: <rolename>
o User: <username>; Role: <rolename>
o If nothing is selected, Control-M for PeopleSoft uses defaults that are defined in Run Control.
• In the Portal Folder field, type the name of the PeopleSoft portal folder.
• Click OK to return to the PeopleSoft Form.
9. To change parameters for the job click Advanced. See Specifying and sharing data (on page 32).
10. To append output to Sysout, select the checkbox.
11. Click Save.
12. To continue defining a job, see the Control-M User Guide.
Specifying and sharing data
This procedure describes how to share data between Control-M and a PeopleSoft job or process. You can
enter parameters, such as variables or PeopleSoft constants according to your requirements (for example,
filename). These parameters enable you to create different Control-M for PeopleSoft jobs that correspond to
the same process, but with different parameters for iteration.
Before You Begin
Create a Control-M for PeopleSoft job or process, as described in Defining a Control-M for PeopleSoft job (on
page 31).
 To share data between Control-M and PeopleSoft:
1. In the PeopleSoft form, click Advanced.

33
The Advanced window appears.
2. Type the required parameters in the Bind Variable (USERDEF) fields.
EXAMPLE: To redefine the user-defined value in the PeopleSoft process by using USERDEF1, do the
following:
From the ProcessScheduler, process definition, select:
Override Options > Parameter List > Override
To replace the database type do the following:
Override Options > Parameter List, set CT: CONTROLM.USERDEF1.
From the PeopleSoft form Advanced window type your database type, such as Oracle in the
USERDEF1 field.
3. Click Save.
The job adds to the specified scheduling table.
Monitoring a PeopleSoft process or job
This procedure describes how to monitor the status of an ordered job or process in Control-M/EM.
Before you begin
Ensure that you do the following:
 You have ordered a job in Defining a Control-M for PeopleSoft job (on page 31).
 Control-M/EM is running.
 To monitor a PeopleSoft process or job:
1. In Control-M/EM, click the job that you want to monitor.
The job editing form appears.
2. Click the PeopleSoft tab.
The PeopleSoft panel appears.
3. When a job or process is running click Refresh to see how the job or process is progressing.
NOTE: If there is no data, an error message appears, and you must close and reopen the Job Editing
Form.
4. Click Details .
The job process details window appears.
5. To update the process, click one of the following:
• Hold Request: This enables you to hold or pause a queued job.
• Restart Request: This enables you to resubmit or queue a job after holding.
• Delete Request: This deletes the job from the PeopleSoft database.
 To kill a job select the kill option in Control-M/EM.

34
Control-M for PeopleSoft Parameters
Job definition parameters in Control-M for PeopleSoft enable you to set values for variables, as described in
the Control-M User Guide.
The following table describes the parameters for the Control-M for PeopleSoft.
Connection profile
(on page 35)
Defines a set of connection attributes between Control-M for
PeopleSoft and a PeopleSoft application server
Email subject (on
page 36)
Refers to an email message subject line that is sent by the job
Email text (on page
36)
Refers to message text displayed in the body of an email message
Email web report (on
page 37)
Specifies whether to attach the web report to the email sent at the
completion of this job. This parameter is set only when the Type
parameter for the request is Web.
Email with log (on
page 37)
Specifies whether to attach the log file to the email sent at the
completion of this job
Format (on page 37) Defines the output format for all job processes
Process name (II)
(on page 38)
Defines the name of the scheduled process
Process name (II)
(on page 38)
Defines the name of the scheduled job
Process type (on
page 39)
Defines the type of process for the process or job definition
Rerun from step (on
page 39)
Refers to when a job reruns from a specific process number, which has
previously failed
Run control ID (on
page 40)
Defines run control attributes, which are associated with a process or
job
Server name (on
page 40)
Defines the name of the PeopleSoft server used for running the process
or job
Type (on page 41) Defines the output destination type of a process or a job
User ID (on page 41) Defines the PeopleSoft user ID name used for the process or job

35
Userdef1-20 (on
page 42)
Refers to user defined parameters that are available for the PeopleSoft
process or jobs
Connection profile
Defines the name for a set of attributes of a connection between Control-M for PeopleSoft and the PeopleSoft
application server
The following table describes the parameters for connection profile.
Additional
Information
Description
Usage Mandatory
Length 1 - 50 characters
Case Sensitive Yes
Valid Characters Blanks . - _ 0-9 a-z A-Z
Default None
Variable Name %%PS8-CON_PROFILE
A connection profile defines the connection attributes between Control-M for PeopleSoft and a PeopleSoft
environment. The connection profile must exist before it is specified in a job.
The connection profile contains the following parameters and the optional parameter domain password:
 Connection profile name
 PeopleSoft user name
 PeopleSoft password
 PeopleSoft server name
 PeopleSoft server port
 PeopleTools version
The PeopleSoft user name specified in the profile must have authorization to handle all PeopleSoft jobs and
processes in the PeopleSoft environment.
To manage connection profiles, see Connection profile management (on page 19).
NOTE: During the Control-M for PeopleSoft installation, an existing Control-M for PeopleSoft environment
file can be converted to a connection profile.

36
Email subject
Indicates the subject line for an email message that is sent by the job
The following table describes the parameters for email subject.
Additional
Information
Description
Usage Optional. Available if the Type parameter is set to Email.
Length 1- 50 characters
Case Sensitive No
Variable Name %%PS8-EMAIL_SUBJECT
When the Type parameter in the Distribution window is set to Email, use the Email Subject parameter to
enter the subject line for the email message produced by the job. The text must not exceed 50 characters.
For more information, see Type (on page 41).
Email text
Defines the body of an email message that is sent by the job
The following table describes the parameters for email text.
Additional
Information
Description
Case Sensitive No
Variable Name %%PS8-EMAIL_TEXT
When the Type parameter in the Distribution window is set to Email, use the Email Text parameter to
enter the message text for the email message produced by the job. The text must not exceed 250 characters.
For more information, see Type (on page 41).

37
Email web report
Specifies whether to attach the web report to the email sent at the completion of this job
The following table describes the parameters for email web report.
Additional
Information
Description
Usage Optional. Available if the Type parameter is set to Web.
Variable Name %%PS8-EMAIL_WEB_REPORT
This parameter is set to Web when the OutDestType property for the request is sent.
Email with log
Defines the attached log files generated by the SQR program to an email message that is sent by the job
The following table describes the parameters for email with log.
Additional
Information
Description
Specifies whether to attach the log file to the email sent at the
completion of this job
Variable Name %%PS8-EMAIL_ATTACH_LOG
When the Type parameter in the Distribution window is set to Email, use the Email With Log parameter to
include log files as an attachment to the email message produced by the job. The Structured Query Report
(SQR) program generates the log file when SQR is selected as the Process Type for the job.
Format
Indicates the output format for all processes in a job
The following table describes the parameters for format.
Additional
Information
Description
Usage Optional
Variable Name %%PS8-OUTDESTFORMAT
Lists the format types that are available for the specified Process Type and Type parameters.

38
NOTE: Valid values for this parameter correspond to values for a PeopleSoft job. For more information about
the Format parameter, see your PeopleSoft Process Scheduler manual.
Process name (I)
Name of the process to be scheduled
The following table describes the parameters for process name (I).
Additional
Information
Description
Usage Mandatory
Case Sensitive Uppercase only
Invalid Characters Blanks
Variable Name %%PS8-PRCSNAME
Enter a name in the text box field or click Select and Edit to display a list of process names that have been
defined.
Process name (II)
Name of the job to be scheduled
The following table describes the parameters for process name (II)
Additional
Information
Description
Usage Mandatory
Case Sensitive Uppercase only
Variable Name %%PS8-JOBNAME
Enter a name in the text box field or click Select and Edit to display a list of job names that have been
defined.

39
Process type
Indicates the type of process for the process or job definition
The following table describes the parameters for process type.
Additional
Information
Description
Usage Mandatory
Case Sensitive Yes
Invalid Characters None
Variable Name %%PS8-PRCSTYPE
A global definition under which related processes or jobs definitions are grouped. Enter a name in the text
box field or click Search to display a list of process types.
Examples of process types are COBOL, Crystal, SQR, and Application Engine.
Rerun from step
Rerun a job from a specific process number
The following table describes the parameters for rerun from step.
Additional Information Description
Usage Optional
Value Integer
Variable Name %%PS8-FAILEDSTEP
The process or job must have run and ended. Jobs that ended successfully can be run.
Jobs that contain more than one process, and did not end successfully, can be rerun from a specified process
number. For more information about rerunning a job from a failed process, see the Control-M User Guide.

40
Run control ID
Run control attributes that are associated with a process or job
The following table describes the parameters for run control ID.
Additional
Information
Description
Usage Mandatory
Case Sensitive Yes
Variable Name %%PS8-RUNCONTROLID
The Run Control ID and User ID parameters, identify the process that is running. This enables required
parameters to be available for a process when it runs. Enter an ID in the text box field or click Search to
display a list of IDs.
Server name
Identifies the name of the server to be used for running the process or job
The following table describes the parameters for server name.
Additional
Information
Description
Usage Optional
Case Sensitive Yes
Default None
Variable Name %%PS8-SERVERNAME
The name of the server depends on the Connection Profile parameter. The Server Name parameter identifies
the name of the application server on which the process or job is scheduled to run.
To specify the Server Name parameter, enter a name in the text box field or click Select to display a list of
existing server names.

41
Type
Output destination type, specifying the file path, printer destination, URL, or email address
The following table describes the parameters for type.
Usage Optional
Default File
Variable Name %%PS8-OUTDESTTYPE
The output destination types available for the Type parameter depend on the process specified with the
Process Type parameter. For example, if SQR is specified for the Process Type parameter, you can select one
of the following output destination types:
 Email
 File
 Printer
 Web
Additional distribution information must be specified when the output type is either Email or Web. When the
output type is Web, select a folder name to which the output should be distributed.
User ID
PeopleSoft user ID of the user authorized to submit the process or job
The following table describes the parameters for user ID.
Usage Mandatory
Case Sensitive Yes
Variable Name %%PS8-USERID
The PeopleSoft user with the specified User ID must be authorized to run the specified process or job.
Control-M has a security mechanism that ensures that requesters cannot submit a job that they are not
authorized to do so. In addition, when building a job processing definition, the selection list of possible jobs
and processes is limited by the user’s authorization in PeopleSoft.

42
This parameter is mapped to the Control-M/EM Owner parameter. For more information, see Control-M
Parameters Guide.
Userdef1-20
Specify Control-M data to be shared with PeopleSoft processes or jobs
The following table describes the parameters for userdef1-20.
Additional
Information
Description
Usage Optional
Case Sensitive No
Invalid Characters None
Variable Name %%PS8-USERDEF1-20
This parameter enables you to specify and share data from Control-M for PeopleSoft processes or jobs. You
can enter variables or constants, according to your requirements (for example, filename).
User-defined values are made available to your application by accessing userdef(x) in the Control-M record.
NOTE: You can create a number of Control-M for PeopleSoft jobs that correspond to the same process, but
with different parameters.

3
Conversion of PeopleSoft option jobs to
Control-M for PeopleSoft jobs
This section describes how to change PeopleSoft option jobs to Control-M for PeopleSoft jobs. These jobs
should be converted to enable you to use all of Control-M functionalities for PeopleSoft jobs, including
advanced scheduling criteria, complex dependencies, quantitative and control resources, and variables.
Converting PeopleSoft Option Jobs to Control-M for
PeopleSoft Jobs
This procedure explains how to convert PeopleSoft Option Jobs to Control-M for PeopleSoft Jobs.
NOTE: This procedure is only available from the installation DVD.
Before You Begin
Ensure the following:
 You have installed Java JRE 1.5 or later
 Control M/Enterprise Manager Server for Windows or Client is installed
 You have downloaded Control-M Table to Control-M/Enterprise Manager
 To Convert PeopleSoft Option Jobs to Control-M for PeopleSoft Jobs:
1. Log in to Control-M Enterprise Manager Server or Client.
2. Create a temporary directory C:PS_OPTION on your computer.
3. Mount the installation DVD.
4. Copy the following files to C:PS_OPTION folder:
• All files from <DVD_Root>Conversion folder
• <Control-M/Enterprise Manager home><instance>DataResourcedefjob.dtd
• <Control-M/Enterprise Manager home><instance>DataResourcedeftable.dtd
5. Create a new directory C:PS_OPTIONENVFILES
6. Copy all existing Control-M Option for PeopleSoft ENV files to the new directory referred to in step 5.
7. Navigate to <Control-M/Enterprise Manager home><instance>bin directory.
8. Execute one of the following utilities to export the Control-M Option for PeopleSoft to an output file:
• ExportDefJob.exe
• ExportDeftable.exe
NOTE: The OUT_FILE should be set relative to the C:PS_OPTION folder, created in step 2.
9. Navigate to the temporary folder created in step 2 and execute the following command:

ctmpsconvert <exported job def file> <converted output file name> <path to ENV files>
The ctmpsconvert execution screen appears and ctmpsconvert log file ConvertJobs.log is created in the
current executing directory.
EXAMPLE: Assuming the exported output file resides in C:PS_OPTIONLegacyJobDef.txt and the
directory where the ENV files are stored is C:PS_OPTIONENVFILES, the ctmpsconvert
execution command should be as follows:
ctmpsconvert C:PS_OPTIONLegacyJobDef.txt convertedJobDEF.txt
C:PS_OPTIONENVFILES
The output appears as follows:
Convert Jobs Utility begins 11/30/10 15:28:03:405
Total jobs = 1
Total converted jobs = 1
Convert Jobs Utility ends 11/30/10 15:28:03:535
10. Import the converted job definitions from the <converted output file name> by navigating to the
<Control-M/Enterprise Manager home><instance>bin directory and executing the defjob or deftable
utility (see the Control-M Utilities Guide for more information).
The Connection Profile field in the PeopleSoft job is set according to the ENV file as
<hostname>_<port>_<user>
NOTE: Ensure that the names for Connection Profiles in Control-M for PeopleSoft match the names in
the ENV file.

Cm peoplesoft admin

Recommended

Recommended

More Related Content

Similar to Cm peoplesoft admin

Similar to Cm peoplesoft admin (20)

Recently uploaded

Recently uploaded (20)

Cm peoplesoft admin