BMC Control-M for SAP 8.0.00 Administrator Guide
Tangazo
Tangazo
Control-M for SAP
8.0.00
Administrator Guide
February 2014
www.bmc.com
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com
. From this website, you can obtain information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada
Address BMC SOFTWARE INC
2101 CITYWEST BLVD
HOUSTON TX
77042-2827
USA
Telephone 713 918 8800
800 841 2031
Fax 713 918 8000
14/01/2014
Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
© Copyright 2013 BMC Software, Inc.
BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners. IT Infrastructure Library® is a registered trademark of the Office of
Government Commerce and is used here by BMC Software, Inc., under license from and with the permission of OGC.
ITIL® is a registered trademark, and a registered community trademark of the Office of Government
Commerce, and is registered in the U.S. Patent and Trademark Office, and is used here by BMC Software,
Inc., under license from and with the permission of OGC.
Linux is the registered trademark of Linus Torvalds.
Oracle is a registered trademark of Oracle Corporation.
UNIX is the registered trademark of The Open Group in the US and other countries.
BMC Software considers information included in this documentation to be proprietary and confidential.
Your use of this information is subject to the terms and conditions of the applicable End User License
Agreement for the product and the proprietary and restricted rights notices included in this documentation.
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER
THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR
Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS
252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101
CITYWEST BLVD, HOUSTON TX 77042-2827, USA. Any contract notices should be sent to this address.
2
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting
Customer Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at http://www.bmc.com/support . From this website, you can:
read overviews about support services and programs that BMC offers
find the most current information about BMC products
search a database for issues similar to yours and possible solutions
order or download product documentation
download products and maintenance
report an issue or ask a question
subscribe to receive proactive e-mail alerts when new product notices are released
find worldwide BMC support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers
Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call
800 537 1813 or send an e-mail message to [email protected]
. (In the subject line, type
SupID:<yourSupportContractID>, such as SupID:12345). Outside the United States and Canada, contact your local support center for assistance.
Before contacting BMC
Have the following information available so that Customer Support can begin working on your issue immediately:
product information
product name
product version (release number) license number and password (trial or permanent)
operating system and environment information
machine type
operating system type, version, and service pack or other maintenance level such as PUT or PTF system hardware configuration serial numbers
related software (database, application, and communication) including type, version, and service pack or maintenance level
3
sequence of events leading to the issue
commands and options that you used
messages received (and the time and date that you received them)
product error messages
messages from the operating system, such as file system full messages from related software
License key and password information
If you have questions about your license key or password, contact BMC as follows:
(USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail message to [email protected]
.
(Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20
354 8702, or send an e-mail message to [email protected]
.
(Asia-Pacific) Contact your BMC sales representative or your local BMC office.
4
Contents
5
1
Control-M for SAP overview
Chapter
1
Control-M for SAP is an application plug-in that enables you to automate planned and automated SAP processes, and the unpredicted real-time, event-driven dynamic job submission. Before you begin, do the following:
Install Control-M for SAP, as described in Installation
Configure Control-M for SAP in the CCM, including adding accounts, configuring settings, managing events, managing extractor rules, and importing Control-M for SAP calendar, as described in
Control-M configuration manager administration (on page 35 ).
Check SAP Notes that may resolve problems which might occur using Control-M for SAP, as described
in Known SAP notes (on page 8 ).
Control-M for SAP jobs are integrated with other Control-M jobs into a single scheduling environment. This enables you to control and operate the SAP report generation within Control-M and enables you to do the following:
Define and monitor Control-M for SAP jobs and reports, as described in Job definition
(on page
Integrate SAP jobs with other Control-M jobs into a single scheduling environment, as described in the
Control-M User Guide
.
Introduce all Control-M capabilities to SAP, including advanced scheduling criteria, complex dependencies, quantitative and control resources, and autoedit variables, as described in the
Control-M User Guide
.
6
Control-M for SAP Administrator Guide
Administrative roles
Certain Control-M for SAP tasks might need to be performed by different professionals in your organization, as follows:
System Administrator: Responsible for reviewing the system requirements and performing the installation process.
Control-M Administrator : Responsible for the administration of all Control-M processes.
Control-M Production Controller : Responsible for defining and/or monitoring Control-M jobs.
The following table lists the tasks performed when working with the Control-M for SAP and the role of the professional who is responsible for its administration.
Tasks Roles
Install Control-M for SAP on a Control-M/Agent on UNIX, as
described in Installing Control-M for SAP on
Control-M/Agent on UNIX (on page 16 ) and on Windows,
as described in Installing Control-M for SAP on
Control-M/Agent on Windows (on page 17 ).
System Administrator
Control-M Administrator
Install Secure Network Communication on Control-M for
SAP, as described in Installing the Secure Network
Communications (SNC) on Control-M for SAP (on page 18 ).
Install Control-M for SAP on a Control-M/Enterprise
Manager (Control-M/EM) client and server, as described in
Installation on Control-M/EM (on page 19 ).
System Administrator
Control-M Administrator
Configure Control-M for SAP in the CCM, including adding accounts, configuring settings, managing events, managing extractor rules, and importing Control-M for SAP calendar,
as described in Control-M configuration manager administration (on page 35 ).
Control-M Administrator
Define Control-M for SAP jobs, as described in Job definition (on page 117 ).
Control-M Administrator
Apply values for the autoedit variables to the Control-M for
SAP definition parameters, as described in Control-M for
SAP parameters (on page 126 ).
Control-M Administrator
7
Control-M for SAP Administrator Guide
Known SAP notes
The following table describes known SAP Notes that resolve problems which might occur when using
Control-M for SAP. For more information, access either the SAPNet - R/3 Frontend or the SAP Service
Marketplace, at http://service.sap.com/notes .
NOTE : You may need to install later support packages on your SAP system.
SAP Note number Description
1003941
1005481
1723482
706292
888681
756201
792850
903329
1030158
SAP BW, Process Chain: On the agent tracker process, an error occurs that the chain is not continued despite the fact that the process was completed successfully.
SAP BW, Process Chain: On the agent tracker process, In very quick parallel asynchronous processes, even though one or more processes may be successful, the process chain log may not contain any instances.
As a result, the chain does not continue after the successful process.
When the same process chain is started in parallel via the FM
RSPC_API_CHAIN_START, the chain is not executes and it results in an endless loop.
DB2 database system. A function that checks or reads the status of a job report, and understands that the job does not exist, even though it clearly does.
As 706292, for the DB6 database system.
As 706292, for the SQL Server Microsoft database.
Kernel corrections.
The FKJO_SCHEDULE report prepares jobs for a mass activity run for external job schedulers. Jobs should be created in "Scheduled" status.
However, these jobs exist in 'Released' status for a short time during the report runtime before their status is changed to
Scheduled . This can be a problem for some external job schedulers.
8
Control-M for SAP Administrator Guide
SAP Note number
1048051
1004083
1059049
1016441
856780
790615
839526
835846
833777
782127
756901
732350
Description
When an external job scheduler reads child jobs of the
FKJO_SCHEDULE report, no results are shown, because scheduled jobs are not child jobs. In this situation, the jobs must have
Released status, released and the external job scheduler must intercept these jobs.
(This is a continuation of the note 1030158)
This SAP note relates to the Restart from Point of Failure option in the SAP panel of Control-M/EM Active Jobs file. Process
Chain jobs do not restart.
Control-M for SAP reports that Process Chain jobs ended NOTOK, when they have actually completed successfully. This is due to an internal SAP problem.
Control-M for SAP reports that R/3 jobs ended NOTOK, when they have actually completed successfully. This is due to an internal
SAP problem.
Load ABAP fails with error 101,
Call back function with events called
.
When you activate the process chain using the
RSPC_API_CHAIN_START function, the E_LOGID parameter is empty but no exception is triggered.
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 .
If you want to create jobs with the After Event start condition, this note must be installed in your SAP system.
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.
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.
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 an SAP problem.
9
Control-M for SAP Administrator Guide
SAP Note number
728947
699144
677081
664830
654802
641175
635095
628917
612564
610480
609462
605483
604496
602683
487374
Description
Job count cannot be created.
When restarting a Process Chain from point of failure using
Control-M, irrelevant processes are also started.
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.
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.
Jobs become stuck in Released status instead of being executed.
When copying a job, the Spool List Recipient is not copied.
Short dump with BAPI_XBP_REPORT_SEARCH
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 for SAP Release Notes, FD5311.
Jobs are created with the wrong job class.
Slow reaction of certain BAPI functions can affect the Extractor
Management performance, and the loading of job names in the
Job Editing form.
Incorrect print parameters for XBP (Version 2.0) In XBP 2.0, the
Use ABAP Program default does not work properly. This is an SAP problem.
Authorization checks are not performed when releasing intercepted jobs.
A composite SAP Note on XBP 2.0.
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.
Spool list recipient is lost when you use XBP.
10
Control-M for SAP Administrator Guide
SAP Note number
458670
330267
182963
101146
16083
1721035
Description
Data Archiving: This SAP Note should be implemented when using
XBP 1.0 on SAP 4.6C.
Importing Control-M Function Modules to Unicode SAP systems.
See Installing the Control-M Function Modules in a Unicode SAP system (on page 22 ).
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.
Problems with background processing authorizations
A review of Standard Jobs and Reorganization jobs. See also SAP
Note 182963.
XBP 3.0: The function BAPI_XBP_VARIANT_CHANGE does not change the description of a Variant.
11
Control-M for SAP Administrator Guide
Control-M for SAP compatibility with SAP authorizations
The following table describes the authorizations that SAP users need to use this product.
Requirements Details
SAP Basis Release: 4.5B, 4.6C,
4.6D, 6.10, 6.20, 6.40
(NetWeaver), 7.x
Kernel version
If you are working with SAP Basis 7.0, you need to install
SAPKB70012 (Support Package 12) as a minimum requirement.
XBP interface
Data archiving
Due to SAP changes in the RFC libraries, a minimum kernel for your SAP system is required, which is detailed in SAP note 792850 and 903329. Failure to do so, prevents Control-M for SAP from working and the following connection error is displayed:
You are not authorized to logon to the target system (error code 1) Connect to SAP gateway failed partner not reached (host <...>, service
33<nn>)
SAP recommends that you always have the most updated version of Kernel installed.
It is recommended that your SAP system includes at least the XBP
2.0 interface. Some of the features are available without XBP 2.0, if you use Control-M Function Modules. The XBP 3.0 interface is required for application log features. For more information, see
Differences between XBP BAPIs and Control-M Function Modules
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
7.0 - SAPKB70012 (Support Package 12)
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.
If you are use XBP 1.0 on SAP 4.6C and plan to implement
Control-M support for Data Archiving, you must apply SAP Note
458670 to your SAP system. Follow the instructions provided in the SAP note. When using XBP 2.0 or XBP 3.0, this note is not necessary.
12
Control-M for SAP Administrator Guide
Requirements
SAP Business Information
Warehouse
Import SAP Calendar
Details
Releases: 2.0B, 2.1C, 3.0B, 3.1 Content, 3.1 Content with BI
CONT 3.20, 3.5, 7.x.
If you plan to use the Control-M 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 986892)
BW 7.0 - SAPKW70014 (release details in SAP Note 991094)
If you plan to use the Control-M for SAP Interrupt functionality, for
BW 3.0 and 3.5, SAP Note 786748 must be installed manually. For
If you plan to use Control-M for SAP functionality, you must install the following SAP Basis Support packages:
Known SAP notes (on page 8 ), which resolve problems which can
occur when using Control-M for SAP.
Install the following SAP Basis Support Packages, to avoid installing each note separately, :
4.6C -- SAPKB46C52 (Support Package 52)
4.6D -- SAPKB46D43 (Support Package 43)
6.10 -- SAPKB61046 (Support Package 46)
6.20 -- SAPKB62059 (Support Package 59)
6.40 -- SAPKB64017 (Support Package 17)
The following SAP Business Warehouse Support Packages can also be installed. These Support Packages include SAP Note 1059049, which correct a previous SAP problem.
BW 7.0 - SAPKW70015 (release details in SAP Note 991095)
BI 7.1 - SAPKW71001 (release details in SAP Note 1011773)
NOTE: Information regarding the availability of the above support packages and other related data should be verified directly with
SAP.
If you plan to use the Import SAP Calendar utility, your SAP system version should be PI_BASIS 2002_2_620 or later .
13
Control-M for SAP Administrator Guide
Requirements Details
SAP Event Based Scheduling
Open ports
SAP Basis Release: 7.0 and later
The gateway port in the SAP host should always be open. If you are using a firewall, ensure that this port is open.
The port is usually 33<SYSNR>, where SYSNR represents the
System number of the computer on which the SAP Gateway
Server is running.
EXAMPLE : Port 3335 is used when the System number is 35.
If you are using Log in Groups, ensure that the Message Server port you are using is open.
NOTE : You can use a transport user role,
BMCCTRLM_CM_USER, which includes all the authorizations
(with the exception of S_RS_PC), needed to work with Control-M for SAP. Use this role in your Control-M
authorization checks if the job is completed in SAP using the Owner of the job step. However, if you do not set an Owner for the job step, the Owner is set in the connection profile and must have the required authorizations.
NOTE : The User Type, as defined in the SAP User maintenance transaction (SU01), can be either System or Dialog. Different User Types might cause errors in connection
14
2
Installation
Chapter
2
Control-M for SAP can be installed on Windows Control-M/Agent or on a UNIX Control-M/Agent. If either
Control-M for SAP version 6.2.01, 6.3.01 or 7.0.00 is already installed, you must upgrade to version
8.0.00, as prompted by the installation wizard. Before performing an upgrade, first stop the Extractor process.
The following procedure describes how to install Control-M for SAP and Control-M Function Modules
(FMs).
Setting environment variables in UNIX (on page 15 ): Describes how to set environment variables in
UNIX.
Installing Control-M for SAP on Control-M/Agent on UNIX (on page 16 ): Describes how to install
Control-M for SAP on Control-M/Agent on UNIX via an interactive and automatic installation.
Installing Control-M for SAP on Control-M/Agent on Windows (on page 17 ): Describes how to install
Control-M for SAP on Control-M/Agent on Windows via an interactive and automatic installation.
Installation on Control-M/EM (on page 19 ): Describes how to install Control-M for SAP plug-in on
Control-M/EM client and Control-M/EM Server computer.
Installing the Control-M Function Modules in a non Unicode SAP system (on page 21 ): Describes how
to install Control-M Function Modules (FMs) in a non Unicode SAP system.
Installing the Control-M Function Modules in a Unicode SAP system (on page 22 ): Describes how to
install Control-M Function Modules (FMs) in a Unicode SAP system.
For more information, see: Control-M for SAP XBP interface and Control-M Function Modules (on page
Setting environment variables in UNIX
This procedure describes how to set environment variables in UNIX, which enables you to see messages from the console.
To set environment variables in UNIX:
Do one of the following:
If you use csh or tcsh , use the following syntax: setenv
<envVar> <value>
EXAMPLE : setenv DISPLAY myhost:0.0
If you use sh or ksh , use the following syntax:
<envVar>=<value>
export
<envVar>
15
Control-M for SAP Administrator Guide
EXAMPLE : DISPLAY=myhost:0.0
export DISPLAY
<envVar>
is the name of the environment variable.
<value>
is the value assigned to the environment variable.
Installing Control-M for SAP on Control-M/Agent on UNIX
This procedure describes how to install Control-M for SAP on Control-M/Agent on UNIX interactively or automatically.
If you want to install multiple instances of Control-M for SAP on several computers using the same configuration, use the automatic installation, as described in this procedure.
NOTE : The default installation is interactive and uses a GUI display. XServer must be running and configured using the DISPLAY environment variable. If you do not have XServer available, BMC recommends that you continue with the console installation or perform an automatic installation.
Before You Begin
Ensure the following:
Verify that all jobs running on Control-M/Agent have ended.
If you are using Linux x86_64 platform that runs 32bit version of the Control-M/Agent, install the following 32bit libraries: libXtst.so.6
and libXi.so.6
.
To install on UNIX:
1.
Log in as the Control-M/Agent user, and stop the Control-M/Agent by typing the following command:
$CONTROLM/scripts/shut-ag -u <agentUser> -p all
NOTE : If the Control-M/Agent was installed with user root , then log in as user root every time you start up or shut down the Control-M/Agent throughout this procedure.
If you are using an AIX operating system, you must remove unused libraries from memory, by typing the following command as a root user:
/usr/sbin/slibclean
2.
Do one of the following:
Mount the installation DVD.
Extract the files from the temporary directory that you created when obtaining the installation files via EPD (see
Control-M for SAP Release Notes
).
3.
Use one of the following modes:
Display: If you install using GUI (or XServer), set your DISPLAY environment variable, as
described in Setting environment variables in UNIX (on page 15 ).
Console: It is not necessary to set DISPLAY .
4.
From the installation DVD or from the installation files via EPD, activate the installation script with the following command:
<
source_path
>/setup.sh
16
Control-M for SAP Administrator Guide
5.
Do one of the following:
Interactive install : Continue with the on-screen instructions until the installation is complete.
Automatic install : Do the following: a.
Continue with the on-screen instructions until the Summary window. b.
Click Generate and select the location to create the XML parameter file. c.
Click Yes.
d.
Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation. e.
To run the installation script, enter the following command:
<
source_path
>/setup.sh -silent <
filename.xml>
The installation logs can be found at the following location:
$HOME/BMCINSTALL/log/cmsap/BMC_Control-M_For_SAP_Install_<date-time>.log
6.
Log out of the Control-M/Agent account.
7.
Start the Control-M/Agent by running the following command:
$CONTROLM/scripts/start-ag -u <agentUser> -p all
8.
To use the Control-M for SAP utilities in the CCM, run the ctmgetcm utility in the Control-M/Server.
For more information, see the
Control-M Administrator Guide
.
9.
Continue with Installation on Control-M/EM (on page 19 ).
Installing Control-M for SAP on Control-M/Agent on
Windows
This procedure describes how to install Control-M for SAP on Control-M/Agent on Windows.
If you want to install multiple instances of Control-M for SAP on several computers using the same configuration, use the automatic installation, as described in this procedure.
Before You Begin
Verify that all jobs running on Control-M/Agent have ended.
To install on Windows:
1.
Log in to the computer as a user who has Administrator authorization.
2.
Do one of the following:
From the installation DVD, double-click the Setup.exe
file.
From a command prompt window, type <
source_path
>\Setup.exe
.
17
Control-M for SAP Administrator Guide
3.
Do one of the following:
Interactive install : Continue with the on-screen instructions until the installation is complete.
Automatic install : Do the following: a.
Continue with the on-screen instructions until the Summary window. b.
Click Generate and select the location to create the XML parameter file. c.
Click Yes . d.
The automatic installation XML parameters file that is created (< only for computers with the same agent instance name. Otherwise, a separate
<
filename
computer.
filename
>.xml) is relevant
>.xml file must be created for each computer, or modified manually for each e.
Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation. f.
Run the installation script, as follows:
<DVDROM_path>\Setup.exe -silent <
silent.xml
>
The installation log can be found at the following location:
<instance_install_path>\BMCINSTALL\log\cmsap\BMC_Control-M_For_SAP_Install_
mestamp>.
log
<ti
In case of installation failure, the log file is located in the following location:
%temp%\BMC_Control-M for SAP_Install_
<timestamp>
.log
4.
To use the Control-M for SAP utilities in the CCM, you must run the ctmgetcm utility in the
Control-M/Server. For more information, see the
Control-M Administrator Guide
.
5.
Continue with Installation on Control-M/EM (on page 19 ).
Installing the Secure Network Communications (SNC) on
Control-M for SAP
This procedure describes how to install the SNC protocol on Control-M for SAP, which enables the encryption of data between Control-M for SAP and the SAP system.
To install the SNC:
1.
Follow the download and installation procedures, as described in the Knowledge Base solution
SLN000015111830 on the Customer Support website, located at http://www.bmc.com/support .
2.
After the SNC set up is complete, stop Control-M/Agent.
3.
Stop Control-M for SAP by typing one of the following commands:
4.
UNIX: sapcmbe.sh stop
Windows: sapcmbe.cmd stop
(UNIX only) Start Control-M for SAP, using the following command: sapcmbe.sh start &
18
Control-M for SAP Administrator Guide
5.
Start Control-M/Agent.
Installation on Control-M/EM
After you have installed Control-M for SAP on the Control-M/Agent, you must install Control-M for SAP plug-in on the Control-M/EM client and the Control-M/EM Server computer.
This procedure must be performed on every computer that has Control-M/EM client or Control-M/EM
Server components installed.
The following procedures describe how to install the Control-M for SAP client and server plug-in module on Control-M/EM:
Installing the Control-M for SAP plug-in on Control-M/EM on UNIX (on page 19 )
Installing the Control-M for SAP plug-in on Control-M/EM on Windows (on page 20 )
Installing the Control-M for SAP plug-in on Control-M/EM on UNIX
This procedure describes how to install Control-M for SAP plug-in on the Control-M/EM on UNIX, which installs the CCM, self service, Find and Update and forms on Control-M/EM.
Before you begin
Ensure that Control-M for SAP LPRMC.8.0.00 DVD is mounted or accessible through your network.
To install on Control-M/EM client:
1.
Log in as the Control-M/EM user.
2.
Use one of the following modes:
Display: If you install using GUI (or XServer), set your DISPLAY environment variable,
3.
For csh or tcsh shell users: setenv DISPLAY <your computer name>:0.0
Console : It is not necessary to set DISPLAY .
From the installation DVD or from the installation files via EPD, activate the installation script with the following command:
< DVDROM_path > /EM/setup.sh
4.
Do one of the following:
Interactive install: Continue with the on-screen instructions until the installation is complete.
Automatic install: Do the following: a.
Continue with the on-screen instructions until the Summary window. b.
Click Generate and select the location to create the XML parameter file. c.
Click Yes . d.
Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation.
19
Control-M for SAP Administrator Guide e.
To run the installation script, type the following command:
<source_path> /setup.sh -silent <filename.xml>
The installation logs can be found at the following location:
$HOME/BMCINSTALL/log/BMC_Control-M-CM_EM_Install_<date-time>.log
5.
Once completed, run the following commands to restart Control-M Configuration Server:
stop_cms start_cms
6.
From the Control-M Configuration Manager, restart the Control-M GUI server.
The plug-in is now installed on Control-M/EM.
Installing the Control-M for SAP plug-in on Control-M/EM on
Windows
This procedure describes how to install Control-M for SAP plug-in on the Control-M/EM on Windows, which installs the CCM, self service, Find and Update and forms on Control-M/EM.
Before You Begin
Ensure the following:
Control-M for SAP LPRMC.8.0.00 DVD is mounted or accessible through your network.
Control-M Configuration Manager is closed.
To install on Windows:
1.
Log in with a user ID with administrator privileges on the specific computer.
2.
On the LPRMC.8.0.00 DVD, navigate to the EM directory.
3.
Do one of the following:
From the installation DVD, double-click the EM\setup.exe
From a command prompt window, type <
source_path
>\EM\setup.exe
.
4.
Do one of the following:
Interactive install : Continue with the on-screen instructions until the installation is complete.
Automatic install : Do the following: a.
Continue with the on-screen instructions until the Summary window. b.
Click Generate and select the location to create the XML parameter file. c.
Click Yes . d.
The automatic installation XML parameters file that is created (< only for computers with the same agent instance name. Otherwise, a separate
<
filename
computer.
filename
>.xml) is relevant
>.xml file must be created for each computer, or modified manually for each
20
Control-M for SAP Administrator Guide e.
Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation. f.
Run the installation script, as follows:
<DVDROM_path>\EM\Setup.exe -silent <
silent.xml
>
The installation log can be found at the following location or under the directory that contains the
%temp% directory:
%temp%\BMC_Control-M-CM_EM_Install_<date-time>.log
5.
If the Control-M for SAP plug-in was installed on Control-M/EM Server, you need to restart the
Control-M Configuration Server service and restart the Control-M GUI server from the Control-M
Configuration Manager.
The plug-in is now installed.
Control-M for SAP XBP interface and Control-M Function
Modules
Control-M for SAP version 8.0.00 works integrally with the XBP interface and supports XBP 1.0, XBP 2.0 and XBP 3.0. XBP 2.0 was created by SAP to work with external scheduling applications and it replaces and upgrades functionality previously provided by the Control-M FMs in earlier versions of Control-M for
SAP. These improvements are also supported in XBP 3.0.
Control-M FMs are Control-M for SAP specific APIs that enhance the functionality of SAP. Control-M FMs,
) and Installing the Control-M
Function Modules in a Unicode SAP system (on page 22 ).
To work with Control-M for SAP XBP functionality, you must set the value of the XBP Version account parameter to the required version. To verify whether your SAP system includes the XBP interface, see XBP
Version in Set Connection details parameters for specific application server (on page 38 ).
For the major differences in actions performed with XBP 1.0, XBP 2.0, XBP 3.0 and Control-M FMs see:
Differences between XBP BAPIs and Control-M Function Modules (on page 24 )
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 an SAP system with XBP 1.0 installed, Control-M
FMs must be installed. However, if your SAP system has XBP 2.0 or later installed and the account is configured with this XBP version, the variant is copied using the XBP BAPIs.
Installing the Control-M Function Modules in a non Unicode SAP system
This procedure describes how to install the Control-M Function Modules (FMs) in a non Unicode SAP system. The Control-M Function Modules (FMs) are required to perform tasks that are not provided by the
SAP standard BAPIs. They are Control-M for SAP specific APIs that enhance the functionality of SAP. A set of predefined Control-M FMs is provided together with Control-M for SAP.
21
Control-M for SAP Administrator Guide
You can set Control-M FMs in a Unicode system. For more information, see: Installing the Control-M
Function Modules in a Unicode SAP system (on page 22 ).
If you do not want to install Control-M Function Modules, ensure that the Use Extended check box in
Configuration Management is cleared. For more information, see Account management (on page 35 ).
Before you begin
Ensure you have the following SAP Transports located on the installation DVD:
UNIX: <DVDROM_path>/Tools/Transports
Windows: <DVDROM_path>\Tools\Transports
To install the Control-M FMs in the SAP system:
1.
Copy the transport files into the transport directory of the SAP system.
2.
Remove the read-only attribute of the transport files copied from the DVD. This prevents problems with the import to the SAP system.
3.
Use the SAP Transport Management System (transaction STMS) or the operating system executable program to import the required transport.
For more information about the Transport Management System and the program, refer to SAP documentation.
Installing the Control-M Function Modules in a Unicode SAP system
This procedure describes how to install the Control-M Function Modules (FMs) in a Unicode SAP system.
The Control-M Function Modules (FMs) are required to perform tasks that are not provided by the SAP standard BAPIs. They are Control-M for SAP specific APIs that enhance the functionality of SAP. A set of predefined Control-M FMs is provided together with Control-M for SAP.
Function Modules in a non Unicode SAP system (on page 21 ). If you do not want to install Control-M
Function Modules, ensure that the Use Extended check box in Configuration Management is cleared. For
more information, see Account management (on page 35 ).
Before you begin
Ensure you have the following SAP Transports located on the installation DVD:
UNIX: <DVDROM_path>/Tools/Transports
Windows: <DVDROM_path>\Tools\Transports
To install the Control-M FMs in a Unicode SAP system:
Do one of the following:
If you want to use a Unicode flag, do the following: a.
Follow the instructions provided in SAP Note 330267 in the section, Transports from 4.6 to
6.10/6.20/6.30 regarding actions to be performed during the import procedure.
22
Control-M for SAP Administrator Guide
b.
Copy the transport files into the transport directory of the SAP system. c.
Remove the read-only attribute of the transport files copied from the DVD. This prevents problems with the import to the SAP system. For more information about the contents of the
sub-folders of the Transports folder, see Transport sub-folder contents (on page 28 ).
d.
Use the SAP Transport Management System (transaction STMS) or the operating system executable program to import the required transport.
For more information about the Transport Management System and the program, refer to SAP documentation.
If you do not want to use a Unicode flag do the following: a.
Copy the transport files into the transport directory of the SAP system. b.
Remove the read-only attribute of the transport files copied from the DVD. This prevents problems with the import to the SAP system. For more information about the contents of the
sub-folders of the Transports folder, see Transport sub-folder contents (on page 28 ).
c.
Use the SAP Transport Management System (transaction STMS) or the operating system executable program to import the required transport. Ignore the displayed warnings. d.
Extract the file uc_support.zip located under directory transports on the Control-M for SAP
DVD root to a temporary directory. e.
Import the transport QW1K900062 from the extracted files. f.
Open transaction SE38 and execute the following program:
/BMCCTRLM/RUN_CHANGE_TO_UNICOD.
The program updates the Control-M FMs to run SAP Unicode systems.
23
Control-M for SAP Administrator Guide
Differences between XBP BAPIs and Control-M Function Modules
The following table describes the differences between XBP BAPIs and Control-M Function Modules.
Action XBP 1.0 BAPI XBP 2.0 BAPI XBP 3.0 BAPI Control-M Function
Modules x x Parent/Child (mass parallel) functionality
Intercept functionality
Enhanced Extract functionality
Basic Extract functionality
(ctmextract) x x x x x x x x x 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 x x x x x
Job Class (A, B) in
Create mode x
(Using the
Parent/Child and the
Interception functions) x x
(Using the
Parent/Child and the
Interception functions) x x
24
Control-M for SAP Administrator Guide
Action
Preventing duplication in extracting jobs from
SAP
Support for External
Command
Spool List Recipient in
Create job mode
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
XBP 1.0 BAPI XBP 2.0 BAPI XBP 3.0 BAPI Control-M Function
Modules x x x x x x x x x x x x x x x x x x x x x x x x
25
Control-M for SAP Administrator Guide
Action
Application logs and status support
Load and Action requests:
ABAP Programs list
Variants list
Show variant
Variant copy
Variant change
Output devices (printers) list
Layouts (print formats)
Load Job Server Groups
Load External Command
Load for distribution list
Load owner
Load event
View Job Steps
Manage Event History Profiles
Manage Interception Profiles
XBP 1.0 BAPI XBP 2.0 BAPI XBP 3.0 BAPI Control-M Function
Modules x x x x x x x x x x x x x x x x x x x x x x x x x (supported when working with SAP 6.20 or above) x (supported when working with SAP 6.20 or above) x x x x x x x x x
26
Control-M for SAP Administrator Guide
Differences between SAP Business Warehouse and Control-M
Function Modules
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 or later BAPIs, and Control-M Function
Modules.
Action Control-M Function Modules
Start I/P
BW 2.x BAPI BW 3.x or above BAPI x x
Monitor I/P
I/P Output
Get Background Job
Name/Count
Set Background Job Name
Display the number of records transferred and requested of an I/P run x
Start P/C
Monitor P/C
N/a
N/a x x x x x x x x x
Restart P/C
P/C Output
N/a
N/a x x
NOTE : Process Chains (P/C) capabilities are only available in SAP-BW 3.x or above systems.
27
Control-M for SAP Administrator Guide
Transport sub-folder contents
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 for SAP System user type.
The following table lists the contents of the sub-folders in the Transports folder.
Transport name
SAP_R3
BW
DA
AUTH
Description
This transport must be installed to use any of the Control-M
FMs, and it must be installed before installing any other transports.
This transport contains the BW-related FMs. Install it only after the SAP_R3 transport is installed.
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.
Install this transport if you want to use the Control-M authorization-role.
Control-M for SAP post installation procedures
After installation is complete, you need to perform a number of the following actions before using
Control-M for SAP:
Start Control-M/Agent services if they were stopped by the installation process when it started.
After upgrading, start the SAP CM extractor service if stopped by the installation.
(Optional) Configure Control-M for SAP to work with Secure Network Communications (SNC), as
described in Installing the Secure Network Communications (SNC) on Control-M for SAP (on page 18 ).
Use these procedures only if you are using SNC.
(Optional) Install the Control-M Option for R/3 jobs conversion utility, which converts Control-M
Comply with SAP authorizations, as described in SAP authorizations (on page 30 ).
Create an account, as described in Account management (on page 35 ).
28
Control-M for SAP Administrator Guide
Downloading the sapjco3.jar and sapjco3 C library files
This procedure describes how to download the required SAP Java Connector files.
To download the sapjco3.jar and sapjco3 C library files:
1.
Download the sapjco3.jar and sapjco3 C library files from the following location: http://service.sap.com/connectors
2.
In the left pane, under Connectors , click SAP Java Connector and then click Tools & Services .
3.
In the right pane, under SAP Java Connector (SAP JCo) , click the quick link to download SAP JCo
Release 3.x
.
4.
Download the required files from that section.
5.
Copy the sapjco3.jar and sapjco3 C library files to the following paths:
UNIX: $CONTROLM/cm/SAP/exe/sapjco
Windows: <Agent_home>\cm\SAP\exe\sapjco
6.
(Windows only) Obtain and install the Visual Studio .NET C/C++ runtime libraries required by JCo.
For more information about how to obtain and install the Visual Studio runtime libraries, see the
and Release Strategy
section in the
SAP Java Connector Download Page
.
Support
Maintaining the Control-M for SAP process
This procedure describes how to start, stop, and view the status of Control-M for SAP process.
To maintain the Control-M for SAP process:
1.
Use the following directories:
UNIX: $CONTROLM/cm/SAP/exe
2.
Windows: <Agent_home>\cm\SAP\exe
Type the following:
UNIX: sapcmbe.sh {start|stop|status|change_port|refresh|jco}
Windows: sapcmbe.cmd {start|stop|status|change_port|refresh|jco}
3.
Do one of the following:
start: Starts the Control-M for SAP process stop : Stops the Control-M for SAP process
29
Control-M for SAP Administrator Guide
NOTE : If the Control-M for SAP process was stopped and a new request for the Control-M for SAP process arrives, it starts automatically. You should note the following:
status:
Indicates whether the Control-M for SAP process and the Extractor process are running or not.
change_port:
Updates the TCP/IP port used by the Control-M for SAP
refresh:
Refreshes the data collected from the XAL interface that is used for load balancing. If you do not run this command, the data is refreshed automatically on a daily basis.
jco:
Prints the version of the SAP JCo JAR file and the version of the C library file. If one of these files is not installed correctly, an error message appears.
Installing Control-M Option for R/3 jobs conversion utility
(Microsoft Windows only) This procedure describes how to install the Control-M Option for R/3 jobs conversion utility, which converts Control-M Option for R/3 jobs, and jobs created by Control-M Desktop to Control-M for SAP jobs.
To install the conversion utility:
1.
Log on to the Control-M/EM computer.
2.
Extract the sap_cm_conv_ut.zip
file from the <DVDROM_path>\Tools\conversion folder to a temporary folder on the computer.
SAP authorizations
The following table describes the authorizations that are necessary for SAP users defined in an account.
Authorization Object Authorization Values
JOBACTION
JOBGROUP
*
*
S_BTCH_JOB
Object class: BC_A (Basis:
Administration)
S_BTCH_ADM
Object class: BC_A (Basis:
Administration)
S_BTCH_NAM
Object class: BC_A (Basis:
Administration)
BTCADMIN *
BTCUNAME
NOTE: For an explanation on restricting this authorization see the User parameter
in Advanced Options (on page 181 )
*
30
Control-M for SAP Administrator Guide
Authorization Object
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)
S_LOG_COM
Object class: BC_A (Basis:
Administration)
S_SPO_DEV
Object class: BC_A (Basis:
Administration)
S_USER_GRP
Object class: BC_A (Basis:
Administration)
S_RS_ADMWB
Object class: RS (Business
Information Warehouse)
Authorization Values
ACTVT
RFC_NAME
RFC_TYPE
EXTCOMPANY
EXTPRODUCT
INTERFACE
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.
NOTE: For further restriction of this authorization, see SAP note 605483 in
*
*
*
*
BMC Software
Control-M
XBP
COMMAND
HOST
OPSYSTEM
SPODEVICE
*
*
*
*
ACTVT
CLASS
ACTVT
RSADMWBOBJ
*
*
03, 16, 23, 66
*
31
Control-M for SAP Administrator Guide
Authorization Object Authorization Values
S_RS_ISOUR
Object class: RS (Business
Information Warehouse)
S_RS_ISRCM
Object class: RS (Business
Information Warehouse)
ACTVT
RSAPPLNM
RSISOURCE
RSTSRCOBJ
ACTVT
RSAPPLNM
RSTSRCOBJ
RSOSOURCE
RSPCCHAIN
RSAPPLNM
RSPCPART
ACTVT
03, 23, 49
*
*
*
23
*
*
*
*
*
*
03, 16, 23
S_RS_PC - (Data
Warehousing Workbench -
Process Chains)
Object class: RS (Business
Information Warehouse)
S_RS_DS Activity
DataSource
Sub object for New DataSource
Source System
23,49
*
*
*
NOTE : All BW authorizations under the RS Object Class are required only if you work with Control-M for SAP solution for BW.
S_ARCHIVE
Object class: BC_A (Basis:
Administration)
S_DATASET
ACTVT
APPLIC
ARCH_OBJ
ACTVT
FILENAME
PROGRAM
*
*
*
*
*
*
NOTE : The S_ARCHIVE and S_DATASET authorizations are required only if you use Control-M for
SAP solution for Data Archiving
32
Control-M for SAP Administrator Guide
Control-M for SAP Uninstall
The following procedures describe how to uninstall Control-M for SAP from UNIX and Microsoft Windows and how to uninstall Control-M Option for R/3 conversion utility:
Uninstalling Control-M for SAP from UNIX (on page 33 )
Uninstalling Control-M for SAP from Windows (on page 33 )
Performing an automatic uninstall from Windows (on page 34 )
Uninstalling the Control-M Option for R/3 jobs conversion utility (on page 34 )
Uninstalling Control-M for SAP from UNIX
This procedure describes how to uninstall Control-M for SAP from UNIX.
Before You Begin
Verify that all jobs have ended.
To uninstall from UNIX:
1.
From a Control-M/Agent computer, log in as a Control-M/Agent user, and enter the following command to shut down Control-M/Agent:
$CONTROLM/scripts/shut-ag -u <agentUser> -p all
2.
NOTE : If the Control-M/Agent was installed with user root, then log in as user root every time you start up or shut down the Control-M/Agent throughout this procedure.
If you are using an AIX operating system, you must remove unused libraries from memory by typing the following command:
/usr/sbin/slibclean
3.
Set your DISPLAY
4.
Enter one of the following commands:
Interactive: $HOME/BMCINSTALL/uninstall/DRRMC.8.0.00/uninstall.sh
Automatic : $HOME/BMCINSTALL/uninstall/DRRMC.8.0.00/uninstall.sh -silent
Control-M for SAP has been successfully removed from your computer.
5.
To restart Control-M/Agent, enter the following command:
$CONTROLM/scripts/start-ag -u <agentUser> -p all
Uninstalling Control-M for SAP from Windows
This procedure describes how to uninstall Control-M for SAP from Windows.
Before You Begin
Verify that all jobs have ended.
33
Control-M for SAP Administrator Guide
To uninstall from Windows:
1.
From the Start menu, select Settings > Control Panel .
2.
Double-click Add/Remove Programs .
3.
Select Control-M for SAP <Agent Name>, and click Add/Remove .
4.
Click OK to continue.
Control-M for SAP is successfully removed from your computer.
Performing an automatic uninstall from Windows
This procedure describes how to perform an automatic uninstall from Windows.
Before You Begin
Verify that all jobs have ended.
To perform an automatic uninstall from Windows:
1.
Log in to the computer using a user ID that has Administrator privileges.
2.
Type the following command:
<Agent Install Path>\BMCINSTALL\uninstall\DRRMC.8.0.00\Uninstall.exe -silent
Control-M for SAP has been successfully removed from your computer.
Uninstalling the Control-M Option for R/3 jobs conversion utility
This procedure describes how to uninstall the Control-M Option for R/3 jobs conversion utility.
To uninstall the conversion utility:
Delete the temporary directory and all its contents.
34
Chapter
3
3
Control-M configuration manager administration
Chapter
Control-M for SAP enables you to perform the following configuration and administrative tasks in the
Control-M Configuration Manager (CCM):
Account management (on page 35 ): Enables you to create, update, delete, test, copy, and export
accounts.
Configuring Control-M for SAP settings (on page 43 ): Enables you to configure Control-M for SAP
settings.
Event Watcher Management (on page 48 ): Enables you to activate the Event Watcher for a specified
account, define, update, copy, delete, and prioritize events. You can also define, edit, copy, and delete SAP Event History Profiles.
Extractor Management (on page 60 ): Enables you to build rules for Control-M for SAP. You can also
define, edit, copy and delete SAP interception profiles.
Importing the SAP Calendar (on page 82 ): Enables you to import calendars from your SAP computer
to your Control-M environment for use when you define batch jobs.
Account management
Before you can define a Control-M for SAP job in Control-M/Desktop, you need to create an account in the
Control-M Configuration Manager, which enables you to connect to the required SAP server.
An account contains the connection parameters to a specified SAP server, such as host name, port, user name, and password. By adding an account to the Control-M Configuration Manager, you enable
Control-M for SAP users to connect to the required SAP server with only the account name.
Users then can run a job without having to provide authentication details every time they connect to the
SAP server.
The following procedures describe how to create, edit, delete, test, copy, and export an account in the
Control-M Configuration Manager.
Creating an account (on page 36 )
Editing an account (on page 41 )
Deleting an account (on page 41 )
Testing an account (on page 42 )
Copying an account (on page 42 )
Exporting an account (on page 43 )
35
Control-M for SAP Administrator Guide
Account user permissions
The following table describes the Control-M/EM user permissions for account management.
Permission Description
BROWSE
UPDATE
FULL
View already defined Accounts
Update an existing Account
Test Account
Add new Account
Delete Account
Creating an account
This procedure describes how to create an SAP account in the Control-M Configuration Manager (CCM), which enables you to define an SAP job in the Control-M/Desktop.
Before you begin
If you plan on using Secured Network Communication, verify that you have installed.
To create an account:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Account Management .
The CM for SAP Accounts Management dialog box appears.
2.
Click .
The Step 1: Set Logon Type dialog box appears.
3.
In the Account Name field, enter the name of the account that you want to add. The account name must begin with a letter and without any blanks or special characters.
4.
In the Choose Logon Type field, select one of the following logon types:
Specific Application Server : Defines an account using a direct connection.
5.
Group : Defines an account using a logon group connection.
To use Secured Network Communication (SNC) for this account, select the Activate Secured
Network Communication check box.
For information about installing and configuring the SNC, see Installing the Secure Network
Communications (SNC) on Control-M for SAP (on page 18 ).
6.
Click Next .
The Step 2: Set Connection Details dialog box appears.
36
Control-M for SAP Administrator Guide
7.
Do one of the following:
If Specific Application Server was selected, set the fields in the Step 2: Set Connection
Details
If Group was selected, do the following: a.
Set the fields in the Step 2: Set Connection Details dialog box for a group, as described in
Set Connection details parameters for group (on page 39 ).
b.
If you are using log on groups, go to the services file that are found in the following folders:
UNIX: /etc/
Windows: <system drive>:\Windows\system32\drivers\etc c.
Add a new line to the services file on the computer where 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. The following is an example of the new line: sapmsDEV 3619/tcp d.
Add this new line for each System ID for which you defined a logon group. For more information about Logon Groups and also load balancing, see solution SLN000000192593 in the Knowledge Base on the Customer Support website, located at http://www.bmc.com/support.
8.
Click Next .
If the Activate Secured Network Communication was selected, the Step 2a: Set Secured network Connection Details dialog box appears, otherwise the Step 3: Advanced Options dialog box appears.
9.
Do the following: a.
If the Activate Secured Network Communication was selected in step 5, set the fields in the
Step 2a: Set Secured network Connection Details
dialog box, as described in Set Secured
Network Connection details parameters (on page 40 ).
The Step 3: Advanced Options dialog box appears. b.
Set the fields in the Step 3: Advanced Options
dialog box, as described in Advanced Options parameters (on page 40 ).
The Step 4: Summary dialog box appears.
10.
Review the account details and click Test .
If the test completed successfully, the account is validated and you can now define a SAP job, as
described in Job definition (on page 117 ). If the test fails, review the error message and test it
again.
11.
Click Finish .
The account is added to the CM for SAP -Accounts Management dialog box.
37
Control-M for SAP Administrator Guide
Set Connection details parameters for specific application server
The following table lists the set connection details parameters for a Specific Application log in type.
Field
System Number
Description
Application Server Host Name Defines the host name of the computer running the SAP
Application Server.
Defines a two-digit number of the SAP instance.
Valid values: 2 characters
SAP Client Specifies a three digit number of the SAP client.
Valid values: 3 characters
Login User Name Defines the SAP log in user name.
Length: 1 - 127 characters
For details about required authorizations, see the table in
Transport sub-folder contents (on page 28 ).
Defines the password for the SAPlog in user. Login Password
Confirm Password
Language
SAP Application Version
XBP Version
Confirms the password for the SAP log in user.
Indicates the SAP language.
Default: English
Defines the version of the SAP application.
Valid values are:
R/3 (Default)
BW 2.x
BW 3.x or later
Defines the SAP XBP interface version installed on the SAP server.
Valid values are:
XBP 1.0
XBP 2.0
XBP 3.0 (Default)
38
Control-M for SAP Administrator Guide
Set Connection details parameters for group
The following table lists the set connection details parameters for a group logon type:
Field
System ID
Description
Defines a three alpha-numeric characters that represent the
SAP System ID.
Valid values: 3 characters
Message Server Host Name Defines host name of the computer on which the SAP
System Message Server is running.
Valid values: 3 characters
Group
SAP Client
Login User Name
Defines the SAP log on group name.
The Group name is defined in the SAP SMLG transaction
Specifies the SAP client.
Valid values: 3 characters
Defines the SAP log in user.
Length: 1 - 127 characters
Login Password
Confirm Password
Language
SAP Application Version
XBP Version
Defines the password for the SAP log in user.
Confirms the password for the SAP log in user.
Indicates the SAP language.
Default: English
Defines the version of the SAP application.
Valid values are:
R/3 (Default)
BW 2.x
BW 3.x or later
Defines the SAP XBP interface version installed on the SAP server.
Valid values are:
XBP 1.0
XBP 2.0
XBP 3.0 (Default)
39
Control-M for SAP Administrator Guide
Set Secured Network Connection details parameters
The following table lists the set connection details parameters for a Specific Application logon type:
Field
SNC Partner Name
SNC Lib
Quality of Protection
SNC My Name
Description
Defines SNC name of the application server. For example, p:CN=LE1, OU=BPM, O=BMC, C=US
Specifies the client full path and file name to SAP crypto lib.
For example /home1/agsapfp/SNC/libsapcrypto.sl
Defines the quality of the protection.
Valid values: 1, 2, 3, 8, 9
Default: 8
Defines the SNC name of the user sending the RFC.
Default: The name provided by the security product for the user who is logged on.
Advanced Options parameters
The following table describes the additional parameters for an account.
Field
SAP Response Timeout
Description
Defines the number of seconds the program waits for an
RFC request to be handled by the SAP system before returning a time out error.
Default: 180
Use Extended Determines whether the extended functionality of Control-M for SAP should be used.
Valid values:
No (Default)
Yes
NOTE: If you select this option, the Control-M Function
Modules must be installed on your SAP server, as described
in Installing the Control-M Function Modules in a non
Unicode SAP system (on page 21
Control-M Function Modules in a Unicode SAP system (on page 22 ).
40
Control-M for SAP Administrator Guide
Field
Solution Manager Account
This is a Solution Manager
Account
Description
Defines the required Solution Manager account from the drop-down list.
If there is no Solution Manager account in the drop-down list, first define an account as a Solution Manager Account.
For more information about Solution Manager accounts and
viewing SAP job documentation, see: View SAP Job
Determines whether the specified account is a Solution
Manager account. For more information about Solution
Manager accounts and viewing SAP job documentation, see:
View SAP Job Documentation (on page 166 ).
Editing an account
This procedure describes how to edit an account in the Control-M Configuration Manager.
To edit an account:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage and Select
Account Management .
The CM for SAP-Accounts Management dialog box appears.
2.
Select the account that you want to edit, and click .
The Update <
account
> Account dialog box appears.
For each field, logon type, set the fields, as described in the following topics:
3.
Set Connection details parameters for specific application server (on page 38 )
Set Connection details parameters for group (on page 39 )
Set Secured Network Connection details parameters (on page 40 )
Advanced Options parameters (on page 40 )
4.
Review the account details, and click Test .
If the test completes successfully, the account validates and you can now define an SAP job, as
described in Job definition (on page 117 ). If the test fails review the error message, and test it
again.
5.
Click OK .
The account is updated in the CM for SAP -Accounts Management dialog box.
Deleting an account
This procedure describes how to delete an account from the Control-M Configuration Manager.
41
Control-M for SAP Administrator Guide
To delete an account:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage and right-click Account Management .
The CM for SAP -Accounts Management dialog box appears.
2.
Select an account that you want to delete and click
A confirmation message appears.
3.
Click Yes .
The account is deleted.
.
Testing an account
This procedure describes how to test an account in the Control-M Configuration Manager, which enables you to validate the connection parameters.
To test an account:
1.
From the CCM, right-click the CM ( SAP) component on the host that you want to manage and right-click Account Management .
The CM for SAP -Accounts Management dialog box appears.
2.
Select an account that you want to test and click .
If the test completed successfully, the account is validated and you can now define a SAP job, as
Copying an account
This procedure describes how to copy an account in the Control-M Configuration Manager, which enables you to create an additional account using the parameters of an existing account.
To copy an account:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage and right-click Account Management .
The CM for SAP Accounts Management dialog box appears.
2.
Select an account that you want to copy, and click .
The Copy <
account
> Account dialog box appears.
3.
In the Account Name field, type a name for the new account and click OK .
4.
For each field, logon type, set the fields, as described in the following topics:
Set Connection details parameters for specific application server (on page 38 )
Set Connection details parameters for group (on page 39 )
Set Secured Network Connection details parameters (on page 40 )
Advanced Options parameters (on page 40 )
42
Control-M for SAP Administrator Guide
5.
Click Test (Optional).
If the test completes successfully, the account is validated and you can now define a SAP job, as
described in Job definition (on page 117 ). If the test fails, review the error message and test it
again.
6.
Click OK .
Exporting an account
This procedure describes how to export an account from one Control-M/Agent to another
Control-M/Agent, where Control-M for SAP is installed.
To export an account:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage and right-click Account Management .
The CM for SAP Accounts Management dialog box appears.
2.
Select an account that you want to export and click .
The CM for SAP -Export Account dialog box appears.
3.
From the Control-M/Server name drop-down list, select the Control-M/Server that contains the
Control-M/Agent, where you want to export the account.
4.
From the Control-M/CM Host Name drop-down list, select the Control-M/Agent that contains the account on the CM you want to export.
5.
Click OK .
The Export Account Destination dialog box appears.
6.
In the Account Name field, type a name for the exported account and change any required parameters, and then click OK .
7.
Click Test (Optional).
If the test completes successfully, the account is validated and you can now define a SAP job, as
described in Job definition (on page 117 ). If the test fails, review the error message and test it
again.
8.
Click OK .
Configuring Control-M for SAP settings
This procedure describes how to configure Control-M for SAP settings through the configuration management utility.
43
Control-M for SAP Administrator Guide
Before you begin
Ensure you have the following Control-M/EM user permissions for Configuration Management:
BROWSE: Enables you to view already defined configuration parameters
UPDATE: Enables you to update configuration parameters
To configure the Control-M for SAP settings:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to configure, and select Configuration Management .
The CM for SAP - Configuration Management dialog box appears.
2.
Change the configuration parameters as required, which are described in Configuration parameters.
3.
Click OK .
4.
If any of the parameters change, you may be prompted to recycle Control-M for SAP. If so, a
Configuration Management dialog box appears.
NOTE : If you do not recycle at this stage, you need to shut down manually, as described in Shutting down Control-M for SAP.
5.
Click Yes .
A Configuration Management dialog box appears, which confirms that the recycle request completed successfully.
44
Control-M for SAP Administrator Guide
Configuration parameters
Configuration Management parameters in Control-M for SAP enable you to set values for variables, as
described in ctmr3req interrupt parameters (on page 113 ).
The following table describes the parameters for Control-M for SAP.
Parameter
Audit Level
Description
Determines 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 List Entries Specifies the maximum number of rows to be produced for a
Load list.
Valid values are: 1-1000.
Default: 250
Max Wait for SAP Recovery Specifies an Executing/Unknown status for Control-M for
SAP jobs running in an SAP system when the connection to the SAP system is lost.
This parameter allows the connection to be repaired without losing the Control-M job.
Valid values are: 0-1500
Default: 0 (minutes). An alert is sent to Control-M/EM when the connection to SAP is lost or reconnected.
If Control-M/Agent, Control-M/EM and Control-M/Server are of version 7.0.00 and later and the value is 0 , the job status will be set to Unknown until Control-M/Server times out (2 hours by default) and then the job will fail.
If the value is greater than 0 , the job status will remain
Executing for the time set by the parameter. If the connection is still lost after this time has elapsed, the job fails and is assigned a status of Disappeared .
45
Control-M for SAP Administrator Guide
Parameter
Run Copy Mode
Run Org Mode
Output File Name
Load Balancing Algorithm
Description
Specifies 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
Specifies 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
Defines the name of the Output file.
You can assign a specific prefix to this file name. Valid values are:
JOBNAME : as defined in the Control-M/EM job definition
MEMNAME : as defined in the Control-M/EM job definition
None (default)
Determines which of the following load balancing algorithms is used when the Target Server field in SAP R/3 Job Editing form:
XAL : Uses performance data collected by XAL based on
CPU, memory, and background processes usage
SAP : Uses default SAP algorithm
To ensure high performance with the XAL load balancing, verify that Tree Monitor threshold limits for CPU and memory are configured correctly.
Default: XAL
46
Control-M for SAP Administrator Guide
Parameter
Mixed Case Job Name
(External Jobs)
Description
Enables mixed case job name for External Mode jobs (for job 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.
Mixed Case Job Name (Other
CTM Jobs)
Enables mixed case job name for other Control-M jobs (for 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.
Enable RFC library trace
Log/Spool Maximum size
Enables the creation of log trace files (.trc)
These log files record the communication and interaction between Control-M for SAP and your SAP system, using the
RFC library.
The trace log files are located in the Control-M/Agent proclog directory.
Determines the maximum size of the spool log that
Control-M for SAP can read, in MB
Valid values: 0 - 1000
Options:
Unlimited maximum size (default)
Set Maximum Size (in MB)
This parameter (LOG_SPOOL_MAX) is only relevant to R/3 jobs.
47
Control-M for SAP Administrator Guide
Event Watcher Management
The Event Watcher utility enables you to manage events to watch and executing Control-M jobs in a specific order, and to add or remove active conditions based on events within the SAP system. The actions specified in a condition are performed when the criteria of a condition are met by an event. This enables the integration of Control-M managed batch processes and flows with ad-hoc events occurring with the SAP system.
If your SAP account is set to work with XBP 3.0, you can define, edit, copy and delete SAP Event History
The following topics how to manage events including set up and definition of the Event Watcher Manager
The definition, includes defining, updating, copying, deleting, and prioritizing an event in the Control-M
Configuration Manager:
Setting up Event Watcher Management (on page 48 )
Event Watcher definition (on page 49 )
Control-M for SAP job ordering (on page 52 )
Job condition configuration (on page 55 )
Setting up Event Watcher Management
The procedure describes the set up for managing events to watch and executing Control-M jobs in a specific order, and adding or removing active conditions based on events within the SAP system. This enables the integration of Control-M managed batch processes and flow events occurring with the SAP system.
To set up SAP Event Watcher Management:
1.
Ensure that the Extractor Management service (Windows) or process (UNIX) is running to use the SAP
Event Based Scheduling functionality, as described in Extractor Management (on page 60 ).
2.
Only one Extractor Management service (Windows) or process (UNIX) can be running at the same time for each SAP system.
3.
Before using the SAP Event Based Scheduling feature, you should go into your SAP system and ensure that all events in the event history have a status of Confirmed. This ensures that action items are not triggered by previous events when you use Event Watcher Management. SAP events that have a status of Confirmed do not trigger Control-M for SAP actions when using Event Watcher
Management.
4.
You must configure the event history in your SAP system prior to using the SAP Event Watcher
Management, to ensure that events are displayed in the Event History. Use SAP transaction sm62 to add appropriate entries in the Criteria and Reorganization tabs. This specifies which events are included in the Event History.
5.
Ensure you have the following Control-M/EM user permissions in CCM:
BROWSE: Enables you to view Event Watcher general configuration and rules.
48
Control-M for SAP Administrator Guide
UPDATE: Enables you to change Event Watcher general configuration and rules, and to clear
Events from SAP system.
Event Watcher definition
The following procedures describe how to activate the Event Watcher Manager, and define, update, delete, copy, and move an event in the CCM:
Activating the Event Watcher for a specified account (on page 49 )
Defining events to watch (on page 49 )
Updating an event (on page 50 )
Copying an event (on page 50 )
Deleting an event (on page 51 )
Prioritizing events (on page 51 )
Activating the Event Watcher for a specified account
This procedure describes how to activate the event watcher for a specified account so that Control-M for
SAP can detect when the specified event occurs.
To activate the Event Watcher for a specified account:
1.
From the CCM, right-click the Control-M for SAP component on the host that you want to manage, and select Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account whose events must be watched.
4.
To erase previously specified events for the specified account, click Clear Events .
The Clear Events action changes the status of any new event that occurred previously, to
Confirmed . This ensures that when the SAP Event Watcher is activated, no old existing events are watched.
The Event Watcher is activated to watch for events for a specified account.
Defining events to watch
This procedure describes how to create events to watch so that Control-M for SAP can detect when the specified event occurs and what action to take, such as, running a job, or adding or deleting a condition to the active conditions.
NOTE : These rules are independent of an SAP client and therefore only one account per SAP system should be used in the rules definitions.
To define events to watch:
1.
From the CCM, right-click the CM ( SAP) component on the host that you want to manage, and select
Event Watcher Management .
49
Control-M for SAP Administrator Guide
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
Click in the Watch for the following events area.
The Add Event dialog box appears.
5.
In the Event ID field, type the name of the SAP background processing event or click Load .
(Load only) The Event ID dialog box appears.
NOTE : Use % wildcard to filter the events list. If you type the name, the Event ID must begin with a letter and without any blanks or special characters.
6.
(Load only) Select the SAP event and either double click or click OK .
The event ID is copied into the Event ID field.
7.
In the Parameter field, enter the event parameter, for example, entering the * wildcard watches for all events of the type specified. This field can also be left blank, since this parameter value is optional in SAP.
8.
Click OK .
Control-M for SAP event IDs and parameters are defined.
9.
Repeat this procedure for all required events.
Updating an event
This procedure describes how to update an event in the Control-M Configuration Manager.
To update an event:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
Select an event in the Watch for the following events area that you want to update and click .
The Update Event dialog box appears.
5.
Update the required parameter values in the fields that are displayed.
6.
Click OK .
Control-M for SAP event IDs and parameters are updated.
Copying an event
This procedure describes how to copy an event in the Control-M Configuration Manager and how to use the copied parameter values to create a new event.
50
Control-M for SAP Administrator Guide
To copy an event:
1.
From the CCM, right-click the CM ( SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
Select the event in the Watch for the following events area that you want to copy and click .
The Copy Event dialog box appears.
5.
Update the required parameters in the fields that are displayed.
6.
Click OK .
A new event is created, based on the Control-M for SAP event IDs and parameters that were copied.
Deleting an event
This procedure describes how to delete an event from the Control-M Configuration Manager.
To delete an event:
1.
From the CCM, right-click the CM ( SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
Select the event in the Watch for the following events area that you want to delete and click
.
A confirmation message appears.
5.
Click Yes .
The specified event is deleted.
Prioritizing events
This procedure describes how to change the order in which events are watched in the Control-M
Configuration Manager.
To prioritize events:
1.
From the CCM, right-click the CM ( SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
51
Control-M for SAP Administrator Guide
4.
Select the event in the Watch for the following events area whose order that you want to change and click either or .
The priority of events is rearranged.
Control-M for SAP job ordering
The following procedures describe how to define and manage jobs in the Control-M Configuration
Manager so that Control-M for SAP can order jobs in Control-M to perform the required procedure when the specified event occurs:
Adding jobs to be ordered after an event confirmation (on page 52 )
Updating a job to be ordered after an event confirmation (on page 53 )
Copying a job to be ordered after an event confirmation (on page 53 )
Deleting a job to be ordered after an event confirmation (on page 54 )
Adding jobs to be ordered after an event confirmation
This procedure describes how to add jobs to events so that Control-M for SAP can perform the required procedure when the specified event has occurred. The jobs specified should be defined in Control-M before the event takes place.
To add jobs to be ordered on event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
From the Define Control-M actions to execute after event confirmation area, in the Order
Jobs tab, click .
The Add Control-M Job to Order dialog box appears.
3.
In the Job Name field, type the name of the job that you want to add that must begin with a letter and without any blanks or special characters.
4.
In the Folder Name field, type the name of the table that you want to add that must begin with a letter and without any blanks or special characters. In the case of a sub-table, use "/" to separate between table names.
5.
To add specifications that are required to identify the job do the following. a.
Click Advanced .
The expanded Add Control-M Job to Order dialog box appears. b.
In the Scheduling Date area, select one of the following dates: o ODAT – Job's order date: Default o Any ctmorder date value. Select the required date in the calendar that appears. c.
In the SMART Folder Parameters area, for each field define the required value as described in
SMART Folder Parameters area parameters (on page 54 ).
52
Control-M for SAP Administrator Guide d.
In the Variable area, you can specify new variables to be added to the job.
Structure: %%<
variable name
> <
variable value
>
6.
Click OK .
The job to be ordered is added to the event.
Updating a job to be ordered after an event confirmation
This procedure describes how to update a job to be ordered after an event confirmation in the Control-M
Configuration Manager.
To update a job to be ordered after an event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
2.
The Event Watcher Management dialog box appears.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
In the Define Control-M actions to execute after event confirmation area, in the Order Jobs tab, click .
The Update Control-M Job to Order dialog box appears.
5.
Update the required parameters.
6.
Click OK .
The job to be ordered is updated.
Copying a job to be ordered after an event confirmation
This procedure describes how to copy a job to be ordered after an event confirmation in the Control-M
Configuration Manager.
To copy a job to be ordered after an event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
In the Define Control-M actions to execute after event confirmation area, in the Order Jobs tab, click .
The Copy Control-M Job to Order dialog box appears.
5.
Update the required parameters.
6.
Click OK .
53
Control-M for SAP Administrator Guide
The details of a new Control-M job to be ordered is defined, based on the Control-M job definitions that were copied.
Deleting a job to be ordered after an event confirmation
This procedure describes how to delete a job to be ordered after an event confirmation from the
Control-M Configuration Manager.
To delete a job to be ordered after an event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
In the Define Control-M actions to execute after event confirmation area, in the Order Jobs tab, click .
A confirmation message appears.
5.
Click Yes .
The selected job to be ordered after an event confirmation is deleted.
SMART Folder Parameters area parameters
The following table lists the SMART Folder Parameters area parameters:
Parameter Description
Into Folder Identifies into which Control-M folder the job is submitted
Valid values are:
None (Default) - use when the job template does not belong to a folder
Recent - add the job to the folder that was most recently ordered
Standalone - order the job by adding it to a folder
New folder - order the job to a new folder
Selected - set a folder 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 folders and Force Into parameters, see the
Control-M User Guide
.
Folder ID Identifies the specified folder of jobs to be ordered
This field is enabled only when Selected is specified in the Into Folder field.
54
Control-M for SAP Administrator Guide
Job condition configuration
The following procedures in this section describe how to define and manage conditions to jobs in the
Control-M Configuration Manager so that Control-M can perform the required condition when the specified event occurs.
Adding conditions to be executed after an event confirmation (on page 55 )
Updating a job to be ordered after an event confirmation (on page 53 )
Copying a condition to be executed after an event confirmation (on page 56 )
Deleting a condition to be executed after an event confirmation (on page 57 )
Adding conditions to be executed after an event confirmation
This procedure describes how to add conditions to events so that Control-M for SAP can perform the required procedure when the specified condition has occurred.
To add conditions to event confirmations:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
From the Define Control-M actions to execute after event confirmation area, in the
Conditions tab, click .
The Add Control-M Condition dialog box appears.
5.
In the Name field, type the unique name of the condition that you want to add that must begin with a letter and without any blanks or special characters.
If the Name parameter is left empty, the condition created in Control-M is named in the following way: sap_<
Event_ID
>_<
Event_Param
>
If the Event ID parameter value is SAP_END_OF_JOB , the SAP event parameter value is truncated, and the job count number is omitted from the condition.
If the SAP event parameter value is left blank, the condition structure is: sap_<
Event_ID
>
6.
In the Date field, select either ODAT (default) or STAT .
Considerations
Specify ODAT to use the Control-M scheduling date. (Default)
Specify STAT if a date is not relevant.
Specify a date in mmdd format (a date only exists in the current year). The asterisk "*" wildcard character is supported.
7.
In the Action field, select either ADD (default) or DELETE .
55
Control-M for SAP Administrator Guide
Specify "*" by itself to include all dates (only valid for DELETE actions).
8.
Click OK .
The condition is added to the event. For more information about specifying conditions, see
User Guide
.
Control-M
Updating a job to be ordered after an event confirmation
This procedure describes how to update a job to be ordered after an event confirmation in the Control-M
Configuration Manager.
To update a job to be ordered after an event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
In the Define Control-M actions to execute after event confirmation area, in the Order Jobs tab, click .
The Update Control-M Job to Order dialog box appears.
5.
Update the required parameters.
6.
Click OK .
The job to be ordered is updated.
Copying a condition to be executed after an event confirmation
This procedure describes how to copy a condition to be executed after an event confirmation in the
Control-M Configuration Manager.
To copy a condition to be executed after an event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
In the Activate Event Watcher field, select On .
5.
In the SAP Account field, select the account whose events must be watched.
6.
In the Define Control-M actions to execute after event confirmation area, in the Condition tab, click .
The Copy Control-M Condition dialog box appears.
7.
Update the required parameter values.
56
Control-M for SAP Administrator Guide
8.
Click OK .
Details of a new condition to be executed are defined based on the definitions that were copied.
Deleting a condition to be executed after an event confirmation
This procedure describes how to delete a condition to be ordered after an event confirmation from the
Control-M Configuration Manager.
To delete a condition to be executed after an event confirmation:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
2.
The Event Watcher Management dialog box appears.
In the Activate Event Watcher field, select On .
3.
In the SAP Account field, select the account for the events that need to be watched.
4.
In the Define Control-M actions to execute after event confirmation area, in the Condition tab, click .
5.
A confirmation message appears.
Click Yes .
The selected condition is deleted.
SAP Event History Profiles management
The following procedures describe how to define, edit, copy and delete SAP Event History profiles in the
Event Watcher Manager from the CCM:
Adding an SAP Event History Profile (on page 57 )
Editing an SAP Event History Profile (on page 59 )
Copying an SAP Event History Profile (on page 59 )
Deleting an SAP Event History Profile (on page 60 )
NOTE : Your SAP account must be set to work with XBP 3.0 to use this functionality.
Adding an SAP Event History Profile
This procedure describes how to add an SAP Event History Profile.
To add an SAP Event History Profile:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the SAP Account field, select the account for the events that need to be watched.
3.
In the SAP Event History Profiles section, click Load .
The SAP Event History Profiles table for the selected account name is loaded.
57
Control-M for SAP Administrator Guide
4.
Click
The SAP Event History Profiles Management dialog box appears.
5.
Type the Profile Name .
NOTE : The profile name cannot be empty and can contain any character.
6.
In the Criteria Hierarchy section, complete the hierarchy by using one of more of the following tool bar buttons:
AND : Adds an And folder under the selected item
OR : Adds an OR folder under the selected item
Delete : Deletes the selected item and any item included.
NOTE : When opening a new profile, the
AND
folder appears. This folder is empty and cannot be deleted. You can delete the folder contents but not the folder.
7.
To add criteria, highlight the folder and click Criteria .
8.
Do one or more of the following:
To add criteria details, see: Adding SAP Event History profile criteria details (on page 58 ).
To delete criteria details, see: Deleting SAP Event History Profile criteria details (on page 58 ).
9.
When you finish building the criteria hierarchy, click OK .
The new SAP Event History Profile is created.
Adding SAP Event History profile criteria details
This procedure describes how to add SAP Event History Profile criteria details when building a hierarchy.
To add criteria details:
1.
From the SAP Event History Profiles Management dialog box, in the Criteria Hierarchy section, highlight the criteria that you want to add.
2.
In the Criteria Details section, click .
3.
Select one of the following sections from the drop down list:
Event ID
Event Parameter
4.
Complete the SAP criteria fields as required.
The criteria details are now added to the hierarchy.
Deleting SAP Event History Profile criteria details
This procedure describes how to delete SAP Event History Profile criteria details when building a hierarchy.
To delete criteria details:
1.
From the SAP Event History Profiles Management dialog box, in the Criteria Detail s section, highlight the criteria that you want to delete and click .
58
Control-M for SAP Administrator Guide
A confirmation message appears.
2.
Click Yes .
The criteria details are now deleted.
Editing an SAP Event History Profile
This procedure describes how to edit an SAP Event History profile in the CCM.
To edit an SAP Event History profile:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
2.
The Event Watcher Management dialog box appears.
In the SAP Account field, select the account for the events that need to be watched.
3.
In the SAP Event History Profiles section, click Load .
The SAP Event History Profiles table for the selected account name is loaded
4.
Select a profile and click .
The SAP Event History Profiles Management dialog box appears.
NOTE : The
Criteria Hierarchy
field is fully expanded, but the
Criteria Details
section remains empty until you select a criteria.
5.
Edit the required parameters.
6.
Click OK .
The SAP Event History Profile is updated.
Copying an SAP Event History Profile
This procedure describes how to copy an SAP Event History Profile in the CCM.
To copy an SAP Event History Profile:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the SAP Account field, select the account for the events that need to be watched.
3.
In the SAP Event History Profiles section, click Load .
The SAP Event History Profiles table for the selected account name is loaded.
4.
Select a profile and click .
The SAP Event History Profiles Management dialog box appears.
Update the required parameter values.
5.
Click OK .
A new SAP Event History Profile is created, based on the copied information.
59
Control-M for SAP Administrator Guide
Deleting an SAP Event History Profile
This procedure describes how to delete an SAP Event History Profile in the CCM.
To delete an SAP Event History Profile:
1.
From the CCM, right-click the CM (SAP) component on the host that you want to manage, and select
Event Watcher Management .
The Event Watcher Management dialog box appears.
2.
In the SAP Account field, select the account for the events that need to be watched.
3.
In the SAP Event History Profiles section, click Load .
The SAP Event History profiles table for the selected account name is loaded.
4.
Select a profile and click .
A confirmation message appears.
5.
Click Yes .
The selected SAP Event History Profile is deleted.
Extractor Management
You can use Control-M for SAP Extractor Management to create one or more mirror-image jobs by using criteria identical to that of specific jobs already running in SAP. These jobs 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.
The Extractor Management utility contains the following functionality:
SAP interception profiles management (on page 62 ):
Enables you to define and manage SAP interception profiles in the Control-M Configuration Manager. Relevant for SAP accounts that are configured with XBP 3.0.
criteria definitions in the Control-M Configuration Manager. Relevant for SAP accounts that are configured with XBP 2.0.
Control-M interception rules (on page 67 ): Enables you to add and manage Control-M interception
rules so that the intercepted jobs are put on hold in Scheduled status until they are released by
Control-M.
SAP jobs that Control-M must extract from SAP and then apply in Control-M.
SAP jobs are extracted and how they are represented in Control-M. These rules are defined for each job extraction criteria type.
60
Control-M for SAP Administrator Guide
Extractor Management user permissions
The following table describes the Control-M/EM user permissions for Extractor Management:
Permission Description
BROWSE
FULL
View extractor general configuration
View SAP Interception Criteria
View CTM Interception Rules
View Extraction Criteria and Rules
Change extractor general configuration
Change SAP Interception Criteria
Change CTM Interception Rules
Change Extraction Criteria and Rules
Prioritizing SAP job types for detection
This procedure describes how to set the priority level of SAP job types, which enables Control-M for SAP to handle jobs that match more than one job type. Extracted jobs cannot have a priority that is higher than Intercepted or Spawned jobs.
To set job type priorities:
1.
From Control-M Configuration Manager, select CM (SAP) on the host that you want to manage, and right-click Extractor Management .
The Extractor Management dialog box appears.
2.
In the General Configuration area, for each job type field, select the required priority from the drop-down menu. You can also select not to have a job type detected (default) or you can set first, second, or third priority for each job type.
NOTE : If Intercepted Jobs is assigned a priority, ensure that at least one CTM Interception Rule is selected.
3.
Select the Activity Log field to enable Extractor Management activities to be logged. Default: On
4.
The activity log is saved in the Control-M/Agent proclog directory with the name: xt_log_<YYMMDD>
In the Interval Time field, enter the required number of seconds between loop cycles of the
Extractor. Default: 120 seconds
5.
In the Extractor alert settings field, select the check box to enable the Control-M for SAP to check if the Extractor process is running.
NOTE : You receive an alert in Control-M/EM alerts window in case the Extractor process stops unexpectedly. You can select the severity alert and the interval time.
61
Control-M for SAP Administrator Guide
Default: Alert severity: Regular
NOTE : Interval time: 5 minutes.
6.
Either click Apply (to continue configuring parameters) or click OK .
The general Extractor Management parameters are configured.
SAP interception profiles management
The following procedures define and manage SAP interception profiles in the CCM.
Adding an SAP interception profile (on page 62 )
Editing an SAP interception profile (on page 63 )
Copying an SAP interception profile (on page 64 )
Deleting an SAP interception profile (on page 64 )
NOTE : Relevant for SAP accounts that are configured with XBP 3.0 only. For SAP accounts that are
configured with XBP 2.0, see: SAP interception criteria definitions (on page 65 ).
Adding an SAP interception profile
This procedure describes how to add an SAP interception profile.
To add an SAP interception profile:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
2.
The Extractor Management dialog box appears.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Profiles tab, click Load .
The SAP interception table for the selected account name is loaded.
4.
Click .
The SAP Interception Profiles Management dialog box appears.
5.
Type the Profile Name.
NOTE : The profile name cannot be empty and can contain any character.
6.
In the Criteria Hierarchy section, complete the hierarchy by using one of more of the following tool bar buttons:
AND : Adds an And folder under the selected item.
OR : Add an OR folder under the selected item.
Delete : Deletes the selected item and any item included.
NOTE : When opening a new profile, the AND folder appears. This folder is empty and cannot be deleted. You can delete the folder contents but not folder.
7.
To add criteria, highlight the folder, and click Criteria .
62
Control-M for SAP Administrator Guide
8.
Do one or more of the following:
To add criteria details, see: Adding interception profile criteria details (on page 63 ).
To delete criteria details, see: Deleting interception profile criteria details (on page 63 ).
9.
When you have finished building the hierarchy, click OK .
The new SAP interception profile is created.
Adding interception profile criteria details
This procedure describes how to add criteria details when building a hierarchy for an interception profile.
To add criteria details:
1.
From the SAP Interception Profiles Management dialog box, in the Criteria Hierarchy section, highlight the criteria that you want to add.
2.
In the Criteria Details section , click .
3.
Select one of the following sections from the drop down list:
Client
Job Class
Job Creator
Job Name
4.
Complete the SAP criteria fields as required.
The criteria details are now added to the hierarchy.
Deleting interception profile criteria details
This procedure describes how to delete criteria details when building a hierarchy for an interception profile.
To delete criteria details:
1.
From the SAP Interception Profiles Management dialog box, in the Criteria Details section, highlight the criteria that you want to delete and click .
A confirmation message appears.
2.
Click Yes.
The criteria details are now deleted.
Editing an SAP interception profile
This procedure describes how to update an SAP interception profile in the CCM.
To edit an SAP interception profile:
1.
From the CCM, select the CM (SAP) on the host that you want to manage and right-click Extractor
Management .
63
Control-M for SAP Administrator Guide
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Profiles tab, click Load .
The SAP interception profiles table for the selected account name is loaded.
4.
Select a profile and click .
The SAP Interception Profiles Management dialog box appears.
5.
Edit the required parameters.
6.
Click OK .
The SAP interception profile is updated.
Copying an SAP interception profile
This procedure describes how to copy an SAP interception profile in the CCM.
To copy an SAP interception profile:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Profiles Management tab, click Load .
The SAP interception profiles table for the selected account name is loaded.
4.
Select a profile and click .
The SAP Interception Profiles Management dialog box appears.
5.
Update the required parameter values.
6.
Click OK .
A new SAP interception profile is created, based on the copied information.
Deleting an SAP interception profile
This procedure describes how to delete an SAP interception profile from the CCM.
To delete an SAP interception profile:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Profiles tab, click Load .
The SAP interception profiles table for the selected account name is loaded.
64
Control-M for SAP Administrator Guide
4.
Select a profile and click .
A confirmation message appears.
5.
Click Yes .
The selected SAP interception profile is deleted.
SAP interception criteria definitions
The following procedures define and manage SAP interception criteria definitions in the CCM.
Adding an SAP Interception criteria definition (on page 65 )
Editing an SAP interception criteria definition (on page 66 )
Copying an SAP interception criteria definition (on page 66 )
Deleting an SAP interception criteria definition (on page 66 )
NOTE : Relevant for SAP accounts that are configured with XBP 2.0 only. For SAP accounts that are
configured with XBP 3.0, see: SAP interception profiles management (on page 62 ).
Adding an SAP Interception criteria definition
This procedure describes how to add an SAP interception criteria definition.
To add an SAP interception criteria definition:
1.
From the CCM, right-click the Control-M for SAP on the host that you want to manage, and select
Extractor Management .
The Extractor Managemen t dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Criteria tab, click Load .
The SAP interception criteria table for the selected account name is loaded.
4.
Click .
The Add SAP Interception Criteria dialog box appears.
5.
In the Job Name field, type the name of the SAP job that will be intercepted and then extracted from
SAP to Control-M. The job name must begin with a letter and without any blanks. The asterisk "*" wildcard can be used.
6.
In the User field, define the SAP user that created the job. The asterisk "*" wildcard can be used.
NOTE : Consider how you specify
Job Name
and
User Name
criteria. Definitions that are too general
(for example, entering * in both fields), could cause system or other user jobs to be intercepted.
Additionally, ensure that you have no more than one account that uses Interception rules using the same system and client.
7.
Click OK .
The new SAP interception criteria definition is created.
65
Control-M for SAP Administrator Guide
Editing an SAP interception criteria definition
This procedure describes how to update an SAP interception criteria definition in the CCM.
To update an SAP interception criteria definition:
1.
From the CCM, select the CM (SAP) on the host that you want to manage and right-click Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Criteria tab, click Load .
The SAP interception criteria table for the selected account name is loaded.
4.
Select a criteria and click .
The Update SAP Interception Criteria dialog box appears.
NOTE : The
Criteria Hierarchy
field is fully expanded, but the
Criteria Details
field remains empty until you select a criteria.
5.
Edit the required parameters.
6.
Click OK .
The SAP interception criteria definition is updated.
Copying an SAP interception criteria definition
This procedure describes how to copy an SAP interception criteria definition in the CCM.
To copy an SAP interception criteria definition:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Criteria tab, click Load .
The SAP interception criteria table for the selected account name is loaded.
4.
Select a criteria and click .
The SAP Interception Criteria dialog box appears.
5.
Update the required parameter values.
6.
Click OK .
A new SAP interception criteria definition is created, based on the copied information.
Deleting an SAP interception criteria definition
This procedure describes how to delete an SAP interception criteria definition from the CCM.
66
Control-M for SAP Administrator Guide
To delete an SAP interception profile:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the SAP Interception Criteria tab, click Load .
The SAP interception criteria table for the selected account name is loaded.
4.
Select a criteria and click .
A confirmation message appears.
5.
Click Yes .
The selected SAP interception criteria definition is deleted.
Control-M interception rules
The following procedures describe how to add and manage Control-M interception rules so that the intercepted jobs are put on hold in Scheduled status until they are released by Control-M:
Adding interception rules to Control-M (on page 67 )
Editing a Control-M interception rule (on page 69 )
Copying Control-M interception rule information (on page 69 )
Deleting a Control-M interception rule (on page 70 )
Adding interception rules to Control-M
This procedure describes how to add Control-M interception rules so that Control-M for SAP can perform the required procedure when the specified condition has occurred.
To add interception rules to Control-M:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name .
3.
In the CTM Interception Rules tab, click .
The Add Control-M Interception Rule dialog box appears.
4.
NOTE : Consider how you specify Job Name and User parameters. Definitions that are too general
(for example, entering * in both fields), could cause system or other user jobs to be intercepted.
Additionally, ensure that you have no more than one account that uses Interception rules using the same system and client.
67
Control-M for SAP Administrator Guide
5.
Click OK .
The new Control-M interception rule is created.
Control-M Interception Rule parameters
Parameter
Job Name
User
Description
Specifies the SAP job name to be extracted from SAP to Control-M.
The * wildcard can be used.
Defines the name of the SAP user that created the job.
The * wildcard can be used.
Program Indicates the program that is used by the SAP job.
The * wildcard can be used. Default (*)
BMC recommends that the value * is used.
Into Table
Folder Order ID
Template Job
Name
Identifies into which Control-M table the job is submitted.
Valid values are:
None (Default) - use when the job template does not belong to a folder
Recent - add the job to the folder that was most recently ordered
Standalone - order the job by adding it to a folder
New folder - order the job to a new folder
Selected - set a folder 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 folders and Force
Into parameters, see
Control-M User Guide
.
Identifies the specified folder of jobs to be ordered.
This field is enabled only when Selected is specified in the Into
Folder field.
Defines the name of an 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.
68
Control-M for SAP Administrator Guide
Parameter
Template Table
Name
User Exit
Description
Defines the name of the existing Control-M table to which the Job
Name, described above, belongs.
Mandatory, unless User Exit is selected.
Defi nes the 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.
NOTE: If you access this file from the Control-M Configuration
Manager, it has to exist in the USER_EXIT directory. This is located in the Control-M/Agent directory, under CM/SAP.
Editing a Control-M interception rule
This procedure describes how to update a Control-M interception rule in the CCM.
To update a Control-M interception rule
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
2.
The Extractor Management dialog box appears.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the CTM Interception Rules tab, select the required entry in the Control-M interception rule table and click .
4.
The Update Control-M Interception Rule dialog box appears.
Edit the required parameters.
In the default rule, the Job Name , User Name and Program fields cannot be changed.
5.
Click OK .
The Control-M interception rule is updated.
Copying Control-M interception rule information
This procedure describes how to copy Control-M interception rule information in the CCM.
69
Control-M for SAP Administrator Guide
To copy Control-M interception rule information:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the CTM Interception Rules tab, select the required entry in the Control-M interception rule table and click .
The Copy Control-M Interception Rule dialog box appears.
3.
Update the required parameter values.
4.
Click OK .
A new Control-M interception rule is created, based on the copied information.
Deleting a Control-M interception rule
This procedure describes how to delete a Control-M interception rule from the CCM.
To delete a Control-M interception rule:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the CTM Interception Rules tab, select the required entry in the Control-M interception rule table and click .
A confirmation message appears.
4.
Click Yes .
The selected Control-M interception rule is deleted.
Job extraction criteria definitions
You can define extraction criteria for the kinds of SAP job that Control-M must extract from SAP. All jobs that have these criteria are extracted from SAP and mirrored in Control-M.
The following procedures describe how to add, edit, copy, and delete job extraction criteria:
Adding job extraction criteria (on page 71 )
Editing job extraction criteria (on page 72 )
Copying job extraction criteria (on page 73 )
Deleting job extraction criteria (on page 73 )
70
Control-M for SAP Administrator Guide
Adding job extraction criteria
This procedure describes how to add job extraction criteria so that Control-M for SAP can perform the required procedure when the specified condition has occurred.
To add job extraction criteria:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the Extraction Criteria tab, in the Jobs Extraction Criteria area, click .
The Add Extraction Criteria dialog box appears.
4.
and click OK and then click Apply .
The extraction criteria is added.
Extraction Criteria parameters
Parameter Parameter description
Job Name 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
STAR and JOB_STAR, for example, would be recognized as one and the same job. This is a known SAP problem.
User Name
Job Group
Job Count
With Pred
Owner of the job in SAP. Mandatory.
Valid values are: any generic value, for example: *Y*
Group to which the jobs belong. Free text. Optional
CCMS job number. 8-digit number. Optional.
Selection flag for jobs with start after predecessor. Optional. Valid values are: X/N
Event Id Background event ID. Free text. Optional
Event Param Background Event parameter. Free text. Optional.
71
Control-M for SAP Administrator Guide
Parameter Parameter description
From Date Scheduled start date for the CCMS job. Optional.
Valid format: YYYYMMDD
From Time Scheduled start time for the 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 the CCMS job. Optional. Valid format is: YYYYMMDD
To Time
No Date
Statuses
Scheduled end time for the CCMS job. Optional. Valid format: HHMMSS
NOTE: This parameter depends on the specification of both
From Date
and
To Date
for the same day.
Selection flag for jobs with no start date. Optional. Valid values are: X/N
Status of the CCMS job. The status types are:
Released
Ready
Finished
Scheduled
Active
Canceled
The status types can optionally be selected.
Editing job extraction criteria
This procedure describes how to edit a Control-M interception rule in the CCM.
To update job extraction criteria:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the Extraction Criteria tab, in the Jobs Extraction Criteria area, select a criteria from the table and click .
The Update Extraction Criteria dialog box appears.
4.
Edit the required parameters.
72
Control-M for SAP Administrator Guide
5.
Click OK .
The job extraction criteria is updated.
Copying job extraction criteria
This procedure describes how to copy job extraction criteria in the CCM.
To copy job extraction criteria
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the Extraction Criteria tab, in the Jobs Extraction Criteria area, select a criteria and click .
The Copy Extraction Criteria dialog box appears.
4.
Edit the required parameter values.
5.
Click OK .
The New job extraction criteria is created, based on the copied information.
Deleting job extraction criteria
This procedure describes how to delete job extraction criteria from the CCM.
To delete job extraction criteria:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
2.
The Extractor Management dialog box appears.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the Extraction Criteria tab, in the Jobs Extraction Criteria area, select a criteria and click
.
A confirmation message appears.
4.
Click Yes .
The selected job extraction criteria is deleted.
73
Control-M for SAP Administrator Guide
Add rules to extract SAP jobs
The following procedures describe extraction rules to determine which SAP jobs are extracted and how they are represented in Control-M. These rules are defined for each job extraction criteria type.
Adding rules to extract SAP jobs (on page 74 )
Editing extraction rules (on page 77 )
Copying extraction rules (on page 77 )
Deleting extraction rules (on page 78 )
Adding rules to extract SAP jobs
This procedure describes how to add extraction rules so that the intercepted jobs are put on hold in
Scheduled status until they are released by Control-M.
To add extraction rules:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
The Extractor Management dialog box appears.
2.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
3.
In the Extraction Criteria tab, in the Job Extraction Criteria area, select the criteria that you want to add rules.
4.
In the Extraction Rules area, click .
The Add Extraction Rule dialog box appears.
5.
For each field, define the required value as described in Extraction Rules parameters (on page 74 ).
NOTE : Consider how you specify Job Name and User Name criteria. Definitions that are too general (for example, entering * in both fields), could cause system or other user jobs to be intercepted. Additionally, ensure that you have no more than one account that uses Interception rules using the same system and client.
6.
Click OK .
The new extraction rule is created.
Extraction Rules parameters
Parameter Description
Job Name SAP job name. Mandatory
Can be either a specific or a generic name.
74
Control-M for SAP Administrator Guide
Parameter
Into Folder
Description
Identifies into which Control-M folder the job is submitted
Valid values are:
None (Default) - use when the job template does not belong to a folder
Recent - add the job to the folder that was most recently ordered
Standalone - order the job by adding it to a folder
New - order the job to a new folder
Selected - set a folder 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 folders and Force Into parameters, see
Control-M User
Guide
.
NOTE : You can define either according to a predefined job and folder (Template Job Name and Template Folder Name), or according to a user-defined script ( User Exit ).
Folder Order ID
Template Job Name
Template Folder Name
Identifies the specified folder of jobs to be ordered
This field is enabled only when Selected is specified in the
Into Folder field.
Name of an existing Control-M job (not submitted) to be used as a template for creating an SAP-type job in
Control-M. Mandatory, unless User Exit is selected.
An existing Control-M folder to which the Template Job
Name belongs. Mandatory, unless User Exit is selected.
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 enter a valid path to a pre-defined executable or script file
Click Select to select an existing file.
If you access this file from the Control-M Configuration
Manager, it has to exist in the USER_EXIT directory. This is located in the Control-M/Agent directory, under CM/SAP.
NOTE : From the Add Extraction Rule dialog box, the following parameters are available when you click Advanced Parameters .
75
Control-M for SAP Administrator Guide
Parameter
JOBCOUNT
STEPCOUNT
SDLSTRTDT
SDLSTRTTM
BTCSYSTEM
SDLDATE
SDLTIME
SDLUNAME
LASTCHDATE
LASTCHTIME
LASTCHNAME
RELDATE
RELTIME
RELUNAME
STRTDATE
STRTTIME
ENDDATE
ENDTIME
PERIODIC
STATUS
AUTHCKNAM
AUTHCKMAN
SUCCNUM
PREDNUM
Description
Job ID. Optional. 8-digit number.
Job step ID number. Optional.
Scheduled start date for background job. Optional.
Scheduled start time for background Job. Optional.
Target system to run background job. Optional.
Date of job or step scheduling. Optional.
Time of a scheduled job or step. Optional.
Initiator of job or step scheduling. Optional.
Date of last job change. Optional
Time of last job change. Optional
Name of user who made last job change. Optional.
Release date for background schedule. Optional.
Release time of scheduled background job. Optional.
User that released scheduled batch job. Optional.
Job start date. Optional.
Batch job start time. Optional.
Job start date. Optional.
Batch job start time. Optional.
Periodic jobs indicator ('X'). Optional.
Status of background job. Optional.
Background user name for authorization check. Optional.
Background client for authorization check. Optional.
Number of successor jobs. Optional.
Number of previous jobs. Optional.
76
Control-M for SAP Administrator Guide
Parameter
LASTSTRTDT
LASTSTRTTM
WPNUMBER
WPPROCID
EVENTID
EVENTPARM
JOBCLASS
CALENDARID
EXECSERVER
REAXSERVER
Description
Latest run date for batch job. Optional.
Latest run time for batch job. Optional.
Work process number. Optional.
Work process ID. Optional.
Background event ID. Optional.
Background Event parameters (for example,
Jobname/Jobcount). Optional.
Job classification. Optional.
Factory calendar ID for background processing. Optional.
Server name. Optional.
Server name. Optional.
Editing extraction rules
This procedure describes how to update extraction rules in the CCM.
To update extraction rules:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
2.
The Extractor Management dialog box appears.
3.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
4.
In the Extraction Criteria tab, in the Job Extraction Criteria area, select the criteria that you want to edit rules.
5.
In the Extraction Rules area, click .
The Update Extraction Rule dialog box appears.
6.
Edit the required parameters.
7.
Click OK .
The extraction rules are updated.
Copying extraction rules
This procedure describes how to copy job extraction criteria in the CCM.
77
Control-M for SAP Administrator Guide
To copy extraction rules:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
2.
The Extractor Management dialog box appears.
3.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
4.
In the Extraction Criteria tab, in the Job Extraction Criteria area, select the criteria that you want to copy rules.
5.
In the Extraction Rule area, click .
The Copy Extraction Rule dialog box appears.
6.
Update the required parameter values.
7.
Click OK .
The new extraction rule is created based on the copied information.
Deleting extraction rules
This procedure describes how to delete extraction rules from the CCM.
To delete extraction rules:
1.
From the CCM, right-click the CM (SAP) on the host that you want to manage, and select Extractor
Management .
2.
The Extractor Management dialog box appears.
3.
In the Extractor Definitions area, in the Account Name field, select the required Account Name.
4.
In the Extraction Criteria tab, in the Job Extraction Criteria area, select the criteria that you want to delete rules.
5.
In the Extraction Rules area, click
A confirmation message appears.
6.
Click Yes .
The selected extraction rule is deleted.
.
Detecting spawned jobs
This procedure describes how to detect spawned jobs. A spawned job is created by another (parent) job, and monitored by Control-M. The Extractor Management utility can detect and extract spawned jobs into
Control-M.
78
Control-M for SAP Administrator Guide
Before you begin
Ensure that the Parent/Child function is enabled in your SAP system.
Assign a priority to Spawned jobs in the Extractor General Configuration tab.
To detect the spawned jobs of a parent job:
1.
Define a regular SAP-type job in Control-M.
2.
In the SAP panel, click Detect Spawned Jobs
The Detect Spawned Jobs dialog box appears.
3.
For each field, type the required value, as described in Spawned job parameters (on page 79 ).
4.
Click OK .
The Extractor Management detects spawned jobs, according to the priority set in the General
Configuration panel of the Extractor Management.
Spawned job parameters
The following table lists the spawned job parameters.
Parameter
Start Spawned Job
Parameter description
If you select Start Spawned Job, Control-M for SAP checks the status of each spawned job and starts any spawned job with Scheduled status.
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.
79
Control-M for SAP Administrator Guide
User exit definition
When processing intercepted or extracted jobs, you can either extract them to the Control-M environment, 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 Extractor Management utility runs the script, and passes a list
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 Extractor Management utility.
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.
NOTE : When using Extractor Management, the User Exit script can only exist in the following location:
<Agent_dir>/cm/SAP/USER_EXIT
User Exit script parameters
The following table describes the Control-M for SAP User Exit script parameters.
2
Parameter number
1
Parameter value
<SAP Job Name>
<Job count>
Pre-defined User Exit for the Extractor Management utility
Extractor Management automatically defines a default CTM Interception Rule that avoids discarding intercepted jobs. This Interception Rule calls a pre-defined User Exit script with the following name and location:
UNIX: <Agent_homedir>/ctm/cm/SAP/exe/default_order
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.
80
Control-M for SAP Administrator Guide
Extractor Management startup/shutdown
The following procedures describe how to start up and stop the Extractor Management service:
Starting up the Extractor Management service in UNIX (on page 81 )
Stopping the Extractor Management service in UNIX (on page 81 )
Starting up the Extractor Management service in Windows (on page 81 )
Stopping the Extractor Management service in Windows (on page 81 )
Starting up the Extractor Management service in UNIX
This procedure describes how to start up the Extractor Management service in UNIX.
To start up the Extractor Management in UNIX:
From a command prompt type the following command: start-xt
Stopping the Extractor Management service in UNIX
This procedure describes how to stop the Extractor Management service in UNIX.
To stop the Extractor Management service in UNIX:
From a command prompt, type the following command: shut-xt .
NOTE : If the computer on which Control-M/Agent is installed is rebooted while the Extractor process is active, Control-M/Agent automatically restarts the Extract Management Utility.
Starting up the Extractor Management service in Windows
This procedure describes how to start up the Extractor Management service in Windows.
If the computer has not been restarted since the installation of Control-M for SAP, you must restart it before activating the Extractor Management service.
To start up the Extractor Management service in Windows:
1.
Select Start > Settings > Control Panel > Administrative Tools > Services.
2.
Select Control-M for SAP <Agent Instance> Extractor , and click Start to start the Extractor
Management service.
Stopping the Extractor Management service in Windows
This procedure describes how to stop the Extractor Management service in Windows.
To stop the Extractor Management service in Windows:
1.
Select Start > Settings > Control Panel > Administrative Tools > Services .
81
Control-M for SAP Administrator Guide
2.
Select Control-M for SAP <Agent Instance> Extractor , and click Stop to stop the Extractor
Management service.
Importing the SAP Calendar
This procedure describes how to import the SAP calendar from your SAP computer to your Control-M environment for use when defining batch jobs. Only SAP factory calendars can be imported.
Before you begin
Ensure you have the following Control-M/EM user permissions in CCM:
BROWSE: Enables you to view existing calendars on the SAP system
UPDATE: Enables you to import a calendar
To use the Import SAP Calendar Manager, your SAP system version should be PI_BASIS 2002_2_62- or later.
To import SAP calendars:
1.
In the Control-M Configuration Manager, select the CM (SAP) on the host that you want to manage and right-click Import SAP Calendar .
The Import SAP Calendar dialog box is displayed.
2.
3.
Calendar parameters, Control-M Definition (on page 83 ).
4.
Click Import Calendar .
The following file is created:
%temp%\BMC_importedSAPcalendar_<account name>_<SAP calendar name>_<SAPcalendar year>.xml
5.
Copy this file to a computer where a Control-M/EM server is installed.
6.
Run the Control-M/EM defcal utility using this file.
For more information about the defcal utility, see the
Control-M Utilities Guide
.
7.
Upload the result of the defcal utility to the required Control-M/Server.
The specified SAP calendar is imported.
82
Control-M for SAP Administrator Guide
Import SAP Calendar parameters, Calendar to Import area
The following table lists the Import SAP Calendar parameters, Calendar to Import area:
Field
Account Name
SAP Calendar Name
SAP Calendar Year
Description
Defines the name of the Control-M for SAP account.
Defines the name of the SAP calendar.
NOTE : This field is enabled when an account is specified
Defines the SAP calendar year.
NOTE: This field is enabled when an account is specified.
Import SAP Calendar parameters, Control-M Definition
The following table lists the import SAP Calendar parameters, Control-M Definition area:
Field
Import to all
Control-M/Servers
Description
Determines whether to import the SAP calendar to all online instances of Control-M/Server.
Selected: the SAP calendar is imported to all online instances of Control-M/Server. Default
Not selected: the SAP calendar is not imported to all online instances of Control-M/Server.
Import to a specific
Control-M/Server
Calendar Name
Determines whether to import the SAP calendar to a specific instance of Control-M/Server.
Selected: the SAP calendar is imported to a specific instance of Control-M/Server.
Not selected: the SAP calendar is not imported to a specific instance of Control-M/Server. Default
Determines the automatic display of the default <SAP calendar name>_<SAP calendar year>.
This parameter is enabled when the SAP calendar name and year are selected. You can specify a calendar name and overwrite the calendar name that was entered by default.
83
Control-M for SAP Administrator Guide
Field
Calendar Description
Description
Determines the automatic display to describe the default
<SAP calendar name>_<SAP calendar year>.
This parameter is enabled when the SAP calendar name and year are selected. You can specify a calendar name and overwrite the calendar name that was entered by default.
84
4
Control-M for SAP Utilities
Chapter
4
This section describes the Control-M for SAP utilities which enables you to do the following:
Convert Control-M Option for R/3 jobs that can be run and monitored in Control-M for SAP using the
List, create, alter and display variants and define, delete, and modify jobs using the ctmr3req utility,
as described in SAP actions using the ctmr3req utility (on page 99 ).
Extract and monitor jobs using the ctmextract utility
This section describes how to monitor and extract SAP jobs to Control-M by using the Control-M
Extraction ctmextract utility. The ctmextract utility can be used in the following circumstances:
When you create one or more mirror image jobs by using criteria identical to specific jobs already running in SAP. These jobs are monitored using the Control-M ctmcreate utility (but are not submitted as jobs to be executed by Control-M). This enables Control-M to track the progress of the actual job in
SAP. This mirror image is stored in Active Jobs File in the Control-M/Server database. For more information, see: Monitoring SAP jobs with ctm extract.
Define one or more jobs in Control-M, by using criteria identical to that of specific jobs defined in the
SAP database. The Control-M ctmdefine utility stores these jobs in the Control-M definition environment. For more information, see: Extracting job definitions with ctmextract.
NOTE : You can also use Control-M for SAP Extractor Management but you may need to use the utility in the following circumstances:
If the XBP 2.0 interface is not installed on your SAP system
When extracting job definitions
85
Control-M for SAP Administrator Guide
Defining a rule file with ctmextract utility
This procedure describes how to create a rule file, which is needed to use the ctmextract utility to either monitor SAP jobs with ctmcreate, or to extract job definitions to Control-M using ctmdefine.
Before you begin
Do one of the following:
Windows: Ensure that you have a DOS window running.
UNIX: Ensure that you are logged on to a Control-M/Agent account.
To define a rule file with ctmextract utility:
1.
Open a new text file in a text editor program.
2.
Structure the rule file into the following 2 sections:
The first Section: Indicates which job definitions are monitored or extracted by setting the
selection criteria for the job. You can set variables under the [CONDITION1] string. Enter the Rule
File AutoEdit parameters (on page 87 ) and save the file.
EXAMPLE : [CONDITION1]
%%SAPR3-JOBNAME SH_CR15
%%SAPR3-ACCOUNT CM2
%%SAPR3-OWNER SH*
The second section: Specifies whether to monitor the job (ctmcreate), or extract its definition to
Control-M (ctmdefine). Select either [CTMCREATE] or [CTMDEFINE], as required: o Choose [ctmcreate] to create one or more jobs that monitor identical jobs already running in
SAP. For more information see: Monitoring SAP jobs with ctmextract (on page 91 )
o Choose [ctmdefine] to extract job definitions from SAP into the Control-M/Server database.
For more information, see: Extracting job definitions with ctmextract (on page 92 ).
EXAMPLE : {[CTMCREATE]|[CTMDEFINE]}
NODEGRP TLVW2K065
GROUP SAP1
%%SAPR3-ACCOUNT CM2
3.
Set the parameters for the second section. See ctmcreate and ctmdefine parameters (on page 89 )
and ctmdefine parameters (on page 90 ).
86
Control-M for SAP Administrator Guide
Rule File autoedit parameters
This table describes the rule file autoedit parameters. autoedit variable Description
%%SAPR3-ACCOUNT
%%SAPR3-JOBNAME
%%SAPR3-OWNER
%%SAPR3-JOBCOUNT
%%SAPR3-JOBGROUP
%%SAPR3-FROM_DATE
%%SAPR3-FROM_TIME
%%SAPR3-TO_DATE
Defines the name of the Control-M for SAP account. Mandatory.
Free text
Defines the name of the job to be monitored or submitted.
NOTE : If an SAP job name contains spaces, (for example, JOB
STAR1) the corresponding Control-M job name is the same, with underscores replacing the spaces (for example, JOB_STAR1).
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 STAR and JOB_STAR, for example, would be recognized as the same job. This is a known SAP problem.
Defines the owner of the SAP job. Valid values: Any generic value.
EXAMPLE : *
Mandatory.
Defines the CCMS job number.
Free text
Defines the jobs summary for a group.
Free text
Defines the scheduled start date for CCMS job.
Valid format: YYYYMMDD
Defines the scheduled start time for CCMS job.
Valid format: HHMMSS
NOTE: This parameter depends on the specification of both%%SAPR3-FROM_DATE and %%SAPR3-TO_DATE for the same day.
Defines the scheduled end date for CCMS job.
Valid format: YYYYMMDD
87
Control-M for SAP Administrator Guide autoedit variable
%%SAPR3-TO_TIME
%%SAPR3-EVENT_ID
%%SAPR3-EVENT_PARAM
%%SAPR3-RELEASED
%%SAPR3-READY
%%SAPR3-ACTIVE
%%SAPR3-FINISHED
%%SAPR3-CANCELED
Description
Defines the scheduled end time for CCMS job.
Valid format: HHMMSS
NOTE: This parameter depends on the specification of both
%%SAPR3-FROM_DATE and %%SAPR3-TO_DATE for the same day.
Defines the background event ID.
Free text
Defines the background event parameter.
Free text
Defines the status of CCMS job.
Valid values: X/N (default X)
Defines the status of CCMS job.
Valid values: X/N (default X)
Defines the status of CCMS job.
Valid values: X/N (default X)
Defines the status of CCMS job.
Valid values: X/N (default X)
Defines the status of CCMS job.
Valid values: X/N (default X)
88
Control-M for SAP Administrator Guide
ctmcreate and ctmdefine parameters
The following table describes the mandatory parameters for ctmcreate and ctmdefine.
Parameter
NODEGRP
%%SAPR3-ACCOUNT
GROUP
Description
Node group. Valid value: Agent name.
Mandatory when Control-M/Server and Control-M/Agent are not installed on the same computer.
Defines the name of the Control-M for SAP account.
Defines the relevant Control-M/Server group name (for ctmdefine-set actions).
TABLE Defines the 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 more information see
Control-M Parameters Guide
.
89
Control-M for SAP Administrator Guide
ctmdefine parameters
The following table describes the optional parameters for ctmdefine.
Parameter Description
JOB_MODE
JOB_COUNT
Defines the job mode. Use this parameter with value COPY in order to define the SAP job in Control-M. Type COPY, instead of the default CREATE.
EXAMPLE : A rule file that sets the SAP job in Control-M as type
COPY:
[CONDITION1]
%%SAPR3-JOBNAME TEST
%%SAPR3-ACCOUNT DXI
%%SAPR3-OWNER JAMY
[CTMDEFINE]
NODEGRP CN7Z9CJ-048
GROUP SAP1
%%SAPR3-ACCOUNT DXI
TABLE sap_table
JOB_MODE COPY
JOB_COUNT last_scheduled
Specifies the job count type. Must be used if JOB_MODE COPY was set.
Can have one of the following values:
specific: Specific job count - extracted from SAP
last_scheduled
first_scheduled
last
first
90
Control-M for SAP Administrator Guide
Monitoring SAP jobs with ctmextract
This procedure describes how 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 Active Jobs in the Control-M/Server database.
NOTE : Mirror images are only created for jobs that do not have scheduled status.
Before you begin
Do one of the following:
Windows: Ensure that you have a DOS window running.
UNIX: Ensure that you are logged on to a Control-M/Agent account.
To monitor SAP jobs with ctmextract:
1.
Create a rule file. For more information, see Defining a rule file with ctmextract utility.
2.
Type the following command:
ctmextract -CM_APPL_TYPE SAP -RULETABLE <rule file name and path>
3.
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.
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.
For the parameters, see Monitoring job parameters (on page 91 ).
Monitoring job parameters
The following table describes the parameters for monitoring a job.
Parameter Description
-CM_APPL_TYPE
-RULETABLE
-IGNORE_DUP
Represents SAP as an external application.
Valid value: SAP
Sets the name and path of the rule file.
Valid value: Selected rule file.
Causes a ctmextract instance to re-extract all jobs, regardless of whether they were already extracted.
Valid value: Y
91
Control-M for SAP Administrator Guide
Extracting job definitions with ctmextract
This procedure describes how to extract a job definition from the SAP database to Control-M and manage this job from Control-M. Only jobs that have scheduled status can have their definition extracted.
Before you begin
Do one of the following:
Windows: Ensure that you have a DOS window running.
UNIX: Ensure that you are logged on to a Control-M/Agent account.
To extract job definitions with ctmextract:
1.
Create a rule file.
For more information, see: Defining a rule file with ctmextract utility (on page 86 ).
2.
Enter the following command:
ctmextract -CM_APPL_TYPE SAP -RULETABLE <rule file name and path>
For parameters, see Monitoring job parameters (on page 91 )
3.
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.
Control-M Option conversion for R3 account definitions
The Control-M for SAP conr3acc conversion utility is used to create new account definitions for Control-M for SAP based on existing accounts in Control-M/Option for R/3. If the Control-M for SAP uses a non-default encryption key, you must restore the encryption key to the default key (using the agkeystore utility) before using the conr3acc utility. After the accounts file has converted successfully, the
Control-M Utilities Guide.
NOTE : The conr3acc
utility is specific to users who have a previous installation of Control-M/Option for
R/3. Both Control-M for SAP and Control-M option for R/3 can run concurrently on your computer. The
Control-M for SAP sapacc.dat accounts file should be empty before running the conr3acc
utility.
The following topics describe how to convert Control-M Option for R3 account definitions and R/3 jobs:
Converting Control-M Option for R3 account definitions (on page 93 )
Converting Control-M Option for R/3 jobs (on page 93 )
To define standard and extended modes, see: Standard and extended mode operations (on page 96 ).
92
Control-M for SAP Administrator Guide
Converting Control-M Option for R3 account definitions
The following procedure describes how to convert Control-M Option for R3 account definitions.
Before you begin
Do one of the following:
Microsoft Windows: Open a new DOS prompt window.
UNIX: 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 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 for SAP accounts file. The account definition is automatically saved.
Converting Control-M Option for R/3 jobs
The ctmr3con conversion utility 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 for SAP. The conversion utility can only be run if you are using a Windows operating system.
NOTE : This utility can convert both command line jobs, and jobs that use the Grid functionality in
To convert Control-M Option R/3 jobs:
1.
Open a new DOS prompt window.
2.
In Control-M/EM, export the folder that you want to convert, using the exportdeftable utility. For more information, see the exportdeftable utility in
Control-M Utilities Guide.
3.
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|
93
Control-M for SAP Administrator Guide
FIRST_SCHEDULED}] [-HELP]
NOTE : The syntax is available for both Microsoft Windows and UNIX operating systems. However, in
UNIX you may need to add ./ before
-JOB_MAN_DEF_MODE RUN_ORG ctmr3con
utility parameter descriptions (on page 96 ).
(for example,
./ctmr3con - IN_FILE abc.xml
). For more information about the parameters, see: Conversion
The conversion utility should only be run from the directory in which it is located.
4.
Before importing the new folder into Control-M/EM, either delete the original folder (using the Local
Delete functionality), or rename it.
5.
(Control-M/EM version 7.0.00 or lower) In Control-M for SAP, the SAP Job Name (SAP panel) and
Control-M Job Name (General panel) parameters are linked and dependent upon each other. When
Jobs for Control-M Option for R/3 utilities convertibility
The following table describes the jobs for the Control-M Option for R/3 utilities which can be converted using the conr3acc utility.
Utility Conversion 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)
Yes 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)
No
NOTE : The ctm_r3_job_mand
and ctm_r3_xjob_mand
utilities are not converted because Control-M 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.
94
Control-M for SAP Administrator Guide
Solving the linkage problem between SAP Job Name and
Control-M Job Name
In Control-M for SAP, the SAP Job Name (SAP panel) and Control-M Job Name (General panel) parameters are linked and dependent upon each other. When running the Conversion utility, if the value of the -job parameter (from Control-M Option for R/3) is not the same as the Control-M Job Name, the linkage can lead to problems. The following workaround can be performed in order to disconnect the two parameters.
To solve the linkage problem:
1.
Close Control-M/EM GUI and Control-M/Desktop.
2.
On the computer that is running Control-M/Desktop, back up the SAP1.xml
file from the following location:
Control-M/EM version 6.4.01:
<CONTROL-M EM path>\Data\ECSApplicationForms
Control-M/EM versions 7.0.00:
<CONTROL-M EM path>\Data\ApplicationForms
3.
Delete the following lines from this file:
<PAIR>
<AEV>SAPR3-JOBNAME</AEV>
<DB>DBF_DEF_JOB_JOB_NAME</DB>
</PAIR>
NOTE : This disables linkage for all Control-M for SAP jobs. If you define Extraction or Interception rules in the Extractor utility, ensure that the Template Job Name relates to the Control-M Job Name parameter, not to the SAP Job Name parameter.
4.
Run the deftable utility on the output file (converted scheduling table).
The output file name appears at the end of the conversion utility’s output (see Step 2 in Converting
Control-M Option for R/3 jobs (on page 93 )).
The jobs in the selected folder are converted.
For more information, see the deftable utility in
Control-M Utilities Guid
e.
95
Control-M for SAP Administrator Guide
Conversion utility parameter descriptions
The following table describes the conversion utility parameters.
Parameter Description and default value
-IN_FILE
-OUT_FILE
-JOB_MAN_DEF_MODE
-RUN_COPY_MODE
Input file. Default name: db_out.xml
NOTE: <input_file>
in the above syntax represents the exported folder 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.
Specifies the default function to be performed by the Job Manager utility. Default value is RUN_COPY .
NOTE : For more information, see the
Administrator Guide
.
Control-M for R/3
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
.
Standard and extended mode operations
Standard and Extended modes are defined in Control-M for SAP on a global level during run time.
Standard mode or Extended mode is selected using the Account Management utility. This is different from
Control-M Option for R/3, where you can 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 Account
Management utility.
see: Preventing the MemLib (Path) field from being overwritten (on page 98 ).
96
Control-M for SAP Administrator Guide
Known issues for conversion of parameters and utilities
The following table describes special considerations and limitations for conversion of certain parameters or utilities.
Parameter/feature Clarification/remarks ctm_r3_var_man
-list
-modify
-acc
-pass
-cancel
-debug ctm_r3_bi_mon rfc_trace
Any unknown parameter
Redirection
(> or >>)
The Copy Variant function is not supported.
Not supported.
Not supported for creating new steps (not existing steps).
Mandatory, unless the -pass parameter is entered. For jobs without the -acc parameter that are based on parameters in the configuration file. For more information, see -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.
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 this name.
Not Supported.
This parameter is ignored. Debugging information is recorded by
Control-M for SAP according to the debug level configured in
Control-M/Agent. For more information, see the Configuration
Management utility in the
Control-M Administrator Guide
.
Only jobs with a -start value of Y are converted.
The -wait parameter is ignored.
Not Supported.
Job is not converted and an error message is issued.
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 for SAP jobs, with a tasktype of
JOB.
97
Control-M for SAP Administrator Guide
Parameter/feature
Output command line length greater than 512 characters
MemLib and MemName
Clarification/remarks
Not supported.
When migrating from Control-M Option for R/3 to Control-M for
SAP, the MemLib and MemName parameters are overwritten, even when the values of the parameters are not empty. For more
information, see Preventing the MemLib (Path) field from being overwritten (on page 98 ).
Preventing the MemLib (Path) field from being overwritten
During conversion, the MemLib and MemName fields maintain their original values if the fields are not empty. The conversion utility enters a default value if the fields are empty. However, the File path field is still overwritten when you open the Job Editing Form. This procedure describes how to prevent the
MemLib field from being overwritten.
NOTE : This is only relevant if you are using Control-M/EM version 7.0.00 or lower.
To prevent the file path from being overwritten:
1.
Close the Control-M/Enterprise Manager GUI and the Control-M Desktop.
2.
On the computer that is running Control-M Desktop back up the SAP1.xml
file from the following locations:
Control-M/EM version 6.4.01:
<CONTROL-M EM path>\Data\ECSApplicationForms
Control-M/EM versions 7.0.00:
<CONTROL-M EM path>\Data\ApplicationForms
3.
Delete the following lines from this file:
<PAIR>
<AEV>SAPR3-JOBNAME</AEV>
<DB>DBF_DEF_JOB_MEM_LIB</DB>
</PAIR>
4.
Save the SAP1.xml file.
The default value is no longer entered automatically.
NOTE : The File path field is mandatory for all Control-M for SAP jobs. You must ensure that the File path field in the SAP Skeleton contains a non-empty value. For example, Not in use for SAP jobs.
Failing to do so causes new SAP jobs to fail if the File path field value is not specified.
98
Control-M for SAP Administrator Guide
SAP actions using the ctmr3req utility
The Control-M for SAP Request utility (ctmr3req) can be used to request that SAP performs certain actions and uses information from the SAP database. The ctmr3req utility can request that SAP performs the following actions:
Creates a variant for a specific program, as described in Creating a variant (on page 101 ).
Copies a variant for a specific program, as described in Copying a variant (on page 102 ).
Deletes a job from the SAP database, as described in Deleting a job (on page 107 ).
Defines a new job, as described in Defining a new job (on page 108 ).
Modifies an existing job, as described in Modifying a job (on page 110 ).
Viewing a job's spool, as described in Viewing a jobs spool (on page 111 ).
Removes a process chain from schedule, as described in Removing a process chain from schedule
Tests the connectivity between Control-M and the SAP system defined in the account, as described in
Testing connectivity between Control-M and the SAP system (on page 114 ).
99
Control-M for SAP Administrator Guide
Displaying a list of variants for a program
This procedure describes how to request that SAP displays a list of defined variants for a specific ABAP program.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To display a list of variants for a program:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION var_mon -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name>
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_mon
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name> [-Agent
<agent_name>]
For a list of parameters, see: var_mon action parameters (on page 100 )
EXAMPLE : The ctmr3req utility used to display a list of variants, using the STAR account, for the prog1 program:
D:\Program files\BMC Software\CONTROL-M Agent\David\ctmr3req -SAPR3-
ACTION var_mon -SAPR3-ACCOUNT STAR -SAPR3-PROGRAM prog1 -Agent
Default
var_mon action parameters
The following table describes the var_mon action parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
Determines the action of the ctmr3req utility. (var_mon)
Mandatory.
Defines the name of a specific SAP account. Mandatory. Maximum length: 30 characters.
Defines the name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
100
Control-M for SAP Administrator Guide
Creating a variant
This procedure describes how to request that SAP creates defined variants for a specific ABAP program.
You can view a selection screen of a variant based on the ABAP program, set values for the parameters and save the new variant in the SAP system.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To create a variant for a program:
1.
Type one of the following commands and press enter:
UNIX:
ctmr3req -SAPR3-ACTION var_create -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name>
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_create
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
For a list of parameters, see: var_create action parameters (on page 102 ).
The Selection screen for program dialog box appears.
2.
Type the number for Variant Name and press enter.
3.
Type the variant name and press enter.
4.
Type the number for Variant Description and press enter.
5.
Type the variant description and press enter.
6.
(Optional) Type any number to vary any of the remaining parameters.
7.
Type s to save.
The variant is created.
EXAMPLE : The ctmr3req utility used to create variants, using the STAR account, for the prog1 program:
D:\Program files\BMC Software\CONTROL-M Agent\David\ctmr3req -SAPR3-
ACTION var_create -SAPR3-ACCOUNT STAR -SAPR3-PROGRAM prog1 -Agent
Default
101
Control-M for SAP Administrator Guide
var_create action parameters
The following table describes the var_create action parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
Determines the action of the ctmr3req utility. (var_create)
Mandatory.
Defines the name of a specific SAP account. Mandatory. Maximum length: 30 characters.
Defines the name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
Copying a variant
This procedure describes how to copy a variant for a specific program.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To copy a variant:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION var_copy -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> -SAPR3-VAR <Original Variant Name>
-SAPR3-NEW_VAR <New Variant Name>
Windows:
<
Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_copy
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
-SAPR3-VAR <Original Variant Name> -SAPR3-NEW_VAR <New Variant Name>
[-Agent <agent_name>]
For a list of parameters, see: var_copy parameters (on page 103 ).
EXAMPLE : The ctmr3req utility is used to copy Variant VAR_.A to a new Variant VAR_B using the
STAR account for program PROG1. All parameters are mandatory. ctmr3req -SAPR3-ACTION var_copy -SAPR3-ACCOUNT STAR
-SAPR3-PROGRAM PROG1 -SAPR3-VAR VAR_A -SAPR3-NEW_VAR VAR_B
102
Control-M for SAP Administrator Guide
var_copy parameters
The following table describes the var_copy parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
-SAPR3-VAR
-SAPR3-NEW_VAR
Determines the action of the ctmr3req utility. (var_copy)
Mandatory.
Defines the name of a specific SAP account. Mandatory. Maximum length: 30 characters.
Defines the name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
Defines the name of the variant to copy from for a specific program in SAP. Mandatory.
Defines the name of the variant to copy for a specific program in
SAP. Mandatory.
Altering parameter values in a variant
This procedure describes how to alter the value of set parameters in a variant.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To alter parameter values in a variant:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION var_edit -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> -SAPR3-VAR <variant_name>
-SAPR3-VAR_PARAM<nnn>
“<variant_parameter_name>=<variant_parameter_value> [-SAPR3-VAR_TEXT
“<variant_text>”]
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_edit
103
Control-M for SAP Administrator Guide
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
-SAPR3-VAR <variant_name> -SAPR3-VAR_PARAM<nnn>
“<variant_parameter_name>=<variant_parameter_value> [-SAPR3-VAR_TEXT
“<variant_text>”] [-Agent <agent_name>]
For a list of parameters, see: var_edit action parameters (on page 104 ).
EXAMPLE : The ctmr3req utility is used to alter parameter values, using the STAR account for the prog1 program, with the var1 variant, when the Airline value is an integer between 5 and 9. 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 STAR -SAPR3-PROGRAM prog1 -SAPR3-VAR var1 -SAPR3-VAR_PARAM001 "AIRLINE=I,BT,5 => 9" [-
SAPR3-VAR_TEXT "This is a test var"]
var_edit action parameters
The following table describes the var_edit action parameters.
Parameter Value
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
-SAPR3-VAR
-SAPR3-VAR_PARAM<nnn>
-SAPR3-VAR_TEXT
Determines the action of the ctmr3req utility. (var_edit)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
Defines the name of the variant for a specific program in SAP.
Mandatory.
Defines the variant parameter. Mandatory. nnn is a three-digit number that represents the parameter count number.
Describes the variant. Optional
104
Control-M for SAP Administrator Guide
Displaying variant details within a program
This procedure describes how to display variant details within a program.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To display variant details in a program:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION var_show -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> -SAPR3-VAR <variant_name>
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>]
For a list of parameters, see: var_show action parameters (on page 105 )
EXAMPLE : The ctmr3req utility displays variant details in a program, searching for var1 variants, using the STAR account, for the RSAAA02 program. All parameters are mandatory. ctmr3req -SAPR3-ACTION var_show -SAPR3-ACCOUNT STAR -SAPR3-PROGRAM prog1 -SAPR3-VAR var1
var_show action parameters
The following table describes the var_show action parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
-SAPR3-VAR
Determines the action of the ctmr3req utility. (var_show)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
Defines the SAP program variant. Mandatory
105
Control-M for SAP Administrator Guide
Raising an SAP event
This procedure describes how to enable a specific SAP background processing event to be raised
(triggered).
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To raise an SAP event:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION raise_event -SAPR3-ACCOUNT <account_name>
-SAPR3-EVENT_ID <event_ID> -SAPR3-EVENT_PARAM <event_parameter>
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>]
For a list of parameters, see: raise_event action parameters (on page 107 ).
EXAMPLE : The ctmr3req utility raises the ev1 event, with the parameter value of evparm1, using the
STAR account. All parameters are mandatory. ctmr3req -SAPR3-ACTION raise_event -SAPR3-ACCOUNT STAR -SAPR3-
EVENT_ID ev1 -SAPR3-EVENT_PARAM evparm1
106
Control-M for SAP Administrator Guide
raise_event action parameters
This table describes the raise_event action parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-EVENT_ID
-SAPR3-EVENT_PARAM
Determines the action of the ctmr3req utility. (raise_event)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the name of SAP background processing event.
Mandatory.
Defines additional parameters for an SAP background processing event. Optional
Deleting a job
This procedure describes how to delete a specific job from the SAP database.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To delete a job:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION job_delete -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-JOBCOUNT <job_count>
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>]
For a list of parameters, see: job_delete action parameters (on page 108 )
EXAMPLE : The ctmr3req utility deletes a job. All parameters are mandatory. ctmr3req -SAPR3-ACTION job_delete -SAPR3-ACCOUNT STAR -SAPR3-JOBNAME job1 -SAPR3-JOBCOUNT 12344321
107
Control-M for SAP Administrator Guide
job_delete action parameters
This table describes the job_delete parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-JOBCOUNT
Determines the action of the ctmr3req utility. (job_delete)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the job name in SAP to be deleted. Mandatory.
Defines the unique ID number for the job in SAP. Mandatory.
Defining a new job
This procedure describes how to define a new job in the SAP database.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To define a new a job:
Type one of the following commands:
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>
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>]
For a list of parameters, see: job_define action parameters (on page 109 )
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. The Target Group and Target Server parameters are not supported by the ctmr3req utility in job define mode.
108
Control-M for SAP Administrator Guide
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:
A = ABAP program
C = External command
E = External program
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 STAR -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
job_define action parameters
This table describes the job_define action parameters. For information about additional parameters for use when defining a new job, see
Control-M Parameters guide.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-STEP-S<nn>-
STEP_TYPE
-SAPR3-STEP-S<nn>-
PROGRAM
Determines the action of the ctmr3req utility. (job_define)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the job name in SAP. Mandatory.
Defines the 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.
The name of the job step program. Mandatory. nn is a two-digit number that represents the step number.
109
Control-M for SAP Administrator Guide
Modifying a job
This procedure describes how to modify an existing job in the SAP database.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To modify a job:
Type one of the following commands:
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>
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>]
For a list of parameters, see: job_modify action parameters (on page 111 ).
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. The Target Group and Target Server parameters are not supported by the ctmr3req utility in job define mode.
EXAMPLE : The ctmr3req utility is used to modifying an existing job. The first five parameters are mandatory and 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 STAR -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
110
Control-M for SAP Administrator Guide
job_modify action parameters
The following table describes the job_modify action parameters. For information about additional parameters for use when defining a new job, see
Control-M Parameters guide.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-STEP-S<nn>-
STEP_TYPE
-SAPR3-STEP-S<nn>-
PROGRAM
Determines the action of the ctmr3req utility. (job_modify)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the job name in SAP. Mandatory.
Defines the 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.
The name of the job step program. Mandatory. nn is a two-digit number that represents the step number.
Viewing a jobs spool
This procedure describes how to view a specific SAP job's spool. You can view a specific spool based on the account name, SAP job count and SAP job name.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To view a job's spool:
1.
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION get_spool -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBCOUNT <job_count> -SAP3-JOBNAME <job_name>
111
Control-M for SAP Administrator Guide
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION get_spool
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBCOUNT <job_count>
-SAP3-JOBNAME <job_name> [-Agent <agent_name>]
2.
For a list of parameters, see: get_spool action parameters (on page 112 ).
Type a number for a step from the list and press enter.
A List of spools for step appears.
3.
Type a number from the List of Spools and press enter.
Follow the on screen instructions to view the next page, return to the list of spools or to quit the command.
EXAMPLE : The ctmr3req utility used to view a job's spool, using the STAR account, for the prog1 program:
D:\Program files\BMC Software\CONTROL-M Agent\David\ctmr3req -SAPR3-
ACTION get_spool -SAPR3-ACCOUNT STAR -SAPR3-JOBCOUNT 15570601
-SAP3-JOBNAME PROG1 -Agent Default
get_spool action parameters
The following table describes the get_spool action parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBCOUNT
-SAPR3-JOBNAME
Determines the action of the ctmr3req utility. (get_spool)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the unique ID number for the job in SAP. Mandatory.
Defines the spool SAP job name spool to view. Mandatory.
112
Control-M for SAP Administrator Guide
Removing a process chain from schedule (Interrupts)
This procedure describes how to remove a process chain from schedule.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To remove a process chain from schedule:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION PC_STOP_SCHEDULE -SAPR3-ACCOUNT
<account_name> -SAPR3-PROCESSCHAIN_ID <chain_id>
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>]
For a list of parameters, see: ctmr3req interrupt parameters (on page 113 ).
EXAMPLE : Below is an example of the ctmr3req utility when used to remove a process chain from schedule, using the STAR account, and pc1 as processchain_id: ctmr3req -SAPR3-ACTION PC_STOP_SCHEDULE -SAPR3-ACCOUNT STAR -SAPR3-
PROCESSCHAIN_ID pc1
ctmr3req interrupt parameters
This table describes the ctmr3req interrupt parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROCESSCHAIN_ID
Determines the action of the ctmr3req utility. (pc_stop_schedule)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Defines the name of the Process Chain in SAP. Mandatory.
113
Control-M for SAP Administrator Guide
Testing connectivity between Control-M and the SAP system
This procedure describes how to test the connectivity between Control-M and the SAP system.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To test connectivity between Control-M and the SAP system:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION check_account -SAPR3-ACCOUNT <account_name>
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION check_account
-SAPR3-ACCOUNT <account_name>
For a list of parameters, see: check_account parameters (on page 114 )
EXAMPLE : In the following example, the ctmr3req utility deletes a job. All parameters are mandatory. ctmr3req -SAPR3-ACTION CHECK_ACCOUNT -SAPR3-ACCOUNT STAR
check_account parameters
This table describes the check_account parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
Determines the action of the ctmr3req utility. (check_account)
Mandatory.
Defines the name of a specific SAP account. Maximum length: 30 characters. Mandatory.
114
Control-M for SAP Administrator Guide
Checking an SAP setting for Interception
This procedure describes how to check if Interception is set on the SAP system and which XBP version it works with.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To check an SAP setting for Interception:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION check_initxbp2 -SAPR3-ACCOUNT <account_name>
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION check_initxbp2
-SAPR3-ACCOUNT <account_name> [-Agent <agent_name>]
For a list of parameters, see: check_initxbp2 action parameters (on page 115 ).
EXAMPLE : The ctmr3req utility checks the Interception settings using the STAR account. All parameters are mandatory. ctmr3req -SAPR3-ACTION check_initxbp2 -SAPR3-ACCOUNT STAR
NOTE : Return values: If the utility returns “0”, it means that Interception is switched off on the SAP system. Any other number returned by the utility represents the XBP version that Interception is set to, for example, “2” or “3”.
check_initxbp2 action parameters
This table describes the check_initxbp2 action parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
Determines the action of the ctmr3req utility. (check_initxbp2)
Mandatory.
Defines the name of a specific SAP account. Mandatory. Maximum length: 30 characters.
115
Control-M for SAP Administrator Guide
Displaying intercepted status in an SAP job
This procedure describes how to display intercepted status in an SAP job.
Before you begin
Do one of the following:
Windows: Open a new DOS prompt window.
UNIX: Ensure that you are logged on as the Control-M/Agent user.
To check an SAP setting for Interception:
Type one of the following commands:
UNIX:
ctmr3req -SAPR3-ACTION get_itcp -SAPR3-ACCOUNT <account_name>
Windows:
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION get_itcp
-SAPR3-ACCOUNT <account_name> [-Agent <agent_name>]
For a list of parameters, see: get_itcp parameters (on page 116 ).
EXAMPLE : The ctmr3req utility displays the intercepted status using the STAR account. All parameters are mandatory. ctmr3req -SAPR3-ACTION get_itcp -SAPR3-ACCOUNT STAR
get_itcp parameters
This table describes the get_itcp parameters.
Parameter Description
-SAPR3-ACTION
-SAPR3-ACCOUNT
Determines the action of the ctmr3req utility. (get_itcp)
Mandatory.
Defines the name of a specific SAP account. Mandatory. Maximum length: 30 characters.
116
5
Job definition
Chapter
5
A Control-M for SAP is an application plug-in that connects to an SAP server, which enables you to define and monitor SAP jobs. You can define these jobs in the Job Editing Form in Control-M/Desktop.
Control-M for SAP consists of the following three job types:
SAP R3. For more information, see: Defining an SAP R3 job (on page 118 ).
SAP Data Archiving. For more information, see: SAP Data Archiving job definition (on page 121 ).
Control-M for SAP jobs are integrated with other Control-M jobs into a single scheduling environment.
Control-M capabilities are available for Control-M for SAP, including advanced scheduling criteria, complex dependencies, quantitative and control resources, and autoedit variables.
To access the SAP form, see Accessing the SAP forms (on page 117 ).
Job definition parameters in Control-M for SAP enable you to apply values for the autoedit variables, as described in the
Control-M User Guide
. For a list of Control-M for SAP parameters, see Control-M for SAP
Accessing the SAP forms
This procedure describes how to access the SAP R3 form, SAP Business Warehouse form, or SAP Data
Archiving form which enables you to define a SAP job.
To access the SAP form:
1.
2.
Log in to Control-M/Desktop, as described in the
Control-M User Guide
.
From the Edit menu, select New > Job .
3.
From the Job Type drop down list, select one of the following:
SAP R3
SAP Business Warehouse
SAP Data Archiving
4.
Depending on what you selected, click one of the following :
SAP R3
SAP Business Warehouse
SAP Data Archiving
The relevant SAP form appears.
117
Control-M for SAP Administrator Guide
Defining an SAP R3 job
This procedure describes how to define an SAP R3 job.
Before You Begin
Ensure that you have met the following requirements:
A configured SAP account, as described for the Control-M for SAP application plug-in in the Control-M
Configuration Manager Help Account management (on page 35 ).
Successful completion of Accessing the SAP forms (on page 117 )
To define an SAP R3 job:
1.
From the
Job Mode (on page 128 ) drop-down list, select one of the following:
Create - Enables you to schedule a new SAP job in Control-M.
Original - Enables you to schedule a previously defined SAP job in Control-M.
Copy - Enables you to schedule a copy of an SAP job in Control-M for multiple runs of identical jobs.
External - Enables you to schedule an SAP job in Control-M to monitor a job that is currently in
SAP.
Batch Input - Enables you to schedule a pre-defined SAP batch input sessions in Control-M.
2.
For each field type the required value, as described in SAP R3 parameters (on page 126 ).
3.
When you select the job mode, Create, do one or more of the following:
To add a job step, click .
The Add Step -Webpage Dialog box appears.
From the Program Type drop-down list, select one of the following job step types: o
ABAP: For more information, see ABAP parameters (on page 133 ).
o
External Program: For more information, see External Program parameters (on page 154 )
o
External Command: For more information, see External Command parameters (on page 158 ).
4.
Continue to define the job, as described in the
Control-M User Guide
.
SAP Business Warehouse job definition
Control-M for SAP can automate the following Business Warehouse process jobs:
Defining a Process Chain job (on page 119 ): Control-M can be used to schedule, monitor, and
post-process existing Process Chains from SAP-BW. Therefore, you must first create and test the
Process Chains using SAP-BW tools provided by SAP GUI. 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.
118
Control-M for SAP Administrator Guide
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.
The sysout file for Process Chain prints a summary before each section that describes a step. This summary can then be used in On Statement processing. Format:
<step_type>_<status>_<variant> .
EXAMPLE : TRIGGER_FINISHED_START
Defining an InfoPackage job (on page 120 ): To use Control-M to schedule, monitor, and post-process
existing InfoPackages from SAP-BW, 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 creating 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
SAP XT process should be started in order to perform the monitoring.
The Output 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.
Defining a Process Chain job
This procedure describes how to define a Process Chain job for Control-M for SAP Business Warehouse.
Before You Begin
Ensure that you have met the following requirements:
A configured SAP account, as described for the Control-M for SAP application plug-in in the Control-M
Configuration Manager Help Account management (on page 35 ).
Successful completion of Accessing the SAP forms (on page 117 )
To define a Process Chain job:
1.
From the Process Type drop-down list, select Process Chain .
2.
From the Account field, click Load .
The Selector dialog box appears.
3.
Select the account that you want to use to run a process chain job, and click OK .
In the Process Chain Characteristics area, enter the specific Process Chain information or click
Load to generate a list of available Process Chains.
119
Control-M for SAP Administrator Guide
4.
From the ReRun Options drop-down list, select one of the following:
Restart from point of failure
Rerun from start
5.
Click Advanced Options and select one or more of the following:
Enable Periodic Job : Determines whether the first run of the Process Chain prepares for the next run and is useful for reruns when big Process Chains are scheduled
Consider only the overall chain status : Determines whether to view the status of the overall
Process Chain
Retrieve Log : Determines whether to add the Process Chain logs to the job output
6.
Continue to define the job, as described in the
Control-M User Guide
.
Defining an InfoPackage job
This procedure describes how to define an Info Package job for Control-M for SAP Business Warehouse.
Before You Begin
Ensure that you have met the following requirements:
A configured SAP account, as described in Control-M configuration manager administration (on page
Successful completion of Accessing the SAP forms (on page 117 )
To define an InfoPackage job:
1.
From the Process Type drop-down list, select InfoPackage.
2.
From the Account field, click Load .
The Selector dialog box appears.
3.
Select the account that you want to use to run a process chain job, and click OK .
4.
In the InfoPackage Description field do one of the following:
Type the specific InfoPackage and Tech.Name information
Click Load
The Info Package Selector appears, select an Info Package and click OK .
The Info Package and Tech. Name fields are populated.
5.
In the Background Job Name field, type a name for the Info Package Background Job Name.
6.
Continue to define the job, as described in the
Control-M User Guide
.
120
Control-M for SAP Administrator Guide
SAP Data Archiving job definition
Control-M for SAP can automate the following Data Archiving sessions:
Write: The job runs spawns Delete jobs in the SAP system. These Delete jobs then spawn Store
jobs. For more information, see: Creating Data Archiving Write jobs (on page 124 ).
Delete: The Delete jobs that were created by the Write job in SAP are ordered automatically into
Control-M by the Extractor process using this template. For more information, see: Creating a Job
Definition template for Delete jobs (on page 125 ).
Store : The Store jobs that were created by the Delete jobs in SAP are ordered automatically into
Control-M by the Extractor process using this template. For more information, see: Creating a Job
Definition template for Store jobs (on page 124 ).
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.
A sample Data Archiving session, containing all the components described above, is provided in a
Control-M/EM draft file, named Data_Archiving_example_XBP(10/20/30)_800.xml
located in the
<DVD_ROM>\Tools\Data_Archive_Drafts directory. Choose XBP1 draft, XBP2 xml, or XBP3 xml files, according to your Control-M/EM version.
121
Control-M for SAP Administrator Guide
NOTE : The templates for Delete and Store jobs should only be created as templates. Do not order or submit them.
122
Control-M for SAP Administrator Guide
Data archiving sessions
Data Archiving sessions run Data Archiving jobs using Control-M tables. The following table describes data archiving sessions with XBP 1.0, XBP 2.0 and XBP 3.0.
Type of session
Data archiving with
XBP 1.0
Data archiving with
XBP 2.0 and later
Description
A typical Data Archiving session in XBP 1.0 includes a Write job and two Detect jobs, as follows:
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: SAP Data Archiving job definition (on page 121 ).
A typical Data Archiving session with XBP 2.0 or later includes a Write job and two job definition templates, one for Delete jobs and another for Store jobs, as follows:
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: SAP Data Archiving job definition (on page 121 ).
123
Control-M for SAP Administrator Guide
Creating Data Archiving Write jobs
The following procedures describe how to create a job definition for a data archiving write job.
Before You Begin
Ensure that you have met the following requirements:
A configured SAP account, as described for the Control-M for SAP application plug-in in the Control-M
Configuration Manager Help Account management (on page 35 ).
Successful completion of Accessing the SAP forms (on page 117 ).
To create a Data Archiving Write job:
1.
From the Job Mode drop-down list, select Write job.
2.
From the Account field, click Load .
The Account Selection dialog box appears.
3.
Select the account that you want to use, and click OK .
4.
5.
For a description of all Print parameters, see Advanced Options (on page 181 ).
6.
Click Save.
The Write job definition is saved as a template for further SAP Data Write job definitions.
Continue to define the job, as described in the
Control-M User Guide
.
Creating a Job Definition template for Store jobs
This procedure describes how to create a Job Definition template that is used for Store jobs. Store jobs are spawned by Delete jobs.
Before you begin
Ensure that you have met the following requirements:
A configured SAP account, as described for the Control-M for SAP application plug-in in the Control-M
Configuration Manager Help Account management (on page 35 ).
Successful completion of Accessing the SAP forms (on page 117 ).
To create a Data Archiving Write job:
1.
From the Job Mode drop-down list, select Detect store job .
2.
From the Account field, click Load .
The Account Selection dialog box appears.
3.
Select the account that you want to use, and click OK .
4.
Define the parameters for the job definition template for Store jobs as appropriate. For more
information, see: SAP Data Archiving parameters (on page 174 ).
5.
Click Save.
124
Control-M for SAP Administrator Guide
The Store job definition is saved as a template for further SAP Data Archiving job definitions.
Creating a Job Definition template for Delete jobs
This procedure describes how to create a Job Definition template that is used for Delete jobs. The Write job spans jobs that copies data from the SAP database to archive files and spawns the Delete jobs in SAP using the Delete Job Definition template.
Before you begin
Ensure that you have met the following requirements:
A configured SAP account, as described for the Control-M for SAP application plug-in in the Control-M
Configuration Manager Help Account management (on page 35 ).
Successful completion of Accessing the SAP forms (on page 117 )
To create the Job Definition template for Delete jobs:
1.
From the Job Mode drop-down list, select Detect delete job.
2.
From the Account field, click Load .
The Account Selection dialog box appears.
3.
Select the account that you want to use, and click OK .
4.
Define the required parameters for the job definition template for Delete jobs. For more information,
see: SAP Data Archiving parameters (on page 174 ).
5.
Click Save.
The Delete job definition is saved as a template for further SAP Data Archiving job definitions.
Configuring the environment to work with Data Archiving Sessions
This procedure describes how to configure the system environment to use Data Archiving.
To configure the environment to work with Data Archiving Sessions:
1.
Ensure that the Job Interception and Spawned Jobs functionalities are activated in the relevant
SAP system.
2.
Use the Extractor Management utility to set the following priorities for the Extractor process:
Spawned jobs - first priority
Intercepted jobs - second priority
Setting first priority for spawned jobs in the Extractor 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.
125
Control-M for SAP Administrator Guide
3.
Use SAP interception profiles management (on page 62 ) in
Extractor Management (on page 60 )
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:
EXAMPLE : JOB NAME: ARV_EXAMPLE_DEL*
USER NAME: CONTROLM
Control-M for SAP parameters
Job definition parameters in Control-M for SAP enable you to apply values for the AutoEdit variables, as described in the
Control-M User Guide
.
Control-M for SAP contains the following parameter types:
SAP R3 parameters (on page 126 )
SAP Business Warehouse parameters (on page 168 )
SAP Data Archiving parameters (on page 174 )
SAP R3 parameters
The following table describes SAP R3 parameters:
Parameters
Description
Determines the task that the job performs.
Defines the name of the Control-M for SAP account.
Defines the application server on which the job runs.
Defines the name of the job to be monitored or submitted.
Defines the name of the newly created job (in copy mode).
Start Condition (on page 132 )
Specifies whether the job should run with the ASAP option, immediately, or after event.
Defines the job submission priority (in SAP).
Defines a unique SAP job ID number.
Enables you to rerun an SAP R/3 job from its point of failure.
126
Control-M for SAP Administrator Guide
Parameters Description
Defines a read-only field that displays the job steps
(actions) to be performed as part of an SAP job.
Rerun from step (on page 160 )
Enables the rerun an SAP R/3 job from the specified step.
Defines output management for spool and job log.
Defines the job completion status.
Retrieves SAP job Documentation from the Solution
Manager.
Determines the properties of the detected job.
Defines the Batch Input Session Queue ID number.
Specifies a filter for one or more sessions that you can execute, for Batch Input mode when Use Batch Input
Pattern is selected.
Defines the type of the recipient of the print job.
Defines the recipient of the print job.
Indicates whether to detect and monitor jobs that were spawned by the current SAP job.
Determines the properties of the detected job.
Indicates whether to create a new SAP spool.
127
Control-M for SAP Administrator Guide
Job Mode
Determines the task that the job performs.
Usage
Format
Mandatory
Option buttons
Valid Values Valid values for SAP R/3 jobs:
Create - Enables you to schedule a new SAP job in
Control-M. - CREATE
Original - Enables you to schedule a previously defined SAP job in Control-M. - RUN_ORG
Copy - Enables you to schedule a copy of an SAP job in
Control-M for multiple runs of identical jobs.
External - Enables you to schedule an SAP job in Control-M to monitor a job that is currently in SAP.
Valid values for SAP Data Archiving jobs:
Write job - Create and run a Data Archiving Write job
- DA_WRITE
Detect Delete job - Detect a Data Archiving Delete job created in SAP
- DA_DETECTOR
The %%SAPR3-DA_JOB_TYPE parameter should be set to
DELETE.
Detect Store job - Detect a Data Archiving Store job created in
SAP
- DA_DETECTOR
The %%SAPR3-DA_JOB_TYPE parameter should be set to
STORE.
Variable Name %%SAPR3-JOB_MODE
Related Variable %%SAPR3-DA_JOB_TYPE
The Job Mode parameter must be specified for both SAP R/3 jobs and SAP Data Archiving jobs. For
SAP-BW jobs, see SAP-BW Business Process Type (on page 170 ).
128
Control-M for SAP Administrator Guide
Account
Defines the Control-M for SAP account.
Usage
Format
Mandatory
Text box
Length
Case Sensitive
1 - 30 characters
Yes - only capital letters
Invalid Characters Blanks
Variable Name %%SAPR3-ACCOUNT
Job Name
Defines the name of the job to be monitored or submitted. In Batch Input job mode this parameter is called Session Name.
Usage
Format
Mandatory
Text box
Valid Values
Case Sensitive
1-32 characters
No
Invalid Characters None
Variable Name %%SAPR3-JOBNAME
Related Variable %%SAPR3-JOB_COPY_TARGET_VAL
This parameter is mapped to the Job Name parameter.
129
Control-M for SAP Administrator Guide
Exec. Target
Defines the application server on which the job runs. The Target Group parameter can be specified for
SAP R/3 jobs only.
Usage
Availability
Optional
Create, Original, or Copy job mode
Format
Valid Values
Text box
1-20 characters
Case Sensitive Yes
Invalid Characters Blanks
Variable Name %%SAPR3-TARGET_SERVER
Related Parameter %%SAPR3-SERVER_OR_GROUP_TYPE
Valid values are:
G - Group
S - Server
If left unspecified, SAP determines a value for this parameter during runtime.
Not supported in ctmr3req in job define mode (-SAPR3-ACTION job_define).
130
Control-M for SAP Administrator Guide
Job Class
Defines the job submission priority (in SAP). The Job Class parameter can be specified for both SAP R/3 jobs and SAP Data Archiving jobs.
Usage
Availability
Format
Valid Values
Default
Variable Name
XBP Interface
Mandatory
Create job mode
Write job mode in the SAP Data Archiving panel
List
A - most urgent
B - urgent
C - least urgent
For SAP R/3 jobs: C
For SAP Data Archiving jobs: C
%%SAPR3-JOBCLASS
The A and B values of this parameter are only functional in one of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
131
Control-M for SAP Administrator Guide
Start Condition
Specifies whether the job should run with the ASAP option, immediately, or after the event.
Usage
Availability
Format
Valid Values
Default
Optional
Create, Original, or Copy job mode
All job modes in the SAP Data Archiving panel
Option buttons
X - ASAP
N - Immediate
E - After Event
N (Immediate)
Variable Name %%SAPR3-SUBMIT_ASAP
Related Variables %%SAPR3_EVENT_ID, %%SAPR3_EVENT_PARAM
If the ASAP option 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 the Immediate option is selected, the job either runs immediately, or fails in case there are no work processes available to run it.
If the After Event option is selected, the job waits for the event to be triggered.
Rerun from POF (Point of Failure)
Enables you to rerun an SAP R/3 job from its point of failure.
Usage
Availability
Optional
SAP R/3 jobs in Create or Copy mode.
Format
Valid Values
Default
Variable Name
Check box
Y
N
Not checked
%%SAPR3-RERUN_FROM_POF
132
Control-M for SAP Administrator Guide
Notes When a job fails, the number of the failed step is displayed in the first line of the output file. You can use an On statement to reset the failed step value to rerun the job from any step number required.
The failed step number can be reset as follows:
For job mode COPY : Use the autoedit variable:
%%SAPR3-START_STEP
For job mode CREATE : Use the autoedit variable:
%%SAPR3-RERUN_STEP_NUM
The job can also be rerun from a higher or lower step by setting the autoedit variable
SAP-POF_STEP_OFFSET
to a positive or negative number. If the result of the offset is lower than 1, the failed step number is set to 1. If it is higher than the number of job steps, the failed step number is set to the last step.
"+" or "-" values must precede the offset number, for example +4,
-3.
ABAP parameters
The following table describes ABAP parameters.
Parameters
Description
The name of the ABAP program, where ABAP is a language used within the SAP system.
Defines the authorized step owner.
Defines the language of the ABAP step.
Indicates the variant for the specified ABAP program or
Archiving Object.
Specifies temporary variant values for the specified ABAP program.
Specifies a variant value for the specified ABAP program of Archiving Object.
Defines the logical name of the designated printer.
Number of Copies (on page 142 ) Defines the number of copies to be printed.
Determines whether the spool of the step is printed to an output device, to the archive, or both.
133
Control-M for SAP Administrator Guide
Parameters
Description
Indicates when to print the job output.
Print Expiration (on page 143 )
Defines the number of days until a print job expires.
Indicates whether to request a new spool.
Delete After Print (on page 144 ) Indicates whether the report is deleted after printing.
Defines the name of the recipient of the job output.
Defines the Spool department.
Defines the type of cover page for output.
Defines the type of cover page for output.
Indicates whether a cover page should be used.
Defines the spool list name.
Defines the spool list titles.
User with print authorization.
Use ABAP Program Default (on page 166 )
Defines the maximum number of rows per page.
Indicates whether the ABAP program default is used, rather than a number entered in the Rows or Columns box.
Defines the print layout format.
Defines the maximum number of characters in an output line.
SAP ArchiveLink Storage system ID.
A free text description of the archive location.
Defines an archive object type.
Defines an archive object document type.
Information Field (on page 154 ) Defines archive information.
134
Control-M for SAP Administrator Guide
ABAP Program
The name of the ABAP program, where ABAP is a language used within the SAP system.
Usage Mandatory
Availability
Format
Valid Values
Case Sensitive
Add ABAP window in Create job mode
Text box
1-40 characters
Uppercase only
Invalid Characters Special characters not permitted
Blanks permitted
Variable Name %%SAPR3-STEP-S<nn>-PROGRAM
User
Defines the authorized step owner.
Usage
Availability
Format
Optional
Add ABAP window in Create job mode
Add External Program window in Create job mode
Add External Command window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Text box
Valid Values
Case Sensitive
1-12 characters
Uppercase only
Invalid Characters Blanks
Variable Name %%SAPR3-STEP-S<nn>-OWNER
If left unspecified, the value is taken from the Account owner field. Create, apply, and restore keys for job owners credentials using a Blowfish algorithm.
135
Control-M for SAP Administrator Guide
NOTE : The load functionality works only in SAP 6.20 or later, 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.
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 more information, see SAP documentation.
Language
Defines the language of the ABAP step.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Case Sensitive
Text box
1 alphanumeric character
Example: D for German; d for Serbo-Croatian.
Yes
Invalid Characters Blanks
Special characters
Variable Name %%SAPR3-STEP-S<nn>-LANGU
Variant Name
Indicates the variant for the specified ABAP program or Archiving Object.
Usage Optional for SAP R/3 jobs.
Mandatory for SAP Data Archiving Write jobs.
Availability
Format
Valid Values
Add ABAP window in Create job mode
Write job mode in the SAP Data Archiving panel
Text box
1-14 characters
136
Control-M for SAP Administrator Guide
Case Sensitive Uppercase only
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-VAR-NAME
Available for SAP R/3 and SAP Data Archiving jobs.
NOTE : You can 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. 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.
Edit:
Enables you to modify the values of the various variant parameters.
To apply these parameter values click
OK.
To keep the variant’s original parameter values, click
Undo
Changes
.
The changes in the values of the variant parameters are only performed during job run time.
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.
Temporary Variant
Specifies temporary variant values for the specified ABAP program.
Usage
Availability
Format
Optional for SAP R/3 jobs
Add ABAP window in Create job mode
Requires %%SAPR3-STEP-S<yy>-VAR-TYPE to be set to "TMP"
<yy> stands for Step Number (sequential)
<xxx> stands for Variant parameter number (sequential)
Variable Name
Variable Name
Availability
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE
Valid Values:
Simple
Range
Selection
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-VALUE - Specifies the value of the Variant parameter
Only available when
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE is set to “Simple” or “Selection”
137
Variable Name
Availability
Control-M for SAP Administrator Guide
Variable Name
Availability
Variable Name
Availability
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-LOW – Specifies the low value of the Variant parameter
Only available when
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE is set to “Range”
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-HIGH – specifies the high value of the Variant parameter
Only available when
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE is set to “Range”
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-OPTION
Valid Values: When
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE is set to “Range”, valid values are:
BT : Interval
NB : Outside range
Case sensitive
When %%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE is set to
“Selection”, valid values are:
EQ: Single value
NE: Not Equal to
GT: Greater than
LT: Less than
GE: Greater than or Equal to
LE: Less than or equal to
CP: Include pattern
NP: Exclude pattern
Case sensitive
Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to “Range” or “Selection”
138
Control-M for SAP Administrator Guide
Variable Name
Availability
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-SIGN
Valid Values:
I: Include
E: Exclude
Case sensitive
Only available when
%%SAPR3-STEP-S<yy>-VAR-TMP-P<xxx>-TYPE is set to “Range” or “Selection”
Variant Values
Specifies a variant value for the specified ABAP program of Archiving Object. Available for SAP R/3 and
SAP Data Archiving jobs.
Usage
Availability
Format
Variable Name
Variable Name
Optional for SAP R/3 jobs and for SAP Data Archiving Write jobs.
Add ABAP window in Create job mode
Write job mode in the SAP Data Archiving panel
Requires %%SAPR3-STEP-S<nn>-VAR-NAME to be set (Variant name).
<yy> stands for Step Number (sequential)
<xxx> stands for Variant parameter number (sequential)
%%SAPR3-STEP-S<xx>-VAR-P<yyy>-MODIFY
Valid Values:
X: Variant parameter value is modified on the next job run
N: Variant parameter value is not modified on the next job run
Case sensitive
%%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE
Valid Values:
Simple
Range
Selection
Case sensitive
139
Control-M for SAP Administrator Guide
Variable Name
Availability
Variable Name
Availability
Variable Name
Availability
Variable Name
Availability
%%SAPR3-STEP-S<yy>-VAR-P<xxx>-VALUE - Specifies the value of the variant parameter
Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to "Simple" or "Selection"
%%SAPR3-STEP-S<yy>-VAR-P<xxx>-LOW - Specifies the low value of the variant parameter
Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to "Range"
%%SAPR3-STEP-S<yy>-VAR-P<xxx>-HIGH - Specifies the high value of the Variant parameter
Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to "Range"
%%SAPR3-STEP-S<yy>-VAR-P<xxx>-OPTION
Valid Values:
When %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range , valid values are:
BT: Interval
NB: Outside range
Case sensitive
When %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to
Selection , valid values are:
EQ: Single value
NE: Not Equal to
GT: Greater than
LT: Less than
GE: Greater than or Equal to
LE: Less than or equal to
CP: Include pattern
NP: Exclude pattern
Case sensitive
Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to "Range" or "Selection"
140
Control-M for SAP Administrator Guide
Variable Name
Availability
%%SAPR3-STEP-S<yy>-VAR-P<xxx>-SIGN
Valid values:
I: Include
E: Exclude
Case sensitive
Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to "Range" or "Selection"
Output Device
Defines the logical name of the designated printer.
Usage
Availability
Format
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Text box
Valid Values
Case Sensitive
1-4 characters
Uppercase only
Invalid Characters Blanks
Variable Name %%SAPR3-STEP-S<nn>-PRINT_DEST
If the device does not exist, SAP adds a $ sign before the device name.
NOTE : You can click
Load
to generate and display a list of all output devices. The asterisk * can be used as a wildcard to filter the search. The
Load
button only works if you use XBP 2.0 functionality.
141
Control-M for SAP Administrator Guide
Number of Copies
Defines the number of copies to be printed.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Default
Variable Name
Text box
A three-digit integer between 001-255
001
%%SAPR3-STEP-S<nn>-PRINT_COPIES
Print Archive Mode
Determines whether the spool of the step is printed to an output device, to the archive, or both.
Usage Optional
Availability
Format
Valid Values
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
List
Default
Variable Name
PRINT: (Print)
ARCHIVE: (Archive)
PRINT_ARCHIVE: (Print & Archive)
%%SAPR3-STEP-S<nn>-PRINT_ARCHMODE
142
Control-M for SAP Administrator Guide
Time of Print
Indicates when to print the job output.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
List
N : Send to SAP spooler
X : Print out immediately
A : Print later
Send to SAP spooler Default
Variable Name %%SAPR3-STEP-S<nn>-PRINT_IMMED
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 earlier than 6.10, the SAP system uses its default value.
Print Expiration
Defines the number of days until a print job expires.
Usage
Availability
Format
Valid Values
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
List
Default
Variable Name
Single-digit number:
1-8: A specific number of days
9: A special value that signifies Do Not Delete
8
%%SAPR3-STEP-S<nn>-PRINT_EXPIRATION
143
Control-M for SAP Administrator Guide
New Spool Request
Indicates whether to request a new spool.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Default
Variable Name
XBP Interface
Check box
X: (Selected) - request a new spool
N: (Cleared) - do not request a new spool
X (Selected)
%%SAPR3-STEP-S<nn>-NEW_LIST_ID
This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
Delete After Print
Indicates whether the report is deleted after printing.
Usage
Availability
Format
Valid Values
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Check box
Default
Variable Name
X: (Selected) - delete after printing
N: (Cleared) - do not delete after printing
N (Cleared)
%%SAPR3-STEP-S<nn>-PRINT_RELEASE
144
Control-M for SAP Administrator Guide
Recipient
Defines the name of the recipient of the job output.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Text box
1-12 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-PRINT_RECIPIENT
Department
Defines the Spool department.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Text box
1-12 characters
Case Sensitive Yes
Invalid Characters None
Variable Name
XBP Interface
%%SAPR3-STEP-S<nn>-DEPT
This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
145
Control-M for SAP Administrator Guide
SAP Cover Page
Defines the type of cover page for output.
Usage
Availability
Format
Valid Values
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
List
D: (Default Setting) - use the default setting from SAP
X: (Print) - print the cover page
N: (Do Not Print) - do not print the cover page
Default
Variable Name
D
%%SAPR3-STEP-S<nn>-PRINT_BANNER
NOTE : In SAP 4.6D, this parameter can return different values, depending on specific SAP user-definitions. This is a known SAP problem.
OS Cover Sheet
Defines the type of cover page for output.
Usage
Availability
Format
Valid Values
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
List
Default
Variable Name
D : (Default Setting) - use the default setting from SAP
X : (Print) - print the cover page
N : (Do Not Print) - do not print the cover page
D
%%SAPR3-STEP-S<nn>-PRINT_HOST_BANNER
NOTE : In SAP 4.6D, this parameter can return different values, depending on specific SAP user-definitions. This is a known SAP problem.
146
Control-M for SAP Administrator Guide
Selection Cover Page
Indicates whether a cover page should be used.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Default
Variable Name
Check box
X : (Selected) - use cover page
N : (Cleared) - do not use cover page
N (Cleared)
%%SAPR3-STEP-S<nn>-PRINT_BANNER_PAGE
Name
Defines the spool list name.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Case Sensitive
Text box
1-12 characters
Uppercase only
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-LIST_NAME
XBP Interface This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
147
Control-M for SAP Administrator Guide
Titles
Defines the spool list titles.
Usage Optional
Availability Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Text box Format
Valid Values
Case Sensitive
1-68 characters
Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-LIST_TEXT
XBP Interface This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
148
Control-M for SAP Administrator Guide
Authorization
User with print authorization.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Text box
1-12 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-PRINT_AUTH
Rows
Defines the maximum number of rows per page.
Usage
Availability
Mandatory
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Default
Variable Name
Text box and check box
Integer between 1-90
-1 Use ABAP Program Default check box is selected)
Special value indicating that the number of rows is obtained from the ABAP program code.
65
%%SAPR3-STEP-S<nn>-PRINT_NUMLINES
149
Control-M for SAP Administrator Guide
Layout
Defines the print layout format.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Text box
1-16 characters
Case Sensitive Uppercase only
Invalid Characters Blanks
Variable Name %%SAPR3-STEP-S<nn>-PRINT_LAYOUT
XBP Interface This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
NOTE : You can click
Load
to generate and display a list of all layouts. The asterisk * can be used as a wildcard to filter the search. The Load button only works if you use XBP 2.0 functionality.
150
Control-M for SAP Administrator Guide
Columns
Defines the maximum number of characters in an output line.
Usage
Availability
Mandatory
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Format
Valid Values
Default
Variable Name
Text box and check box
Integer. Any value from 1 through 255.
-1 (Use ABAP Program Default check box is selected) Special value indicating that the number of columns is obtained from the ABAP program code.
80
%%SAPR3-STEP-S<nn>-PRINT_NUMCOLUMNS
Archive ID
SAP ArchiveLink Storage system ID.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Only enabled if Print Archive Mode is set to Archive or Print
& Archive
Format Text box
Valid Values
Default
2 characters
ZZ
Case Sensitive Yes
Invalid Characters Only trailing blank spaces permitted
Variable Name %%SAPR3-STEP-S<nn>-ARCH_ID
151
Control-M for SAP Administrator Guide
XBP Interface This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
Archive Text
A free text description of the archive location.
Usage Optional
Availability Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Only enabled if Print Archive Mode is set to Archive or Print
& Archive
Format
Valid Values
Text box
1-40 characters
Case Sensitive Yes
Invalid Characters Blanks
Variable Name
XBP Interface
%%SAPR3-STEP-S<nn>-ARCH_TEXT
This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
152
Control-M for SAP Administrator Guide
Object Type
Defines the archive object type.
Usage
Availability
Format
Valid Values
Case Sensitive
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Only enabled if Print Archive Mode is set to Archive or Print
& Archive
Text box
1-10 characters
Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-ARCHIVE_SAPOBJECT
Document Type
Defines an archive object document type.
Usage
Availability
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Only enabled if Print Archive Mode is set to Archive or Print
& Archive
Format Text box
Valid Values
Case Sensitive
1-10 characters
Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-ARCHIVE_OBJECT
153
Control-M for SAP Administrator Guide
Information Field
Defines archive information.
Usage
Availability
Format
Valid Values
Case Sensitive
Optional
Add ABAP window in Create job mode
Print Parameters window in Write job mode (SAP Data Archiving panel)
Only enabled if Print Archive Mode is set to Archive or Print
& Archive
Text box
1-3 characters
Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-ARCHIVE_INFO
External Program parameters
The following table describes the External Program parameters.
Parameters
Description
Defines the name of the external program.
Defines the authorized step owner.
Defines the parameters for an external program or an external command.
Defines the host computer on which the external program runs.
Indicates whether SAP waits for the external program to end before starting the next step, or before exiting.
Indicates whether SAP logs external output in the job log.
Log External Errors in Joblog (on page 157 )
Indicates whether SAP logs external errors in the job log.
154
Control-M for SAP Administrator Guide
Parameters Description
Activate Traces (on page 158 )
Indicates whether SAP activates traces.
Name
Defines the name of the external program.
Usage
Availability
Format
Valid Values
Case Sensitive
Optional
Add External Program window in Create job mode
Text box
1-128 characters
Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-PROGRAM
Parameters
Defines the parameters for an external program or an external command.
Usage
Availability
Optional
Add External Program and Add External Command windows in
Create job mode
Format
Valid Values
Text box
1-214 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-VAR-NAME
155
Control-M for SAP Administrator Guide
Target Host
Defines the host computer on which the external program runs.
Usage
Availability
Format
Valid Values
Case Sensitive
Mandatory
Add External Program window in Create job mode
Text box
1-32 characters
Yes
Invalid Characters Blanks
Variable Name %%SAPR3-STEP-S<nn>-TARGET_HOST
Job Waiting for External Termination
Indicates whether SAP waits for the external program to end before starting the next step, or before exiting.
Usage
Availability
Optional
Add External Program window or Add External Command window in
Create job mode
Format
Valid Values
Default
Variable Name
Check box
X: (Selected) - wait
N: (Cleared) - do not wait
X (Selected)
%%SAPR3-STEP-S<nn>-WAIT_FOR_TERM
156
Control-M for SAP Administrator Guide
Log External Output to Joblog
Indicates whether SAP logs external output in the joblog.
Usage
Availability
Format
Valid Values
Default
Variable Name
Optional
Add External Program window or Add External Command window in
Create job mode
Check box
X: (Selected) - output written in the log
N: (Cleared) - output not written in the log
X (Selected)
%%SAPR3-STEP-S<nn>-LOG_STDOUT
Log External Errors in Joblog
Indicates whether SAP logs external errors in the joblog.
Usage Optional
Availability
Format
Valid Values
Default
Variable Name
Add External Program window or Add External Command window in
Create job mode
Check box
X: (Selected) - external errors written in the log
N: (Cleared) - external errors not written in the log
X (Selected)
%%SAPR3-STEP-S<nn>-LOG_STDERR
157
Control-M for SAP Administrator Guide
Activate Traces
Indicates whether SAP activates traces.
Usage
Availability
Format
Valid Values
Default
Variable Name
Optional
Add External Program window or Add External Command window in
Create job mode
Check box
X: (Selected) - active
N: (Cleared) - not active
N: (Cleared) - not active
%%SAPR3-STEP-S<nn>-ACTIVATE_TRACE
External Command parameters
The following table describes the External Command parameters.
Parameters
Description
Defines the name of the external program.
Defines the authorized step owner.
Defines the parameters for an external program or an external command.
Defines the application server on which the external command runs.
Operating system (on page 159 ) Indicates the operating system.
Indicates whether SAP waits for the external program to end before starting the next step, or before exiting.
Indicates whether SAP logs external output in the joblog.
Log External Errors in Joblog (on page 157 )
Indicates whether SAP logs external errors in the joblog.
158
Control-M for SAP Administrator Guide
Parameters Description
Activate Traces (on page 158 )
Indicates whether SAP activates traces.
Output Management
Defines output management for spool and job log.
Usage
Format
Optional drop-down menu
Valid Values
Variable Name
Spool:
Don’t Copy
Copy to sysout
Job log:
Don’t Copy
Copy to sysout
%%SAPR3-SPOOL - for spool
%%SAPR3-JOBLOG - for joblog
Operating system
Indicates the operating system.
Availability
Format
Valid Values
Add External command window in Create job mode
List or free text
1-10 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-STEP-S<nn>-OPERSYS
Available for external commands.
159
Control-M for SAP Administrator Guide
Rerun from step
Enables the rerun an SAP R/3 job from the specified step.
Usage
Availability
Optional
SAP-R/3 jobs in Create mode
Format
Valid Values
Default
Option buttons
Integers
1
Detect Spawned Jobs
Indicates whether to detect and monitor jobs that were spawned by the current SAP job. A spawned job is a job created by another (parent) job, and monitored by Control-M.
Usage
Format
Valid Values
Optional
Option buttons and text box, and a read-only check box
For %%SAPR3-DETECT_OPTION
1: (No Detection Needed)
2: (Parent (current) Job definition)
3: (A specific Job definition)
For %%SAPR3-DETECT_CHILD_JOBNAME
Name of the parent job (for option 2)
Name of the specific job (for option 3)
For %%SAPR3-DETECT_CHILD_TABLE
Name of the table in which the parent exists
For option 2 or 3 always set the value
%%SCHEDTAB
For %%SAPR3-GROUP_ORDID
The Order ID of the table
For option 2 or 3 always set the value %%GROUP_ORDID
For %%SAPR3-DETECT_CHILD_RELEASE
Specify whether to start spawned jobs that have a status of
Scheduled.
160
Control-M for SAP Administrator Guide
For option 2 or 3, set the following values:
Y - Start Spawned Jobs
N - Do not start Spawned Jobs
Variable Names %%SAPR3-DETECT_OPTION
%%SAPR3-DETECT_CHILD_JOBNAME
%%SAPR3-DETECT_CHILD_RELEASE
%%SAPR3-DETECT_CHILD_TABLE
Related Variable %%SAPR3-GROUP_ORDID
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 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 specified (not the current) job.
NOTE : The specified job must exist in the same folder as the current job.
161
Control-M for SAP Administrator Guide
Detect and Create By
Determines the properties of the detected job.
Usage
Default
Optional
Parent [current] Job definition
Valid Values
Variable Names
2 : Parent [current] Job definition
3 : A specific job definition
%%SAPR3-DETECT_OPTION
Recipient Name
Defines the recipient of the print job.
Usage
Availability
Format
Valid Values
Optional
Create job mode
Name - 214 characters
Any string value, up to 214 characters
Variable Name
Related
Parameters
%%SAPR3_RECIPIENT
%%SAPR3_RECIP_TYPE
%%SAPR3_RECIP_COPY
%%SAPR3_RECIP_BLIND_COPY
%%SAPR3_RECIP_EXPRESS
%%SAPR3_RECIP_NO_FORWARDING
162
Control-M for SAP Administrator Guide
Recipient Type
Defines the type of the recipient of the print job
Usage
Availability
Optional
Create job mode
Format
Valid Values
Variable Name
Related
Parameters
Type - List of single characters
A - External
B - Username
C - Shared distribution
P - Private distribution
%%SAPR3_RECIP_TYPE
%%SAPR3_RECIPIENT
%%SAPR3_RECIP_COPY
%%SAPR3_RECIP_BLIND_COPY
%%SAPR3_RECIP_EXPRESS
%%SAPR3_RECIP_NO_FORWARDING
163
Control-M for SAP Administrator Guide
Job Count
Defines a unique SAP job ID number. In the SAP-BW panel, the Info Package Job Count parameter is relevant only in Active Job Mode, after job submission.
Usage
Availability
Mandatory
Copy, Original, or External job mode
Format List for special values
Text box for digits
Valid Values For %%SAPR3-JOB_COUNT:
Job count of a specific job
- Specific_Job
If this value is set, the value for %%SAPR3-JOBCOUNT must be an
8-digit number.
Special values:
FIRST
FIRST_SCHEDULED
LAST
LAST_SCHEDULED
For %%SAPR3-JOBCOUNT:
Job count of a specific job
- An 8-digit number
Only if Specific_Job is set for the value of %%SAPR3-JOB_COUNT
Special values:
The same special value set for %%SAPR3-JOB_COUNT
Note :
In Copy job mode, these parameters can be set for either a specific job, or as one of the special values.
In Original job mode, these parameters can be set for either a specific job, or as either the FIRST_SCHEDULED or
LAST_SCHEDULED special values.
In External job mode , only a specific job can be set.
Variable Names %%SAPR3-JOB_COUNT
%%SAPR3-JOBCOUNT
164
Control-M for SAP Administrator Guide
New Job Name
Defines the name of the newly created job (in copy mode).
Usage
Format
Optional
Text box
Valid Values
Variable Name
1-32 characters
%%SAPR3-JOB_COPY_TARGET_VAL
View Job Steps
Defines a read-only field that displays the job steps (actions) to be performed as part of an SAP job.
Usage Read-only
Availability
Format
Valid Values
Create job mode
Read-only text list
You can specify any number of steps from 1 through 99 steps
ABAP Program - Add an ABAP program
External command - Add an external command
External Program - Add an external program
No Case Sensitive
Invalid Characters Blanks
Related Variables All step parameters must use the following prefix:
%%SAPR3-STEP-S<nn>-
When the specified Job Mode is Create, at least one step must be specified in an SAP job definition. This job definition can consist of one or more ABAP program steps, or External program steps, or both.
In the Variables given for each of the Add ABAP Window parameter descriptions in this section, S<nn> represents a logical number between S01 and S99.
165
Control-M for SAP Administrator Guide
Use ABAP Program Default
Indicates whether the ABAP program default is used, rather than a number entered in the Rows or
Columns box.
Related parameters:
If selected, the Rows box is not available. If not selected, enter a number in the Rows box.
If selected, the Columns box is not available. If not selected, enter a number in the Columns box.
View SAP Job Documentation
Job documentation is retrieved only if the jobs exists in SAP Solution Manager or if jobs where imported to the SAP Solution Manager from another system. The job names in the Solution Manager are unique to avoid different job documentations for the same job name.
The View SAP job Documentation button is enabled only if the Job Name field is not empty and when Job Mode is set to Create , Original , or Copy .
When creating an account, ensure that Solution Manager account is selected.
Related parameters:
The job mode must be one of the following types: Create, Original, or Copy.
A job name must be specified.
QID
Defines the Batch Input Session Queue ID number.
Usage
Availability
Optional
Batch Input job mode
Format
Valid Values
Text box
20-digit number
Variable Name %%SAPR3-QID
Batch Input jobs that are deleted after they run are not monitored. The status of jobs marked for deletion is not displayed. If left unspecified, the oldest defined session is scheduled.
166
Control-M for SAP Administrator Guide
Pattern
Specifies a filter for one or more sessions that you can execute, for Batch Input mode when Use Batch
Input Pattern is selected.
Usage
Availability
Format
Optional
Batch Input job mode
Text box
Valid values
Variable Name
The following wildcards:
"?" – any single character
"*" – any characters
%%SAPR3- BI_PATTERN_NAME
Session Name
Determines the properties of the detected job.
Usage
Default
Optional
N/A
Valid Values 1-12 characters
Variable Names %%SAPR3-JOBNAME
167
Control-M for SAP Administrator Guide
SAP Spool Recipient Attribute
Indicates whether to create a new SAP spool.
Usage
Availability
Format
Valid Values
Optional
This parameter should be specified 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 table.
This parameter should not be specified if the Write job and the
Detect job are part of the same table.
Delete or Store job mode in the SAP Data Archiving panel
Text box
6-digit number
Variable Name %%SAPR3-DA_SESSION_NUMBER
SAP Business Warehouse parameters
The following table describes the External Command parameters.
Parameters
Process Chain Description (on page 171 )
Description
Defines the name of the Control-M for SAP account.
Describes a Process Chain.
Process Chain ID (on page 171 ) Defines a unique BW-generated ID of a Process Chain.
Determines the task that the job performs.
Defines a description of the InfoPackage.
InfoPackage Description (on page 172 )
InfoPackage Tech. Name (on page 173 )
Defines a unique BW-generated InfoPackage ID.
Name of the InfoPackage background job name.
168
Control-M for SAP Administrator Guide
Parameters
Description
Indicates how the Process Chain should be rerun, if an
SAP-BW job fails.
Defines a unique BW-generated ID for the Process Chain running session.
Defines a unique SAP job ID number.
InfoPackage RNR (on page 173 ) Defines a unique BW-generated ID for the InfoPackage's
running session.
Rerun Options
Indicates how the Process Chain should be rerun, if an SAP-BW job fails.
Usage
Availability
Format
Valid Values
Default
Mandatory
When SAP-BW Business Process Type is set to Process Chain, in Active mode, and the job is in Hold status ("Zoom and Save" action)
Option buttons
Restart from point of failure
Rerun from start
Restart from point of failure
169
Control-M for SAP Administrator Guide
Background Job Name
Name of the InfoPackage background job name.
Usage
Availability
Optional
InfoPackage SAP-BW Business Process Type
Format
Valid Values
Text box
1-25 characters
NOTE : The BI_BTCH prefix is automatically added to the beginning of the job name in SAP-BW.
If no value is entered, SAP-BW generates a name for the background job
Case Sensitive No
Invalid
Characters
None
Variable Name %%SAPR3-BACKJOBNAME
SAP-BW Business Process Type
Determines the task that the job performs.
Usage
Format
Valid Values
Default
Variable Name
Mandatory
Option buttons
PC_RUN_ORG (Process Chain)
IP_RUN_ORG (InfoPackage)
IP_RUN_ORG (InfoPackage)
%%SAPR3-JOB_MODE
170
Control-M for SAP Administrator Guide
Process Chain Description
Describes a Process Chain.
Usage
Availability
Optional
Process Chain SAP-BW Business Process Type
Format
Valid Values
Text box
1-60 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-ProcessChain_Desc
Process Chain ID
Defines a unique BW-generated ID of a Process Chain.
Usage Mandatory
Availability
Format
Valid Values
Case Sensitive
Process Chain SAP-BW Business Process Type
Text box
30 characters
Uppercase only
Invalid Characters Blanks
Variable Name %%SAPR3-ProcessChain_ID
171
Control-M for SAP Administrator Guide
Process Chain Log ID
Defines a unique BW-generated ID for the Process Chain running session.
Relevant only in Active Job Mode, after job submission.
Usage
Availability
Read-only.
Process Chain SAP-BW Business Process Type
Format
Variable Name
Read-only text box
%%SAPR3-ProcessChain_LogID
InfoPackage Description
Defines a description of the InfoPackage.
Usage
Availability
Format
Valid Values
Mandatory
InfoPackage SAP-BW Business Process Type
Text box
1-60 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-InfoPackage_Desc
172
Control-M for SAP Administrator Guide
InfoPackage RNR
Defines a unique BW-generated ID for the InfoPackage's running session.
Relevant only in Active Job Mode, after job submission.
Usage
Availability
Read-only
InfoPackage SAP-BW Business Process Type
Format
Variable Name
Read-only text box
%%SAPR3-InfoPackage_RNR
InfoPackage Tech. Name
Defines a unique BW-generated InfoPackage ID.
Usage
Availability
Format
Valid Values
Mandatory
InfoPackage SAP-BW Business Process Type
Text box
30 characters
Case Sensitive Yes
Invalid Characters None
Variable Name %%SAPR3-InfoPackage_TechName
173
Control-M for SAP Administrator Guide
SAP Data Archiving parameters
The following table describes the External Command parameters.
Parameters
Description
Determines the task that the job performs.
Defines the name of the Control-M for SAP account.
Archiving Object (on page 176 ) The name of the archiving object in SAP Data Archiving
jobs.
Defines the name of the job to be monitored or submitted.
Defines the application server on which the external command runs.
Indicates the archiving session number in SAP.
Indicates the variant for the specified ABAP program or
Archiving Object.
Advanced Options (on page 181 ) Defines printer parameters for an SAP Data Archiving job.
Specifies a variant value for the specified ABAP program of Archiving Object.
Defines whether to check for an incomplete archiving session for a specific archiving object. An incomplete archiving session is one for which not all Delete jobs ended successfully.
Start Condition (on page 132 )
Defines whether to check for a Write job that exists with the specific variant for the archiving object defined for this job.
Specifies whether the job should run with the ASAP option, immediately, or after event.
Defines the job submission priority (in SAP).
Indicates whether to detect and monitor jobs that were spawned by the current SAP job.
Determines the properties of the detected job.
174
Control-M for SAP Administrator Guide
Parameters
Description
Defines the template for new created detected SAP type jobs. The selected job must exist in the same folder as the current job.
Defines the name and path of the file to which the spool should be copied.
Defines the job completion status.
Indicate the nature of the SAP job in Active job mode
(Read-only fields)
Defines the type of step to be performed.
Job Name
Defines the name of the job to be monitored or submitted. In Bach Input mode this parameter is called
Session Name.
Usage
Format
Valid Values
Case Sensitive
Optional
Text box
1-32 characters
No
Invalid Characters None
Variable Name %%SAPR3-DETECT_CHILD_JOBNAME
Related Variable %%SAPR3-GROUP-ORDID
175
Control-M for SAP Administrator Guide
Archiving Object
The name of the archiving object in SAP Data Archiving jobs.
Usage
Format
Mandatory
Text box
Valid Values
Case Sensitive
1-10 characters
Uppercase only
Invalid Characters Blanks
Variable Name %%SAPR3-DA_ARC_OBJ
The Archiving Object parameter is only relevant for SAP Data Archiving jobs.
Check Sessions
Defines whether to check for an incomplete archiving session for a specific archiving object. An incomplete archiving session is one for which not all Delete jobs ended successfully.
Usage
Availability
Optional
Write job mode in the SAP Data Archiving panel
Format
Valid Values
Check box
X: (Selected) - perform a check
N: (Cleared) - do not perform a check
N (Cleared) Default
Variable Name %%SAPR3-DA_CHECK_SESSIONS
If an incomplete archiving session is found, a message is displayed, and a Data Archiving write job is not created.
The Check Sessions parameter is only relevant for SAP Data Archiving jobs.
176
Control-M for SAP Administrator Guide
Check Variant
Defines whether to check for a Write job that exists with the specific variant for the archiving object defined for this job.
Usage
Availability
Optional
Write job mode in the SAP Data Archiving panel
Format
Valid Values
Check box
X: (Selected) - perform a check
N: (Cleared) - do not perform a check
Default
Variable Name
N (Cleared)
%%SAPR3-DA_CHECK_VARIANT
If such a Write job is found, a message is displayed, and a new Write job is not created.
The Check Variant parameter is only relevant for SAP Data Archiving jobs.
177
Control-M for SAP Administrator Guide
Event Parameter
The following table lists languages that are compatible with Control-M for SAP.
Languages
Basic ASCII
Level of support
US English
W. European (Latin-1 character set)
Defines special Western European characters used in
English, Spanish, German, and French in most free-text fields and parameters.
Some compatibility requirements might have changed since Control-M for SAP version 8.0.00 was released. For the most current compatibility information, see http://webapps.bmc.com/paczos/faces/pac/index.jsp
.
Usage
Availability
Format
Valid Values
Optional
Create job mode when the "start after event" start condition is selected.
Text box
1-64 characters
Related Parameter %%SAPR3-EVENT_ID
Variable Name %%SAPR3-EVENT_PARAM
178
Control-M for SAP Administrator Guide
Target Server
Defines the application server on which the external command runs.
The Target Server parameter can be specified for both SAP R/3 jobs and SAP Data Archiving jobs.
Usage
Availability
Optional
Create, Original, Copy, or Batch Input job mode
All job modes in the SAP Data Archiving panel
Text box Format
Valid Values 1-20 characters
The following (full) format must be used: hostname_SYSID_sysnumber
Case Sensitive Yes
Invalid Characters Blanks
Variable Name %%SAPR3-TARGET_SERVER
Related Parameter %%SAPR3-SERVER_OR_GROUP_TYPE
Valid values are:
G - Group
S - Server
If left unspecified, SAP determines a value for this parameter during runtime.
Not supported in ctmr3req in job define mode (-SAPR3-ACTION job_define).
179
Control-M for SAP Administrator Guide
Session Number
Indicates the archiving session number in SAP.
Usage
Availability
Format
Valid Values
Optional
This parameter should be specified 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 table.
This parameter should not be specified if the Write job and the
Detect job are part of the same table.
Delete or Store job mode in the SAP Data Archiving panel
Text box
6-digit number
Variable Name %%SAPR3-DA_SESSION_NUMBER
Job Name
Defines the template for new created detected SAP type jobs. The selected job must exist in the same folder as the current job.
Usage Optional
Format
Valid Values
Text box
1-32 characters
Case Sensitive No
Invalid Characters None
Variable Name %%SAPR3-DETECT_CHILD_JOBNAME
Related Variable %%SAPR3-GROUP-ORDID
180
Control-M for SAP Administrator Guide
Advanced Options
The following table describes the Advanced Options for an SAP Data Archiving job.
Parameters
Description
Defines the template for new created detected SAP type jobs. The selected job must exist in the same folder as the current job.
Defines the authorized step owner.
Indicates the variant for the specified ABAP program or
Archiving Object.
Defines the language of the ABAP step.
Defines the logical name of the designated printer.
Number of Copies (on page 142 ) Defines the number of copies to be printed.
Determines whether the spool of the step is printed to an output device, to the archive, or both.
Indicates when to print the job output.
Print Expiration (on page 143 )
Defines the number of days until a print job expires.
Indicates whether to request a new spool.
Delete After Print (on page 144 ) Indicates whether the report is deleted after printing.
SAP ArchiveLink Storage system ID.
A free text description of the archive location.
Defines an archive object type.
Defines an archive object document type.
Information Field (on page 154 ) Defines archive information.
Defines the spool list name.
Defines the spool list titles.
User with print authorization.
181
Control-M for SAP Administrator Guide
Parameters
Use ABAP Program Default page 166 )
Description
Defines the maximum number of rows per page.
Defines the maximum number of characters in an output line.
Indicates whether the ABAP program default is used, rather than a number entered in the Rows or Columns box.
Defines the print layout format.
Defines the name of the recipient of the job output.
Defines the Spool department.
Defines the type of cover page for output.
Defines the type of cover page for output.
Indicates whether a cover page should be used.
Copy Spool To
Defines the name and path of the file to which the spool should be copied.
Usage Optional
Format
Valid Values
Text box
1-214 characters
Case Sensitive Yes
Invalid Characters Blanks
Variable Name %%SAPR3-SPOOL
The Copy Spool To parameter can be specified only for SAP Data Archiving jobs.
NOTE : If *OUTPUT is specified, the spool is copied into the job OUTPUT.
182
Control-M for SAP Administrator Guide
Job Status
Defines the job completion status.
Usage
Format
Optional check box
Valid Values Select for job completion status to depend on the application status
Job Type
Indicate the nature of the SAP job in Active job mode (Read-only fields).
The type is indicated by the check boxes that are selected. Only relevant for jobs extracted by the
Extractor process.
Usage Mandatory
Availability
Format
Valid Values
XBP Interface
Active job mode
Check boxes and text boxes
Extracted: An SAP job extracted from SAP to Control-M by the
Extractor process for monitoring and managing purposes
Intercepted: A job that was intercepted by SAP, extracted to
Control-M by the Extractor process, activated by Control-M 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 Extractor 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.
This parameter is functional in any of the following XBP interfaces:
XBP 3.0
XBP 2.0
XBP 1.0 with Control-M Function Modules installed (when Use
Extended is selected)
183
Control-M for SAP Administrator Guide
Step Type
Defines the type of step to be performed.
Usage
Length
Optional.
1 character. Valid values:
A: ABAP program step
C: External Command step
E: External Program step
F: Fax Number
L: Telex Number
U: Internet Address
X: X.400 Address
R: Remote Mail Address
Uppercase only. Case-Sensitive
Variable Name %%SAPR3_STEP-S<nn>-STEP_TYPE
The variable described above must be specified for every single step in a job.
184
Pakua
Kiungo cha umma kime sasishwa
Kiungo cha umma kwa mazungumzo yako kimesasishwa. You may view and manage your chat links after registration here.
Kiungo cha umma cha hati
Tangazo
