SAP 6201 Admin Guide
SAP 6201 Admin Guide
SAP 6201 Admin Guide
for SAP
Administrator Guide
Supporting
CONTROL-M/Control Module for SAP version 6.2.01
Telephone
Fax
Fax
Copyright 2005 BMC Software, Inc., as an unpublished work. 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.
All other trademarks belong to their respective companies.
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.
Customer support
You can obtain technical support by using the Support page on the BMC Software website or by contacting Customer
Support by telephone or e-mail. To expedite your inquiry, please see Before Contacting BMC Software.
Support website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at
http://www.bmc.com/support_home. From this website, 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
product information
product name
product version (release number)
license number and password (trial or permanent)
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
messages received (and the time and date that you received them)
Contents
Chapter 1
Introduction
11
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
More about CONTROL-M . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
An overview of SAP job scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using CONTROL-M to schedule SAP jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring and controlling SAP jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTROL-M and SAP job statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Defining and scheduling new SAP jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
XBP 2.0 functionality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTROL-M solution for Business Information Warehouse . . . . . . . . . . . . . . . .
CONTROL-M solution for Data Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12
13
14
15
15
15
16
16
17
17
18
19
Chapter 2
25
Installation
26
29
31
31
33
34
36
37
37
37
40
40
42
42
Chapter 3
45
45
49
49
51
60
73
75
5
Administrator tasks
99
141
Index
149
151
Figures
SAP panel, Job Editing form (Job Definition mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Add ABAP dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Change variant dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
External command dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
External program dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
SAP panel, Job Editing form (Active Job mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
SAP panel for Data Archiving, Job Editing form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
SAP panel for Data Archiving, Job Editing form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
SAP panel for BW - InfoPackage, Job Editing form . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
SAP panel for BW - Process Chain, Job Editing form . . . . . . . . . . . . . . . . . . . . . . . . . . 92
SAP-BW panel - InfoPackage (Active Job mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Configuration management window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Xtractor management - general configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Xtractor management - select SAP account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
SAP Interception Criteria panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Figures
Tables
SAP authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
RFC library details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
XBP BAPIs versus CONTROL-M function modules . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SAP-BW BAPIs versus CONTROL-M function modules . . . . . . . . . . . . . . . . . . . . . . . 40
Job skeleton field values (recommended) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
SAP panel parameters - Job Definition mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Add ABAP dialog box parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Change Variant subparameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Variant options for selection and range types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
External Command dialog box parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Add External Program dialog box parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Additional SAP panel parameters - Active Job mode . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Data-archiving SAP panel parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
SAP-BW job panel parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Additional SAP-BW panel parameters - Active Job Mode . . . . . . . . . . . . . . . . . . . . . . 97
Account configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Configuration parameters for the ctmr3cfg utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
CTM interception rules parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Parameters for avoiding discarded intercepted jobs . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Extraction rules panel parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Rules Viewer parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
User Exit script parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Parameters for var_mon action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Parameters for var_edit action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Parameters for var_show action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Parameters for raise_event action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Parameters for job_delete action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Parameters for job_define action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Parameters for job_modify action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ctmr3req interrupt parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Conversion utility parameter description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Problem parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Rule file AutoEdit parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Mandatory parameters for ctmcreate and ctmdefine . . . . . . . . . . . . . . . . . . . . . . . . . 145
Parameters for monitoring a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Known SAP Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Tables
10
Chapter
Introduction
Batch processing and background job scheduling play a key part when working with
the SAP application. Working closely with SAP, CONTROL-M created a batch
management solution for SAP users. This solution is CONTROL-M Control Module
for SAP (CONTROL-M/CM for SAP), which provides a complete and SAP-certified
interface between CONTROL-M and the specific SAP environment.
CONTROL-M/CM for SAP also greatly increases batch processing and existing
scheduling capabilities in SAP as follows
a user-friendly GUI, in which you can easily view the job flow
the ability to control the workload using logical or real resource availability
Chapter 1
Introduction
11
Terminology
archive and delete older data as required, using the CONTROL-M solution for SAP
Data Archiving
use SAP advanced load-balancing mechanism, such as Logon Groups and Job
Server Group
Other SAP-related functionality is described later in the book, including defining new
SAP jobs and raising events, among others.
Terminology
The following table lists abbreviations and terms used in this document:
:
12
Term
Description
ABAP
SAP Server
Computer on which the SAP Application server runs. This can also
be the same computer on which CONTROL-M/Agent runs.
SAP Client
SAP Note
BAPI
Term
Description
BC-XBP (External
Interface for Job
Background
Processing)
For more information about the XBP 2.0 interface, see SAP Note
6044996.
CONTROL-M
function modules
Spawned job
Parent job
I/P
Administrator
Workbench
CONTROL-M/EM
CONTROL-M/Enterprise Manager.
FixPack
Chapter 1
Introduction
13
Related Publications
Product
Description
CONTROL-M/Enterprise
Manager
CONTROL-M/Server
CONTROL-M/Agent
Related Publications
14
Description
Scheduled
Released
The job is defined with scheduling criteria, but the scheduling criteria have
not been met.
Ready
Scheduling criteria have been met. The job is waiting for a resource.
Active
Canceled
Finished
Running jobs
SAP jobs can be executed in any of the following ways:
For more information about how to define a SAP job, see Chapter 3, Defining and
monitoring SAP jobs in CONTROL-M.
Chapter 1
Introduction
15
After the job starts to run, CONTROL-M/CM for SAP monitors the SAP system to
check the status of the job. As the job progresses, its status is updated in the
CONTROL-M database and in CONTROL-M/EM viewpoint. In addition to
monitoring the running job, CONTROL-M can also cancel it in SAP, if necessary.
For more information about controlling jobs from within CONTROL-M/EM, see the
CONTROL-M/Enterprise Manager User Guide.
When the job ends, CONTROL-M/CM for SAP provides CONTROL-M/EM with the
SAP job output for each request. The SAP job log and the SAP job spool are copied to
the job sysout or to files if required. Post-processing mechanisms can then be
activated in CONTROL-M/EM.
Executing
Scheduled
Released
Ready
Active
Ended OK
Finished
Ended NOTOK
Canceled
The SAP job status can be seen in CONTROL-M/EM, in the SAP panel of the Job
Editing form, in the SAP Job Status field.
16
intercept SAP jobs (not created by CONTROL-M) through CONTROL-M, and then
activate these jobs according to CONTROL-M parameters
For more information, see Job interception and control with the Xtractor process
on page 110.
create mirror-image jobs in CONTROL-M, using various criteria that set which
currently running jobs are to be mirrored in CONTROL-M (using the Extraction
functionality)
For more information, see Extracting and monitoring SAP CCMS jobs with the
Xtractor on page 116.
Chapter 1
Introduction
17
18
automate all phases of Data Archiving, including SAP-owned jobs and other
business processes
Data Archiving sessions are monitored and managed from the CONTROL-M/EM
GUI. Each session is a separate entity in itself. Prerequisites and post-processing
instructions can be set for each session. A Data Archiving session can be scheduled to
run periodically, by assigning it specific scheduling parameters.
Chapter 1
Introduction
19
A Write job creates and starts a new archiving session, and copies data from the
SAP database to archive files.
A Detect Delete job detects Delete jobs created in SAP. It adds them to a group
scheduling table, which is then inserted into the Active Jobs file, to be run
according to the definition of the Detect job.
A Detect Store job detects Store jobs created in SAP. It adds them to a group
scheduling table, which is then inserted into the Active Jobs file, to be run
according to the definition of the Detect job.
CONTROL-M/CM for SAP transfers the session number of a Write job to the
corresponding Detect job, to ensure that it only handles jobs that belong to the
appropriate session.
NOTE
Avoid changing the job definition of a Detect job in CONTROL-M, while it is running. Doing
so causes the corresponding Store or Delete jobs to be ordered according to this new definition
of the Detect job.
20
NOTE
This is a typical work flow. You can change the order of events, using the SARA transaction in
SAP. For more information about SARA functionality, see the SAP documentation.
If your SAP system supports XBP 2.0, you can use either the XBP 1.0 functionality
described above (see page 20) or the more simplified method, using XBP 2.0,
described in this section.
The XBP 2.0 Job Interception and Spawned Jobs functionalities help simplify the
Data Archiving scheduling table in CONTROL-M.
Job Interception makes it possible to prevent CCMS from releasing Delete jobs and
Store jobs. These jobs can, therefore, be controlled from CONTROL-M. In addition,
SAP note 458670, used when working with XBP 1.0, is no longer necessary.
Chapter 1
Introduction
21
By using the Job Interception and Spawned Jobs functionalities introduced with XBP
2.0 you can simplify your work with Data Archiving. You no longer need to define
Detect jobs, and do not need to use SAP note 458670.
For more information on the Xtractor Interception and Spawned Jobs functions, see
page 107.
The Write job creates a Write job in SAP. When this job runs, it spawns Delete jobs
in the SAP system. These Delete jobs then spawn Store jobs.
The template for Delete jobs - The Delete jobs that were created by the Write job in
SAP are ordered automatically into CONTROL-M by the Xtractor process using
this template. You can, therefore, control these jobs in CONTROL-M using
CONTROL-M tools, such as conditions and resources.
The template for Store jobs - The Store jobs that were created by the Delete jobs in
SAP are ordered automatically into CONTROL-M by the Xtractor process using
this template. You can, therefore, control these jobs in CONTROL-M using
CONTROL-M tools, such as conditions and resources.
NOTE
If you use a store-before-delete, instead of a delete-before-store, configuration (defined using
the SARA transaction in SAP), you must switch between the Store and Delete templates in
CONTROL-M.
22
NOTE
The templates for Delete and Store jobs should only be created as templates, and should not
be ordered and submitted.
Quantitative Resources are defined for the templates in the draft. To run the sample
session successfully, you must add these logical resources in your CONTROL-M. In
addition, you must configure the Xtractor process to fit this procedure. For detailed
information, see Data archiving with XBP 2.0 on page 76 and Configuring the
environment to work with Data Archiving Sessions in XBP 2.0 on page 84.
Chapter 1
Introduction
23
NOTE
This is a typical work flow. You can change the order of events, using the SARA transaction in
SAP. For more information about SARA functionality, see the SAP documentation.
24
Chapter
Installation
This chapter describes how to install CONTROL-M/CM for SAP at your site.
Instructions are also provided for upgrading a previous version of
CONTROL-M/CM for SAP, and for uninstalling the current version of
CONTROL-M/CM for SAP.
NOTE
If a version of CONTROL-M Option for R/3 is installed on the Agent computer on which you
plan to install CONTROL-M/CM for SAP, it is not necessary to uninstall CONTROL-M
Option for R/3. The two products can function simultaneously, using the same Agent.
However, to use the new features of the current product, convert Option jobs using the
CONTROL-M/CM for SAP conversion utility. Instructions for installing this utility can be
found in Installing the Conversion utility on page 42.
The following steps are provided for installing or upgrading CONTROL-M/CM for
SAP:
Chapter 2
Installation
25
Version
CONTROL-M/Agent
6.1.03 or later
Note: When installing on Itanium platforms, ensure that the
CONTROL-M/Agent version supports this.
6.1.0x
Supported platforms
See the release notes for a detailed list of the operating systems that are compatible with CONTROL- M/CM for SAP
version 6.2.01.
26
Requirements
Version
SAP
SAP Basis Release: 4.5B, 4.6C, 4.6D, 6.10, 6.20, and 6.40
(NetWeaver)
Kernel version
Due to SAP changes in the RFC libraries, a minimum kernel for
your SAP system is required. The minimum kernel is detailed in
SAP note 792850.
Warning:
Failing to fulfill this requirement prevents CONTROL-M/CM
for SAP from working and the following connection error is
displayed:
You are not authorized to logon to the target
system (error code 1)
XBP interface
Your SAP system must include the XBP 2.0 interface in order for
all new features of this release to work.
However, if you do not have XBP 2.0 in your system, BMC
Software recommends that you install CONTROL-M/CM for
SAP 6.2.01, since it replaces and enhances all previous releases.
Some of the new features are available without XBP 2.0, if you
use CONTROL-M Function Modules. For more information see,
Step 4 - CONTROL-M function modules on page 37 and the
comparison table Table 3 XBP BAPIs versus CONTROL-M
function modules on page 38.
According to SAP documentation, the XBP 2.0 interface is
included in the following SAP Basis Support Packages:
Chapter 2
Installation
27
Requirements
Version
SAP continued
BW 2.0B - SAPKW20B35
(release details in SAP Note 601001)
BW 2.1C - SAPKW21C27
(release details in SAP Note 601023)
BW 3.0B - SAPKW30B27
(release details in SAP Note 723258)
BW 3.1 - SAPKW31021
(release details in SAP Note 723263)
BW 3.5 - SAPKW35012
(release details in SAP Note 763340)
1.3.1 or later
JRE is not delivered with the CONTROL-M/CM for SAP and
must be installed separately. For details, see
http://www.java.com.
You must ensure that the Java Binaries Directory is in the path
environment variable.
Minimum RAM
28
256 MB
SAP authorizations
Requirements
Version
200 MB
RFC library
SAP authorizations
SAP users of this product must have the following authorizations:
Table 1
Authorization Object
Authorization
Values
S_BTCH_JOB
JOBACTION
JOBGROUP
S_BTCH_ADM
BTCADMIN
BTCUNAME
*
*
*
EXTCOMPANY
EXTPRODUCT
INTERFACE
BMC Software
Control-M
XBP
ACTVT
S_LOG_COM
Object class: BC_A (Basis:
Administration)
COMMAND
HOST
OPSYSTEM
*
*
*
Chapter 2
Installation
29
SAP authorizations
Table 1
Authorization Object
Authorization
Values
S_SPO_DEV
SPODEVICE
S_USER_GRP
ACTVT
CLASS
S_RS_ADMWB
ACTVT
RSADMWBOBJ
S_RS_ISOUR
ACTVT
03, 23, 49
RSAPPLNM
RSISOURCE
RSTSRCOBJ
S_RS_ISRCM
ACTVT
23
RSAPPLNM
RSTSRCOBJ
RSOSOURCE
Note: All BW authorizations under the RS Object Class are required only if you work with
CONTROL-M/CM for SAP solution for BW.
S_ARCHIVE
ACTVT
APPLIC
ARCH_OBJ
S_DATASET
ACTVT
FILENAME
PROGRAM
Note: The S_ARCHIVE and S_DATASET authorizations are required only if you use
CONTROL-M/CM for SAP solution for Data Archiving.
30
NOTE
There is a transport that includes a user role with all the authorizations needed for working
with the SAP CM.
The role is named 'BMCCTRLM_CM_USER '. Use this role in your CONTROL-M user.
For details on how to install the Transport, see Installing the CONTROL-M FMs in the SAP
system on page 40.
You may need to add additional authorizations to the above if your jobs require
them.
The authorization checks for the job run are done in SAP using the Owner of the
job step. However, if you do not set an Owner for the job step, the Owner set in the
account is used and must have the required authorizations.
Chapter 2
Installation
31
1 On your CONTROL-M/Agent computer, log on as the root user and run the
shut-ag command to shut down CONTROL-M/Agent.
5 Press Y to confirm that you accept the license agreement and to continue with the
installation.
Various messages detailing file extraction are displayed. Follow the on-screen
instructions.
6 A message regarding account definition and the SAP RFC library is displayed. You
must download the RFC library to the locations indicated in the message. For
details on downloading the RFC library see Downloading the RFC library on
page 33.
The installation is complete.
7 To restart the CONTROL-M/Agent, log on as the root user, and run the start-ag
command.
32
4 Click Finish and follow the instructions in the Installation Complete dialog box.
5 Download the RFC library to the appropriate locations. For details on
downloading the RFC library see Downloading the RFC library on page 33.
Location
Defining an account
Kernel
version
32-bit or
64-bit
Library file
name
Microsoft Windows
6.20
32-bit
librfc32.dll
6.20
64-bit
librfc32.dll
Chapter 2
Installation
33
Table 2
Kernel
version
32-bit or
64-bit
Library file
name
Solaris 32-bit/64-bit
6.20
32-bit
librfccm.so
AIX 32-bit/64-bit
6.20
32-bit
librfccm.o
HP-UX 32-bit/64-bit
6.20
32-bit
librfccm.sl
HP-UX Itanium
6.40
64-bit
librfccm.so
6.40
32-bit
librfccm.so
6.40
64-bit
librfccm.so
6.20
64-bit
librfccm.so
After downloading the RFC library, extract it from the SAR file using the sapcar
(Unix) or SAPCAR.exe (Windows) executable. For more information, see SAP Note
413708.
You must then copy the RFC library to the following locations:
In Unix
<Agent home directory>/CM/SAP/EXE/
<Agent home directory>/EXE/
In Windows
<Agent home directory>\CM\SAP\EXE\
<Agent home directory>\EXE\
1 On your CONTROL-M/Agent computer, log on as the root user, and run the
shut-ag command to shut down CONTROL-M/Agent.
3 If you are upgrading from 6.1.02 or 6.1.03, run the shut-xt command to shut down
the Xtractor process.
7 Enter I.
NOTE
If a version of CONTROL-M/CM for SAP that cannot be upgraded is detected, you need to
uninstall that version and perform a new installation procedure (see To install
CONTROL-M/CM for SAP on Unix on page 31).
8 Download the RFC library, and copy it to the following two locations:
<home directory>/ctm/cm/SAP/exe
<home directory>/ctm/exe
For more information see Downloading the RFC library on page 33.
Chapter 2
Installation
35
<Drive_ID>:\SETUP
NOTE
If a version of CONTROL-M/CM for SAP that cannot be upgraded is detected, a confirmation
message to uninstall is displayed.
5 You can now restart the CONTROL-M/Agent and CONTROL-M/CM for SAP
Xtractor services.
3 Shut down CONTROL-M/Enterprise Manager GUI, and then restart it. This
enables the newly imported SAP panel functionality (see Figure 1 on page 50).
36
For more information about the Job Editing form, refer to the
CONTROL-M/Enterprise Manager User Guide.
NOTE
If you are upgrading an existing installation of CONTROL-M/CM for SAP, jobs that were
defined and stored in CONTROL-M 6.1.01, 6.1.02, or 6.1.03 can still be used with the new
installation of CONTROL-M/CM for SAP.
NOTE
If you do not want to install CONTROL-M Function Modules, ensure that the Use Extended
check box in the configuration utility is cleared. For more information, see Configuring
general parameters on page 104.
Chapter 2
Installation
37
To work with CONTROL-M/CM for SAP XBP 2.0 functionality, you must set the
value of the XBP Version account parameter as XBP20. For more information, see
Handling accounts for CONTROL-M/CM for SAP on page 99.
The XBP 2.0 interface is integrated in the SAP system as part of the standard Support
Package supplied by SAP. To see which Support Package includes the XBP 2.0
interface, see XBP interface on page 27.
To verify whether your SAP system includes the XBP 2.0 interface, see XBP Version
on page 110.
The following table describes the major differences in actions performed with
XBP 1.0, XBP 2.0, and CONTROL-M FMs.
If, to perform a specific action, either XBP BAPIs or CONTROL-M FMs can be used,
CONTROL-M always uses XBP BAPIs. For example, if you want to copy a variant on
a SAP system with XBP 1.0 installed, CONTROL-M FMs must be installed. However,
if your SAP system has XBP 2.0 installed, the variant is copied using the XBP BAPIs
(2.0).
Table 3
Action
Parent/Child (mass
parallel) functionality
Intercept functionality
Enhanced Extract
functionality
Basic Extract
functionality
(ctmextract)
CONTROL-M Function
Modules
X
(Works partially
without
CONTROL-M FMs)
Submit an event-based
job
Batch Input
functionality
Submitting Data
Archiving jobs
38
Table 3
Action
CONTROL-M Function
Modules
Preventing duplication
in extracting jobs from
SAP
X
X
(requires both XBP 2.0
(requires both XBP 2.0
and CONTROL-M FMs) and CONTROL-M FMs)
Improved faster
mechanism for tracking
jobs in SAP
Configure Joblog
retrieval
CP and NP options in
variant selection
X
X
Show Variant
Variant Copy
Variant Change
Output devices
(printers) list
Load External
Command
Chapter 2
Installation
39
Table 3
Action
CONTROL-M Function
Modules
Load owner
Load event
Action
BW 2.x BAPIs
BW 3.x BAPIs
Start I/P
Monitor I/P
I/P Sysout
CONTROL-M Function
Modules
X
X
X
X
Start P/C
Not relevant
Monitor P/C
Not relevant
Restart P/C
Not relevant
P/C Sysout
Not relevant
NOTE
Process Chains (P/C) capabilities are only available in SAP-BW 3.x systems.
40
On Unix: <CDROM_path>/Transports
On Microsoft Windows: <Drive_ID>:\Transports
To install the FMs in the SAP system, you must import the containing transport into
the SAP system.
Copy the transport files into the transport directory of the SAP system. Ensure that
you remove the read-only attribute of the transport files copied from the CD.
Otherwise, the import to the SAP system may fail.
Use the SAP Transport Management System (transaction STMS) or the operating
system executable program tp to import the required transport. For information
about the Transport Management System and the tp program, refer to SAP
documentation.
Each of the following subfolders under the Transports folder contains transports as
follows:
SAP_R3
This transport must be installed in order to use any of the CONTROL-M FMs, and
it must be installed before installing any other transports.
BW
This transport contains the BW-related FMs. Install it only after the SAP_R3
transport is installed.
DA
Install this transport if you use the CONTROL-M Data Archiving functionality.
Install it only after the SAP_R3 transport is installed.
Do NOT install this transport on SAP release 4.5B.
AUTH
Chapter 2
Installation
41
The authorization transport contains a role that includes all of the minimum
authorization needed for CONTROL-M users. This transport must be imported
into Client 000 and then the role must be copied to the specific client by creating a
local transport and importing it to the target client. BMC Software recommends
defining SAP users for CONTROL-M with the SAP System user type.
42
Subject
Location
1 On your CONTROL-M/Agent computer, log on as the root user, and run the
shut-ag command to shut down CONTROL-M/Agent.
2 Log on as the CONTROL-M/Agent user, and run the shut-xt command to shut
down the Xtractor process.
4 Type Y, and press <Enter> to confirm the uninstall procedure; a message detailing
what is being removed is displayed.
The uninstallation procedure is complete. CONTROL-M/CM for SAP has been
successfully removed from your computer.
To restart CONTROL-M/Agent, log on as the root user again, and run the start-ag
command.
1 From the Start menu, choose Settings => Control Panel, and double-click
Add/Remove Programs.
2 Select CONTROL-M/Control Module for SAP under the relevant agent, and click
Add/Remove.
3 Select Uninstall your Current Version and click OK. The uninstallation procedure is
complete.
Chapter 2
Installation
43
44
Chapter
CONTROL-M jobs are defined using the Job Editing form in CONTROL-M/Desktop.
This Job Editing form contains a series of panels.
Each job processing definition is a collection of parameters and values set using this
form. The parameters included in the job definition depend on the selected job
template (skeleton). When a job skeleton is designed for SAP jobs, a SAP panel is
added to the Job Editing form. This includes all SAP parameters for defining and
monitoring SAP jobs.
The following sections are included in this chapter:
Chapter 3
45
Ensure that the application type parameter of the required Node Group is SAP. For
more information, see the Node Group Menu section in the Maintenance chapter
of the CONTROL-M/Server Administrator Guide.
Run the ctmgetcm utility on CONTROL-M/Server with a set value of Get for the
Action parameter for the Node ID under which CONTROL-M/CM for SAP is
installed.
For more information, see the ctmgetcm section, in the Utilities chapter in the
CONTROL-M/Server Administrator Guide.
NOTE
Create separate job skeletons for SAP R/3 jobs, SAP Data Archiving jobs, and SAP BW jobs.
2 Enter a name for the new job skeleton, and click OK.
3 The following parameters must be defined in the Field/Value table. Each of the set
values is applied to every job created using this job skeleton. Set values according
to your requirements.
Scheduling table
Group
Application
Author
MemName (BMC Software recommended values for this parameter are
described in Table 5 on page 46.)
For more information, see the CONTROL-M Parameters and Variables Reference Guide.
Recommended values to be set for other job skeleton fields are shown in Table 5 .
Table 5
Field
Value
Owner
Name
46
Field
Value
MemName
Set {Name} to give the MemName the same value as the Job
Name.
MemLib
4 Choose the required CONTROL-M instance from the list. CONTROL-M must first
be defined, using Edit => CONTROL-M Definitions in CONTROL-M/Desktop. For
information about setting CONTROL-M definitions, see the
CONTROL-M/Enterprise Manager Administrator Guide.
5 Click Application, and in the Application Node Group field, set either
To choose a Node Group, manually enter the name of the Node Group, or click Load
to generate a list of Application Node Groups.
Choose a SAP type Node Group and click OK. If the required Node Group is not
displayed in this list, the ctmgetcm utility was not run properly. For information see
the CONTROL-M/Server Administrator Guide.
if you chose the Application Node Group field manually, you must set applicable
values from the list
Chapter 3
47
if you chose the Application Node Group field from the Load list, this field is
automatically set according to your selection
choose SAP R3 to load the SAP job panel designed to work with SAP jobs
choose SAP Data Archiving to load the SAP job panel designed to work with
Data Archiving jobs
choose SAP Business Warehouse to load the SAP job panel designed to work with
SAP-BW jobs
NOTE
If none of these are displayed in the Form Name field, the SAP panel was not imported
properly. For more information, see Step 3 - Importing the SAP panel on page 36.
8 Click OK.
Where to go from here
48
Subject
Location
Defining a Skeleton
Defining a Job
2 Choose Edit => Job => New from the menu bar, or click New Job
NOTE
For descriptions of all panels in the Job Editing form, see Chapter 3 of the
CONTROL-M/Desktop User Guide.
3 Click the SAP tab of the Job Editing form to display the SAP panel, as shown in
Figure 1 on page 50.
Choose Create to create and run a new job in SAP. At least one step must be
selected in order to define a SAP job in CONTROL-M. For explanations about
setting Job steps, see Selecting job steps on page 60.
Chapter 3
49
Choose Copy to copy an existing job in SAP and run the new job.
Choose External to monitor an existing job in SAP. This can also be used for
monitoring and post-processing.
The appropriate parameters are enabled for the selected job mode. For descriptions
of all SAP panel parameters, see Table 6 on page 51.
Figure 1
5 After you set the parameters in the SAP panel, click Save to Draft to add the job to
the scheduling table set in the General panel.
50
Subject
Location
SAP-BW Jobs
NOTE
For a more detailed description of each parameter, see the SAP Parameters chapter in the
CONTROL-M Job Parameter and Variable Reference Guide.
Clicking the Load buttons in the SAP panel generates a list in real time that satisfies relevant
criteria. To enter a value in a specific field, select the item from this list and click OK.
The asterisk * can be used as a wildcard to filter parameters such as account names, Job
names, and so on. For example, entering *DE* in the Account field generates a list of all
accounts that contain the string DE.
Table 6
Parameter
Definition
Account
Indicates from which Job step in the original job to begin the copying
procedure.
Mandatory for Copy job mode. Disabled for other job modes.
Valid values are: 1-99. Default: 1
Chapter 3
51
Table 6
Parameter
Detect Spawned Jobs A spawned job is a job created by another (parent) job, and
monitored by CONTROL-M. This parameter indicates whether to
detect and monitor jobs that were spawned by the current SAP job.
The following options are available:
Start Spawned Job: start any detected spawned job that has a
status of Scheduled.
A (most urgent)
B (urgent)
C (least urgent) (Default)
Note: The A and B values only work if you use XBP 2.0 functionality
or the Extended functionality in an XBP 1.0 system with the
CONTROL-M Function Modules installed.
52
Table 6
Parameter
Definition
Job Count
FIRST
FIRST_SCHEDULED
LAST
LAST_SCHEDULED
When the job mode value is Copy, the parameter can contain digits
or any of the special values.
When the job mode value is Original, the parameter can contain
digits, FIRST_SCHEDULED, or LAST_SCHEDULED.
When the job mode value is External, the Special Values are not
applicable and an 8-digit number must be entered.
Job Mode
Determines the task that the job performs. Mandatory. Valid values
are:
Chapter 3
53
Table 6
Parameter
Definition
Job Name
The Filter and Load options are not available in Create job mode.
In Original job mode, when you open the Job Status Filter dialog
box only Scheduled is selected and cannot be modified. All other
statuses are disabled.
In Copy and External job modes, when you open the Job Status
Filter dialog box, all statuses are enabled.
In Batch Input job mode, the Filter option is not available. Click
Load to display a list of available Batch Input sessions.
In Batch Input job mode the Job Name field is also called Map
Name.
54
Table 6
Parameter
Output Management When you click the Output Management button the Output
Management dialog box opens. The field formerly known as Copy
spool to is included in this dialog box. Manage and control the
output of your job, Optional.
The Spool of the job and its Joblog are both created in SAP. You can
customize the way CONTROL-M handles them by selecting one of
the following options for each output type:
QID
Copy to file - name and path of the file to which the Spool or
Joblog is copied. Case sensitive, no blank spaces permitted.
Chapter 3
55
Table 6
Parameter
Definition
When you click the Spool List Recipient button, the Spool List
Recipient dialog box opens. Optional.
Recipient type - Select the recipient type from the list.
Note: The following Recipient types are supported:
SAP user name
External address
Shared distribution list
Private distribution list
Other Recipient types are not fully supported.
Recipient name - Name of the recipient of the job. Click Load to
generate and display a list of all recipients. The list of recipients is
displayed according to the selected recipient type. The asterisk * can
be used as a wildcard to filter the search. The Load action is available
for the following recipient types:
SAP user name
Shared distribution list
Private distribution list
Other recipient types can be entered manually.
Copy
Express
Blind copy
No forwarding
Note: This functionality only works if you use XBP 2.0 functionality
and the Extended functionality of the CONTROL-M Function
Modules.
56
Table 6
Parameter
Definition
Start Condition
When you click the Start Condition button the Start Condition
dialog box opens.The field formerly known as Submit Job with
ASAP Option is included in this dialog box. In this dialog box, you
can set whether the job runs with the ASAP option immediately or
after event.
Valid values are:
Chapter 3
57
Table 6
Parameter
Definition
Steps
Step (action) to be performed as part of the SAP job. At least one step
must be defined in Create job mode. Disabled for every other job
mode.
Between 1-99 steps can be selected.
ABAP program: Add an ABAP program.
External command: Add an external command.
External program: Add an external program.
The following control buttons can be used for each step:
Move up
Move down
Delete
Edit
Duplicate step
58
Table 6
Parameter
Definition
Target Group
Job server group on which the job runs. Optional. Case sensitive, no
blank spaces permitted.
Click Load to generate and display a complete list of available Job
server groups.
If this parameter is left unset, the SAP system decides on which
server to run the job. See also, Target Server below in this table.
The Job server groups are defined in the SAP SM61 transaction. They
contain a list of Application Server names. If you set a group name in
the Target group field of the job definition, the job is submitted using
a Background work process, on the most available Application
Server from the list included in this group.
Note: this functionality only works if your SAP system is release 6.10
or later and you have SAP Note 729317 installed. The Load action for
the Target Group list only works if you use XBP 2.0 functionality.
For information about load-balancing during logon time, see
Adding or modifying a CONTROL-M/CM for SAP account on
page 100.
Target Server
Chapter 3
59
ABAP program
External command
External program
2 Click the Add step button corresponding to the type of job step you want to add
(ABAP Program, External command, or External program). The appropriate dialog box
opens.
4 Click OK to add the job step to the SAP job, and to return to the SAP panel of the
Job Editing form.
Use the control buttons to edit and manipulate selected program steps.
60
Chapter 3
61
Table 7
Parameter
Description
ABAP Program
SAP ArchiveLink Storage system ID. Case sensitive, only trailing blank
spaces permitted. Default: ZZ.
Note: This only works if you use XBP 2.0 functionality or the Extended
functionality in an XBP 1.0 system with the CONTROL-M Function
Modules installed.
Only enabled if Print Archive Mode is set to Archive or Print & Archive.
Archive Text
Authorization
Columns
Delete After
Print
62
Table 7
Parameter
Description
Department
Document Type Archive object document type. Optional. Case sensitive, blank spaces
permitted.
Only enabled if Print Archive Mode is set to Archive or Print & Archive.
Information
Field
Job Name
Language
Layout
Name
New Spool
Request
Note: This only works if you use XBP 2.0 functionality or the previous
Extended functionality in an XBP 1.0 system with the CONTROL-M
Function Modules installed.
Number of
Copies
Object Type
Chapter 3
63
Table 7
Parameter
Description
OS Cover Sheet
Type of cover sheet for output. Optional. Drop down list format. Valid
values are:
Output Device
Default Setting
Print
Do Not Print
Owner
R/3 user whose authorizations the Job Step uses during processing.
Optional. Uppercase only, no blank spaces permitted.
If left unset, the value is taken from the account owner field.
Click Load to generate and display a list of all owners.
Note: The load functionality works only in version 6.20 and higher, and
only with a specific Basis SP installed. For more details, see SAP note
753559.
The asterisk * can be used as a wildcard to filter the search.
Note: To prevent users from running job steps with a different user, use
authorization restrictions in SAP. To do this, give the authorization object
S_BTCH_NAM a specific value for BTCUNAME. For details, see SAP
documentation.
Print Archive
Mode
Print (Default)
Archive
Print & Archive
Print Expiration The number of days after which print job expires. Optional.
Range: 1-8 or Do Not Delete.
Recipient
64
Table 7
Parameter
Description
Rows
SAP Cover Page Type of cover page for output. Optional. Valid values are:
Default Setting
Print
Do Not Print
Selection Cover
Page
Time of Print
Note: the default value Send to SAP spooler can only be used in SAP
release 6.10 or later. If you do not change this value in SAP releases lower
than 6.10, the SAP system uses its default value.
Titles
Chapter 3
65
Table 7
Parameter
Description
Use ABAP
This parameter exists for both the Rows and the Columns parameters.
Program Default Select it if you want to use the ABAP program default for either the
maximum number of rows per page (Rows), or the maximum number of
characters on an output line (Columns). Valid values are:
Variant Name
Cleared - Do not use the ABAP program default. Use the number
entered in the Rows or Columns box.
Note: The Copy, Show and Change buttons only work if you use XBP 2.0
functionality or the Extended functionality in an XBP 1.0 system with the
CONTROL-M Function Modules installed.
66
Variant subparameters
Figure 3
The following subparameters are displayed in the Show/Change variant dialog box:
Table 8
Parameter
Description
Description
Name
Type
Value
Low
the lower limit value; used only for Range parameter type
High
Chapter 3
67
Table 8
Parameter
Description
Sign
Option
Table 9
I - inclusive
E - exclusive
Option
Type
Description
BT
Range
NB
Range
EQ
Selection
NE
Selection
GT
Selection
LT
Selection
GE
Selection
LE
Selection
CP
Selection
NP
Selection
Does not contain the pattern - used with wildcards in the Value
field
68
Table 10
Parameter
Description
Activate trace
Name
Selected - activate
Cleared - not activated (Default)
Job name
Chapter 3
69
Table 10
Parameter
Description
Indicates whether SAP waits for the external command to end before
starting the next step, or exiting. Optional.Valid values are:
Log external
errors in job log
Indicates whether to write errors to the job log. Optional. Valid values are:
Log external
Indicates whether to write output to the job log. Optional. Valid values
output in job log are:
Operating
System
Owner
Parameters
Step number
Target Server
70
Table 11
Parameter
Description
Activate trace
Selected - activate
Cleared - not activated (Default)
Name
Job name
Indicates whether SAP waits for the external program to end before
starting the next step, or exiting. Optional. Valid values are:
Log external
errors in job log
Indicates whether to write errors to the job log. Optional. Valid values are:
Chapter 3
71
Table 11
Parameter
Description
Log external
Indicates whether to write output to the job log. Optional. Valid values
output in job log are:
Owner
Parameters
Step number
Target host
72
All fields that are set in SAP R/3 jobs on page 49 are read-only. Additional fields
are also displayed. These are described in Table 12 on page 74.
The parameters described in Table 12 are available when a job is created and
scheduled, and can be seen in the Job Editing form, in CONTROL-M/EM.
Chapter 3
73
Table 12
Parameter
Description
Job Type
This shows the nature of the SAP job. Indicated if the check box is
selected. Only relevant for jobs extracted by the Xtractor process.
Notes:
For jobs that were not extracted by the Xtractor process, no
information is displayed in any of these fields.
A job can fit more than one job type criteria. For example, it can
be both spawned and intercepted. If this is the case, the job type
assigned the higher priority is the actual job type, and is
indicated by a bold ring around the check box. For more
information about priorities and job detection criteria, see
Configuring and working with the Xtractor process on
page 107.
These fields are only enabled if you are using XBP 2.0
functionality.
SAP Job Status
Classification for the job. Displays the actual status of the job in SAP.
Important: This is updated when the Job Editing form is opened.
However, the status is not refreshed automatically.
Note: This field is active only if you are using XBP 2.0 functionality.
A (Data Archiving) Write job copies data from the SAP database to archive files.
A Detect job detects either Delete or Store jobs that are created in SAP during the
Write job process.
A Delete job reads information from an archive file, verifies that this
information is the same as in the SAP database, and deletes it from the database.
A Store job copies archive files to a storage system.
As a Detect job discovers a Delete or Store job, a new job is created in
CONTROL-M. This job runs the Delete or Store job in SAP, enabling you to
monitor it from CONTROL-M. The Detect job continues to search for Delete or
Store jobs, according to session specifications. It runs cyclically until all Delete or
Store jobs are detected and run.
For more information, see Creating a Data Archiving session with XBP 1.0 on
page 76.
Chapter 3
75
The Write job copies data from the SAP database to archive files and spawns the
Delete jobs in SAP. The Write job is defined in CONTROL-M as a parent job
(meaning, the Detect Spawned Jobs option is selected).
The job definition template for Delete jobs is used when Delete jobs are detected
as spawned by the Write job. Each Delete job spawns one Store job, so the
template for Delete jobs should also be defined as a parent.
Store jobs are spawned by Delete jobs in SAP. The job definition template for Store
jobs is used when they are detected as spawned by Delete jobs.
For more information, see Creating a Data Archiving session with XBP 2.0 on
page 79.
NOTE
A pre-prepared draft for a Data Archiving session when using XBP 1.0 can be found on the
CONTROL-M/CM for SAP installation CD, in <CD_ROM>\Forms. You can use it either as
an example of a typical Data Archiving session, or as a template for new Data Archiving
sessions. For more information, see Sample Data Archiving session with XBP 1.0 on
page 20.
form.
76
NOTE
For more information about the Group Editing form, see the CONTROL-M/Desktop User
Guide.
2 Choose Edit => Job => New from the menu bar, or click
NOTE
For descriptions of all panels in the Job Editing form, see Chapter 3 of the
CONTROL-M/Desktop User Guide.
3 Click the SAP tab of the Job Editing form to display the SAP panel as shown in
Figure 7.
Figure 7
Chapter 3
77
The fields in the SAP panel are described in Table 13 on page 86.
Choose Write to copy information from the SAP database to archive files.
Choose Detect Delete to detect Delete jobs. A Delete job reads information from
an archive file, verifies that this information is the same as in the SAP database,
and deletes it from the database.
Choose Detect Store to detect Store jobs. A Store job copies archive files to a
storage system.
The appropriate parameters are enabled for the selected job mode. For descriptions
of all SAP panel Data Archiving parameters, see Table 13 on page 86.
If you selected the Write job mode, proceed to step 8.
If you selected either the Detect Delete or Detect Store job mode, continue with
step 5.
NOTE
If the set intervals are small, the job detection is quicker. However, if the intervals are longer,
job cycles are less likely to run without detecting any jobs.
78
7 To set additional print parameters for the job, click Print Parameters to open the
Print Parameters dialog box. The fields in the Print Parameters dialog box are
described in Table 7 Add ABAP dialog box parameters on page 62.
8 When you are finished entering parameters in the SAP panel, click Save to Draft to
add the job to the group scheduling table of the Data Archiving session.
Location
NOTE
A pre-prepared draft for a Data Archiving session when using XBP 2.0 can be found on the
CONTROL-M/CM for SAP installation CD, in <CD_ROM>\Forms. You can use it either as
an example of a typical Data Archiving session, or as a template for new Data Archiving
sessions. For more information, see Sample Data Archiving session with XBP 2.0 on
page 23.
Chapter 3
79
form.
2 Choose Edit => Job => New from the menu bar, or click
NOTE
For descriptions of all panels in the Job Editing form, see Chapter 3 of the
CONTROL-M/Desktop User Guide.
3 Click the SAP tab of the Job Editing form to display the SAP panel, as shown in
Figure 8.
80
Figure 8
6 Select A specific job definition, and for Job Name enter the name of the Delete
template to use as a template for creating spawned jobs.
Click OK to close the dialog box.
8 To set additional print parameters for the job, click Print Parameters to open the
Print Parameters dialog box. The fields in the Print Parameters dialog box are
described in Table 7 Add ABAP dialog box parameters on page 62.
9 When you are finished entering parameters in the SAP panel, click Save to Draft.
The job is added to the group scheduling table of the Data Archiving session.
Chapter 3
81
2 Choose Edit => Job => New from the menu bar, or click
NOTE
For descriptions of all panels in the Job Editing form, see Chapter 3 of the
CONTROL-M/Desktop User Guide.
3 Click the SAP tab of the Job Editing form to display the SAP panel, as shown
below.
82
6 Select A specific job definition, and for Job Name, enter the name of the Store
template to use as a template for creating spawned jobs. Click OK to close the
dialog box
7 Define the parameters for the job definition template for Delete jobs as appropriate.
For descriptions of the parameters, see Table 13 on page 86.
8 When you are finished entering parameters in the SAP panel, click Save to Draft.
The job is added to the group scheduling table of the Data Archiving session.
2 Choose Edit => Job => New from the menu bar, or click
NOTE
For descriptions of all panels in the Job Editing form, see Chapter 3 of the
CONTROL-M/Desktop User Guide.
3 Click the SAP tab of the Job Editing form to display the SAP panel.
Chapter 3
83
Configuring the environment to work with Data Archiving Sessions in XBP 2.0
6 When you are finished entering parameters in the SAP panel, click Save to Draft.
The job is added to the group scheduling table of the Data Archiving session.
NOTE
The templates for Delete and Store jobs should only be created as templates, and should
not be ordered and submitted.
Location
Configuring the Environment For more information, see Configuring the environment to
to Work with Data Archiving work with Data Archiving Sessions in XBP 2.0 on page 84
Sessions in XBP 2.0
1 Ensure that the Job Interception and Spawned Jobs functionalities are activated in
the relevant SAP system. See Activating Interception and Parent/Child functions
in SAP on page 108 and the relevant SAP documentation.
2 Use the ctmxtcfg utility to set the following priorities for the Xtractor process:
84
Configuring the environment to work with Data Archiving Sessions in XBP 2.0
Setting first priority for spawned jobs in the Xtractor process ensures that Delete
jobs and Store jobs are created (ordered) according to the template definition of
their parent jobs, and NOT according to CONTROL-M interception rules.
For more information, see To set job type priorities on page 109.
3 Use the SAP Interception Criteria panel of the ctmxtcfg utility to configure your
SAP system to intercept Data Archiving Delete jobs and Store jobs. This can be
done using a rule that is similar to the following:
Chapter 3
85
NOTE
The asterisk can be used as a wildcard to filter such parameters as account names, Job names
and so on. For example, entering *DE* in the Account field generates a list of all accounts that
contain the DE string.
Table 13
Parameter
Definition
Account
Archiving Object
Check Sessions
86
Table 13
Parameter
Definition
Check Variant
Name and path of the file to which the spool should be copied.
Optional. Case sensitive, no blank spaces permitted.
Note: If *SYSOUT is set, the spool is copied to the same
location as the job output. (See Sysout Handling in the
CONTROL-M Job Parameter and Variable Reference Guide).
Chapter 3
87
Table 13
Parameter
Definition
Job Class
A - most urgent
B - urgent
C - least urgent (Default)
Note: The A and B values only work if you use XBP 2.0
functionality or the Extended functionality in an XBP 1.0 system
with the CONTROL-M Function Modules installed.
Job Mode
Job Name
Print Parameters
Session Number
88
Table 13
Parameter
Definition
Specifies whether the job should run with the ASAP option or
immediately. Check box format. Valid values are:
Chapter 3
89
Table 13
Parameter
Definition
Target Server
Variant
Note: The Copy, Show, and Change buttons only work if you
use XBP 2.0 functionality or the Extended functionality in an
XBP 1.0 system with CONTROL-M Function Modules installed.
90
Ensure that you have a SAP Business Warehouse skeleton defined. For more
information, see Creating a job skeleton for SAP jobs on page 45.
Ensure that the required InfoPackages (I/P) or Process Chains (P/C) are already
defined in the SAP BW system.
NOTE
When defining a P/C in the SAP BW system, ensure that you choose Start Using Meta
Chain or API as the start condition for the trigger process (Start Process) of the P/C. If you
do not do this, the job fails in CONTROL-M.
You can access this parameter from the SAP transaction RSPC; right-click the Trigger
process and select Maintain Variant.
2 Choose Edit => Job => New from the menu bar, or click
NOTE
For descriptions of all panels in the Job Editing form, see Chapter 3 of the
CONTROL-M/Desktop User Guide.
3 Click the SAP tab of the Job Editing form to display the SAP-BW panel.
The fields in the SAP panel are described in Table 14 on page 93.
Chapter 3
91
4 Choose the required SAP BW/Business Process Type to enable the appropriate
parameters. There are two options:
Figure 9
Figure 10
Process Chain - Enter the specific Process Chain information, or click Load to
92
Location
NOTE
The asterisk can be used as a wildcard to filter parameters such as account names and Job
names. For example, entering *DE* in the Account field generates a list of all accounts that
contain the DE string.
Table 14
Parameter
Definition
Account
Chapter 3
93
Table 14
Parameter
Definition
CONTROL-M Job
Name
InfoPackage
Description
InfoPackage Tech.
Name
Note: The Load button generates data for both this parameter and
InfoPackage Description.
Process Chain
Description
94
Table 14
Parameter
Definition
Process Chain ID
SAP-BW/Business
Process Type
Chapter 3
95
All fields that were set in Creating a Business Information Warehouse job on
page 91 now have read-only status. Additional fields are also displayed. These are
described in Table 15 on page 97.
The parameters described in Table 15 are available when a job is created and
scheduled, and can be seen in the Job Editing form, in CONTROL-M/EM.
96
Table 15
Parameter
Description
Rerun options
Chapter 3
97
98
Chapter
Administrator tasks
This chapter describes tasks that can be performed using the CONTROL-M/CM for
SAP utilities. These are described under the following topics:
For more information about CONTROL-M command line utilities, see the
CONTROL-M/Server Administrator Guide, and the CONTROL-M/Enterprise Manager
Utility Guide.
Administrator tasks
99
The Account utility encrypts the accounts information in a data file located in the
CONTROL-M/Agent data directory.
To add an account
1 Access the account utility.
On Unix, ensure that the Unix DISPLAY environment variable is set correctly
and enter ctmr3acc on the command line
In CONTROL-M/Agent version 6.20, instead of running ctmr3acc, run ctmag.
Select the SAP tab, and select Account management.
2 Click Add
100
Parameter
Description
Account Name
Application Server
hostname
System Number
Client
101
Table 16
Parameter
Description
Login
Password
Confirm Password
Language
XBP Version
Defines the SAP XBP interface version installed on the SAP server.
Valid values are:
XBP1.0 (Default)
XBP2.0
R/3 (Default)
BW 2.x
BW 3.x
System ID
Message Server
Hostname
Group
If you are using logon groups, you must add a new line to the services file on the
computer on which CONTROL-M/Agent is running, as follows:
sapms<SID>
36<SYSNR>/tcp
SID represents the System ID, and SYSNR represents the System number of the
computer on which the SAP Message Server is running. For example:
sapmsDEV
3619/tcp
102
On Unix: /etc/
On Windows: <system drive>:\WINNT\system32\drivers\etc
On Windows 2003: <system drive>:\Windows\system32\drivers\etc
This should be done for each System ID for which you defined a logon group. For
more information about Logon Groups and load balancing, go to the BMC Software
Customer Support web site at http://www.bmc.com/support_home ==> Resolution
Knowledge Database and see Resolution 192593.
4 Click OK to save the new account. The Add dialog box closes, and the new account
information is added to the CONTROL-M/CM for SAP Account Management
window.
NOTE
The Copy , Edit , and Remove
buttons in this window are now enabled. You can
use these buttons to add accounts, or edit or delete existing accounts.
103
NOTE
The Administrator password is also used to open the Xtractor Configuration utility, see
The Xtractor process mechanism on page 107.
On Unix, ensure that the Unix DISPLAY environment variable is set correctly and
enter ctmr3cfg on the command line.
In CONTROL-M/Agent version 6.20, instead of running ctmr3cfg, run ctmag.
Select the SAP tab, and select Configuration management.
On Microsoft Windows, go to Start => Programs => CONTROL-M/CM for SAP =>
Configuration Utility.
In CONTROL-M/Agent version 6.20, go to Start => Programs =>
CONTROL-M/Agent <agent>. Select the SAP tab, and select Configuration
management to open the Configuration Management window.
104
Figure 12
Parameter
Description
Audit Level
Sets the audit level for the current session. Valid values are:
Default: 0
Note: Additional audit level information can be viewed in the RZ15
SAP transaction.
Max Wait for SAP
Recovery
The Max Wait for SAP Recovery (minutes) parameter enables you
to maintain an Executing status for CONTROL-M/CM for SAP jobs
running in a SAP system even when the connection to the SAP
system is lost. Default: 0 (minutes). An alert is sent to
CONTROL-M/EM when the connection to SAP is lost or
reconnected.
Note: If the connection is still lost after the set number of minutes has
elapsed, the job fails and is assigned a status of Disappeared.
Specifies how many times the program should try to reconnect to the
SAP system after either
a connection failure
a Function Call error
105
Table 17
Parameter
Description
Default: LAST_SCHEDULED
Run Org Mode
Default: LAST_SCHEDULED
Use Extended
Cleared = No
Selected = Yes (Default)
Mixed Case Job Name Allow mixed case job name for External Mode jobs. (For job
(External Jobs)
monitoring purposes only.) Valid values are:
Note: When this parameter is cleared, searches only find job names
with all uppercase characters, regardless of how information was
entered. When this parameter is selected, all searches are run exactly
specific to the character information entered.
Applicable for the External job mode only.
106
Table 17
Parameter
Description
Mixed Case Job Name Allow mixed case job name for other CONTROL-M jobs. (For
(Other CTM Jobs)
creating or submitting jobs.) Valid values are:
Note: When this parameter is cleared, searches only find job names
with all uppercase characters, regardless of how information was
entered. When this parameter is selected, all searches are run exactly
specific to the character information entered.
Applicable for Create, Copy, and Original job modes.
Each of these functions is a separate procedure. All three are managed by the Xtractor
process, to coordinate these functions to work simultaneously and without conflicts.
The Xtractor Configuration Management utility (ctmxtcfg) has an easy-to-use GUI. It
includes the following panels:
107
Extraction Rules, as described in Extracting and monitoring SAP CCMS jobs with
the Xtractor on page 116
The configuration for detecting spawned jobs is performed separately, using the Job
Editing form. For more information, see Initiating a mass parallel process (detecting
spawned jobs) on page 121.
The Xtractor process stores its configuration files in the CONTROL-M/Agent
cm/SAP/data directory, on both Unix and Microsoft Windows.
NOTE
The Xtractor process uses the CONTROL-M ctmorder utility to create jobs in CONTROL-M.
Therefore, you may need to adjust the security settings in CONTROL-M/Server.
To activate these functions, run the INITXBP2 ABAP program in your SAP system
and switch on the required actions.
108
NOTE
Extracted jobs cannot have a higher priority than Intercepted or Spawned jobs.
On Unix, ensure that the Unix DISPLAY environment variable is set correctly
and enter ctmxtcfg on the command line.
In CONTROL-M/Agent version 6.20, instead of running ctmxtcfg, run ctmag.
Select the SAP tab, and select Xtractor management.
109
If you defined an Administrator password for the ctmr3acc utility, you are
prompted to enter it now. (See To configure an Administrator password on
page 103.)
NOTE
If Intercepted Jobs is assigned a priority, you must ensure that at least one CTM
Interception Rule is selected, as described on page 113.
3 Select the Activity Log check box, to have a log created and saved in the
CONTROL-M/Agent proclog directory. This log has the following name structure:
xt_log_<YYMMDD>.
4 In the Interval Time field, enter the required number of seconds between loops
cycles of the Xtractor.
5 Click Save.
110
NOTE
All intercepted jobs must be processed by CONTROL-M to avoid jobs being stuck in
Scheduled status forever.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
Ensure that the Interception function is enabled in your SAP system (see
Activating Interception and Parent/Child functions in SAP on page 108).
Assign a priority to Intercepted jobs in the Xtractor General Configuration tab (see
General configuration of the Xtractor process on page 109).
Activate the Xtractor process (see Activating the Xtractor process on page 124).
On Unix, ensure that the Unix DISPLAY environment variable is set correctly
and enter ctmxtcfg on the command line.
In CONTROL-M/Agent version 6.20, instead of running ctmxtcfg, run ctmag.
Select the SAP tab, and select Xtractor management.
111
Figure 14
NOTE
The Change Account button can be used at any time to open the Select SAP Account dialog
box and configure a different account.
Click SAP Interception Criteria to open the SAP Interception Criteria panel.
3 Click Load
Figure 15
The Add
, Copy
, Edit
, and Remove
5 Set the Job Name criteria (for example BTC_*) and the User criteria (for example,
DEB*), and click OK. The * symbol can be used as a wildcard filter for both
parameters.
6 When you are satisfied that all criteria in the SAP Interception Criteria panel are set
according to your requirements, click Save. Information is sent to SAP, and all jobs
that match the Interception Criteria are intercepted by SAP.
112
WARNING
Carefully consider how you set Job Name and User Name criteria. Anything too general
(for example, entering * in both fields), could cause system or other user jobs to be
intercepted. Additionally, you should ensure that you have no more than one account that
uses Interception rules using the same system and client.
dialog box:
Parameter
Description
Into Group
The last four options are similar to the Force Into options of
CONTROL-M/EM. For more information about
CONTROL-M group scheduling tables and Force Into
parameters, see the CONTROL-M/EM User Guide.
Job Name
User
SAP user that created the job. The *wildcard can be used.
Program
113
Table 18
Parameter
Description
User Exit
9 Click OK. The data is saved in the Xtractor Configuration utility, but no
information is passed to the Xtractor process until you click Save. The Copy
, and Remove
buttons are now enabled.
, Edit
10 When you are satisfied that all criteria in the CTM Interception Rules panel are set
according to your requirements, click Save.
114
Table 19
Parameter
Value
Job Name
User
Program
User Exit
NOTE
If you do not follow this procedure, a predefined User Exit is used by the Xtractor. For more
information, see Pre-defined User Exit for the Xtractor Process on page 124.
1 Define SAP interception criteria to intercept all jobs created by a specific group of
users.
4 In the CTM Interception Rules panel, set the job that you just defined as the
Template Job Name.
In this example, if your system has ten Background WPs available, the selected
group of users cannot use more than eight, and, therefore, the system always
leaves two WPs available for other purposes.
115
NOTE
The functionality available in previous versions of CONTROL-M/CM for SAP using the
ctmextract utility is still supported. For details, see Appendix A, Extracting and monitoring
jobs.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
Assign a priority to Extracted jobs in the Xtractor General Configuration tab (see
General configuration of the Xtractor process on page 109).
Activate the Xtractor process (see Activating the Xtractor process on page 124).
On Unix, ensure that the Unix DISPLAY environment variable is set correctly
and enter ctmxtcfg on the command line.
In CONTROL-M/Agent version 6.20, instead of running ctmxtcfg, you can run
ctmag. Select the SAP tab, and select Xtractor management.
2 The Xtractor Configuration Management dialog box is displayed, overlaid with the
Select SAP Account dialog box.
116
NOTE
The Change Account button can be used at any time to display the Select SAP Account
dialog box and configure a different account.
3 An Add dialog box is displayed, in which you can set values for the Extraction
Rules parameters. These rules set which jobs should be extracted from SAP.
117
Table 20
Field Name
Field Description
JOBNAME
JOBCOUNT
JOBGROUP
USERNAME
FROM_DATE
FROM_TIME
TO_DATE
Scheduled end date for CCMS job. Optional. Valid format is:
YYYYMMDD
TO_TIME
118
NO_DATE
WITH_PRED
EVENTID
EVENTPARAM
PRELIM
SCHEDULED
READY
RUNNING
FINISHED
ABORTED
5 Click Add
in the Rules Viewer to display another Add dialog box where you can
assign sub-rules to jobs or sets of jobs. These rules determine how jobs are created
and monitored in CONTROL-M, and are described in Table 21. This step can be
repeated to add additional rules in the Rules Viewer.
Table 21
Field Name
Field Description
JOBNAME
Note: The following parameters are used to set how the job should be created in
CONTROL-M. You can define either according to a predefined job and scheduling table
(Template Job Name and Template Scheduling Table), or according to a user-defined
script (User Exit).
Template Job Name
119
Table 21
Field Name
Field Description
User Exit
120
JOBCOUNT
STEPCOUNT
SDLSTRTDT
SDLSTRTTM
BTCSYSTEM
SDLDATE
SDLTIME
SDLUNAME
LASTCHDATE
LASTCHTIME
LASTCHNAME
RELDATE
RELTIME
RELUNAME
STRTDATE
STRTTIME
ENDDATE
ENDTIME
PERIODIC
STATUS
AUTHCKNAM
AUTHCKMAN
SUCCNUM
PREDNUM
Table 21
Field Name
Field Description
LASTSTRTDT
LASTSTRTTM
WPNUMBER
WPPROCID
EVENTID
EVENTPARM
JOBCLASS
CALENDARID
EXECSERVER
REAXSERVER
6 Click OK. The data is saved. The Rule Viewer is re-displayed, with the
Copy
, Edit
, and Remove
buttons enabled.
7 Click OK. All of the information that you set during this procedure is displayed as
one entry in the Extraction Rules panel. The Copy
buttons are enabled.
, Edit
, Rules
, and Remove
NOTE
Click
to directly access the Rules Viewer of a specific extraction rule, in the Extraction
Rules panel. You can now modify the existing rules, or add new ones.
8 When you are satisfied that all criteria in the Extraction Rules panel are set
according to your requirements, click Save.
Ensure that the Parent/Child function is enabled in your SAP system (see
Activating Interception and Parent/Child functions in SAP on page 108).
Chapter 4 Administrator tasks
121
Assign a priority to Spawned jobs in the Xtractor General Configuration tab (see
General configuration of the Xtractor process on page 109).
Activate the Xtractor process (see Activating the Xtractor process on page 124).
2 In the SAP panel, click Detect Spawned Jobs to display the Detect Spawned Jobs
dialog box.
122
Parameter
Description
Parameter
Description
No Detection Needed
For more information about the Job Editing form and defining a CONTROL-M job,
see the CONTROL-M/Enterprise Manager User Guide.
4 Click OK. The Xtractor process detects spawned jobs, according to the priority set
in the General Configuration panel of the Xtractor Configuration Management
utility. For more information see General configuration of the Xtractor process
on page 109.
123
Table 22
Parameter number
Parameter value
<Job count>
A successful return value of the script is 0 (zero). Any other return value causes the
job to be intercepted or extracted again, at the next iteration of the Xtractor process.
The User Exit script can run a user-defined action, and can use other CONTROL-M
utilities (for example, ctmorder and ctmcreate) to handle the Extracted or Intercepted
job.
On Unix: <Agent_homedir>/ctm/cm/SAP/exe/default_order
On Microsoft Windows:
<Agent home directory>\CM\SAP\EXE\default_order.bat
This User Exit script is called by the default Interception Rule if the intercepted job
has not met the conditions of any preceding rule.
This script submits the job using the CONTROL-M ctmcreate command. You can use
this script as one example of how to create a User Exit.
124
NOTE
If the computer on which CONTROL-M/Agent is installed is rebooted while the Xtractor
process is active, CONTROL-M/Agent automatically restarts the Xtractor process. (A similar
procedure occurs with CONTROL-M/Tracker.)
1 Select Start => Settings => Control Panel => Administrative Tools => Services to
display the Services dialog box.
Display a list of defined variants for a specific program, as described on page 126.
125
NOTE
This utility can be used within ctmcreate or ctmdefine. However if it is used this way, the
command is limited to 512 characters.
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_mon
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name> [-Agent
<agent_name>]
Table 23
126
Parameter
Description
SAPR3-ACTION
SAPR3-ACCOUNT
SAPR3-PROGRAM
Below is an example of the ctmr3req utility when used to display a list of variants,
using the DGOLDHAD account, for the prog1 program:
D:\Program files\BMC Software\CONTROL-M aGENT\David\ctmr3req
-SAPR3-ACTION var_mon -SAPR3-ACCOUNT DGOLDHAD -SAPR3-PROGRAM prog1
-Agent Default
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_edit
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
-SAPR3-VAR <variant_name> -SAPR3-VAR_PARAM<nn>
<variant_parameter_name>=<variant_parameter_value> [-SAPR3-VAR_TEXT
<variant_text>] [-Agent <agent_name>]
Table 24
Parameter
Value
-SAPR3-ACTION
-SAPR3-ACCOUNT
127
Table 24
Parameter
Value
-SAPR3-PROGRAM
-SAPR3-VAR
-SAPR3-VAR_PARAM<nn>
-SAPR3-VAR_TEXT
In the following example, the ctmr3req utility is used to alter parameter values,
using the DGOLDHAD account, for the prog1 program, with the var1 variant,
when the Airline value is an integer between 5 and 9, and the text is This is a test
variant. All parameters are mandatory, except the -SAPR3-VAR_TEXT
parameter, as indicated by the square brackets.
ctmr3req -SAPR3-ACTION var_edit -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-PROGRAM prog1 -SAPR3-VAR var1 -SAPR3-VAR_PARAM01
"AIRLINE=I,BT,5 => 9" [-SAPR3-VAR_TEXT "This is a test var"]
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
128
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_show
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
-SAPR3-VAR <variant_name> [-Agent <agent_name>]
Table 25
Parameter
Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
-SAPR3-VAR
In the following example, the ctmr3req utility is used to display variant details in a
program, searching for var1 variants, using the DGOLDHAD account, for the
RSAAA02 program. All parameters are mandatory.
ctmr3req -SAPR3-ACTION var_show -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-PROGRAM prog1 -SAPR3-VAR var1
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
129
Deleting a job
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION raise_event
-SAPR3-ACCOUNT <account_name> -SAPR3-EVENT_ID <event_ID>
-SAPR3-EVENT_PARAM <event_parameter> [-Agent <agent_name>]
Table 26
Parameter
Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-EVENT_ID
-SAPR3-EVENT_PARAM
In the following example, the ctmr3req utility is used to raise the ev1 event, with
the parameter value of evparm1, using the DGOLDHAD account. All parameters
are mandatory.
ctmr3req -SAPR3-ACTION raise_event -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-EVENT_ID ev1 -SAPR3-EVENT_PARAM evparm1
Deleting a job
Use this procedure to delete a specific job from the SAP database.
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To delete a job
Enter the following command, with the parameters set according to the values
described in Table 27, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION job_delete -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-JOBCOUNT <job_count>
130
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION job_delete
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBNAME <job_name>
-SAPR3-JOBCOUNT <job_count> [-Agent <agent_name>]
Table 27
Parameter
Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-JOBCOUNT
In the following example, the ctmr3req utility is used to delete a job. All
parameters are mandatory.
ctmr3req -SAPR3-ACTION job_delete -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-JOBNAME job1 -SAPR3-JOBCOUNT 12344321
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To define a job
Enter the following command, with the parameters set according to the values
described in Table 28, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION job_define -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E}
-SAPR3-STEP-S<nn>-PROGRAM <program_name>
131
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION job_define
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBNAME <job_name>
-SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E} -SAPR3-STEP-S<nn>-PROGRAM
<program_name> [-Agent <agent_name>]
NOTE
The remainder of the syntax for this action depends on the value of the
-SAPR3-STEP-S<nn>-STEP_TYPE parameter, and subsequent parameter values.
Table 28
Parameter
Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-STEP-S<nn>STEP_TYPE
-SAPR3-STEP-S<nn>PROGRAM
NOTE
The Target Group and Target Server parameters are not supported by the ctmr3req utility in
In the following example, the ctmr3req utility is used to define a new job. The first
five parameters are mandatory, including -SAPR3-STEP-S01-STEP_TYPE. The
following step types can be selected:
132
A = ABAP program
C = External command
E = External program
Modifying a job
The remaining parameters are defined according to both the step type and your
specifications. There can be more than one step type, and not all step types require the
same specification.
ctmr3req -SAPR3-ACTION job_define -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-JOBNAME job1 -SAPR3-STEP-S01-STEP_TYPE A
-SAPR3-STEP-S01-PROGRAM ZQA_WITH_VARIANTS -SAPR3-STEP-S01-VAR-NAME
MOMO -SAPR3-STEP-S01-PRINT_COPIES 030
Modifying a job
Use this procedure to modify an existing job in the SAP database.
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To modify a job
The procedure for modifying an existing job using the ctmr3req utility is very similar
to the procedure for defining a new job using this utility.
Enter the following command, with the parameters set according to the values
described in Table 29, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION job_modify -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-JOBCOUNT <job_count>
-SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E} -SAPR3-STEP-S<nn>-PROGRAM
<program_name>
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION job_modify
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBNAME <job_name>
-SAPR3-JOBCOUNT <job_count> -SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E}
-SAPR3-STEP-S<nn>-PROGRAM <program_name> [-Agent <agent_name>]
133
Modifying a job
NOTE
The remainder of the syntax for this action depends on the value of the
-SAPR3-STEP-S<nn>-STEP_TYPE parameter, and subsequent parameter values.
Table 29
Parameter
Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-JOBCOUNT
-SAPR3-STEP-S<nn>STEP_TYPE
A = ABAP program
C = External command
E = External Program
NOTE
For information about additional parameters for use when defining a new job, see the
CONTROL-M Parameters and Variables Reference Guide.
In the following example, the ctmr3req utility is used to modify an existing job. As
with the procedure for defining a new job (see page 131), the first five parameters
are mandatory. In this example, the second step is being modified. Even if the step
type is the same as it was previously, it must still be set in the utility.
ctmr3req -SAPR3-ACTION job_modify -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-JOBNAME job1 -SAPR3-JOBCOUNT 13292201
-SAPR3-STEP-S02-STEP_TYPE A -SAPR3-STEP-S02-PROGRAM
ZQA_WITH_VARIANTS -SAPR3-STEP-S02-VAR-NAME KUKU
134
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION
PC_STOP_SCHEDULE -SAPR3-ACCOUNT <account_name>
-SAPR3-PROCESSCHAIN_ID <chain_id> [-Agent <agent_name>]
Table 30
Parameter
Description
SAPR3-ACTION
SAPR3-ACCOUNT
Below is an example of the ctmr3req utility when used to remove a process chain
from schedule, using the DGOLDHAD account, and pc1 as processchain_id:
ctmr3req -SAPR3-ACTION PC_STOP_SCHEDULE -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-PROCESSCHAIN_ID pc1
135
NOTE
This utility is specific to users who have a previous installation of CONTROL-M/Option for
R/3.
Both CONTROL-M/CM for SAP and CONTROL-M option for R/3 can exist and run
concurrently on your computer.
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
Before running this utility, you must use the ctm_r3_acc_man utility of
CONTROL-M option for R/3 to modify the R/3 Language account fields to
single-letter values.
Note that single-letter language values are case sensitive. For example, D stands
for German, while d stands for Serbo-Croatian. The single-letter values for
languages can be found in the SPRAS field of SAP table T002. For more
information on using one or two letters to represent languages, refer to SAP
documentation and SAP Note 92012.
2 Press <Enter>. CONTROL-M/CM for SAP takes the information from the
CONTROL-M/Option for R/3 account file, and creates a new file, based on this
information, located with all CONTROL-M/CM for SAP accounts file. The account
definition is automatically saved.
136
Subject
Location
NOTE
This utility can convert both command line jobs, and jobs that use the Grid functionality in
Enterprise Controlstation 6.0.0x. For more information regarding which jobs can be converted,
see What can be converted? on page 138.
You must use CONTROL-M/EM version 6.1.0x. This means that scheduling tables
that were created using 6.0.x Grid functionality must first be migrated to
CONTROL-M/EM 6.1.0x and then exported, as described in Step 1, below.
If you are working in a Microsoft Windows environment, open a new DOS prompt
window.
To convert jobs
1 In CONTROL-M/EM, export the scheduling table that you want to convert, using
the exportdeftable utility. For more information about the exportdeftable utility,
see the CONTROL-M/Enterprise Manager Utility Guide.
2 Run the conversion utility from the temporary directory using the following
command:
ctmr3con [-IN_FILE <input_file>]
[-OUT_FILE <output_file>]
[-JOB_MAN_DEF_MODE {CREATE|DEFINE|MODIFY|RUN_
COPY|RUN_ORG|WAITONLY}]
[-RUN_COPY_MODE {LAST|FIRST|LAST_SCHEDULED|
FIRST_SCHEDULED}] [-HELP]
NOTE
This syntax is applicable for both Microsoft Windows and Unix operating systems.
However, in Unix you may need to add ./ before ctmr3con (for example, ./ctmr3con
-IN_FILE abc.xml -JOB_MAN_DEF_MODE RUN_ORG).
137
Table 31
Parameter
-IN_FILE
-OUT_FILE
-JOB_MAN_DEF_MODE
-RUN_COPY_MODE
The conversion utility should be run only from the directory in which it is located.
3 Before importing the new scheduling table into CONTROL-M/EM, either delete
the original scheduling table (using the Local Delete functionality), or rename it.
4 Run the deftable utility on the output file (converted scheduling table). The output
file name is displayed at the end of the conversion utilitys output (see Step 2 on
page 137). The jobs in the selected scheduling table are converted.
For more information about the deftable utility, see the CONTROL-M/Enterprise
Manager Utility Guide.
138
ctm_r3_xjob_man
ctm_r3_job_man
ctm_r3_bi_mon
ctm_r3_xvar_mon
ctm_r3_var_man (except the copy variant function)
ctm_r3_xutils (for raise event functionality only)
Jobs for the following CONTROL-M Option for R/3 utilities cannot be converted:
ctm_r3_job_mand
ctm_r3_xjob_mand
ctm_r3_job_mon
ctm_r3_xjob_mon
ctm_r3_xutils (for all functionality except raise event)
NOTE
The ctm_r3_job_mand and ctm_r3_xjob_mand utilities are not converted because
CONTROL-M/Control Module for SAP has a built-in tracking facility, rendering these
utilities redundant. If you are no longer using CONTROL-M Option for R/3, you can stop
using jobs containing these utilities or delete these jobs.
Known issues
The following table describes special considerations and limitations for conversion of
certain parameters or utilities:
Table 32
Problem parameters
Parameter / feature
Clarification / remarks
ctm_r3_var_man
-list
Not supported.
-modify
-acc
139
Table 32
Problem parameters
Parameter / feature
Clarification / remarks
-pass
-cancel
Not supported.
-debug
ctm_r3_bi_mon
-rfc_trace
Not Supported.
Any unknown
parameter
Redirection
(> or >>)
140
Appendix
create one or more mirror-image jobs by using criteria identical to that of specific
jobs already running in SAP
These are then monitored using the CONTROL-M ctmcreate utility (but are not
submitted). This enables CONTROL-M to track the progress of the actual job in
SAP. This mirror image is stored in the Active Jobs file in the CONTROL-M/Server
database. For more information, see Monitoring SAP jobs with the extraction
utility on page 146.
To perform either of these actions, you must create a rule file, as described in
Defining a rule file with the extraction utility on page 142.
141
If you are working in a Microsoft Windows environment, ensure that you have a
DOS window running.
If you are working in a Unix environment, ensure that you are logged in to a
CONTROL-M/Agent account.
The first section indicates which job definitions are to be monitored or extracted,
by setting the selection criteria for the job (described below).
The second section specifies whether to monitor the job (ctmcreate), or extract
its definition to CONTROL-M (ctmdefine), described on page 144.
[CONDITION1]
%%SAPR3-JOBNAME SH_CR15
%%SAPR3-ACCOUNT CM2
%%SAPR3-OWNER SH*
2 In the first section of your rule file, set AutoEdit variables under the [CONDITION1]
string. The AutoEdit variables available are described in Table 33. Type the
required AutoEdit variables, and save.
Table 33
AutoEdit Variable
Description
%%SAPR3-ACCOUNT
142
Table 33
%%SAPR3-JOBNAME
%%SAPR3-OWNER
%%SAPR3-JOBCOUNT
%%SAPR3-JOBGROUP
%%SAPR3-FROM_DATE
%%SAPR3-FROM_TIME
%%SAPR3-TO_DATE
143
Table 33
%%SAPR3-TO_TIME
%%SAPR3-EVENT_ID
Background event ID
Free text
%%SAPR3-EVENT_PARAM
%%SAPR3-RELEASED
%%SAPR3-READY
%%SAPR3-ACTIVE
%%SAPR3-FINISHED
%%SAPR3-CANCELED
144
The second section depends on whether you want to monitor or extract job
definitions. As indicated in the example, you must choose either [CTMCREATE] or
[CTMDEFINE], as required:
Choose [ctmcreate] to create one or more jobs that monitor identical jobs already
running in SAP. For more information, see Monitoring SAP jobs with the
extraction utility on page 146.
3 Set the parameters for the second section. See Table 34 for a full list of parameters.
All parameters are mandatory, regardless of whether you choose to monitor or
extract job definitions.
NOTE
All parameters described in Table 34 exist in both utilities, except where otherwise
indicated.
Table 34
Parameter
Description
NODEGRP
%%SAPR3ACCOUNT
GROUP
TABLE
NOTE
You can define any CONTROL-M parameter accepted by either the ctmcreate or ctmdefine
utilities. For a detailed description of all CONTROL-M job parameters, see the
CONTROL-M Job Parameter and Variable Reference Guide.
145
Subject
Location
Extracting Job Definitions using the rule See Extracting job definitions with the extraction
file you have just created.
utility on page 147
NOTE
Mirror images are only created for jobs that do not have scheduled status.
If you are working in a Microsoft Windows environment, ensure that you have a
DOS window running.
If you are working in a Unix environment, ensure that you are logged in to a
CONTROL-M/Agent account.
NOTE
This command line can be used as part of a CONTROL-M regular job (command line), or
cyclic job. By using a cyclic job, you can repeat the job extraction according to the selected
rule file.
146
NOTE
To make a ctmextract instance re-extract all jobs, add -IGNORE_DUP Y to the original
command, and repeat the procedure described above.
Parameter
Description
-CM_APPL_TYPE
-RULETABLE
-IGNORE_DUP
Location
Extracting Job Definitions using the rule See Extracting job definitions with the extraction
file (as described above) that you have utility on page 147
just created.
NOTE
Only jobs that have scheduled status can have their definition extracted.
147
If you are working in a Microsoft Windows environment, ensure that you have a
DOS window running.
If you are working in a Unix environment, ensure that you are logged in to a
CONTROL-M/Agent account.
NOTE
To make a ctmextract instance re-extract all jobs, add -IGNORE_DUP Y to the original
command, and repeat the procedure described above.
148
Subject
Location
Appendix
NOTE
This may require you to install later support packages on your SAP system.
Table 36
Description
835846
782127
756901
Intercepted jobs are released and started by SAP just after being
intercepted. As a result, the Interception functionality is unusable. See
the following Flash: "Intercepted jobs are released by SAP".
833777
If you want to create jobs with the After Event start condition, this note must be
installed in your SAP system.
732350
699144
609462
Appendix B
149
Table 36
150
Description
101146
635095
487374
728947
839526
330267
664830
677081
Data Archiving: Delete and Store jobs may not be recognized as children
of the Write job. This SAP Note must be implemented when working
with the CONTROL-M solution for Data Archiving with XBP 2.0
functionality.
458670
Data Archiving: This SAP Note should be implemented when using XBP
1.0 on SAP 4.6C.
16083
A review of Standard Jobs and Reorganization jobs. See also SAP Note
182963, below.
182963
When using SAP releases earlier than 4.6C, follow the instructions in
SAP Note 182963.
612564
654802
610480
Slow reaction of certain BAPI functions can affect the Extractor process
performance, and the loading of job names in the Job Editing form.
605483
602683
When a parent job name contains a period ("."), the child job is not
always registered as such, causing the parent job to finish without
waiting until the child job has finished.
641175
604496
Table 36
Description
628917
856780
790615
Load ABAP fails with error 101 - Call back function with events called.
Appendix B
151
152
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Index
A
ABAP
description 12
ABAP Program parameter
Add ABAP window 62
Account Management window 100
Account parameter
Data Archiving 86
SAP panel 51
SAP-BW 93
Accounts
checking configuration 103
configuration parameters 101
converting definitions 135
defining 31, 100
handling 99
Activating Xtractor process 124
Active SAP job status 15
Add ABAP window
parameters 62
Add External Program window
parameters 69, 71
Administrator password 103
Altering variant parameter values 127
Application Node Group parameter 47
Application parameter 47
Archive ID parameter
Add ABAP window 62
Archive Mode parameter
Add ABAP window 64
Archive Text parameter
Add ABAP window 62
Archiving Object parameter
Data Archiving 86
Audit Level parameter 105
Authorization 29
SAP user 102
Authorization parameter
Add ABAP window 62
B
Background Job Count parameter
SAP-BW 97
Background Job Name parameter
SAP-BW 93
BMC Software, contacting 2
Business Warehouse 91
Business Warehouse job
creating 91
C
Canceled
SAP job status 15
Check Sessions parameter
Data Archiving 86
Check Variant parameter
Data Archiving 87
Client parameter
ctmr3acc utility 101
Columns parameter
Add ABAP window 62
Condition Format field
Skeleton Editor 47
Configuration Management window 110
Configuring environment
XBP 2.0 84
conr3acc utility 135
Controlling jobs 111
CONTROL-M Function Modules 37
CONTROL-M functionality 11
CONTROL-M Job Name parameter
SAP-BW 94
CONTROL-M/Option for R/3
existing installation 25
Conversion utility
installing 42
uninstalling 42
Unix 42
Conversion Utility parameters 138
Converting account definitions 135
Converting R/3 jobs 137
Copy From Step parameter
SAP panel 51
Copy Spool To parameter
Data Archiving 87
CTM interception rules 114
CTM interception rules parameters 113
ctmcreate parameters 145
Index
151
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
ctmdefine parameters 145
ctmextract utility 141
ctmgetcm utility 46
ctmr3cfg utility 139
ctmr3req utility 125, 133
ctmxtcfg utility 107
customer support 3
D
DA transport 41
Data Archiving 19
workflow XBP 1.0 20
workflow XBP 2.0 23
XBP 1.0 20
XBP 2.0 21
Data archiving 75
creating a session with XBP 1.0 76
creating a session with XBP 2.0 79
defining a job 77, 80, 82, 83
Data archiving sessions, drafts 79
Defining
accounts 100
Data Archiving job 77, 82, 83
Data Archiving job with XBP 2.0 80
Data Archiving session with XBP 1.0 76
Data Archiving session with XBP 2.0 79
Group Scheduling table 80
job skeleton 45
jobs 131
rule file 142
SAP jobs 49
SAP-BW job 91
user exit 123
Delete After Print parameter
Add ABAP window 62
Delete job 75
Delete job template 76
XBP 2.0 22
Deleting jobs 130
Department parameter
Add ABAP window 63
Detect Delete job
XBP1.0 20
Detect job 75
Detect Spawned Jobs button
SAP panel 52
Detect Spawned Jobs parameter
Data Archiving 87
Detect Store job
XBP 1.0 20
Detecting spawned jobs 121
Displaying variant details 128
Displaying variants 126
Document Type parameter
Add ABAP window 63
152
E
Event, raising 129
Execution panel 78
Existing jobs
scheduling 15
exportdeftable utility 137
Extended and Standard mode 139
Extended mode 37
Extracting job definitions 147
Extracting SAP CCMS jobs 116
Extraction rules parameters 118
Extraction utility 141
F
Features 11
Form Name parameter 48
Function Modules 37
installing 40
G
Group Scheduling table 76, 80
I
Importing
SAP panel 36
transports 41
InfoPackage Description parameter
SAP-BW 94
InfoPackage RNR parameter
SAP-BW 97
InfoPackage Tech. Name parameter
SAP-BW 94
Information Field parameter
Add ABAP window 63
INITXBP2 102, 108
Installation
function modules 40
importing SAP panel 36
importing transports 40
requirements 26
Intercepted jobs
preventing discarding 114
Intercepting jobs 111
Into Group parameter 113
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
K
Known issues 139
L
Language parameter 102
Add ABAP window 63
Layout parameter
Add ABAP window 63
N
Name parameter
Add ABAP window 63
New Spool Request parameter
Add ABAP window 63
Number of Copies parameter
Add ABAP window 63
O
Object Type parameter
Add ABAP window 63
Output Device parameter
Add ABAP window 64
Owner parameter
Add ABAP window 64
Add External Program window 70, 72
P
Parameters 70, 72
Add ABAP window 62
Add External Program window 69, 71
avoiding discarded intercepted jobs 115
Client 101
conversion utility 138
CTM Interception Rules 113
ctmcreate and ctmdefine 145
ctmr3acc utility 101
ctmr3cfg utility 105
Extraction Rules panel 118
for monitoring a job 147
job_define action 132
job_delete action 131
job_modify action 134
problems 139
raise_event action 130
rule file autoedit 142
rules viewer 119
SAP panel Active Job mode 74
SAP panel Job Definition mode 51
Index
153
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
SAP panel, Data Archiving 86
SAP-BW Job panel 93
spawned jobs 122
user exit script 124
var_edit action 127
var_mon action 126
var_show action 129
XBP version 102
Parameters parameter
Add External Program window 70, 72
Password configuration 103
Platforms 26
Preventing discarding intercepted jobs 114
Print Expiration parameter
Add ABAP window 64
Priorities, setting 110
Problem parameters 139
Process Chain Description parameter
SAP-BW 94
Process Chain ID parameter
SAP-BW 95
Process Chain Log ID parameter
SAP-BW 97
product support 3
Products 13
Program parameter 113
Q
QID parameter
SAP panel 55
R
R/3 jobs
converting 137
raise_event action parameters 130
Raising SAP event 129
Ready (SAP job status) 15
Recipient parameter
Add ABAP window 64
Released (SAP job status) 15
Request utility 125
Rerun options parameter
SAP-BW 97
RFC Max Retry parameter 105
RFC Retry Interval parameter 105
Rows parameter
Add ABAP window 65
Rule file
defining 142
Rules viewer parameters 119
Run Copy Mode parameter 106
Run Org Mode parameter 106
Running jobs 15
154
S
SAP account, defining 31
SAP authorization 29
SAP CCMS jobs
extracting and monitoring 116
SAP Cover Page parameter
Add ABAP window 65
SAP event, raising 129
SAP Interception Criteria panel 112
SAP job status
Active 15
Canceled 15
Finished 15
Ready 15
Released 15
Scheduled 15
SAP jobs
cancelling 74
creating 49
skeleton 45
status 74
SAP language 102
SAP panel
illustration, Active Job mode 73
illustration, BW InfoPackage 92
illustration, BW Process Chain 92
illustration, Data Archiving 77, 81
illustration, Job Definition mode 50
importing functionality 36
Job Editing form 49
parameters, Active Job mode 74
parameters, BW 93
parameters, Data Archiving 86
parameters, Job Definition mode 51
steps 49
SAP system number 101
SAP-BW jobs 91
monitoring 96
SAP-BW panel
illustration, InfoPackage 96
parameters 93
parameters, Active Job mode 97
SAP-BW/Business Process Type parameter
SAP-BW 95
SARA transaction 24
Scheduled
SAP job status 15
Scheduling jobs 15
Selection Cover Page parameter
Add ABAP window 65
Session Number parameter
Data Archiving 88
Setting job type priorities 110
Skeleton
SAP jobs 45
SM37 transaction 15
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Spawned jobs 18, 122
XBP 2.0 21
Standard and Extended mode 139
Statuses 16
statuses (SAP jobs) 15
Steps buttons
SAP panel 58
Steps panel 78
Store job 75
Store job template 76
XBP 2.0 22
Submit Job with ASAP Option parameter
Data Archiving 89
support, customer 3
Supported platforms 26
System Number 101
T
Target Host parameter
Add External Program window 70, 72
Target Server parameter
Data Archiving 90
SAP panel 59
technical support 3
Template Job Name parameter 114
Template Scheduling Table parameter 114
Titles parameter
Add ABAP window 65
transactions
SM37 15
Transport facility 40
Transports, importing 41
W
Wait for Termination parameter
Add External Program window 70, 71
Write job 20, 75, 76
XBP 2.0 22
X
XBP 1.0 75, 76
Data Archiving 20
workflow 20
XBP 2.0 76, 79
configuring environment 84
Data Archiving 21
workflow 23
XBP 2.0 functionality 17, 37
XBP version, specifying 102
Xtractor 116
Xtractor Configuration Management utility 107
general configuration 109
illustration 112
Xtractor service
activating on Unix 124
activating on Windows 125
Uninstalling
conversion utility 42
on Unix 42
on Windows 43
Unix installation 42
Unix uninstallation 42
Upgrading 34
on Unix 34
Use ABAP Program Default parameter
Add ABAP window 66
Use Extended parameter 106
Use_Extended 37
User exit 123
User Exit parameter 114
User parameter 113
V
var_edit action parameters 127
Index
155
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
156
Notes
*56598*
*56598*
*56598*
*56598*
*56598*