Defining the local options

r3batch local configuration options lists the options that you can specify only in the local configuration files.
Table 1. r3batch local configuration options
Option Description
bapi_sync_level (Optional) Specifies the synchronization level between the SAP function modules BAPI_XBP_JOB_COPY and BAPI_XBP_JOB_START_ASAP. Allowed values are:
high
All RFC calls between BAPI_XBP_JOB_START_ASAP and BAPI_XBP_JOB_COPY are synchronized. This is the default.
medium
The RFC calls to BAPI_XBP_JOB_START_ASAP are synchronized.
low
The RFC calls are not synchronized.
blank_libpath (Optional) Clears (ON) the operating system variables LD_LIBRARY_PATH and LIBPATH. The default value is OFF.
fn_cache_enabled (Optional) Enables or disables the file cache on the agent. Can be ON (default value).
fn_cache_purge_interval (Optional) Specifies the time of validity (in days) of the cached files. If it is left unspecified or set equal to or less than 0, the files are valid indefinitely.
get_job_status_retry (Optional) Sets the number of times a Remote Function Call must be attempted to retrieve the actual status of an SAP Job. Allowed values are in the range from 1 to 9999. The default value is 5.
get_job_status_retry_delay (Optional) Sets the number of seconds between two consecutive calls of a Remote Function Call. Allowed values are in the range from 1 to 9999.
job_duration (Optional) Enables (ON) that the CPU time value in the production plan report that is run from the Dynamic Workload Console is set to the actual duration of the SAP job. Default value is OFF.
To retrieve the job duration from the SAP system, ensure that the authorization profile contains the following authorization objects:
  • S_DEVELOP
  • S_TCODE with parameter SE38 (only for SAP 6.40 and 7.00)

For details about the authorization profile, see Creating the authorization profile for the HCL Workload Automation user.
max_jobs_to_release_for_user Defines the maximum number of jobs released for each user each time the release job is submitted. If this option is less than or equal to 0, the option is ignored and all jobs are released when the release job is submitted. This option is present both in global and local options. If you define it in both configuration files, the local value overrides the global one.
primm_enable (Optional) Enables (ON) the SAP print parameter PRIMM (Print Immediately) for all jobs. The default value is OFF.
prnew_enable (Optional) Enables (ON) the SAP print parameter PRNEW (New Spool Request) for all jobs. The default value is OFF.
prrel_enable (Optional) Enables (ON) the SAP print parameter PRREL (Print Release) for all jobs. The default value is OFF.
prsap_enable (Optional) Enables (ON) the SAP print parameter PRSAP (Print SAP Cover Page) for all jobs. The default value is OFF.
prunx_enable (Optional) Enables (ON) the SAP print parameter PRUNX (Print Operating System Cover Page) for all jobs. The default value is OFF.
release_all_intercepted_jobs_for_request
Releases jobs for each user on a cyclic basis, based on the number of jobs specified in the max_jobs_to_release_for_user option. The default value is ON, which means that all jobs are submitted for each user:
  • If the max_jobs_to_release_for_user option is less than or equal to 0, all jobs are released for each user.
  • If the max_jobs_to_release_for_user option is higher than 0, the specified number of jobs is submitted for each user on a cyclic basis. For example, if max_jobs_to_release_for_user=5, the first 5 jobs are submitted for each user, then the following 5 jobs for each user, and so on, until all jobs for all users are submitted.
If this option is set to OFF, it releases for each user only the number of jobs specified in the max_jobs_to_release_for_user option. The remaining jobs are submitted only when a new release job is submitted:
  • If the max_jobs_to_release_for_user option is less than or equal to 0, all jobs are released for each user.
  • If the max_jobs_to_release_for_user option is higher than 0, only the specified number of jobs is submitted, then no other job is submitted until the new release job. If max_jobs_to_release_for_user=5, the first 5 jobs are submitted for each user, then no other job is submitted until the new release job.
This option is present both in global and local options. If you define it in both configuration files, the local value overrides the global one.
r3client (Mandatory) The SAP client number.
r3gateway (Optional) The host name of the SAP gateway.
r3group (Optional) The name of the SAP logon group.
r3gwservice (Optional) The service number of the SAP gateway.
r3host (Mandatory) The host name of the SAP message server when using logon groups, or the host name of the application server in all other cases.

If this server can be reached through one or more SAP gateways, use a string in the format /H/gateway/H/ for each of them.
r3instance (Mandatory) The SAP instance number.

If r3group is set, this option is ignored.
r3password (Mandatory) The password for the r3user. Ensure that you enter the same password when creating this user in the SAP system. It can be a maximum of eight characters and is stored in encrypted format. The value is case sensitive.

For information about how to encrypt the password see Encrypting SAP user passwords.
r3sid (Mandatory) The SAP system ID.
r3snclib (Optional) Specifies the path and file name of the SNC library. This option becomes mandatory if r3sncmode is activated (1).
r3sncmode (Optional) Enables (1), or disables (0), secure network communication (SNC) between r3batch and the SAP R3 system. The default setting is (0). Refer to the SAP documentation for more information about using the SAP cryptographic Library for SNC.
r3sncmyname (Optional) Specifies the name of the user sending the RFC for secure network communication (SNC).
r3sncpartnername (Optional) Specifies the SNC name of the SAP R3 communication partner (application server). This option becomes mandatory if r3sncmode is activated (1).
r3sncqop (Optional) Specifies the secure network communication (SNC) protection level.
r3user (Mandatory) The name of the SAP user with which the access method connects to the SAP system. It must have the appropriate privileges for running background jobs. It is sometimes also called the Maestro™ User ID.
report_list_max_limit (Optional) Sets the maximum number of ABAP reports which can be loaded. The default value is -1, which means no limit.