You are on page 1of 160

CONTROL-M/Control Module

for SAP
Administrator Guide

Supporting
CONTROL-M/Control Module for SAP version 6.2.01

September 30, 2005

Contacting BMC Software


You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information
about the company, its products, corporate offices, special events, and career opportunities.

United States and Canada


Address

BMC SOFTWARE INC


2101 CITYWEST BLVD
HOUSTON TX 77042-2827
USA

Telephone

713 918 8800 or


800 841 2031

Fax

(01) 713 918 8000

Fax

713 918 8000

Outside United States and Canada


Telephone

(01) 713 918 8800

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.

Restricted rights legend


U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE
COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the
U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS
252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is
BMC SOFTWARE INC, 2101 CITYWEST BLVD, HOUSTON TX 77042-2827, USA. Any contract notices should be sent to
this address.

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

Support by telephone or e-mail


In the United States and Canada, if you need technical support and do not have access to the web, call 800 537 1813 or
send an e-mail message to support@bmc.com. Outside the United States and Canada, contact your local support center for
assistance.

Before contacting BMC Software


Before you contact BMC Software, have the following information available so that Customer Support can begin working
on your problem immediately:

product information

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

operating system and environment information

machine type
operating system type, version, and service pack or 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

sequence of events leading to the problem

commands and options that you used

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

product error messages


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

CONTROL-M/Control Module for SAP Administrator Guide

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

Step 1 - Installation and upgrade requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


SAP authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 2 - Installing or upgrading CONTROL-M/CM for SAP . . . . . . . . . . . . . . . . . . . .
Installing CONTROL-M/CM for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Downloading the RFC library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading CONTROL-M/CM for SAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 3 - Importing the SAP panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 4 - CONTROL-M function modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing CONTROL-M function modules to SAP Unicode systems . . . . . . . . .
CONTROL-M/CM for SAP and the SAP XBP interface . . . . . . . . . . . . . . . . . . . . .
CONTROL-M/CM for SAP and SAP Business Information Warehouse . . . . . . .
Installing the CONTROL-M FMs in the SAP system . . . . . . . . . . . . . . . . . . . . . . . .
Installing the Conversion utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstalling CONTROL-M/CM for SAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26
29
31
31
33
34
36
37
37
37
40
40
42
42

Chapter 3

45

Defining and monitoring SAP jobs in CONTROL-M

Creating a job skeleton for SAP jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


SAP R/3 jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating a SAP job in CONTROL-M/Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAP panel parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting job steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring and managing SAP jobs in CONTROL-M . . . . . . . . . . . . . . . . . . . . . .
Data archiving jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents

45
49
49
51
60
73
75
5

Data archiving with XBP 1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75


Data archiving with XBP 2.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Creating a Data Archiving session with XBP 1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Creating a Data Archiving session with XBP 2.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Configuring the environment to work with Data Archiving
Sessions in XBP 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
SAP panel parameters for data archiving. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Business Information Warehouse jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Creating a Business Information Warehouse job . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
SAP panel parameters for SAP-BW jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Monitoring and managing Business Information Warehouse jobs . . . . . . . . . . . . 96
Chapter 4

Administrator tasks

99

Handling accounts for CONTROL-M/CM for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99


Adding or modifying a CONTROL-M/CM for SAP account. . . . . . . . . . . . . . . . 100
Configuring general parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Configuring and working with the Xtractor process . . . . . . . . . . . . . . . . . . . . . . . . . . 107
General configuration of the Xtractor process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Job interception and control with the Xtractor process . . . . . . . . . . . . . . . . . . . . . 110
Extracting and monitoring SAP CCMS jobs with the Xtractor . . . . . . . . . . . . . . . 116
Initiating a mass parallel process (detecting spawned jobs) . . . . . . . . . . . . . . . . . 121
Defining a user exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Activating the Xtractor process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Requesting SAP actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Displaying a list of variants for a program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Altering parameter values in a variant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Displaying variant details within a program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Raising a SAP event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Deleting a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Defining a new job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Modifying a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Converting account definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Converting CONTROL-M option for R/3 jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Appendix A

Extracting and monitoring jobs

141

Defining a rule file with the extraction utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142


Monitoring SAP jobs with the extraction utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Extracting job definitions with the extraction utility . . . . . . . . . . . . . . . . . . . . . . . 147
Appendix B

Related SAP Notes

Index

CONTROL-M/Control Module for SAP Administrator Guide

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

CONTROL-M/Control Module for SAP Administrator Guide

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

CONTROL-M/Control Module for SAP Administrator Guide

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

the ability to integrate and manage large quantities of jobs

advanced scheduling and monitoring capabilities between different SAP systems,


and between SAP and non-SAP systems

advanced high level networking between jobs

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

integration between mySAP (non R/3) and R/3 components

Using CONTROL-M/CM for SAP, you can

define, schedule, and store SAP jobs in the CONTROL-M database

submit SAP jobs using the CONTROL-M/Enterprise Manager


(CONTROL-M/EM) GUI

monitor and control SAP jobs from within CONTROL-M/EM

intercept jobs in SAP, then control and monitor them in CONTROL-M

create and monitor mass parallel processes (spawned jobs)

Chapter 1

Introduction

11

Terminology

archive and delete older data as required, using the CONTROL-M solution for SAP
Data Archiving

monitor and control SAP-Business Warehouse business processes in


CONTROL-M, using the CONTROL-M solution for SAP-BW

use SAP advanced load-balancing mechanism, such as Logon Groups and Job
Server Group

control advanced job submission options from within CONTROL-M, such as


event-dependent jobs and Spool list recipient for the job

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

Language used within the SAP system (ABAP Reports). Also


referred to as ABAP/4.

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

Computer on which the SAP GUI runs.

SAP Note

A SAP-produced document that details a specific problem in the SAP


system, and a suggested solution.

BAPI

Business Application Programming Interface. A set of ABAP/4


function modules accessible through RFC technology (Remote
Function Calls). BAPIs are an open interface for integrating with SAP
products, assuring their stability and compatibility with current and
future releases.

CONTROL-M/Control Module for SAP Administrator Guide

More about CONTROL-M

Term

Description

BC-XBP (External
Interface for Job
Background
Processing)

A set of SAP-created and certified BAPIs that enable CONTROL-M


to control, start and monitor jobs outside SAP R/3. Through this
interface, SAP R/3 Computer Center Management System (CCMS)
supports CONTROL-M integration with existing administration
tools.
XBP 2.0: The new certified version of SAP BC-XBP. XBP 2.0 is an
enhancement of XBP 1.0, and can be installed without changing
current functionality. The primary advantages are:

New Parent/Child (spawned) job functionality


New interception capabilities
Triggering events and additional help functions.
New and enhanced ways of working with jobs:
defining, monitoring, modifying, starting and deleting jobs

For more information about the XBP 2.0 interface, see SAP Note
6044996.
CONTROL-M
function modules

CONTROL-M extended functionality installed in SAP.


For more information see Step 4 - CONTROL-M function modules
on page 37.

Spawned job

A job created by another job that is monitored by CONTROL-M.

Parent job

A job that created one or more spawned jobs.

Business Warehouse SAP Business Information Warehouse (BW) is a data warehouse


(BW)
solution for SAP R/3. However, it is a separate application,
independent of SAP R/3.
P/C

A Business Information Warehouse Process Chain

I/P

A Business Information Warehouse InfoPackage

Administrator
Workbench

The Administrator Workbench is a GUI-based tool for BW


implementation, maintenance, customization, scheduling, and
monitoring and is a part of the SAP front-end.

CONTROL-M/EM

CONTROL-M/Enterprise Manager.

FixPack

A CONTROL-M bug resolution.

More about CONTROL-M


CONTROL-M/CM for SAP, together with the CONTROL-M products described
below, are included in the CONTROL-M scheduling solution.

Chapter 1

Introduction

13

Related Publications

Product

Description

CONTROL-M/Enterprise
Manager

Central GUI-based control center from which you can


manage all scheduling and workflow activities.

CONTROL-M/Server

The engine (on a Unix or Microsoft Windows computer)


used to drive scheduling in a data center. Each
CONTROL-M/Server can manage multiple
CONTROL-M/Agents on various platforms.

CONTROL-M/Agent

Software for job submission and execution. An Agent


must exist on each computer that is used to execute
CONTROL-M jobs.

Additional products are available for interfacing between the CONTROL-M


scheduling solution and other systems management products.
For more information, contact your BMC Software sales representative.

Related Publications

14

CONTROL-M/Server Administrator Guide describes setup, security, and utilities


for CONTROL-M/Server on a specific platform (Unix, or Microsoft Windows).

CONTROL-M/Agent Administrator Guide describes configuration and


maintenance of CONTROL-M/Agent on various platforms.

CONTROL-M/Enterprise Manager User Guide describes


CONTROL-M/Enterprise Manager concepts, features, and facilities.

CONTROL-M/Enterprise Manager Administrator Guide describes administrator


responsibilities, customization, maintenance, and security of CONTROL-M/EM.

CONTROL-M/Enterprise Manager Utility Guide describes command line


utilities, for use with CONTROL-M/Enterprise Manager.

CONTROL-M/Desktop User Guide describes how to define and manage


CONTROL-M job processing definitions, scheduling tables, and calendars.

CONTROL-M Job Parameter and Variable Reference Guide describes the


parameters of job processing definitions, and variables that can be included as
values for these parameters.

CONTROL-M/Control Module for SAP Administrator Guide

An overview of SAP job scheduling

An overview of SAP job scheduling


A job in SAP is composed of a list of steps. Each step should be either an ABAP/4
program, an external program, or an external command.
Jobs in the SAP system are executed in background processes, which are defined on
the SAP servers.
SAP jobs are monitored in SAP using SAP transaction SM37. This transaction
displays all jobs and their associated status. The following table summarizes the
various SAP job statuses.
Status

Description

Scheduled

The job is defined with no scheduling criteria.

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

The job is currently executing.

Canceled

The job was canceled by the operator or has terminated abnormally.

Finished

The job ended successfully.

Using CONTROL-M to schedule SAP jobs


All CONTROL-M capabilities are available to SAP jobs, including advanced
scheduling criteria, complex dependencies, Quantitative and Control resources, and
AutoEdit variables.

Running jobs
SAP jobs can be executed in any of the following ways:

An original SAP job is run.


A SAP job is copied and run, enabling multiple runs of identical jobs.
A SAP job is defined, stored, and submitted using CONTROL-M.

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

Monitoring and controlling SAP jobs

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.

Monitoring and controlling SAP jobs


Jobs defined, scheduled, and submitted in SAP are monitored by CONTROL-M,
using SAP-produced data. This data is obtained by searching for job-specific selection
criteria. For more information, see Extracting and monitoring SAP CCMS jobs with
the Xtractor on page 116.
CONTROL-M creates a mirror image of the job. This mirror image is not submitted
for execution, but is used by CONTROL-M to track and monitor the job.

CONTROL-M and SAP job statuses


During the run time of a job, the job status is reflected differently in CONTROL-M
and SAP databases, as described in the following table.
CONTROL-M job status

SAP job status

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

CONTROL-M/Control Module for SAP Administrator Guide

Defining and scheduling new SAP jobs

Defining and scheduling new SAP jobs


CONTROL-M/CM for SAP enables you to define and schedule new SAP jobs to be
run in SAP, using the Job Editing form in CONTROL-M/Desktop.
When defining a new SAP job, you select job steps. This means all job parameters,
including ABAP program, External command, and External program step
parameters. The job is submitted and monitored as if it were a regularly defined SAP
job. Jobs can also be defined, stored in the CONTROL-M database, and saved for
submission at a later date. For more information, see Selecting job steps on page 60.

XBP 2.0 functionality


CONTROL-M/CM for SAP is now integrated with the SAP XBP 2.0 interface
functionality. This means that many features are now provided that were previously
available only through CONTROL-M function modules, when CONTROL-M/CM
for SAP was configured to Extended mode (that is, when the Use Extended
parameter was set). These features now work through SAP-created and certified
BAPIs, that are an integral part of the CONTROL-M/CM for SAP solution.
Using XBP 2.0 functionality, you can

easily track spawned jobs, requiring no workarounds or scripts

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.

generate online, real-time lists of SAP parameters


For example, Spool list recipient, Job server groups, and step parameters such as
ABAP Programs, Show Variant details, Output Devices, Owners, External
commands, hosts, and so on

maintain better control over ABAP Program variants

Chapter 1

Introduction

17

CONTROL-M solution for Business Information Warehouse

Monitoring mass parallel processes


Mass parallel processes (spawned jobs) are created by SAP jobs that were either
created or monitored in CONTROL-M. CONTROL-M/CM for SAP detects the
spawned jobs of the SAP parent job and creates a mirror image of them in
CONTROL-M. Through these mirror images, the spawned jobs are tracked and
monitored. For more information, see Initiating a mass parallel process (detecting
spawned jobs) on page 121.

Intercepting and controlling jobs


Job interception and control is a two-stage process. Using the Xtractor Configuration
Management utility to determine which jobs should be intercepted by SAP and how
the Xtractor should handle the various intercepted jobs.
For more information, see Job interception and control with the Xtractor process on
page 110.

CONTROL-M solution for Business Information Warehouse


CONTROL-M solution for BW InfoPackages
CONTROL-M can be used to schedule, monitor, and post-process existing
InfoPackages from SAP-BW. Therefore, you should first create and test the
InfoPackages using SAP-BW tools provided by SAPGUI. For more information on
how to create and test SAP-BW InfoPackages, refer to SAP documentation.
After you create an InfoPackage in SAP, you can create a CONTROL-M job to run it.
Running this CONTROL-M job starts the InfoPackage in SAP and enables you to
monitor it.
The monitoring procedure in CONTROL-M does not monitor a specific CCMS job,
since an InfoPackage run in SAP-BW usually includes several CCMS jobs and other
operations. Instead, it uses SAP BAPIs to start and monitor the InfoPackage as a
logical unit that is not limited to one specific CCMS job.
The Sysout of the CONTROL-M job includes information similar to that displayed on
the SAP-BW status panel of the monitoring screen of an InfoPackage specific run
(transaction RSA1), including error messages. You can define post-processing rules in
CONTROL-M based on this information.
For information on how to create InfoPackage jobs in CONTROL-M, see Creating a
Business Information Warehouse job on page 91.

18

CONTROL-M/Control Module for SAP Administrator Guide

CONTROL-M solution for Data Archiving

CONTROL-M solution for BW Process Chains


CONTROL-M can be used to schedule, monitor, and post-process existing Process
Chains from SAP-BW. Therefore, you should first create and test the Process Chains
using SAP-BW tools provided by SAPGUI. For more information on how to create
and test Process Chains, refer to the SAP documentation.
After you create a Process Chain in SAP, you can create a CONTROL-M job that is
used to run it. Running this CONTROL-M job starts the Process Chain in SAP and
enables you to monitor it.
The monitoring procedure in CONTROL-M does not monitor a specific CCMS job in
SAP-BW, since a Process Chain in SAP-BW includes several CCMS jobs. Instead, it
uses BAPIs to start and monitor the Process Chain as a logical unit, not limited to a
specific process or CCMS job. This means that the entire Process Chain, the details of
which can be displayed in SAPGUI as many processes, are represented in
CONTROL-M as one job.
The Sysout of the CONTROL-M job includes information about the updated status of
each process in the chain and the number of Records transferred and requested. You
can define post-processing rules in CONTROL-M based on this information.
For more information about how to create Process Chain jobs in CONTROL-M, see
Creating a Business Information Warehouse job on page 91.

CONTROL-M solution for Data Archiving


The CONTROL-M solution for SAP Data Archiving involves the creation of a Data
Archiving session, which is a group scheduling table of Data Archiving jobs. Such a
session can

automate all phases of Data Archiving, including SAP-owned jobs and other
business processes

