Requesting SAP actions
Requesting SAP actions
The CONTROL-M/CM for SAP Request utility (ctmr3req) can be used to request that
SAP perform certain actions, using information from the SAP database. The ctmr3req utility can request that SAP perform the following actions:
■
Display a list of defined variants for a specific program, as described on
page 140
.
■
Alter the value of a specific variant in a program, as described on
page 141 .
■
Display the details of a specific variant, as described on page 143 .
■
Enable a SAP background processing event to be raised (triggered), as described
on page 144 .
■
Delete a job from the SAP database, as described on
page 145
.
■
Define a new job, as described on
page 146 .
■
Modify an existing job, as described on
page 147 .
■
Remove process chain from schedule on
page 149 .
NOTE
This utility can be used within ctmcreate or ctmdefine. However if it is used this way, the command is limited to 512 characters.
Displaying a list of variants for a program
Use this procedure to request that SAP display a list of defined variants for a specific
ABAP program.
(The program is set in the SAPR3-PROGRAM parameter.)
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
140 CONTROL-M/Control Module for SAP Administrator Guide
Altering parameter values in a variant
To display a list of variants
Enter the following command, with the parameters set according to the values
described in Table 26 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION var_mon -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_mon
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name> [-Agent
<agent_name>]
Table 26 Parameters for var_mon action
Parameter
SAPR3-ACTION
SAPR3-ACCOUNT
SAPR3-PROGRAM
Description
The action that classifies the nature of this version of the
ctmr3req
utility. (var_mon) Mandatory.
Name of a specific SAP account. Mandatory. Maximum length: 30 characters.
Name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
Below is an example of the ctmr3req utility when used to display a list of variants, using the DGOLDHAD account, for the prog1 program:
D:\Program files\BMC Software\CONTROL-M aGENT\David\ctmr3req
-SAPR3-ACTION var_mon -SAPR3-ACCOUNT DGOLDHAD -SAPR3-PROGRAM prog1
-Agent Default
Altering parameter values in a variant
Use this procedure to alter the value of set parameters in a variant.
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
Chapter 4 Administrator tasks 141
Altering parameter values in a variant
To alter parameter values
Enter the following command, with the parameters set according to the values
described in Table 27 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION var_edit -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> -SAPR3-VAR <variant_name>
-SAPR3-VAR_PARAM<nnn>
“<variant_parameter_name>=<variant_parameter_value> [-SAPR3-VAR_TEXT
“<variant_text>”] on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_edit
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
-SAPR3-VAR <variant_name> -SAPR3-VAR_PARAM<nnn>
“<variant_parameter_name>=<variant_parameter_value> [-SAPR3-VAR_TEXT
“<variant_text>”] [-Agent <agent_name>]
Table 27 Parameters for var_edit action
Parameter
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
-SAPR3-VAR
-SAPR3-VAR_PARAM<nnn>
Value
Action that classifies the nature of this version of the
ctmr3req
utility. (var_edit) Mandatory.
Name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
This parameter specifies the name of the variant for a specific program in SAP. Mandatory.
The parameter of the variant. Mandatory.
-SAPR3-VAR_TEXT nnn is a three-digit number that represents the parameter count number.
Description of the variant. Optional
In the following example, the ctmr3req utility is used to alter parameter values, using the DGOLDHAD account, for the prog1 program, with the var1 variant, when the Airline value is an integer between 5 and 9, and the text is “This is a test
variant
”. All parameters are mandatory, except the -SAPR3-VAR_TEXT parameter, as indicated by the square brackets.
ctmr3req -SAPR3-ACTION var_edit -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-PROGRAM prog1 -SAPR3-VAR var1 -SAPR3-VAR_PARAM001
"AIRLINE=I,BT,5 => 9" [-SAPR3-VAR_TEXT "This is a test var"]
142 CONTROL-M/Control Module for SAP Administrator Guide
Displaying variant details within a program
Displaying variant details within a program
Use this procedure to display the details of a specific variant within a program.
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To display variant details in a program
Enter the following command, with the parameters set according to the values
described in Table 28 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION var_show -SAPR3-ACCOUNT <account_name>
-SAPR3-PROGRAM <program_name> -SAPR3-VAR <variant_name> on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION var_show
-SAPR3-ACCOUNT <account_name> -SAPR3-PROGRAM <program_name>
-SAPR3-VAR <variant_name> [-Agent <agent_name>]
Table 28 Parameters for var_show action
Parameter
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-PROGRAM
-SAPR3-VAR
Description
Action that classifies the nature of this version of the ctmr3req utility. (var_show) Mandatory.
Name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Name of the ABAP program in SAP, if such a program has been indicated. Mandatory.
The variant of the SAP program. Mandatory.
In the following example, the ctmr3req utility is used to display variant details in a program, searching for var1 variants, using the DGOLDHAD account, for the
RSAAA02
program. All parameters are mandatory.
ctmr3req -SAPR3-ACTION var_show -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-PROGRAM prog1 -SAPR3-VAR var1
Chapter 4 Administrator tasks 143
Raising a SAP event
Raising a SAP event
Use this procedure to enable a specific SAP background processing event to be raised
(triggered).
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To raise a SAP event
Enter the following command, with the parameters set according to the values
described in Table 29 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION raise_event -SAPR3-ACCOUNT <account_name>
-SAPR3-EVENT_ID <event_ID> -SAPR3-EVENT_PARAM <event_parameter> on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION raise_event
-SAPR3-ACCOUNT <account_name> -SAPR3-EVENT_ID <event_ID>
-SAPR3-EVENT_PARAM <event_parameter> [-Agent <agent_name>]
Table 29 Parameters for raise_event action
Parameter
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-EVENT_ID
-SAPR3-EVENT_PARAM
Description
Action that classifies the nature of this version of the
ctmr3req
utility. (raise_event) Mandatory.
Name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Name of SAP background processing event Mandatory.
Additional parameters for a SAP background processing event. Optional.
In the following example, the ctmr3req utility is used to raise the ev1 event, with the parameter value of evparm1, using the DGOLDHAD account. All parameters are mandatory.
ctmr3req -SAPR3-ACTION raise_event -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-EVENT_ID ev1 -SAPR3-EVENT_PARAM evparm1
144 CONTROL-M/Control Module for SAP Administrator Guide
Deleting a job
Deleting a job
Use this procedure to delete a specific job from the SAP database.
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To delete a job
Enter the following command, with the parameters set according to the values
described in Table 30 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION job_delete -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-JOBCOUNT <job_count> on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION job_delete
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBNAME <job_name>
-SAPR3-JOBCOUNT <job_count> [-Agent <agent_name>]
Table 30 Parameters for job_delete action
Parameter
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-JOBCOUNT
Description
Action that classifies the nature of this version of the
ctmr3req
utility. (job_delete) Mandatory.
Name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Job name in SAP to be deleted. Mandatory.
Unique ID number for the job in SAP. Mandatory
In the following example, the ctmr3req utility is used to delete a job. All parameters are mandatory.
ctmr3req -SAPR3-ACTION job_delete -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-JOBNAME job1 -SAPR3-JOBCOUNT 12344321
Chapter 4 Administrator tasks 145
Defining a new job
Defining a new job
Use this procedure to define a new job in SAP database.
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To define a job
Enter the following command, with the parameters set according to the values
described in Table 31 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION job_define -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E}
-SAPR3-STEP-S<nn>-PROGRAM <program_name> on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION job_define
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBNAME <job_name>
-SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E} -SAPR3-STEP-S<nn>-PROGRAM
<program_name> [-Agent <agent_name>]
NOTE
The remainder of the syntax for this action depends on the value of the
-SAPR3-STEP-S<nn>-STEP_TYPE
parameter, and subsequent parameter values.
Table 31 Parameters for job_define action (Part 1 of 2)
Parameter
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
Description
Action that classifies the nature of this version of the
ctmr3req
utility. (job_define) Mandatory.
Name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Job name in SAP to be defined. Mandatory.
146 CONTROL-M/Control Module for SAP Administrator Guide
Modifying a job
Table 31 Parameters for job_define action (Part 2 of 2)
Parameter
-SAPR3-STEP-S<nn>-
STEP_TYPE
Description
Step type. Mandatory.
Valid values are:
■
A
= ABAP program
■
■
C
= External command
E
= External program
-SAPR3-STEP-S<nn>-
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.
NOTE
The Target Group and Target Server parameters are not supported by the
ctmr3req
utility in job define mode.
For information about additional parameters for use when defining a new job, see the
CONTROL-M Parameters and Variables Reference Guide.
In the following example, the ctmr3req utility is used to define a new job. The first five parameters are mandatory, including -SAPR3-STEP-S01-STEP_TYPE. The following step types can be selected:
■
■
■
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 DGOLDHAD
-SAPR3-JOBNAME job1 -SAPR3-STEP-S01-STEP_TYPE A
-SAPR3-STEP-S01-PROGRAM ZQA_WITH_VARIANTS -SAPR3-STEP-S01-VAR-NAME
MOMO -SAPR3-STEP-S01-PRINT_COPIES 030
Modifying a job
Use this procedure to modify an existing job in the SAP database.
Chapter 4 Administrator tasks 147
Modifying a job
Before you begin
■
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
To modify a job
The procedure for modifying an existing job using the ctmr3req utility is very similar to the procedure for defining a new job using this utility.
Enter the following command, with the parameters set according to the values
described in Table 32 , and press <Enter>.
on Unix ctmr3req -SAPR3-ACTION job_modify -SAPR3-ACCOUNT <account_name>
-SAPR3-JOBNAME <job_name> -SAPR3-JOBCOUNT <job_count>
-SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E} -SAPR3-STEP-S<nn>-PROGRAM
<program_name> on Windows
<Agent home directory>\CM\SAP\EXE\ctmr3req -SAPR3-ACTION job_modify
-SAPR3-ACCOUNT <account_name> -SAPR3-JOBNAME <job_name>
-SAPR3-JOBCOUNT <job_count> -SAPR3-STEP-S<nn>-STEP_TYPE {A|C|E}
-SAPR3-STEP-S<nn>-PROGRAM <program_name> [-Agent <agent_name>]
NOTE
The remainder of the syntax for this action depends on the value of the
-SAPR3-STEP-S<nn>-STEP_TYPE
parameter, and subsequent parameter values.
Table 32 Parameters for job_modify action (Part 1 of 2)
Parameter
-SAPR3-ACTION
-SAPR3-ACCOUNT
-SAPR3-JOBNAME
-SAPR3-JOBCOUNT
Description
Action that classifies the nature of this version of the
ctmr3req
utility. (job_modify) Mandatory.
Name of a specific SAP account. Maximum length: 30 characters. Mandatory.
Job name in SAP to be modified. Mandatory.
Unique ID number for the job in SAP. Mandatory.
148 CONTROL-M/Control Module for SAP Administrator Guide
Modifying a job
Table 32 Parameters for job_modify action (Part 2 of 2)
Parameter
-SAPR3-STEP-S<nn>-
STEP_TYPE
Description
Step type. Mandatory.
Valid values are:
-SAPR3-STEP-S<nn>-
PROGRAM
■
■
■
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.
NOTE
For information about additional parameters for use when defining a new job, see the
CONTROL-M Parameters and Variables Reference Guide.
In the following example, the ctmr3req utility is used to modify an existing job. As with the procedure for defining a new job (see
page 146 ), the first five parameters
are mandatory. In this example, the second step is being modified. Even if the step type is the same as it was previously, it must still be set in the utility. ctmr3req -SAPR3-ACTION job_modify -SAPR3-ACCOUNT DGOLDHAD
-SAPR3-JOBNAME job1 -SAPR3-JOBCOUNT 13292201
-SAPR3-STEP-S02-STEP_TYPE A -SAPR3-STEP-S02-PROGRAM
ZQA_WITH_VARIANTS -SAPR3-STEP-S02-VAR-NAME KUKU
Interrupts - Removing a process chain from schedule
To remove a process chain from schedule, use the following procedure:
Before you begin
■
If you are working in a Microsoft Windows environment, open a new DOS prompt window.
■
If you are working in a Unix environment, ensure that you are logged in as the
CONTROL-M/Agent user.
Chapter 4 Administrator tasks 149