manage, schedule, and monitor individual archiving jobs

schedule archiving jobs according to business requirements and available


resources

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

CONTROL-M solution for Data Archiving

Data Archiving with XBP 1.0


When using XBP 1.0, each Data Archiving session includes three different jobs:

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.

Sample Data Archiving session with XBP 1.0


A sample Data Archiving session, containing all the components described above, is
provided in a CONTROL-M/Desktop draft file, named
Data_Archiving_example_XBP10.DRF. This draft is located in the FORMS directory
on the CONTROL-M/CM for SAP installation CD.
To run this session, certain customer-specific details must be adjusted (for example,
Account and Node Group).

Data Archiving workflow with XBP 1.0


Use the following workflow as a guideline.

20

CONTROL-M/Control Module for SAP Administrator Guide

CONTROL-M solution for Data Archiving

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.

Data Archiving with XBP 2.0


NOTE
For more information about XBP 2.0 functionality, see XBP 2.0 functionality on page 17.

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

CONTROL-M solution for Data Archiving

Spawned Jobs functionality makes it possible to automatically detect Delete jobs


and Store jobs, and for the SAP CM Xtractor process to automatically extract them
during run time, into the CONTROL-M active environment.

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.

Data Archiving session with XBP 2.0


When using XBP 2.0 each Data Archiving session in CONTROL-M consists of one
Write job and two templates:

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

CONTROL-M/Control Module for SAP Administrator Guide

CONTROL-M solution for Data Archiving

Sample Data Archiving session with XBP 2.0


A sample Data Archiving session, containing all the components described above, is
provided in a CONTROL-M/Desktop draft file, named
Data_Archiving_example_XBP20.DRF. This draft is located in the FORMS directory
on the CONTROL-M/CM for SAP installation CD.
To run this session, certain customer-specific details must be adjusted (for example,
Account and Node Group).

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.

Data Archiving workflow with XBP 2.0


When working with XBP 2.0, use the following workflow as a guideline.

Chapter 1

Introduction

23

CONTROL-M solution for Data Archiving

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

CONTROL-M/Control Module for SAP Administrator Guide

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:

Step 1 - Installation and upgrade requirements


Step 2 - Installing or upgrading CONTROL-M/CM for SAP
Step 3 - Importing the SAP panel
Step 4 - CONTROL-M function modules

Following this are instructions on Installing the Conversion utility and


Uninstalling CONTROL-M/CM for SAP.

Chapter 2

Installation

25

Step 1 - Installation and upgrade requirements

Step 1 - Installation and upgrade


requirements
Before installing CONTROL-M/CM for SAP, ensure that the following requirements
are met:
Requirements

Version

CONTROL-M/Agent

6.1.03 or later
Note: When installing on Itanium platforms, ensure that the
CONTROL-M/Agent version supports this.

For the Conversion utility:


CONTROL-M/EM

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

Note: For the most current operating system compatibility


information for this version, see
http://www.bmc.com/supportu/PAC_utility/index.cfm.

CONTROL-M/Control Module for SAP Administrator Guide

Step 1 - Installation and upgrade requirements

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:

4.6C - SAPKB46C41 (Support Package 41)


4.6D - SAPKB46D35 (Support Package 35)
6.10 - SAPKB61028 (Support Package 28)
6.20 - SAPKB62017 (Support Package 17)
6.40 - No support package needed

For information provided by SAP on XBP 2.0, see SAP Note


604496 (Composite SAP note XBP 2.0) and
http://service.sap.com/job-scheduling
Data archiving
If you are using XBP 1.0 on SAP 4.6C and you plan to implement
CONTROL-M support for Data Archiving, you must apply SAP
Note 458670 to your SAP system. Follow instructions provided
in the SAP note. When using XBP 2.0, this note is not necessary.
For more information, see Data archiving jobs on page 75.

Chapter 2

Installation

27

Step 1 - Installation and upgrade requirements

Requirements

Version

SAP continued

SAP Business Information Warehouse


Releases: 2.0B, 2.1C, 3.0B, 3.1 Content, 3.1 Content with BI CONT
3.20, 3.5.
If you plan to use the CONTROL-M/CM for SAP-BW
functionality, the following BW Support Packages must be
installed:

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)

If you plan to use the CONTROL-M/CM for SAP Interrupt


functionality, SAP Note 786748 must be installed manually. For
more details about Interrupts see Interrupts - Removing a
process chain from schedule on page 134.
Related SAP Notes
Various SAP Notes are required for your SAP system to function
properly with CONTROL-M/CM for SAP. Before continuing
with the installation you must read Appendix B, Related SAP
Notes. Take special note of SAP Note 835846 (for more details
see
http://documents.bmc.com/supportu/documents/59/59/5595
9/Output/090f44b18038dcb7.htm).
Java Runtime
Environment (JRE)

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

CONTROL-M/Control Module for SAP Administrator Guide

SAP authorizations

Requirements

Version

Required disk space

200 MB

RFC library

The RFC library is not delivered with the CONTROL-M/Control


Module for SAP. It must be installed separately. For more
information, see Downloading the RFC library on page 33.

SAP authorizations
SAP users of this product must have the following authorizations:
Table 1

SAP authorizations (part 1 of 2)

Authorization Object

Authorization

Values

S_BTCH_JOB

JOBACTION

Object class: BC_A (Basis:


Administration)

JOBGROUP

S_BTCH_ADM

BTCADMIN

BTCUNAME

Object class: BC_A (Basis:


Administration)
S_BTCH_NAM
Object class: BC_A (Basis:
Administration)
S_RFC
Object class: AAAB
(Cross-application)
S_XMI_PROD
Object class: BC_A (Basis:
Administration)
S_RZL_ADM
Object class: BC_A (Basis:
Administration)

Note: For an explanation on restricting this authorization see


the Owner parameter on page 64.
ACTVT
RFC_NAME
RFC_TYPE

*
*
*

EXTCOMPANY
EXTPRODUCT
INTERFACE

BMC Software
Control-M
XBP

ACTVT

Note: To prevent other SAP users (not the CONTROL-M


account user) from releasing Intercepted Jobs manually using
SAP transaction SM37, BMC Software recommends
removing the '01' value for ACTVT in the S_RZL_ADM
Authorization Object.
For further restriction of this authorization, see SAP note
605483 in Appendix B, Related SAP Notes.

S_LOG_COM
Object class: BC_A (Basis:
Administration)

COMMAND
HOST
OPSYSTEM

*
*
*

Chapter 2

Installation

29

SAP authorizations

Table 1

SAP authorizations (part 2 of 2)

Authorization Object

Authorization

Values

S_SPO_DEV

SPODEVICE

S_USER_GRP

ACTVT

Object class: BC_A (Basis:


Administration)

CLASS

S_RS_ADMWB

ACTVT

03, 16, 23, 66

Object class: RS (Business


Information Warehouse)

RSADMWBOBJ

S_RS_ISOUR

ACTVT

03, 23, 49

Object class: RS (Business


Information Warehouse)

RSAPPLNM

RSISOURCE

RSTSRCOBJ

S_RS_ISRCM

ACTVT

23

Object class: RS (Business


Information Warehouse)

RSAPPLNM

RSTSRCOBJ

RSOSOURCE

Object class: BC_A (Basis:


Administration)

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

Object class: BC_A (Basis:


Administration)

APPLIC

ARCH_OBJ

S_DATASET

ACTVT

Object class: BC_A (Basis:


Administration)

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

CONTROL-M/Control Module for SAP Administrator Guide

Step 2 - Installing or upgrading CONTROL-M/CM for SAP

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.

Step 2 - Installing or upgrading


CONTROL-M/CM for SAP
This step consists of the following two options:

Installing CONTROL-M/CM for SAP (see page 31).

Upgrading CONTROL-M/CM for SAP (see page 34).

Installing CONTROL-M/CM for SAP


Choose the appropriate installation procedure in this section. After running the
installation procedure, you must define at least one account profile before you can
use CONTROL-M/CM for SAP to define jobs. For instructions on defining an
account profile, see Handling accounts for CONTROL-M/CM for SAP on page 99.

To install CONTROL-M/CM for SAP on Unix


NOTE
Before beginning the installation procedure, ensure that all jobs are ended and all
CONTROL-M/Agent processes are shut down. For more information, see the
CONTROL-M/Agent for Unix Administrator Guide.

Chapter 2

Installation

31

Installing CONTROL-M/CM for SAP

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 Mount the installation CD.


3 Log on as the CONTROL-M/Agent user.
4 On the command line, enter
<CDROM_path>/Unix/setup.sh

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.

To install CONTROL-M/CM for SAP on Microsoft Windows


Before beginning this procedure, ensure that all jobs are ended.

1 Insert the installation CD.


If the Autorun option is enabled on your computer, installation starts
automatically after inserting the CD in the CD-ROM drive.
If the Autorun option is disabled on your computer, choose Start => Run, and
enter the following command:
<Drive_ID>:\SETUP

2 Click Accept to accept the license agreement.


3 Choose an agent from the multi-agent list. Follow the instructions given in each
window.

32

CONTROL-M/Control Module for SAP Administrator Guide

Downloading the RFC library

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.

6 Restart the CONTROL-M/Agent services.


Where to go from here
The following table describes tasks that you should perform after you complete the
installation procedure.
Subject

Location

Defining an account

See Handling accounts for CONTROL-M/CM for


SAP on page 99.

Altering CONTROL-M/CM for SAP


default configuration.

See Configuring general parameters on


page 104.

Configuring the Xtractor process.

See The Xtractor process mechanism on


page 107.

Activating the Xtractor process.

See Activating the Xtractor process on page 124.

Downloading the RFC library


The RFC library must correspond to the computer and the operating system where
the CONTROL-M/CM for SAP is installed. It also must match the compilation
environment. If you download an incorrect RFC library, CONTROL-M/CM for SAP
may not work.
Use Table 2 to help you decide which library version to download. The Paths to librfc
downloads are available in the following location:
http://www.bmc.com/support/techdocs/PARMC.6.2.01.html.
SAP Note 413708 provides updated details regarding the RFC libraries. For more SAP
information on the RFC library, go to http://service.sap.com/rfc-library.
When selecting a download path, always select non-unicode.
Table 2

RFC library details

Agent operating system

Kernel
version

32-bit or
64-bit

Library file
name

Microsoft Windows

6.20

32-bit

librfc32.dll

Microsoft Windows 2003


EE Itanium

6.20

64-bit

librfc32.dll

Chapter 2

Installation

33

Upgrading CONTROL-M/CM for SAP

Table 2

RFC library details

Agent operating system

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

Red Hat or SuSE Linux

6.40

32-bit

librfccm.so

SuSE Linux Itanium

6.40

64-bit

librfccm.so

Compaq TRU64 Unix

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\

Upgrading CONTROL-M/CM for SAP


This section describes how to upgrade CONTROL-M/CM for SAP version 6.1.01
6.1.02, or 6.1.03.

To upgrade CONTROL-M/CM for SAP on Unix


NOTE
Before beginning the installation procedure, ensure that all jobs are ended and all
CONTROL-M/Agent processes are shut down. For more information, see the
CONTROL-M/Agent for Unix Administrator Guide.

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.


34

CONTROL-M/Control Module for SAP Administrator Guide

Upgrading CONTROL-M/CM for SAP

3 If you are upgrading from 6.1.02 or 6.1.03, run the shut-xt command to shut down
the Xtractor process.

4 Back up your existing installation of CONTROL-M/CM for SAP.


5 Mount the installation CD.
6 On the command line, enter <CDROM_path>/Unix/setup.sh; an Upgrade
installation message is displayed.

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).

The upgrade procedure is performed.

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.

9 To restart the Xtractor process, run the start-xt command.


10 To restart the CONTROL-M/Agent, log on as the root user, and run the start-ag
command.

To upgrade CONTROL-M/CM for SAP on Microsoft Windows


NOTE
Before beginning the upgrade procedure, ensure that all jobs are ended.

1 Back up your existing installation of CONTROL-M/CM for SAP.


2 Insert the installation CD.
If the Autorun option is enabled on your computer, installation starts
automatically after inserting the CD in the CD-ROM drive.
If the Autorun option is disabled on your computer, choose Start => Run and enter
the following command:

Chapter 2

Installation

35

Step 3 - Importing the SAP panel

<Drive_ID>:\SETUP

3 The installation application identifies that a version of CONTROL-M/CM for SAP


that can be upgraded is installed on your computer.
A dialog box opens telling you the identified version of CONTROL-M Control
Module for SAP, and asking you if you want to continue with the upgrade. Click
Yes to continue.

NOTE
If a version of CONTROL-M/CM for SAP that cannot be upgraded is detected, a confirmation
message to uninstall is displayed.

4 The installation is complete. Follow the instructions in the Installation Complete


dialog box, and download the RFC library to the appropriate locations. For details
on downloading the RFC library see Downloading the RFC library on page 33.

5 You can now restart the CONTROL-M/Agent and CONTROL-M/CM for SAP
Xtractor services.

Step 3 - Importing the SAP panel


The following procedure ensures that SAP job parameters (the SAP panel) are
displayed in the Job Editing form in CONTROL-M/EM and CONTROL-M/Desktop.

Before you begin


Ensure that the CONTROL-M/CM for SAP application CD is mounted or easily
accessible through your network.

To import the SAP panel


This procedure must be performed on every computer that has
CONTROL-M/Enterprise Manager client components installed.

1 In CONTROL-M/Desktop, choose Tools => Import Applications Forms.


2 In the browse window, navigate to the Forms directory on the installation CD.
Select the SAP1.xml, SAP_DA.xml, and SAP_BW.xml files, and click Import.

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

CONTROL-M/Control Module for SAP Administrator Guide

Step 4 - CONTROL-M function modules

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.

Step 4 - CONTROL-M function modules


CONTROL-M Function Modules (FMs) are required in order to perform tasks that
are not provided by the SAP standard BAPIs. They are CONTROL-M/CM for
SAP-specific APIs that enhance the functionality of SAP. A set of predefined
CONTROL-M FMs is provided together with 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.

Importing CONTROL-M function modules to SAP Unicode


systems
When importing CONTROL-M Function Modules to a SAP system 6.10 or later,
contact your SAP administrator to determine whether it is a Unicode system. If it is,
you must follow the instructions provided in SAP Note 330267, in the section entitled
"Transports from 4.6 to 6.10/6.20/6.30", regarding actions to be performed during the
import procedure. Otherwise, CONTROL-M Function Modules may not work in the
SAP Unicode system.

CONTROL-M/CM for SAP and the SAP XBP interface


XBP 2.0 was created by SAP to work with external scheduling applications. XBP 2.0
replaces and upgrades many functionalities previously provided by the
CONTROL-M FMs in earlier versions of CONTROL-M/CM for SAP.
CONTROL-M/CM for SAP version 6.2.01 works integrally with the XBP interface
and its latest improved functionality in version 2.0.

Chapter 2

Installation

37

CONTROL-M/CM for SAP and the SAP XBP interface

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

XBP BAPIs versus CONTROL-M function modules (part 1 of 3)

Action

XBP 1.0 BAPIs XBP 2.0 BAPIs

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)

Raise SAP events

Submit an event-based
job

Batch Input
functionality

Submitting Data
Archiving jobs

Detecting and Releasing


Data Archiving jobs

(Using the Parent/Child


and the Interception
functions)
Job Class (A, B) in
Create mode

38

CONTROL-M/Control Module for SAP Administrator Guide

CONTROL-M/CM for SAP and the SAP XBP interface

Table 3

XBP BAPIs versus CONTROL-M function modules (part 2 of 3)

Action

XBP 1.0 BAPIs XBP 2.0 BAPIs

CONTROL-M Function
Modules

Preventing duplication
in extracting jobs from
SAP

Support for External


Command

Spool List Recipient in


Create job mode

X
X
(requires both XBP 2.0
(requires both XBP 2.0
and CONTROL-M FMs) and CONTROL-M FMs)

Additional Print and


Archiving Job Step
parameters

Improved faster
mechanism for tracking
jobs in SAP

Configure Joblog
retrieval

Opersys cover page


parameter

CP and NP options in
variant selection

Parameters for time of


printing (Print
immediate, Print later or
Send to SAP spooler)

Use Logon Groups

Load and Action requests:


ABAP Programs list
Variants list

X
X

Show Variant

Variant Copy

Variant Change

Output devices
(printers) list

Layouts (print formats)


list

Load Job Server Groups

Load External
Command

Load for distribution list

Chapter 2

Installation

39

CONTROL-M/CM for SAP and SAP Business Information Warehouse

Table 3

XBP BAPIs versus CONTROL-M function modules (part 3 of 3)

Action

CONTROL-M Function
Modules

XBP 1.0 BAPIs XBP 2.0 BAPIs

Load owner

Load event

CONTROL-M/CM for SAP and SAP Business Information


Warehouse
When working with SAP-BW there are several actions that cannot be performed by
the SAP standard BAPIs. These are performed by CONTROL-M Function Modules.
The following table describes the major differences in actions performed by BW 2.x
BAPIs, BW 3.x BAPIs, and CONTROL-M Function Modules.
Table 4

SAP-BW BAPIs versus CONTROL-M function modules

Action

BW 2.x BAPIs

BW 3.x BAPIs

Start I/P

Monitor I/P

I/P Sysout

Get Background Job


Name/Count

CONTROL-M Function
Modules

X
X

Set Background Job Name

Display the number of


records transferred and
requested of an I/P run

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

CONTROL-M/Control Module for SAP Administrator Guide

Installing the CONTROL-M FMs in the SAP system

Installing the CONTROL-M FMs in the SAP system


CONTROL-M FMs are packed in SAP Transports, and are located on the installation
CD:

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

Install this transport if you want to use the CONTROL_M authorization-role.

Chapter 2

Installation

41

Installing the Conversion utility

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.

Installing the Conversion utility


The conversion utility (ctmr3con) converts CONTROL-M Option for R/3 jobs, and
jobs created by the CONTROL-M/Desktop Job Editing form, to CONTROL-M/CM
for SAP jobs. For more information about this utility, see Converting CONTROL-M
option for R/3 jobs on page 137.

To install the Conversion utility on Unix


1 Log on to the CONTROL-M/EM computer as the CONTROL-M/EM user.
2 Extract the sap_cm_conv_ut.tar.Z zip file from the <cdrom_path>\conversion\Unix
directory to a temporary directory on the computer.

To install the Conversion utility on Microsoft Windows


1 Log on to the CONTROL-M/EM computer.
2 Extract the sap_cm_conv_ut.zip zip file from the <cdrom_path>\conversion\Windows
folder to a temporary folder on the computer.

To uninstall the Conversion utility


When you finish using the conversion utility, you can remove it by deleting the
temporary directory and all its contents.

Where to go from here


The following table describes where to find information related to this task.

42

Subject

Location

What can be converted and


how to convert jobs.

See Converting CONTROL-M option for R/3 jobs on


page 137.

CONTROL-M/Control Module for SAP Administrator Guide

Uninstalling CONTROL-M/CM for SAP

Uninstalling CONTROL-M/CM for SAP


To uninstall from Unix
NOTE
Before beginning the uninstall procedure, ensure that all jobs are ended.

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.

3 Run the following command to uninstall CONTROL-M/CM for SAP.


$HOME/BMCINSTALL/uninstall/cmsap_uninstall.sh

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.

To uninstall from Microsoft Windows


NOTE
Before beginning the uninstall procedure, ensure that all jobs are ended.

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

Uninstalling CONTROL-M/CM for SAP

44

CONTROL-M/Control Module for SAP Administrator Guide

Chapter

Defining and monitoring SAP jobs in


CONTROL-M
3

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:

Creating a job skeleton for SAP jobs on page 45


SAP R/3 jobs on page 49
Data archiving jobs on page 75
Business Information Warehouse jobs on page 91

Creating a job skeleton for SAP jobs


Use this procedure to prepare a skeleton (template) for SAP jobs in
CONTROL-M/Desktop. For more information about the Job Editing form and Job
Editing parameters, see the CONTROL-M/Desktop User Guide and the CONTROL-M
Job Parameter and Variable Reference Guide.

Before you begin


To work with Node Groups, do the following:

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

45

Creating a job skeleton for SAP jobs

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.

To create or modify a skeleton


1 Click Edit Skeleton

on the toolbar to open the Skeleton Editor, and click New.

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

Job skeleton field values (recommended)

Field

Value

Owner

default account name in use

Name

default job name


For example, JOB_{Counter}.

46

CONTROL-M/Control Module for SAP Administrator Guide

Creating a job skeleton for SAP jobs

Field

Value

MemName

Set {Name} to give the MemName the same value as the Job
Name.

MemLib

Enter any value.

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

the name of the CONTROL-M/Agent, or


the Node Group

on which you want to define and run jobs


To choose an Agent, manually enter the name of the Agent, as in the following
example:

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.

6 In the Application field

if you chose the Application Node Group field manually, you must set applicable
values from the list

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

47

Creating a job skeleton for SAP jobs

if you chose the Application Node Group field from the Load list, this field is
automatically set according to your selection

7 In the Form Name field

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

For more information about defining a skeleton, see Chapter


5 of the CONTROL-M/Desktop User Guide.

Defining a Job

For information about defining a job, see SAP R/3 jobs on


page 49. For a further description of how to define and create
a job, refer to Chapter 3 of the CONTROL-M/Desktop User
Guide.

CONTROL-M/Control Module for SAP Administrator Guide

SAP R/3 jobs

SAP R/3 jobs


You can use CONTROL-M/CM for SAP to run jobs in the SAP system. The following
section describes how to create, monitor and manage SAP R/3 jobs from within
CONTROL-M.
The following tasks are described in this section.

Creating a job skeleton for SAP jobs on page 45


SAP R/3 jobs on page 49
Selecting job steps on page 60
Monitoring and managing SAP jobs in CONTROL-M on page 73

Creating a SAP job in CONTROL-M/Desktop


Use this procedure to create a new CONTROL-M job-processing definition for a SAP
job.

Before you begin


Ensure that you have a job skeleton defined for SAP jobs. For more information, see
Creating a job skeleton for SAP jobs on page 45.

To Create a SAP job


1 Select the skeleton for CONTROL-M/CM for SAP jobs from the Current Skeleton
list in CONTROL-M/Desktop.

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.

4 Choose the required job mode. There are five options:

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

Defining and monitoring SAP jobs in CONTROL-M

49

Creating a SAP job in CONTROL-M/Desktop

Choose Original to run an existing job in SAP.

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.

Choose Batch Input to run a Batch Input session.

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

SAP panel, Job Editing form (Job Definition mode)

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.

Where to go from here


The following table describes where to find information related to this task.

50

Subject

Location

Data Archiving Jobs

See Data archiving jobs on page 75.

SAP-BW Jobs

See Business Information Warehouse jobs on page 91.

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters

SAP panel parameters


The CONTROL-M/CM for SAP fields in the SAP panel of the Job Editing form are
described in Table 6 .

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

SAP panel parameters - Job Definition mode (part 1 of 9)

Parameter

Definition

Account

Account name. Mandatory. Uppercase only, no blank spaces


permitted.
The account is a profile. The remaining parameters are predefined
according to the account, when the account is created. Account is
mapped to the CONTROL-M/EM Owner parameter.
Click the account Load button to display a list of accounts that
comply with the generic name you enter. The asterisk * can be used
as a wildcard to filter account names.
For information about defining an account, see Adding or
modifying a CONTROL-M/CM for SAP account on page 100.

Copy From Step

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

Defining and monitoring SAP jobs in CONTROL-M

51

SAP panel parameters

Table 6
Parameter

SAP panel parameters - Job Definition mode (part 2 of 9)


Definition

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.

No Detection needed: Do not detect spawned jobs of the current


job.

Detect and Create According to:


Parent (current) job definition: Detect spawned jobs of the
current job and extract these jobs to CONTROL-M, with
identical properties to the parent job.
A specific job definition: A field is displayed, in which you
enter a specific SAP-type job name. Detected spawned jobs of
the current job are extracted to CONTROL-M with identical
properties to the selected (not the current) job.
Note: The selected job must exist in the same scheduling table
as the current job.

For detailed information about detecting spawned jobs, see


Initiating a mass parallel process (detecting spawned jobs) on
page 121.
Job Class

Job submission priority (in SAP).


Mandatory for Create job mode only. Disabled for every other job
mode value.
Valid values are:

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

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters

Table 6

SAP panel parameters - Job Definition mode (part 3 of 9)

Parameter

Definition

Job Count

Unique SAP job ID number


Mandatory when Job Mode value is Copy, Original, or External.
8-digit number (specific job) or special values (string).
Special values:

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:

Create: Create a new job.


Copy: Copy an existing job.
Original: Run a previously defined job.
External: Monitors a job that runs in the SAP Server.
Batch Input: Process a Batch Input session.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

53

SAP panel parameters

Table 6

SAP panel parameters - Job Definition mode (part 4 of 9)

Parameter

Definition

Job Name

Job name to be monitored or submitted. Mandatory.


Mapped to the CONTROL-M/EM Job Name parameter.
In any job mode other than Create you can load a list of available jobs
using a Job Status and Owner filter.
Click Filter to display the Job Status Filter window and select criteria
for choosing jobs by Job Status and Owner.
Click Load to display a list of job names that meet the criteria defined
in the Job Status Filter window.

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.

The asterisk * can be used as a wildcard to filter jobs.


Note: This parameter is case-sensitive (for a generated Load list). For
example, if you entered JOBD* as criteria, the generated Load list
would display all jobs beginning with the characters JOBD, but not
jobs beginning with Jobd.
New Job Name

New job name for Copy mode only. Optional.


Mapped to the CONTROL-M/EM Job Name parameter.

54

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters

Table 6
Parameter

SAP panel parameters - Job Definition mode (part 5 of 9)


Definition

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

Do not copy. (Default for Spool)

Copy to Sysout - the Spool or Joblog is copied to the same


location as the job output. (See Sysout Handling in the
CONTROL-M Job Parameter and Variable Reference Guide). (Default
for Joblog).

Copy to file - name and path of the file to which the Spool or
Joblog is copied. Case sensitive, no blank spaces permitted.

Batch Input Session Queue ID number. Optional. Only enabled if the


job mode is set to Batch Input
Default: None
Filled automatically when you click the Job Name Load button and
select a specific Batch Input session.
If left unset, the oldest defined session is scheduled.
Note: Batch Input jobs that are deleted after they run are not
monitored. The status of jobs marked for deletion is not displayed.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

55

SAP panel parameters

Table 6

SAP panel parameters - Job Definition mode (part 6 of 9)

Parameter

Definition

Spool List Recipient

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.

Attributes: The following attributes are available. By default these


are not selected. Copy and Blind copy cannot be selected at the same
time.

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

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters

Table 6

SAP panel parameters - Job Definition mode (part 7 of 9)

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:

ASAP - Submit with ASAP option. If ASAP is selected the job


runs as soon as a background work process is available for it in
SAP. If the job cannot start immediately, it is transformed in SAP
into a time-based job.

Immediate - Start immediately (Default). If Immediate is


selected, the job either runs immediately, or fails in case there are
no work processes available to run it.

After Event - The job is submitted and waits for an event to be


triggered. This option is supported only if SAP Note 833777 is
implemented.
If you selected the After Event option in the Start Condition
window you must enter the following information:

Event: Event name. Maximum 32 characters. Mandatory for


event-based jobs. Upper case only.
Click Load to generate and display a list of available events.
The asterisk * can be used as a wildcard to filter the search.
Parameter: Event parameter. Maximum 64 characters.
Optional.

Jobs submitted with the After Event start condition, remain in


Released status in SAP until the event occurs. A message
indicating this is displayed in the CONTROL-M SYSOUT.
Note: The event-based job functionality only works if you use XBP
2.0 functionality. Load action for Events only works if you use the
Extended functionality of the CONTROL-M Function Modules.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

57

SAP panel parameters

Table 6

SAP panel parameters - Job Definition mode (part 8 of 9)

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

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters

Table 6

SAP panel parameters - Job Definition mode (part 9 of 9)

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

Application Server on which the job runs. Optional. Case sensitive,


no blank spaces permitted.
Click Load to generate and display a complete list of available
application servers.
If this parameter is left unset, the SAP system decides itself on which
application server the job is to be carried out. This is the normal
procedure recommended by SAP, because the system can then carry
out its own load balancing. BMC Software recommends that you
only select the target server if that server has particular resources
necessary for the job processing.
Note: If manually set, the following (full) format must be used:
hostname_SYSID_sysnumber

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

59

Selecting job steps

Selecting job steps


There are three different kinds of job steps that you can add to a job:

ABAP program
External command
External program

To select a job step


1 In the SAP panel of the Job Editing form, ensure that the Create job mode is
selected.

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.

3 Set the parameter values in the dialog box, as described in

Add ABAP dialog box parameters on page 61


External Command dialog box parameters on page 69
External Program dialog box parameters on page 71

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

CONTROL-M/Control Module for SAP Administrator Guide

Selecting job steps

Add ABAP dialog box parameters


The Add ABAP dialog box parameters are described in Table 7 on page 62. For more
information about these parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.
Figure 2

Add ABAP dialog box

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

61

Selecting job steps

Table 7

Add ABAP dialog box parameters (part 1 of 5)

Parameter

Description

ABAP Program

The name of the ABAP program. Mandatory. Uppercase only, blank


spaces permitted, special characters (for example, &, * or ?) not permitted.
Either
Enter a specific ABAP program manually, or

Click Load to generate and display a list of all ABAP programs. If


there are more entries than the number you entered in the Max List
Entries parameter, select Additional Results to see more results. For
more information on configuring the Max List Entries parameter, see
Configuring general parameters on page 104.

Tip: Narrow the search parameters by entering at least one character in


the field, before clicking Load. The asterisk * can be used as a wildcard.
Note: The Load button 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.
Archive ID

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

Free text description of the archive location. Optional. Case sensitive, no


blank spaces permitted.
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.

Authorization

User with print authorization. Optional. Case sensitive, blank spaces


permitted.

Columns

Maximum number of characters on an output line. Mandatory.


Valid values are: An integer between 1-255, or select the Use ABAP
program default check box to indicate that the number of characters is
obtained from the ABAP program code.
Default: 80.

Delete After
Print

Indicates if report is deleted after printing. Optional. Valid values are:

62

Selected = delete after printing


Cleared = do not delete after printing (Default)

CONTROL-M/Control Module for SAP Administrator Guide

Selecting job steps

Table 7

Add ABAP dialog box parameters (part 2 of 5)

Parameter

Description

Department

Spool department. Optional. Case sensitive. Blank spaces permitted.


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.

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

Archive information. Optional.


Free text string. Case sensitive, blank spaces permitted.
Only enabled if Print Archive Mode is set to Archive or Print & Archive.

Job Name

A read-only field that displays the job name.

Language

Language. One character. Case sensitive.


Example: E for English; D for German; d for Serbo-Croatian.

Layout

Print Layout format. Optional. Uppercase only, no blank spaces


permitted.
Click Load to generate and display a list of all layouts.
The asterisk * can be used as a wildcard to filter the search.
Note: The Load button only works if you use XBP 2.0 functionality.

Name

Spool list name. Optional. Uppercase only, blank spaces permitted.


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.

New Spool
Request

New spool request. Optional. Valid values are:

Selected = Request new spool (Default)


Cleared = Do not 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

Number of copies to be printed. Mandatory.


Valid values are: 1 - 255. Default: 1

Object Type

Archive object type. Optional. Case sensitive, blank spaces permitted.


Only enabled if Print Archive Mode is set to Archive or Print & Archive.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

63

Selecting job steps

Table 7

Add ABAP dialog box parameters (part 3 of 5)

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

Designated printer logical name. Optional. Uppercase only, no blank


spaces permitted.
Click Load to generate and display a list of all output devices.
The asterisk * can be used as a wildcard to filter the search.
Notes:
The Load button only works if you use XBP 2.0 functionality.
If the device does not exist, SAP adds a $ sign before the device name.

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 archive mode. Optional. Valid values are:

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

Name of recipient of step output. Optional. Case sensitive, blank spaces


permitted.

CONTROL-M/Control Module for SAP Administrator Guide

Selecting job steps

Table 7

Add ABAP dialog box parameters (part 4 of 5)

Parameter

Description

Rows

Maximum number of rows per page. Mandatory.


Valid values are: An integer between 1-90, or select the Use ABAP
program default check box to indicate that the number of rows is obtained
from the ABAP program code.
Default: 65.

SAP Cover Page Type of cover page for output. Optional. Valid values are:

Default Setting
Print
Do Not Print

SAP Job Step

A read-only field that indicates the step number in the job.

Selection Cover
Page

Indicates whether a selection cover page should be used. Optional. Valid


values are:

Time of Print

Selected Use cover page


Cleared Do not use cover page (Default)

Indicates whether to print job output immediately. Optional. Valid values


are:

Print out immediately


Print Later
Send to SAP spooler (Default)

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

Spool list titles. Optional. Case sensitive, blank spaces permitted.


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.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

65

Selecting job steps

Table 7

Add ABAP dialog box parameters (part 5 of 5)

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

Selected - Use the ABAP program default

Cleared - Do not use the ABAP program default. Use the number
entered in the Rows or Columns box.

Variant name. Optional. Only enabled if the ABAP program parameter is


selected.
Click Load to generate and display a list of variants available for the
selected ABAP program. The asterisk * can be used as a wildcard to filter
the search.
Uppercase only, blank spaces permitted, special characters are permitted
according to SAP guidelines. (For more information, please refer to the
SAP documentation).
When a variant is set for an ABAP program, the following buttons are
enabled:

Copy. Enables the creation of a new variant based on the properties of


an existing variant. The new variant is created as soon as you confirm
its name.

Show. Displays the variant values in a separate window (see Figure 3


on page 67).

Change. Enables you to modify the values of the various variant


parameters, see Figure 3 on page 67.
To apply these parameter values click OK.
To keep the variants original parameter values, click Undo Changes.
Note: The changes in the values of the variant parameters are only
performed during job run time.

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

CONTROL-M/Control Module for SAP Administrator Guide

Selecting job steps

Variant subparameters
Figure 3

Change variant dialog box

The following subparameters are displayed in the Show/Change variant dialog box:
Table 8

Change Variant subparameters (part 1 of 2)

Parameter

Description

Description

the Variant description


This field can be changed in the Change variant window.

a read-only field that indicates the index number of the


Variant parameter

Name

a read-only field that indicates the name of the Variant


parameter

Type

There are three variant types:

Simple - Enter a specific value in the Value field. Other


fields are disabled.
Selection - Enter a specific value in the Value field. Set
values for the Sign and Option fields.
Range - Enter Low and High values. Set values for the
Sign and Option fields.

Value

free text value; used for Simple and Selection parameter


types.

Low

the lower limit value; used only for Range parameter type

High

upper limit value; used only for Range parameter type

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

67

Selecting job steps

Table 8

Change Variant subparameters (part 2 of 2)

Parameter

Description

Sign

used for Selection and Range parameter types; specifies


whether the condition is inclusive (applies) or exclusive
(does not apply). Valid values are:

used for Selection and Range parameter types; contains the


operator for the elementary condition. See Table 9 Variant
options for selection and range types below.

Option

Table 9

I - inclusive
E - exclusive

Variant options for selection and range types

Option

Type

Description

BT

Range

Between - used with lower and upper limits

NB

Range

Not Between - used with lower and upper limits.

EQ

Selection

Equal - used with the Value field

NE

Selection

Not equal - used with the Value field

GT

Selection

Greater than - used with the Value field

LT

Selection

Less than - used with the Value field

GE

Selection

Greater or equal - used with the Value field

LE

Selection

Less than or equal - used with the Value field

CP

Selection

Contains pattern - used with wildcards in the Value field

NP

Selection

Does not contain the pattern - used with wildcards in the Value
field

For more information about select options, see SAP documentation.

68

CONTROL-M/Control Module for SAP Administrator Guide

Selecting job steps

External Command dialog box parameters


The External Command dialog box parameters are described in Table 10 . For more
information about these parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.
Figure 4

External command dialog box

Table 10

External Command dialog box parameters (part 1 of 2)

Parameter

Description

Activate trace

Indicates whether a trace is activated. Optional. Valid values are:

Name

Selected - activate
Cleared - not activated (Default)

External Command name. Mandatory. Upper-case only; blank spaces are


permitted.
Click Load to generate and display a list of all external commands. When
you select a line from the list, this field, and the Operating System fields
are inserted with the selected values.
The asterisk * can be used as a wildcard to filter the search.

Job name

A read-only field that displays the job name.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

69

Selecting job steps

Table 10

External Command dialog box parameters (part 2 of 2)

Parameter

Description

Job waiting for


external
termination

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

Selected Waits (Default)


Cleared Does not wait

Indicates whether to write errors to the job log. Optional. Valid values are:

Selected - write to log (Default)


Cleared - do not write

Log external
Indicates whether to write output to the job log. Optional. Valid values
output in job log are:

Operating
System

Selected - write to log (Default)


Cleared - do not write

Operating system type for the command as defined in SAP.


Use the Load button of the Name field. Enter value manually, or click the
"..." button to select a value from the list.

Owner

Authorized step owner. Optional. Uppercase only, blank spaces not


permitted.
If left unset, the value is taken from the account owner field.
Click Load to generate and display a list of all owners. The asterisk * can
be used as a wildcard to filter the search.

Parameters

Parameters for the external command. Optional. Case sensitive, blank


spaces are permitted.

Step number

A read-only field that indicates the step number in the job.

Target Server

Host computer where the external command runs. Mandatory. Case


sensitive, blank spaces are not permitted.
Click Load to generate and display a list of all target servers
Note: If manually set, the short format must be used: hostname

70

CONTROL-M/Control Module for SAP Administrator Guide

Selecting job steps

External Program dialog box parameters


The External Program dialog box parameters are described in Table 11 . For more
information about these parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.
Figure 5

Table 11

External program dialog box

Add External Program dialog box parameters (part 1 of 2)

Parameter

Description

Activate trace

Indicates whether a trace is activated. Optional. Valid values are:

Selected - activate
Cleared - not activated (Default)

Name

External program name. Mandatory. Case sensitive, blank spaces are


permitted.

Job name

A read-only field that displays the job name.

Job waiting for


external
termination

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

Selected Waits (Default)


Cleared Does not wait

Indicates whether to write errors to the job log. Optional. Valid values are:

Selected - write to log (Default)


Cleared - do not write

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

71

Selecting job steps

Table 11

Add External Program dialog box parameters (part 2 of 2)

Parameter

Description

Log external
Indicates whether to write output to the job log. Optional. Valid values
output in job log are:

Owner

Selected - write to log (Default)


Cleared - do not write

Authorized step owner. Optional. Uppercase only, blank spaces not


permitted.
If left unset, the value is taken from the account owner field.

Parameters

Parameters for the external program. Optional. Case sensitive, blank


spaces are permitted.

Step number

A read-only field that indicates the step number in the job.

Target host

Host computer where the external program runs. Mandatory. Case


sensitive, blank spaces are not permitted.
Note: If manually set, the short format must be used: hostname

72

CONTROL-M/Control Module for SAP Administrator Guide

Monitoring and managing SAP jobs in CONTROL-M

Monitoring and managing SAP jobs in CONTROL-M


You can monitor SAP jobs using CONTROL-M. This includes both original SAP
CCMS jobs, and jobs in SAP that were created using CONTROL-M.

Before you begin


Ensure that you can see the required SAP job in CONTROL-M/EM.

To monitor SAP jobs


Double-click the SAP job to open the Job Editing form in CONTROL-M/EM, in
Active Job mode.
Figure 6

SAP panel, Job Editing form (Active Job mode)

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

Defining and monitoring SAP jobs in CONTROL-M

73

Monitoring and managing SAP jobs in CONTROL-M

Table 12

Additional SAP panel parameters - Active Job mode

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.

Extracted: A SAP job extracted from SAP to CONTROL-M by the


Xtractor process for monitoring and managing purposes.

Intercepted: A job that was intercepted by SAP, extracted to


CONTROL-M by the Xtractor process, activated by
CONTROL-M/CM for SAP and is now being monitored in
CONTROL-M.

Spawned: A job that was created in SAP by a job created or


monitored in CONTROL-M, extracted from SAP by the Xtractor
process and is now being monitored in CONTROL-M.
- Parent Name: If the job type is Spawned, the name of the
parent job is displayed in this field.
- Parent Id: If the job type is Spawned, the SAP job count of the
parent job is displayed in this field.

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.

For more information about monitoring jobs in CONTROL-M, see the


CONTROL-M/Enterprise Manager User Guide.
For information about viewing and updating job details, see the
CONTROL-M/Enterprise Manager User Guide.

To cancel a SAP job


Right-click the required job, and select Kill. The job is cancelled in SAP. This action is
possible as long as the job is still active in SAP.
74

CONTROL-M/Control Module for SAP Administrator Guide

Data archiving jobs

To view a SAP job step list


Right-click the required job, and select View JCL/Script. The job steps are displayed.

Data archiving jobs


CONTROL-M/CM for SAP can archive information in the SAP database, using Data
Archiving jobs that are created using the CONTROL-M/Desktop. A Data Archiving
session is created to perform Data Archiving jobs, using the CONTROL-M group
scheduling table functionality.
To work with Data Archiving jobs, you must install CONTROL-M Function Modules.
For more information, see Step 4 - CONTROL-M function modules on page 37.

Data archiving with XBP 1.0


A typical Data Archiving session in XBP 1.0 includes a Write job and two Detect jobs.

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

Defining and monitoring SAP jobs in CONTROL-M

75

Data archiving with XBP 2.0

Data archiving with XBP 2.0


A typical Data Archiving session in XBP 2.0 includes a Write job and two job
definition templates, one for Delete jobs and another for Store jobs.

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.

Creating a Data Archiving session with XBP 1.0


The following procedures describe how to create a Data Archiving session in XBP 1.0.
This includes creating a group scheduling table, and creating a Data Archiving Write
or Detect job.

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.

Before you begin


Ensure that you have a job skeleton defined for Data Archiving jobs. For more
information, see Creating a job skeleton for SAP jobs on page 45.

To create a group scheduling table


1 Choose Edit => Scheduling Group => New, or click

to open the Group Editing

form.

2 Set the Group Editing form parameters according to your requirements.

76

CONTROL-M/Control Module for SAP Administrator Guide

Creating a Data Archiving session with XBP 1.0

NOTE
For more information about the Group Editing form, see the CONTROL-M/Desktop User
Guide.

3 Click Save to Draft to open the group scheduling table in CONTROL-M/Desktop.


You can now create a Data Archiving job, directly into the group scheduling table
and Data Archiving session.

To create a Data Archiving job in XBP 1.0


1 Select the skeleton for CONTROL-M/CM for SAP Data Archiving jobs from the
Current Skeleton list in CONTROL-M/Desktop.

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

SAP panel for Data Archiving, Job Editing form

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

77

Creating a Data Archiving session with XBP 1.0

The fields in the SAP panel are described in Table 13 on page 86.

4 Choose a job mode from the following options:

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.

5 In the Execution panel, do the following:


A Select the Cyclic check box.
B In the Interval field, enter the number of time units that should be allowed
between runs of the Detect job. This can be days, hours, or minutes.

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.

6 In the Steps panel, do the following:


A In the Statement field, type *.
B In the Code field, type *ALL JOBS DETECTED* (as written here), and click
C Click

D In the DO field, choose Stop Cyclic, and click

E In the Statement field, type *.


F In the Code field, type NOTOK (as written here), and click
G Click

78

CONTROL-M/Control Module for SAP Administrator Guide

Creating a Data Archiving session with XBP 2.0

H In the DO field, choose Stop Cyclic, and click

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.

Where to go from here


The following table describes where to find information related to this task.
Subject

Location

Defining a group scheduling


table for Data Archiving

For information about defining a group scheduling table for


Data Archiving, see CONTROL-M/Desktop User Guide.

Defining other Job Editing


form parameters.

For more information about all CONTROL-M job


parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.

Creating a Data Archiving


Session with XBP 2.0

For more information, see Creating a Data Archiving


session with XBP 2.0 on page 79.

Creating a Data Archiving session with XBP 2.0


The following procedures describe how to create a Data Archiving session in XBP 2.0.

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.

Before you begin


Ensure that you have a job skeleton defined for Data Archiving jobs. For more
information, see Creating a job skeleton for SAP jobs on page 45.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

79

Creating a Data Archiving session with XBP 2.0

To create a group scheduling table


1 Choose Edit => Scheduling Group => New, or click

to open the Group Editing

form.

2 Set the Group Editing form parameters according to your requirements.


NOTE
For more information about the Group Editing form, see the CONTROL-M/Desktop User
Guide.

3 Click Save to Draft; the group scheduling table is displayed in


CONTROL-M/Desktop. You can now create a Data Archiving job, directly into the
group scheduling table and Data Archiving session.

To create a Data Archiving write job


1 Select the skeleton for CONTROL-M/CM for SAP Data Archiving jobs from the
Current Skeleton list in CONTROL-M/Desktop.

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

CONTROL-M/Control Module for SAP Administrator Guide

Creating a Data Archiving session with XBP 2.0

Figure 8

SAP panel for Data Archiving, Job Editing form

4 For Job Mode, select Write job.


5 Click Detect Spawned Jobs to open the Detect Spawned Job dialog box.

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.

7 Define other parameters for the job, as appropriate.


For descriptions of the parameters, see Table 13 on page 86.

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

Defining and monitoring SAP jobs in CONTROL-M

81

Creating a Data Archiving session with XBP 2.0

To create the Job Definition template for Delete jobs


1 Select the skeleton for CONTROL-M/CM for SAP jobs from the Current Skeleton
list in CONTROL-M/Desktop. Ensure that you select a regular SAP R3 skeleton
and not a SAP Data Archiving skeleton.

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.

4 For Job Mode, select Original.


5 Click Detect Spawned Jobs to open the Detect Spawned Job dialog box.

82

CONTROL-M/Control Module for SAP Administrator Guide

Creating a Data Archiving session with XBP 2.0

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.

To Create the Job Definition Template for Store Jobs


1 Select the skeleton for CONTROL-M/CM for SAP jobs from the Current Skeleton
list in CONTROL-M/Desktop. Ensure that you select a regular SAP R3 skeleton
and not a SAP Data Archiving skeleton.

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.

4 For Job Mode, select Original.


5 Define the parameters for the job definition template for Store jobs as appropriate.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

83

Configuring the environment to work with Data Archiving Sessions in XBP 2.0

For descriptions of the parameters, see Table 13 on page 86.

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.

Where to go from here


The following table describes where to find information related to this task.
Subject

Location

Defining a group scheduling


Table for Data Archiving

For information about defining a group scheduling table for


Data Archiving, see CONTROL-M/Desktop User Guide.

Defining other Job Editing


form parameters.

For more information about all CONTROL-M job


parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.

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

Configuring the environment to work with Data Archiving


Sessions in XBP 2.0
The system environment must be properly configured to use Data Archiving with
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

Spawned jobs - first priority


Intercepted jobs - second priority

CONTROL-M/Control Module for SAP Administrator Guide

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:

For more information on extraction management, see To configure the Xtractor to


intercept and control SAP jobs on page 111.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

85

SAP panel parameters for data archiving

SAP panel parameters for data archiving


The SAP panel parameters for Data Archiving are described in Table 13 . For further
information about these parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.

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

Data-archiving SAP panel parameters (part 1 of 5)

Parameter

Definition

Account

Account name. Mandatory. Uppercase only, no blank spaces


permitted.
The account is a profile. The remaining parameters are
predefined according to the account, when the account is
created.
Mapped to the CONTROL-M/EM Owner parameter.
Clicking the account Load button displays a list of accounts that
comply with the generic name you enter. The asterisk * can be
used as a wildcard to filter account names.
For information about defining an account, see Adding or
modifying a CONTROL-M/CM for SAP account on page 100.

Archiving Object

Archiving object in SAP. Mandatory. Free text string. Click


Load to generate and display a list of all archiving objects. The
asterisk * can be used as a wildcard.
Note: The Load button only works if you are using Extended
functionality.

Check Sessions

Only available for Write jobs. Enables the user to check if an


incomplete archiving session exists for a specific archiving
object.
Note: An incomplete archiving session is one for which not all
Delete jobs ended successfully.
Valid values are:
Selected = Perform a check
Cleared = Do not perform a check (Default)
If an incomplete archiving session is found, a message is
displayed, and a Data Archiving write job is not created.

86

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters for data archiving

Table 13

Data-archiving SAP panel parameters (part 2 of 5)

Parameter

Definition

Check Variant

Only available for Write jobs. Enables the user to check if a


Write job already exists with the specific variant for the
archiving object defined for this job. Valid values are:

Selected = Perform a check


Cleared = Do not perform a check (Default)

If such a Write job is found, a message is displayed, and a new


Write job is not created.
Copy Spool To

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).

Detect Spawned Jobs

Only available for Write 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:

No Detection needed: Do not detect spawned jobs of the


current job.

Detect and Create According to:


Parent (current) job definition: Detect spawned jobs of
the current job and extract these jobs to CONTROL-M,
with identical properties to the parent job.
A specific job definition: A field is displayed, in which
you enter a specific SAP-type job name. Detected
spawned jobs of the current job are extracted to
CONTROL-M with identical properties to the selected
(not the current) job.
Important: The selected job must exist in the same
scheduling table as the current job.

For more information, see Initiating a mass parallel process


(detecting spawned jobs) on page 121

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

87

SAP panel parameters for data archiving

Table 13

Data-archiving SAP panel parameters (part 3 of 5)

Parameter

Definition

Job Class

Job submission priority (in SAP). Mandatory for Write job


mode only. Disabled for both Detect Delete and Detect Store
job mode values. Valid values are:

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

Determines the task that the job performs. Mandatory. Valid


values are:

Job Name

Write: Creates and runs a Data Archiving write job.


Detect Delete: Detects a Data Archiving delete job created
in SAP (only used in data archiving with XBP 1.0).
Detect Store: Detects a Data Archiving store job created in
SAP (only used in data archiving with XBP 1.0).

Job name to be monitored or submitted. Mandatory.


Mapped to the CONTROL-M/EM Job Name parameter.

Print Parameters

See Table 7 Add ABAP dialog box parameters on page 62.

Session Number

Available for Detect jobs only. Indicates the archiving session


number in SAP.
Click Load to generate and display a complete list of session
numbers.
This parameter must be set when either of the following occur:
The Write job was not created by CONTROL-M
The Write job and the Detect job are not part of the same
group scheduling table.
This parameter should not be set if the Write job and the Detect
job are part of the same group scheduling table.

88

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters for data archiving

Table 13

Data-archiving SAP panel parameters (part 4 of 5)

Parameter

Definition

Submit Job with ASAP


Option

Specifies whether the job should run with the ASAP option or
immediately. Check box format. Valid values are:

Selected - submit with ASAP option


Cleared - start immediately (Default)

When this parameter is selected the job runs as soon as a


background work process is available for it in SAP. If the job
cannot start immediately, it is transformed in SAP into a
time-based job.
If this parameter is cleared, the job either runs immediately, or
fails if there are no work processes available to run it.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

89

SAP panel parameters for data archiving

Table 13

Data-archiving SAP panel parameters (part 5 of 5)

Parameter

Definition

Target Server

Application Server on which the job runs. Optional. Case


sensitive, no blank spaces permitted.
Click Load to generate and display a complete list of available
application servers.
If this parameter is left unset, the SAP system determines which
application server will execute the job. This is the normal
procedure recommended by SAP, because the system can then
carry out its own load balancing. You should only select the
target machine if that server has particular resources necessary
for the job processing.
Note: If manually set, the following (full) format must be used:
hostname_SYSID_sysnumber

Variant

Variant name. Mandatory. Only enabled if the Archiving Object


parameter is set. Only available for Write jobs.
Click Load to generate and display a complete list of variants
available for the selected Archiving Object.
Uppercase only, blank spaces permitted, special characters are
permitted according to SAP guidelines. (For more information,
refer to the SAP documentation).
When a variant is set for an Archiving Object, the following
buttons are enabled:

Copy. Enables the creation of a new variant based on the


properties of an existing variant. The new variant is created
as soon as you confirm its name.

Show. Displays the variant values in a separate window


(see Figure 3 on page 67).

Change. Enables you to modify the values of the various


variant parameters (see Figure 3 on page 67). To apply these
parameter values click OK. To keep the variants original
parameter values, click Undo Changes.
Note: The changes in the values of the variant parameters
are only performed during job run time.

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

CONTROL-M/Control Module for SAP Administrator Guide

Business Information Warehouse jobs

Business Information Warehouse jobs


The following section describes how to create, monitor, and manage SAP-BW jobs
using CONTROL-M. For an introductory overview, see CONTROL-M solution for
Business Information Warehouse on page 18.

Creating a Business Information Warehouse job


The following procedures describe how to create a Business Information Warehouse
(SAP-BW) Job in CONTROL-M.

Before you begin

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.

To create a SAP BW job


1 Select the skeleton for CONTROL-M/CM for SAP BW jobs from the Current
Skeleton list in CONTROL-M/Desktop.

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

Defining and monitoring SAP jobs in CONTROL-M

91

Creating a Business Information Warehouse job

4 Choose the required SAP BW/Business Process Type to enable the appropriate
parameters. There are two options:

InfoPackage (see Figure 9, below)

Process Chain (see Figure 10, below)

Figure 9

SAP panel for BW - InfoPackage, Job Editing form

Figure 10

SAP panel for BW - Process Chain, Job Editing form

5 Select the required InfoPackage or Process Chain.

InfoPackage - Enter the specific InfoPackage information, or click Load to


generate a list of available InfoPackages from which you can make a selection.

Process Chain - Enter the specific Process Chain information, or click Load to

generate a list of available Process Chains.

6 Set additional parameters as required.


7 When you are finished entering parameters in the SAP panel, click Save to Draft.
The job is added to the scheduling table of the Business Information Warehouse.

92

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters for SAP-BW jobs

Where to go from here


The following table describes where to find information related to this task.
Subject

Location

Defining other Job Editing


form parameters.

For more information about all CONTROL-M job


parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.

SAP panel parameters for SAP-BW jobs


The SAP panel parameters for BW jobs are described in Table 14 . For further
information about these parameters, see the CONTROL-M Job Parameter and Variable
Reference Guide.

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

SAP-BW job panel parameters (part 1 of 3)

Parameter

Definition

Account

Account name. Mandatory. Uppercase only, no blank spaces


permitted.
The account is a profile. The remaining parameters are predefined
according to the account, when the account is created.
Mapped to the CONTROL-M/EM Owner parameter. Clicking the
account Load button displays a list of accounts that comply with
the generic name you enter. The asterisk * can be used as a
wildcard to filter account names. For information about defining
an account, see Adding or modifying a CONTROL-M/CM for
SAP account on page 100.

Background Job Name

Valid when InfoPackage Business Process Type is selected.


Name of the InfoPackage's background job name. Optional.
The BI_BTCH prefix is preset and cannot be changed.
If no value is entered, SAP-BW generates a name for the
background job.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

93

SAP panel parameters for SAP-BW jobs

Table 14

SAP-BW job panel parameters (part 2 of 3)

Parameter

Definition

CONTROL-M Job
Name

The name under which the job is submitted in CONTROL-M.


Mandatory.
Mapped to the CONTROL-M/EM Job Name parameter.

InfoPackage
Description

Valid when InfoPackage Business Process Type is selected.


InfoPackage Description. Mandatory. Free text
Can be used as a filter before loading a list of InfoPackages, or you
can enter a specific InfoPackage name.
Tip: Before clicking Load, narrow the search parameters by
entering at least one character in the field. The asterisk * can be
used as a wildcard.
Note: The Load button generates data for both this parameter and
InfoPackage Tech. Name.

InfoPackage Tech.
Name

Valid when InfoPackage Business Process Type is selected.


InfoPackage Technical Name, a unique BW-generated InfoPackage
ID.
Mandatory. Uppercase only, no blank spaces permitted.
The value of this parameter can be defined by

entering a specific InfoPackage technical name


clicking Load and selecting the required InfoPackage

Note: The Load button generates data for both this parameter and
InfoPackage Description.
Process Chain
Description

Valid when Process Chain Business Process Type is selected.


Mandatory. Free text. Describes a Process Chain. Can be used as a
filter before loading a list of Process Chains, or you can enter a
specific Process Chain name.
Tip: Before clicking Load, narrow the search parameters by
entering at least one character in the field. The asterisk * can be
used as a wildcard.
Note: The Load button generates data according to data set in this
parameter and in Process Chain ID.

94

CONTROL-M/Control Module for SAP Administrator Guide

SAP panel parameters for SAP-BW jobs

Table 14

SAP-BW job panel parameters (part 3 of 3)

Parameter

Definition

Process Chain ID

Valid when Process Chain Business Process Type is selected.


Mandatory. Uppercase only, no blank spaces permitted.
A unique BW-generated ID of a Process Chain. Can be used as a
filter before loading a list of Process Chains, or you can enter a
specific Process Chain name.
Tip: Before clicking Load, narrow the search parameters by
entering at least one character in the field. The asterisk * can be
used as a wildcard.
Note: The Load button generates data according to data set in this
parameter and in Process Chain Description.

SAP-BW/Business
Process Type

Determines the task that the job performs. Mandatory. Valid


values are:

Process Chain (Default)


InfoPackage

Note: Parameters are described further on in this table.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

95

Monitoring and managing Business Information Warehouse jobs

Monitoring and managing Business Information Warehouse


jobs
You can handle SAP-BW jobs using CONTROL-M/CM for SAP. CONTROL-M/CM
for SAP jobs monitor and manage SAP-BW Business Processes (InfoPackages or
Process Chains) that were pre-defined in a SAP-BW system.

Before you begin


Ensure that you can see the required SAP-BW job in CONTROL-M/EM.

To Monitor SAP-BW Jobs


Double-click the SAP-BW job to open the Job Editing form in CONTROL-M/EM, in
Active Job mode.
Figure 11

SAP-BW panel - InfoPackage (Active Job mode)

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

CONTROL-M/Control Module for SAP Administrator Guide

Monitoring and managing Business Information Warehouse jobs

Table 15

Additional SAP-BW panel parameters - Active Job Mode

Parameter

Description

Additional InfoPackage Parameters


InfoPackage RNR

A BW-generated unique ID for the InfoPackage's running


session.

Background Job Count

The InfoPackage's background job count.

Additional Process Chain Parameters


Process Chain Log ID

A BW-generated unique ID for the Process Chain running


session.

Rerun options

If a job fails, select an option to indicate how the Process Chain


should be rerun. Valid values are:

Restart from point of failure (Default)


Rerun from start

Note: Only available while job is in Hold status.

For more information about monitoring jobs in CONTROL-M, see the


CONTROL-M/Enterprise Manager User Guide.

Interrupting SAP-BW Jobs


To remove your process chain from the schedule (interrupt), run the request utility
(ctmr3req) with PC_STOP_SCHEDULE action. The job is removed from the schedule,
and you receive an alert from the EM alert mechanism. The job stays active in
CONTROL-M until it is finished in SAP. For more information, see Interrupts Removing a process chain from schedule on page 134.

Chapter 3

Defining and monitoring SAP jobs in CONTROL-M

97

Monitoring and managing Business Information Warehouse jobs

98

CONTROL-M/Control Module for SAP Administrator Guide

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:

Handling accounts for CONTROL-M/CM for SAP on page 99


Configuring general parameters on page 104
Configuring and working with the Xtractor process on page 107
Activating the Xtractor process on page 124
Requesting SAP actions on page 125
Converting account definitions on page 135
Converting CONTROL-M option for R/3 jobs on page 137

For more information about CONTROL-M command line utilities, see the
CONTROL-M/Server Administrator Guide, and the CONTROL-M/Enterprise Manager
Utility Guide.

Handling accounts for CONTROL-M/CM for SAP


The CONTROL-M/CM for SAP Account utility (ctmr3acc) is used to define user
accounts that are authorized to work with the SAP server. An account is a set of
parameters that must be defined in order to connect to the SAP system, using a
specific SAP server or specific Logon Group (see step 3 on page 101).
If you are using this utility for the first time since installing CONTROL-M/CM for
SAP, you must define at least one account before operating CONTROL-M/CM for
SAP.
You can perform the following tasks using the Account utility:

Adding or modifying a CONTROL-M/CM for SAP account


Checking an account configuration
Configuring an administrator password
Chapter 4

Administrator tasks

99

Adding or modifying a CONTROL-M/CM for SAP account

The Account utility encrypts the accounts information in a data file located in the
CONTROL-M/Agent data directory.

Adding or modifying a CONTROL-M/CM for SAP account


Use this procedure to define a new CONTROL-M/CM for SAP account.

Before you begin


If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.

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.

On Microsoft Windows, go to Start => Programs => CONTROL-M/CM for SAP


=> Account Utility.
In CONTROL-M/Agent version 6.20, go to Start => Programs =>
CONTROL-M/Agent <agent>. Select the SAP tab, and select Account Management
to open the CONTROL-M/CM for SAP Account Management window.

2 Click Add
100

to open the Add dialog box.

CONTROL-M/Control Module for SAP Administrator Guide

Adding or modifying a CONTROL-M/CM for SAP account

3 Enter account-configuration parameters, either by entering a regular


direct-connection account, or entering an account that connects using logon
groups.
If your account uses logon group connection, select Use Logon Group. If you are
entering a direct-connection account, ensure that Use Logon Group is not selected.
In either case, fill the appropriate information for all available account
configuration parameters (parameters that are not appropriate for your selection
are disabled.) The account configuration parameters are described in Table 16. All
enabled parameters are mandatory.
Table 16

Account configuration parameters (Part 1 of 2)

Parameter

Description

Account Name

Name of the CONTROL-M/CM for SAP account.


Free text string. Maximum length: 30 characters.
Uppercase only. No blank spaces permitted.

Application Server
hostname

Host name of the computer running the SAP Application Server.


This parameter is disabled if Use Logon Group is selected.

System Number

The number of the SAP instance, for example: 03


Format: Two-digit.
This parameter is disabled if Use Logon Group is selected.

Client

SAP client, for example: 020


Format: Three-digit.

Chapter 4 Administrator tasks

101

Adding or modifying a CONTROL-M/CM for SAP account

Table 16

Account configuration parameters (Part 2 of 2)

Parameter

Description

Login

SAP login user name.


See Table 1 SAP authorizations on page 29 for details about
required authorizations.

Password

password for the SAP login user.

Confirm Password

confirmation of the password

Language

SAP language indication. Default: English

XBP Version

Defines the SAP XBP interface version installed on the SAP server.
Valid values are:

XBP1.0 (Default)
XBP2.0

To check if XBP 2.0 exists in your system, look in the SAP


transaction SA38 for the ABAP program INITXBP2. If this is there,
XBP 2.0 exists in your system.
SAP Application
Version

Valid values are:

R/3 (Default)
BW 2.x
BW 3.x

System ID

Three alpha-numeric characters that represent the SAP System ID.


This parameter is enabled only if Use Logon Group is selected.

Message Server
Hostname

Host name of the computer on which the SAP System Message


Server is running. This parameter is enabled only if Use Logon
Group is selected.

Group

The Group name as defined in the SAP SMLG transaction. This


parameter is enabled only if Use Logon Group is selected.

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

The services file can be found in the following folders:

102

On Unix: /etc/
On Windows: <system drive>:\WINNT\system32\drivers\etc
On Windows 2003: <system drive>:\Windows\system32\drivers\etc

CONTROL-M/Control Module for SAP Administrator Guide

Adding or modifying a CONTROL-M/CM for SAP account

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.

5 Click Save to save the Accounts list.


NOTE
When deleting an existing account you must ensure that all Rules defined for this account
in the Xtractor utility are removed. You should also ensure that you do not use ctmextract
with Rules for deleted accounts.

To check an account configuration


1 Select the required account in the CONTROL-M/CM for SAP Account
Management window.

2 Click Check Account

. The Account utility checks whether a connection can be


established with the SAP server, using the specific account parameters, and
displays a message, according to the result of the check.

To configure an Administrator password


Use the following procedure to configure an Administrator password. This password
prevents unauthorized users from using or modifying the Account utility.

1 Click Administrator Password in the CONTROL-M/CM for SAP Account


Management window.

2 Choose Add/Change Administrator Password, and click OK.


NOTE
Select Delete if you want to delete an Administrator Password.

Chapter 4 Administrator tasks

103

Configuring general parameters

3 Enter and confirm the password as required, and click OK.


After an Administrator password is set, the CONTROL-M/CM for SAP Account
utility cannot be activated without entering this password.

NOTE
The Administrator password is also used to open the Xtractor Configuration utility, see
The Xtractor process mechanism on page 107.

Configuring general parameters


The CONTROL-M/CM for SAP configuration utility (ctmr3cfg) is used to change the
default operating parameters of CONTROL-M/CM for SAP.

Before you begin


If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.

To change the CONTROL-M/CM for SAP operating parameters


1 Access the Configuration utility.

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

CONTROL-M/Control Module for SAP Administrator Guide

Configuring general parameters

Figure 12

Configuration management window

The Configuration Management window parameters are described in Table 17.


Table 17

Configuration parameters for the ctmr3cfg utility (Part 1 of 3)

Parameter

Description

Audit Level

Sets the audit level for the current session. Valid values are:

0: No additional audit level information to be added to the SAP


server
1: Add audit level 1 information to the SAP server
2: Add audit level 2 information to the SAP server
3: Add audit level 3 information to the SAP server

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.

RFC Max Retry

Specifies how many times the program should try to reconnect to the
SAP system after either

a connection failure
a Function Call error

Valid values are: 1 - 20. Default: 10


RFC Retry Interval

Specifies the number of seconds the program should wait, after a


Function Call error is encountered, before trying to reconnect to the
SAP system.
Valid values are: 1 - 120. Default: 5

Chapter 4 Administrator tasks

105

Configuring general parameters

Table 17

Configuration parameters for the ctmr3cfg utility (Part 2 of 3)

Parameter

Description

Run Copy Mode

Indicates which job should be copied if Copy mode is set without a


JOBCOUNT value. Valid values are:

LAST_SCHEDULED: Last job with scheduled status


LAST: Last job (any status)
FIRST_SCHEDULED: First job with scheduled status
FIRST: First job (any status)

Default: LAST_SCHEDULED
Run Org Mode

Indicates which job should be released if Original mode is set


without a JOBCOUNT value. Valid values are:

LAST_SCHEDULED: Last job with scheduled status


FIRST_SCHEDULED: First job with scheduled status

Default: LAST_SCHEDULED
Use Extended

Specifies whether the extended functionality of CONTROL-M/CM


for SAP should be used. Valid values are:

Cleared = No
Selected = Yes (Default)

Note: If you select this option, the CONTROL-M Function Modules


must be installed on the SAP server on which you are working.
For more information about extended functionality, see Step 4 CONTROL-M function modules on page 37.
Max List Entries

Specifies the maximum number of rows to be produced for a Load


list. Valid values are: 1-1000. Default: 250

Mixed Case Job Name Allow mixed case job name for External Mode jobs. (For job
(External Jobs)
monitoring purposes only.) Valid values are:

Cleared = No (Upper case only) (Default)


Selected = Yes (Mixed case permitted)

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

CONTROL-M/Control Module for SAP Administrator Guide

Configuring and working with the Xtractor process

Table 17

Configuration parameters for the ctmr3cfg utility (Part 3 of 3)

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:

Cleared = No (Upper case only) (Default)


Selected = Yes (Mixed case permitted)

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.

2 Modify the Configuration parameters, if necessary.


3 Click Save to save your choices.
NOTE
On Microsoft Windows, you must restart CONTROL-M/Agent after modifying any
CONTROL-M/CM for SAP operating parameters, in order for the changes to take effect.

Configuring and working with the Xtractor


process
The Xtractor process mechanism

intercepts and controls SAP CCMS jobs


detects running SAP CCMS jobs
detects spawned jobs

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:

General Configuration, as described in General configuration of the Xtractor


process on page 109

Chapter 4 Administrator tasks

107

Configuring and working with the Xtractor process

SAP Interception Criteria and CTM Interception Rules, as described in Job


interception and control with the Xtractor process on page 110

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.

CONTROL-M job confirmation in SAP


Each SAP job that is submitted in CONTROL-M, regardless of whether it was created
or copied by CONTROL-M/CM for SAP, or whether it was extracted or intercepted
by the Xtractor process is marked in SAP as Confirmed. This procedure enables the
Xtractor process to work cyclically according to predefined rules, so that only new
jobs, that have not yet been submitted in CONTROL-M, are created in CONTROL-M,
and duplication is prevented.

Activating Interception and Parent/Child functions in SAP


The following XBP 2.0 functionalities must be enabled in SAP before using them with
the CONTROL-M Xtractor process.

Interception of SAP jobs


Detection of spawned jobs (Parent/Child functionality)

To activate these functions, run the INITXBP2 ABAP program in your SAP system
and switch on the required actions.

108

CONTROL-M/Control Module for SAP Administrator Guide

General configuration of the Xtractor process

General configuration of the Xtractor process


The General Configuration panel is relevant for all actions performed with the
Xtractor. The Xtractor enables you to set priorities for job types to be detected in SAP.
This is because SAP jobs can be identified with more than one criterion. (For example,
a job could be a spawned job and fulfill interception criteria.) However,
CONTROL-M can only create a job with one job type, and, therefore, you must set job
type priorities. In Figure 13, a spawned job that is also an intercepted job is created in
CONTROL-M as a mirror-image spawned job.
The reason for setting a priority is to indicate to the Xtractor process how a job should
be handled when it matches more than one rule. You must ensure that potential rule
overlapping is avoided wherever possible, or handled if necessary. You should not
use more than one Xtractor process on the same system and client, since this may
cause unexpected results. If you have two accounts configured to work with the same
system and client (for a different user), you must ensure that no more than one of one
of them is configured to work with the Xtractor.

NOTE
Extracted jobs cannot have a higher priority than Intercepted or Spawned jobs.

Before you begin


If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.

To set job type priorities


1 Access the Xtractor Configuration Manager.

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.

On Microsoft Windows, Go to Start => Programs => CONTROL-M/CM for SAP


=> Xtractor Configuration management.
In CONTROL-M/Agent version 6.20, go to Start => Programs =>
CONTROL-M/Agent <agent>. Select the SAP tab, and select Xtractor management.

Chapter 4 Administrator tasks

109

Job interception and control with the Xtractor process

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.)

2 The Xtractor Configuration Management window is displayed, overlaid with the


Select SAP Account dialog box (as shown in Figure 14 on page 112). In each job
type field, select the priority from the list. You can set first, second, or third priority
to a job type. You can also select not to have a job type detected.
Figure 13

Xtractor management - general configuration

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.

Job interception and control with the Xtractor process


Job interception and control is a two-stage process. You set all job interception criteria
using the Xtractor Configuration Management utility.
Stage 1: Which jobs should be intercepted by SAP?
In this stage, you set rules that determine which jobs in SAP should be intercepted.
An intercepted job is a job created in SAP, that fulfills the interception criteria as set
by the Xtractor Configuration Management utility. Once intercepted by SAP, these
jobs are put on hold in Scheduled status, until they are released by CONTROL-M.

110

CONTROL-M/Control Module for SAP Administrator Guide

Job interception and control with the Xtractor process

Stage 2: How should the Xtractor process handle these jobs?


You must now define sets of rules to be applied to these intercepted jobs. These rules
are constructed according to Job Names and User Names. For each rule, an action
must be set. These actions indicate how the Xtractor should handle these jobs.

NOTE
All intercepted jobs must be processed by CONTROL-M to avoid jobs being stuck in
Scheduled status forever.

Before you begin

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).

To configure the Xtractor to intercept and control SAP jobs


1 Access the Xtractor Configuration Manager.

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.

On Microsoft Windows, go to Start => Programs => CONTROL-M/CM for SAP


=> Xtractor Configuration management.
In CONTROL-M/Agent version 6.20, go to Start => Programs =>
CONTROL-M/Agent <agent>. Select the SAP tab, and select Xtractor management.
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.)

2 The Xtractor Configuration Management window is displayed, overlaid with the


Select SAP Account dialog box.

Chapter 4 Administrator tasks

111

Job interception and control with the Xtractor process

Figure 14

Xtractor management - select SAP account

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

to load the Interception Criteria table from SAP.

SAP Interception Criteria panel

, Copy

, Edit

, and Remove

4 To add new Interception criteria, click Add

buttons are now enabled.


.

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

CONTROL-M/Control Module for SAP Administrator Guide

Job interception and control with the Xtractor process

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.

7 Click the CTM Interception Rules tab, and click Add

to display the following

dialog box:

8 Set the parameters, as described in the following table:


Table 18

CTM interception rules parameters (Part 1 of 2)

Parameter

Description

Into Group

Set into which CONTROL-M group scheduling table the job


should be submitted. Valid values are:

None (Default) - use when the job template does not


belong to a group scheduling table
Recent - add the job to the group scheduling table that
was most recently ordered
Standalone - order the job with adding it to a group
scheduling table
New Group - order the job to a new group scheduling
table
Specific - set a group scheduling table Order ID to which
to add the job

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

Intercepted SAP job name, to be extracted from SAP to


CONTROL-M. The *wildcard can be used.

User

SAP user that created the job. The *wildcard can be used.

Program

LEAVE AS DEFAULT (*)

Chapter 4 Administrator tasks

113

Job interception and control with the Xtractor process

Table 18

CTM interception rules parameters (Part 2 of 2)

Parameter

Description

Template Job Name

Name of existing SAP-type CONTROL-M job (not


submitted) to be used as a template for creating the job in
CONTROL-M.
Mandatory unless User Exit is selected.

Template Scheduling Table

Existing CONTROL-M scheduling table to which the


Template Job Name belongs.
Mandatory, unless User Exit is selected.

User Exit

Path to an executable or script file that includes user-specific


definitions about how to create the intercepted jobs in
CONTROL-M.
Mandatory, unless Template Job Name is selected.
If User Exit is selected, you must do one of the following:

Enter a valid path to a pre-defined executable or script


file.
Click Select to select an existing file.

For more information about User Exits, see Defining a user


exit on page 123.

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.

Preventing intercepted jobs from being discarded in SAP


This procedure describes how to avoid a situation in which jobs are intercepted, but
remain in SAP in scheduled status and are never acquired by the Xtractor process. A
special interception rule must be defined to prevent this. Additionally, a default job
that is associated with a specific scheduling table must be predefined and stored in
CONTROL-M. These should be set as part of the following procedure.
Click the CTM Interception Rules tab, and click Add
described in the following table:

114

CONTROL-M/Control Module for SAP Administrator Guide

. Set the parameters, as

Job interception and control with the Xtractor process

Table 19

Parameters for avoiding discarded intercepted jobs

Parameter

Value

Job Name

User

Program

Template Job Name

Default SAP-type job

Template Scheduling Table

Default scheduling table

User Exit

Can be defined instead of a Template Job Name and


Template Scheduling Table

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.

Example of job interception with the Xtractor process


Previously, to supervise the background job load in SAP, the SAP administrators
removed users Release Authorizations, and released these jobs manually, according
to the overall load in the system. The Xtractor Intercept functionality now enables
SAP administrators to provide users with Release Authorizations, and then manage
the background job load by creating intercept rules and scheduling these jobs
through CONTROL-M.
Following is an example of how you can use the job interception functionality to
control Background Work Process (WP) availability in your SAP system.

1 Define SAP interception criteria to intercept all jobs created by a specific group of
users.

2 In CONTROL-M/EM, define Quantitative Resources as WP_emp with a value of


eight units. Eight is the number of WPs to be available for this group of users.

3 In CONTROL-M/Desktop, define a job (to be used as a template) that requires one


unit of WP_emp.

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.

Chapter 4 Administrator tasks

115

Extracting and monitoring SAP CCMS jobs with the Xtractor

Extracting and monitoring SAP CCMS jobs with the Xtractor


The CONTROL-M/CM for SAP Xtractor process can be used to create one or more
mirror-image jobs by using criteria identical to that of specific jobs already running
in SAP. These are then monitored (but not submitted), enabling 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.

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.

Before you begin

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).

To extract running SAP CCMS jobs


1 Access the Xtractor Configuration Manager.

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.

On Microsoft Windows, go to Start => Programs => CONTROL-M/CM for SAP


=> Xtractor Configuration management.
In CONTROL-M/Agent version 6.20, go to Start => Programs =>
CONTROL-M/Agent <agent>. Select the SAP tab, and select Xtractor management.
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.)

2 The Xtractor Configuration Management dialog box is displayed, overlaid with the
Select SAP Account dialog box.

116

CONTROL-M/Control Module for SAP Administrator Guide

Extracting and monitoring SAP CCMS jobs with the Xtractor

NOTE
The Change Account button can be used at any time to display the Select SAP Account
dialog box and configure a different account.

Click the Extraction Rules tab, and click Add

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.

The available fields and definitions are described in Table 20.

Chapter 4 Administrator tasks

117

Extracting and monitoring SAP CCMS jobs with the Xtractor

Table 20

Extraction rules panel parameters

Field Name

Field Description

JOBNAME

Name of the job in SAP. Can be either a specific or generic


name.
Valid values are: any generic value, for example: JOB_*
Mandatory. Free text.
Note: In a Job Name, SAP perceives an underscore _ and a
space to be the same character. This means that two jobs,
named respectively JOB GOLD and JOB_GOLD, for example,
would be recognized as one and the same job. This is a
known SAP problem.

JOBCOUNT

CCMS job number. 8-digit number. Optional.

JOBGROUP

Group to which the jobs belong. Free text. Optional

USERNAME

Owner of the job in SAP. Mandatory.


Valid values are: any generic value, for example: *Y*

FROM_DATE

Scheduled start date for CCMS job. Optional.


Valid format: YYYYMMDD

FROM_TIME

Scheduled start time for CCMS job. Optional. Valid format:


HHMMSS
Note: This parameter depends on the specification of both
FROM_DATE and TO_DATE for the same day.

TO_DATE

Scheduled end date for CCMS job. Optional. Valid format is:
YYYYMMDD

TO_TIME

Scheduled end time for CCMS job. Optional. Valid format:


HHMMSS
Note: This parameter depends on the specification of both
FROM_DATE and TO_DATE for the same day.

118

NO_DATE

Selection flag for jobs with no start date. Optional. Valid


values are: X/N

WITH_PRED

Selection flag for jobs with start after predecessor. Optional.


Valid values are: X/N

EVENTID

Background event ID. Free text. Optional

EVENTPARAM

Background Event parameter. Free text. Optional.

PRELIM
SCHEDULED
READY
RUNNING
FINISHED
ABORTED

Status of CCMS job.


Valid values are: X/N (Default: X).
Optional.

CONTROL-M/Control Module for SAP Administrator Guide

Extracting and monitoring SAP CCMS jobs with the Xtractor

4 Click OK or Rules to display the Rules Viewer.

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

Rules Viewer parameters (Part 1 of 3)

Field Name

Field Description

JOBNAME

SAP job name. Mandatory


Can be either a specific or a generic name.

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

Name of an existing CONTROL-M job (not submitted) to be


used as a template for creating a SAP-type job in
CONTROL-M. Mandatory, unless User Exit is selected.

Template Scheduling Table

An existing CONTROL-M scheduling table to which the


Template Job Name belongs. Mandatory, unless User Exit is
selected.

Chapter 4 Administrator tasks

119

Extracting and monitoring SAP CCMS jobs with the Xtractor

Table 21

Rules Viewer parameters (Part 2 of 3)

Field Name

Field Description

User Exit

The path to an executable or script file, that includes


user-specific definitions about how to create the extracted
jobs in CONTROL-M.
Mandatory, unless Template Job Name is selected.
If User Exit is selected, you must either

Enter a valid path to a pre-defined executable or script


file
or

Click Select to select an existing file.

For more information about User Exits, see Defining a user


exit on page 123.
All of the following parameters are optional, and for advanced users only.

120

JOBCOUNT

Job ID. Optional. 8-digit number.

STEPCOUNT

Job step ID number. Optional.

SDLSTRTDT

Scheduled start date for background job. Optional.

SDLSTRTTM

Scheduled start time for background Job. Optional.

BTCSYSTEM

Target system to run background job. Optional.

SDLDATE

Date of job or step scheduling. Optional.

SDLTIME

Time of a scheduled job or step. Optional.

SDLUNAME

Initiator of job or step scheduling. Optional.

LASTCHDATE

Date of last job change. Optional

LASTCHTIME

Time of last job change. Optional

LASTCHNAME

Name of user who made last job change. Optional.

RELDATE

Release date for background schedule. Optional.

RELTIME

Release time of scheduled background job. Optional.

RELUNAME

User that released scheduled batch job. Optional.

STRTDATE

Job start date. Optional.

STRTTIME

Batch job start time. Optional.

ENDDATE

Job start date. Optional.

ENDTIME

Batch job start time. Optional.

PERIODIC

Periodic jobs indicator ('X'). Optional.

STATUS

Status of background job. Optional.

AUTHCKNAM

Background user name for authorization check. Optional.

AUTHCKMAN

Background client for authorization check. Optional.

SUCCNUM

Number of successor jobs. Optional.

PREDNUM

Number of previous jobs. Optional.

CONTROL-M/Control Module for SAP Administrator Guide

Initiating a mass parallel process (detecting spawned jobs)

Table 21

Rules Viewer parameters (Part 3 of 3)

Field Name

Field Description

LASTSTRTDT

Latest run date for batch job. Optional.

LASTSTRTTM

Latest run time for batch job. Optional.

WPNUMBER

Work process number. Optional.

WPPROCID

Work process ID. Optional.

EVENTID

Background event ID. Optional.

EVENTPARM

Background Event parameters (for example,


Jobname/Jobcount). Optional.

JOBCLASS

Job classification. Optional.

CALENDARID

Factory calendar ID for background processing. Optional.

EXECSERVER

Server name. Optional.

REAXSERVER

Server name. Optional.

6 Click OK. The data is saved. The Rule Viewer is re-displayed, with the
Copy

, Edit

, and Remove

buttons enabled.

You can either add additional rules or proceed to step 7.

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.

Initiating a mass parallel process (detecting spawned jobs)


A spawned job is a job created by another (parent) job, and monitored by
CONTROL-M. The Xtractor process can detect and extract spawned jobs into
CONTROL-M.

Before you begin

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

Initiating a mass parallel process (detecting spawned jobs)

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).

Detecting the spawned jobs of a parent job


1 Define a regular SAP-type job in CONTROL-M. (For more information see SAP
R/3 jobs on page 49.)

2 In the SAP panel, click Detect Spawned Jobs to display the Detect Spawned Jobs
dialog box.

3 Select your choice, according to the available options:

122

Parameter

Description

Start Spawned Job

If you select Start Spawned Job, CONTROL-M/CM for SAP


checks the status of each spawned job and starts any
spawned job with Scheduled status.

CONTROL-M/Control Module for SAP Administrator Guide

Defining a user exit

Parameter

Description

No Detection Needed

No spawned jobs are detected.

Detect and Create According


to:

Parent (current) job definition: Detect spawned jobs of the


current job, and extract these jobs to CONTROL-M, with
identical properties to the parent job.
Notes: This means that if the spawned jobs create spawned
jobs of their own, they are also detected. Additionally, all
generations of spawned jobs are created in the scheduling
table to which the original parent job belongs.
A specific job definition: A field is displayed, in which you
can enter a specific SAP-type job name. Detected spawned
jobs of the current job are extracted to CONTROL-M with
identical properties to the selected (not the current) job.
Important: The selected job must exist in the same
scheduling table as the current job.
Note: To detect further generations of spawned jobs, select
the Detect Spawned Jobs option in the Job Editing form of
the selected set job.

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.

Defining a user exit


When processing intercepted or extracted jobs, you can either extract them to the
CONTROL-M environment, as described in the earlier part of this section, or you can
assign a different manner in which these jobs should be processed. A user exit is a
user-defined script (or executable) that can be used for this purpose.
For each intercepted or extracted job, the Xtractor process runs the script, and passes
a list of parameters with values of the specific intercepted or extracted job. The
parameters are described in Table 22 on page 124.

Chapter 4 Administrator tasks

123

Activating the Xtractor process

Table 22

User Exit script parameters

Parameter number

Parameter value

<SAP Job Name>

<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.

Pre-defined User Exit for the Xtractor Process


The Xtractor automatically defines a default CTM Interception Rule that meets the
conditions described in Table 19 on page 115. This Interception Rule calls a
pre-defined User Exit script with the following name and location:

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.

Activating the Xtractor process


NOTE
The Xtractor process should not be activated before configuring its parameters. For more
information, see Configuring and working with the Xtractor process on page 107.

To activate and stop the Xtractor process in Unix


To activate the Xtractor process mechanism for CONTROL-M/CM for SAP, use the
following procedure:
At the command prompt enter start-xt.

124

CONTROL-M/Control Module for SAP Administrator Guide

Requesting SAP actions

To stop the Xtractor process, enter shut-xt.

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.)

To activate and stop the Xtractor service in Microsoft Windows


If the computer has not been restarted since the installation of CONTROL-M/CM for
SAP, you must restart it before activating the Xtractor service.

1 Select Start => Settings => Control Panel => Administrative Tools => Services to
display the Services dialog box.

2 Select CONTROL-M SAP CM XT, and either

click Start to start the Xtractor service


or
click Stop to stop the Xtractor service

Requesting SAP actions


The CONTROL-M/CM for SAP Request utility (ctmr3req) can be used to request that
SAP perform certain actions, using information from the SAP database. The ctmr3req
utility can request that SAP perform the following actions:

Display a list of defined variants for a specific program, as described on page 126.

Alter the value of a specific variant in a program, as described on page 127.

Display the details of a specific variant, as described on page 128.

Enable a SAP background processing event to be raised (triggered), as described


on page 129.

Delete a job from the SAP database, as described on page 130.

Define a new job, as described on page 131.

Modify an existing job, as described on page 133.

Remove process chain from schedule on page 134.

Chapter 4 Administrator tasks

125

Displaying a list of variants for a program

NOTE
This utility can be used within ctmcreate or ctmdefine. However if it is used this way, the
command is limited to 512 characters.

Displaying a list of variants for a program


Use this procedure to request that SAP display a list of defined variants for a specific
ABAP program.
(The program is set in the SAPR3-PROGRAM parameter.)

Before you begin

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 display a list of variants


Enter the following command, with the parameters set according to the values
described in Table 23, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION var_mon -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name>

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

Parameters for var_mon action

Parameter

Description

SAPR3-ACTION

The action that classifies the nature of this version of the


ctmr3req utility. (var_mon) Mandatory.

SAPR3-ACCOUNT

Name of a specific SAP account. Mandatory. Maximum


length: 30 characters.

SAPR3-PROGRAM

Name of the ABAP program in SAP, if such a program has


been indicated. Mandatory.

CONTROL-M/Control Module for SAP Administrator Guide

Altering parameter values in a variant

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

Altering parameter values in a variant


Use this procedure to alter the value of set parameters in a variant.

Before you begin

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 alter parameter values


Enter the following command, with the parameters set according to the values
described in Table 24, and press <Enter>.
on Unix
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>]

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

Parameters for var_edit action

Parameter

Value

-SAPR3-ACTION

Action that classifies the nature of this version of the


ctmr3req utility. (var_edit) Mandatory.

-SAPR3-ACCOUNT

Name of a specific SAP account. Maximum length: 30


characters. Mandatory.

Chapter 4 Administrator tasks

127

Displaying variant details within a program

Table 24

Parameters for var_edit action

Parameter

Value

-SAPR3-PROGRAM

Name of the ABAP program in SAP, if such a program


has been indicated. Mandatory.

-SAPR3-VAR

This parameter specifies the name of the variant for a


specific program in SAP. Mandatory.

-SAPR3-VAR_PARAM<nn>

The parameter of the variant. Mandatory.


nn is a two-digit number that represents the parameter
count number.

-SAPR3-VAR_TEXT

Description of the variant. Optional

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"]

Displaying variant details within a program


Use this procedure to display the details of a specific variant within a program.

Before you begin

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 display variant details in a program


Enter the following command, with the parameters set according to the values
described in Table 25, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION var_show -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> -SAPR3-VAR <variant_name>

128

CONTROL-M/Control Module for SAP Administrator Guide

Raising a SAP event

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

Parameters for var_show action

Parameter

Description

-SAPR3-ACTION

Action that classifies the nature of this version of the ctmr3req


utility. (var_show) Mandatory.

-SAPR3-ACCOUNT

Name of a specific SAP account. Maximum length: 30


characters. Mandatory.

-SAPR3-PROGRAM

Name of the ABAP program in SAP, if such a program has been


indicated. Mandatory.

-SAPR3-VAR

The variant of the SAP program. Mandatory.

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

Raising a SAP event


Use this procedure to enable a specific SAP background processing event to be raised
(triggered).

Before you begin

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 raise a SAP event


Enter the following command, with the parameters set according to the values
described in Table 26, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION raise_event -SAPR3-ACCOUNT <account_name>
-SAPR3-EVENT_ID <event_ID> -SAPR3-EVENT_PARAM <event_parameter>
Chapter 4 Administrator tasks

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

Parameters for raise_event action

Parameter

Description

-SAPR3-ACTION

Action that classifies the nature of this version of the


ctmr3req utility. (raise_event) Mandatory.

-SAPR3-ACCOUNT

Name of a specific SAP account. Maximum length: 30


characters. Mandatory.

-SAPR3-EVENT_ID

Name of SAP background processing event Mandatory.

-SAPR3-EVENT_PARAM

Additional parameters for a SAP background processing


event. Optional.

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.

Before you begin

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

CONTROL-M/Control Module for SAP Administrator Guide

Defining a new job

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

Parameters for job_delete action

Parameter

Description

-SAPR3-ACTION

Action that classifies the nature of this version of the


ctmr3req utility. (job_delete) Mandatory.

-SAPR3-ACCOUNT

Name of a specific SAP account. Maximum length: 30


characters. Mandatory.

-SAPR3-JOBNAME

Job name in SAP to be deleted. Mandatory.

-SAPR3-JOBCOUNT

Unique ID number for the job in SAP. Mandatory

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

Defining a new job


Use this procedure to define a new job in SAP database.

Before you begin

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>

Chapter 4 Administrator tasks

131

Defining a new job

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

Parameters for job_define action

Parameter

Description

-SAPR3-ACTION

Action that classifies the nature of this version of the


ctmr3req utility. (job_define) Mandatory.

-SAPR3-ACCOUNT

Name of a specific SAP account. Maximum length: 30


characters. Mandatory.

-SAPR3-JOBNAME

Job name in SAP to be defined. Mandatory.

-SAPR3-STEP-S<nn>STEP_TYPE

Step type. Mandatory.


Valid values are:
A = ABAP program
C = External command
E = External program
nn is a two-digit number that represents the step number.

-SAPR3-STEP-S<nn>PROGRAM

The name of the job step program. Mandatory.


nn is a two-digit number that represents the step number.

NOTE
The Target Group and Target Server parameters are not supported by the ctmr3req utility in

job define mode.


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 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

CONTROL-M/Control Module for SAP Administrator Guide

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.

Before you begin

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>]

Chapter 4 Administrator tasks

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

Parameters for job_modify action

Parameter

Description

-SAPR3-ACTION

Action that classifies the nature of this version of the


ctmr3req utility. (job_modify) Mandatory.

-SAPR3-ACCOUNT

Name of a specific SAP account. Maximum length: 30


characters. Mandatory.

-SAPR3-JOBNAME

Job name in SAP to be modified. Mandatory.

-SAPR3-JOBCOUNT

Unique ID number for the job in SAP. Mandatory.

-SAPR3-STEP-S<nn>STEP_TYPE

Step type. Mandatory.


Valid values are:

A = ABAP program
C = External command
E = External Program

nn is a two-digit number that represents the step number.


-SAPR3-STEP-S<nn>PROGRAM

The name of the job step program. Mandatory.


nn is a two-digit number that represents the step number.

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

Interrupts - Removing a process chain from schedule


To remove a process chain from schedule, use the following procedure:

134

CONTROL-M/Control Module for SAP Administrator Guide

Converting account definitions

Before you begin

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 remove a process chain from schedule


Enter the following command, with the appropriate parameters set (for more details
see Table 30, and press <Enter>.
on Unix
ctmr3req -SAPR3-ACTION PC_STOP_SCHEDULE -SAPR3-ACCOUNT
<account_name> -SAPR3-PROCESSCHAIN_ID <chain_id>

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

ctmr3req interrupt parameters

Parameter

Description

SAPR3-ACTION

The action that classifies the nature of this version of the


ctmr3req utility. (pc_stop_schedule) Mandatory.

SAPR3-ACCOUNT

Name of a specific SAP account. Mandatory. Maximum


length: 30 characters.

SAPR3- PROCESSCHAIN_ID Name of Process Chain in SAP. Mandatory.

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

Converting account definitions


The CONTROL-M/CM for SAP Conversion utility (conr3acc) is used to create new
account definitions for CONTROL-M/CM for SAP based on existing accounts in
CONTROL-M/Option for R/3.
Chapter 4 Administrator tasks

135

Converting account definitions

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.

Before you begin

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.

To convert an account definition


1 Enter the conr3acc command and the full path and filename of the account file that
you want to convert, on the command line, as shown in the syntax example below:
conr3acc $HOME/r3/data/acc_file

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.

Where to go from here


The following table describes where to find information about tasks related to this
one.

136

Subject

Location

Adding a new account.

Adding or modifying a CONTROL-M/CM for


SAP account on page 100

CONTROL-M/Control Module for SAP Administrator Guide

Converting CONTROL-M option for R/3 jobs

Converting CONTROL-M option for R/3 jobs


The Conversion utility (ctmr3con) enables you to convert jobs defined previously for
CONTROL-M Option for R/3 into jobs that can be run and monitored using
CONTROL-M/CM for SAP.

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.

Before you begin

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).

Chapter 4 Administrator tasks

137

Converting CONTROL-M option for R/3 jobs

Table 31

Conversion utility parameter description

Parameter

Description and default value

-IN_FILE

Input file. Default name: db_out.xml


Note: <input_file> in the above syntax represents the
exported scheduling table file.

-OUT_FILE

Output file. Default name:


<input_file>_conv_output.xml
For example, if the input file name is em_out_file.xml, the
output file would be em_out_file_conv_output.xml.

-JOB_MAN_DEF_MODE

Specifies the default function to be performed by the Job


Manager utility. Default value is RUN_COPY.
Note: For more information, see the CONTROL-M for R/3
Administrator Guide.

-RUN_COPY_MODE

Indicates which instance of the job should be copied if the


-run_copy parameter is set without a specific -cnt (count)
number. Default value is LAST_SCHEDULED.
Note: For more information, see the CONTROL-M Option
for R/3 Administrator Guide.

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.

What can be converted?


Jobs for the following CONTROL-M Option for R/3 utilities can be converted, using
this patch:

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)

CONTROL-M/Control Module for SAP Administrator Guide

Converting CONTROL-M option for R/3 jobs

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.

Standard versus extended mode operations


Standard and Extended modes are defined in CONTROL-M/Control Module for
SAP on a global level during run time. Standard mode or Extended mode is selected
using the configuration utility (ctmr3cfg). This is different from CONTROL-M Option
for R/3, in which you could define Standard or Extended mode at the job definition
level. Converted jobs acquire the selected mode during run time, according to what is
defined with the configuration utility.

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

The Copy Variant function is not supported.

-list

Not supported.

-modify

Not supported for creating new steps (not existing steps)

-acc

Mandatory, unless the -pass parameter is entered. For jobs without


the -acc parameter that are based on parameters in the configuration
file, see the explanation of the -pass parameter, below.
The account name (as represented by the -acc parameter) is left as is.
The assumption is that the account conversion utility (conr3acc) was
used successfully and that the new account name is identical to the
original one.

Chapter 4 Administrator tasks

139

Converting CONTROL-M option for R/3 jobs

Table 32

Problem parameters

Parameter / feature

Clarification / remarks

-pass

This parameter is ignored if an -acc parameter is indicated. (See the


explanation of the -acc parameter above.)
If this parameter exists, the user must create an account called
DEFAULT, as jobs are converted using enter an account named
DEFAULT.

-cancel

Not supported.

-debug

This parameter is ignored. Debugging information is recorded by


CONTROL-M/Control Module for SAP according to the debug level
configured in CONTROL-M/Agent. For more information, see the
section describing the configuration utility (ctmag) in the
CONTROL-M/Agent Administrator Guide.

ctm_r3_bi_mon

Only jobs with a -start value of Y are converted.


The -wait parameter is ignored.

-rfc_trace

Not Supported.

Any unknown
parameter

Job is not converted and an error message is issued.

Redirection

Redirection symbols at the end of a command line of a job are left as


is. However, this is only when jobs are converted to a command line.
Redirection symbols are removed from the command line of jobs
that are converted to CONTROL-M/ Control Module for SAP jobs,
with a tasktype of JOB.

(> or >>)

Output command line Not supported.


length greater than
512 characters

140

CONTROL-M/Control Module for SAP Administrator Guide

Appendix

Extracting and monitoring jobs


This appendix describes the CONTROL-M Extraction utility (ctmextract), with which
you can monitor and extract SAP jobs to CONTROL-M. While this functionality has
been surpassed for the most part by the Xtractor process (as described in
Configuring and working with the Xtractor process on page 107), there are still
instances when you need to use the Extraction utility, including the following:

if the XBP 2.0 interface is not installed on your SAP system


when extracting job definitions

The Extraction utility can be used to

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.

define one or more jobs in CONTROL-M, by using criteria identical to that of


specific jobs defined in the SAP database
It does this and uses the CONTROL-M ctmdefine utility to store these jobs in the
CONTROL-M definition environment. For more information, see Extracting job
definitions with the extraction utility on page 147.

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.

Appendix A Extracting and monitoring jobs

141

Defining a rule file with the extraction utility

Defining a rule file with the extraction utility


Use this procedure to create a rule file. A rule file is required in order to use the
ctmextract utility to either monitor SAP jobs with ctmcreate, (Monitoring SAP jobs
with the extraction utility on page 146) or to extract job definitions to CONTROL-M
using ctmdefine, (Extracting job definitions with the extraction utility on page 147).

Before you begin

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.

To create a rule file


1 Open a new text file, in a text editor program. A rule file should be structured in
two sections, as described in the following example:

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

Rule file AutoEdit parameters (part 1 of 3)

AutoEdit Variable

Description

%%SAPR3-ACCOUNT

Name of account (connection for this query).


Mandatory.
Free text

142

CONTROL-M/Control Module for SAP Administrator Guide

Defining a rule file with the extraction utility

Table 33

Rule file AutoEdit parameters (part 2 of 3)

%%SAPR3-JOBNAME

Name of the job in SAP. Can be either a specific or


generic name.
Note: If a SAP job name contains spaces, (for example,
JOB GOLD1) the corresponding CONTROL-M job
name is the same, with underscores replacing the spaces
(for example, JOB_GOLD1).
Mandatory. Free text
Note: In a Job Name, SAP perceives an underscore _
and a space to be the same character. This means that,
two jobs, named respectively JOB GOLD and
JOB_GOLD, for example, would be recognized as the
same job. This is a known SAP problem.

%%SAPR3-OWNER

Owner of the job in SAP


Valid values are any generic value.
Example: *
Mandatory

%%SAPR3-JOBCOUNT

CCMS job number


Free text

%%SAPR3-JOBGROUP

Summary of jobs for a group


Free text

%%SAPR3-FROM_DATE

Scheduled start date for CCMS job


Valid format is:
YYYYMMDD

%%SAPR3-FROM_TIME

Scheduled start time for CCMS job


Valid format is:
HHMMSS
Note: This parameter depends on the specification of
both %%SAPR3-FROM_DATE and
%%SAPR3-TO_DATE for the same day.

%%SAPR3-TO_DATE

Scheduled end date for CCMS job


Valid format is:
YYYYMMDD

Appendix A Extracting and monitoring jobs

143

Defining a rule file with the extraction utility

Table 33

Rule file AutoEdit parameters (part 3 of 3)

%%SAPR3-TO_TIME

Scheduled end time for CCMS job


Valid format is:
HHMMSS
Note: This parameter depends on the specification of
both %%SAPR3-FROM_DATE and
%%SAPR3-TO_DATE for the same day.

%%SAPR3-EVENT_ID

Background event ID
Free text

%%SAPR3-EVENT_PARAM

Background event parameter


Free text

%%SAPR3-RELEASED

Status of CCMS job


Valid values are:
X/N (default X)

%%SAPR3-READY

Status of CCMS job


Valid values are:
X/N (default X)

%%SAPR3-ACTIVE

Status of CCMS job


Valid values are:
X/N (default X)

%%SAPR3-FINISHED

Status of CCMS job


Valid values are:
X/N (default X)

%%SAPR3-CANCELED

Status of CCMS job


Valid values are:
X/N (default X)

Following is an example of the second section of a rule file:


{[CTMCREATE]|[CTMDEFINE]}
NODEGRP TLVW2K065
GROUP SAP1
%%SAPR3-ACCOUNT CM2

144

CONTROL-M/Control Module for SAP Administrator Guide

Defining a rule file with the extraction utility

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.

Choose [ctmdefine] to extract job definitions from SAP into the


CONTROL-M/Server database. For more information, see Extracting job
definitions with the extraction utility on page 147.

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

Mandatory parameters for ctmcreate and ctmdefine

Parameter

Description

NODEGRP

Node group. Valid value: Agent name.


Mandatory when CONTROL-M/Server and CONTROL-M/Agent
are not installed on the same computer.

%%SAPR3ACCOUNT

Account name (where the connection parameters to the SAP server


are set).

GROUP

Relevant CONTROL-M/Server group name (for ctmdefine-set


actions).

TABLE

Relevant CONTROL-M/Server table name (for ctmdefine-set


actions).

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.

Where to go from here


The following table describes where to find information about tasks related to this
one.

Appendix A Extracting and monitoring jobs

145

Monitoring SAP jobs with the extraction utility

Subject

Location

Monitoring SAP jobs using the rule file


you have just created.

See Monitoring SAP jobs with the extraction


utility on page 146

Extracting Job Definitions using the rule See Extracting job definitions with the extraction
file you have just created.
utility on page 147

Monitoring SAP jobs with the extraction utility


Use this procedure to create one or more mirror-image jobs by using criteria
identical to that of specific jobs already running in SAP. You can monitor them using
the CONTROL-M ctmcreate utility, although they were not submitted by
CONTROL-M. This enables you to track the progress of the actual job in SAP. The
mirror image is stored in the Active Jobs file in the CONTROL-M/Server database.

NOTE
Mirror images are only created for jobs that do not have scheduled status.

Before you begin

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.

To monitor the job


1 Create a rule file as described in Defining a rule file with the extraction utility on
page 142.

2 Enter the following command:


ctmextract -CM_APPL_TYPE SAP

-RULETABLE <rule file name and path>

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.

The parameters in this command are described in Table 35 on page 147.

146

CONTROL-M/Control Module for SAP Administrator Guide

Extracting job definitions with the extraction utility

NOTE
To make a ctmextract instance re-extract all jobs, add -IGNORE_DUP Y to the original
command, and repeat the procedure described above.

The utility runs according to the specifications in the rule file.


Table 35

Parameters for monitoring a job

Parameter

Description

-CM_APPL_TYPE

Represents SAP as an external application.


Valid value: SAP

-RULETABLE

Used to set the name and path of the rule file.


Valid value is the selected rule file.

-IGNORE_DUP

Causes a ctmextract instance to re-extract all jobs, regardless


of whether they were already extracted.
Valid value: Y

Where to go from here


The following table describes where to find information about tasks related to this
one.
Subject

Location

Defining a rule file to be used when


monitoring jobs or extracting job
definitions.

See Defining a rule file with the extraction utility


on page 142

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.

Extracting job definitions with the extraction utility


Use this procedure to extract a job definition from the SAP database to CONTROL-M,
and manage this job from CONTROL-M.

NOTE
Only jobs that have scheduled status can have their definition extracted.

Appendix A Extracting and monitoring jobs

147

Extracting job definitions with the extraction utility

Before you begin

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.

To extract job definitions


1 Create a rule file (as described in Defining a rule file with the extraction utility
on page 142).

2 Enter the following command:


ctmextract -CM_APPL_TYPE SAP

-RULETABLE <rule file name and path>

The parameters in this command are described in Table 35 on page 147.

NOTE
To make a ctmextract instance re-extract all jobs, add -IGNORE_DUP Y to the original
command, and repeat the procedure described above.

The utility runs according to the specifications in the rule file.

Where to go from here


The following table describes where to find information about tasks related to this
one.

148

Subject

Location

Defining a rule file to be used when


monitoring jobs or extracting job
definitions.

See Defining a rule file with the extraction utility


on page 142

Monitoring SAP jobs using the rule file


(as described above) that you have just
created.

See Monitoring SAP jobs with the extraction


utility on page 146

CONTROL-M/Control Module for SAP Administrator Guide

Appendix

Related SAP Notes


The information contained in Table 36 below describes known SAP Notes that may
cause problems with CONTROL-M/CM for SAP functionality. For more information
about these SAP Notes, access either the SAPNet - R/3 Frontend (previously called
OSS), or the SAP Service Marketplace, at http://service.sap.com/notes.

NOTE
This may require you to install later support packages on your SAP system.

Table 36

Known SAP Notes

SAP Note number

Description

835846

BP_JOB_SELECT: Optimizing the job selection (See also SAP Note


715355; After you import SAP Note 715355, jobs may not be selected
correctly.) See the following Flash: "BMPM009945 Jobs in Copy mode end
in failure after updating the SAP Basis SP level".

782127

Due to an internal SAP problem, jobs intercepted by SAP fail to start


running and are assigned a status of NOTOK in CONTROL-M. See the
following Flash: "CONTROL-M fails to start Intercepted jobs, and displays an
error message".

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

BAPI_XBP_REPORT_SEARCH: Empty report names in output


In XBP 2.0, Load ABAP does not provide the full list of ABAP programs.
This is a SAP problem.

699144

When restarting a Process Chain from point of failure using


CONTROL-M, irrelevant processes are also started.

609462

Incorrect print parameters for XBP (Version 2.0)


In XBP 2.0, the Use ABAP Program default does not work properly. This
is aSAP problem

Appendix B

Related SAP Notes

149

Table 36

150

Known SAP Notes

SAP Note number

Description

101146

Problems with background processing authorizations

635095

Short dump with BAPI_XBP_REPORT_SEARCH

487374

Spool list recipient is lost when you use XBP.

728947

Job count cannot be created.

839526

When you activate the process chain using the


RSPC_API_CHAIN_START function, the E_LOGID parameter is empty
but no exception is triggered.

330267

Importing CONTROL-M Function Modules to Unicode SAP systems.


See also Step 4 - CONTROL-M function modules on page 37.

664830

Severe problems when working with Business Information Warehouse.


This SAP Note must be applied to your SAP system when working with
CONTROL-M solution for Business Information Warehouse.

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

Due to CONTROL-M usage, the SAP table TXMILOGRAW rapidly


increases in size. To resolve this problem:

Follow general instructions for configuring Standard Jobs, as


described in SAP Note 16083.

If this does not resolve the problem, configure


SAP_REORG_XMILOG to delete XMI logs more frequently.

When using SAP releases earlier than 4.6C, follow the instructions in
SAP Note 182963.

612564

Jobs are created with the wrong job class.

654802

Jobs become stuck in "Released" status instead of being executed.

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

Authorization checks are not performed when releasing intercepted jobs.

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

When copying a job, the Spool List Recipient is not copied.

604496

A composite SAP Note on XPB 2.0.

CONTROL-M/Control Module for SAP Administrator Guide

Table 36

Known SAP Notes

SAP Note number

Description

628917

This SAP Note relates to bug number BMPM008968 (No support of


comma as decimal point in numeric fields). For more information, see
the CONTROL-M/CM for SAP Release Notes, FD5311.

856780
790615

Load ABAP fails with error 101 - Call back function with events called.

Appendix B

Related SAP Notes

151

152

CONTROL-M/Control Module for SAP Administrator Guide

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

Drafts, Data Archiving sessions 79

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

CONTROL-M/Control Module for SAP Administrator Guide

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

Java Runtime Environment 28


Job Class parameter
Data Archiving 88
SAP panel 52
Job Count parameter
SAP panel 53
Job definitions, extracting 147
Job Editing form
illustration 50
SAP panel 49
Job interception
XBP 2.0 21
Job Mode option buttons
SAP panel 53
Job Mode parameter
Data Archiving 88
Job Name parameter 113
Data Archiving 88
SAP Panel 54
Job skeleton
defining 46
field values 46
job_define action parameters 132
job_delete action parameters 131
job_modify action parameters 134
Jobs
cancelling 74
controlling 16, 111
converting 137
defining 131
deleting 130
extracting 116, 141
modifying 133
monitoring 16, 73
running 15
scheduling 15
setting priorities 110
spawned 121
statuses 16
jobs. See SAP jobs

Mass parallel process 18, 121


Max List Entries parameter 106
Mixed Case Job Name parameter 106
Modifying job skeletons 46
Modifying jobs 133
Monitoring jobs 16
Monitoring mass parallel processes 18
Monitoring SAP jobs 73
Monitoring SAP-BW jobs 96

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

CONTROL-M/Control Module for SAP Administrator Guide

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

var_mon action parameters 126


var_show action parameters 129
Variant
altering parameters 127
displaying details 128
displaying list of values 126
Variant Name parameter
Add ABAP window 66
Data Archiving 90

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

CONTROL-M/Control Module for SAP Administrator Guide

Notes

*56598*
*56598*
*56598*
*56598*
*56598*

You might also like