Agent SAP

Name of the agent (or proxy agent)

The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $, @, - and #.

Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects.

The host name is used instead if this parameter remains undefined. Lowercase letters are converted to uppercase letters.

Default: SAP01

AE system name

The name can consist of a maximum of 8 characters. Allowed are the upper-case letters A to Z, numbers and "_".

System names must not contain the character "_" if you use a z/OS agent in combination with the SMF technique. By default, the job Includes convert "_" to "#". Should you intend to use "_" despite of this fact, you can bypass this situation by specifying the system name in the Event Monitor with "#".

Default: AUTOMIC

The Language(s) in which the log messages are displayed.Always a pair of languages separated by comma enclosed in brackets.

if a message text is not available in the primary language the secondary language will be taken.

Values

• E: english
• D: german
• F: french

Default: (E,D)

Full file name pattern for log file names

$$ is replaced by the purpose of a Process (CP or WP or JWP or DBSERVICE). No replacements in other components

* is replaced by the 3 digit number of a Worker Process.

## is replaced by the log file sequence number after the existing log files' corresponding numbers have been raised by one during startup of the component.

z/OS components only:

If you comment this parameter, this log file is stored in JES. Also refer to the parameter logpurgeclass= which is described below.

The following parameters can be added if the log is written to a dataset (after the dataset name and separated by semicolons):

"recfm" = (all 27 z/OS plus * and A record formats are valid)

"lrecl" = (0, each positive number up to 32760 and X for each reclen)

"blksize" = (0, each positive number up to 32760)

"space" = ([CYL,TRK],(prim,sec,directory))

AE and Java components only:

Logging to standard output can be enabled by setting the value to CON:

For relative path indications the system uses the installation directory when creating files.

For BS2000/OSD Operation System the name may be specified with or without User ID. If without User ID the log file is written to the user ID under which the component has been started

Default: ..\temp\ucxjr3x_log_##.TXT

number of log files being kept on disk

Default: 10

name of the message text library

may have different names dependent on platform rules.

Default: uc.msl

Availability of the messages and language dependent strings.

Values

• ALL: The complete message file is held in the RAM.
• NONE: Always read from the hard drive.
• CONTROLS: All language dependant strings that are necessary in order to display the dialog program are held in the RAM (not relevant for the Automation Engine).

Default: ALL

The number of report lines that should be transferred to AE in blocked form.

This parameter has been implemented in response to a memory problem of the SAP RFC library on AIX (for further information, see the note 792767). In SAP, you can limit job reports. This solution is not suitable for customers who use a job scheduler such as AE because the whole job report should be transferred. Therefore, AE provides a workaround in the form of this parameter. Large job reports are transferred to AE block by block, thereby avoiding memory problems because doing so consumes less memory. Note that more SAP resources are required in this case. This workaround applies only for the AE interface because AE has no influence on SAP's XBP interface.

Default: 0

The maximum size of the log file in kilobytes.

A new log file is created when the size that you specify here has been reached.

The default value will be used when the value "0" is set.

Default: 10000

The interval in seconds that the agent uses to read previous SAP events after it has lost its connection to the SAP system.

Console events monitor events that have been triggered in SAP. If the agent loses its connection to the SAP system, several SAP events can accumulate that the agent cannot forward to the Console events. As soon as the connection has been re-established, the agent checks again and reports these SAP events to the relevant Console events.

The agent does not read all SAP events at once because a large amount of data might be involved. Each SAP event is triggered at a particular point in time. The agent retrieves all SAP events that have been triggered during the connection loss from the SAP event history. It uses the interval that has been defined using the parameter maxEventTimeStamp=.

Example

The value for maxEventTimeStamp= is set to 600. This value corresponds to 10 minutes. The JOB_CHECKINTERVAL is 60 which corresponds to 1 minute. The agent is not connected to the SAP system between 10:00 and 10:30. SAP events that have been triggered during this time are retrieved as shown below:

SAP events between 10:00 and 10:10 are retrieved at 10:30.

SAP events between 10:10 and 10:20 are retrieved at 10:31.

SAP events between 10:20 and 10:30 are retrieved at 10:32.

SAP events between 10:30 and 10:33 are retrieved at 10:33.

SAP events between 10:33 and 10:34 are retrieved at 10:34

etc.

Default: 600

Specifies the language in which the agent logs in to the SAP system

Values

• 0: The languages that are specified in language= are used.
• 1: The agent uses the language that is defined in the job in order to log on to SAP.

Default: 1

This is an additional parameter that allows to allow or reject particular users.

Values

• INCL: Access must be granted for every single user specified in (USERID).
• EXCL: Access is denied to the users that are specified in (USERID). All other users can start jobs.

Default: EXCL

The maximum size of the log file.

A new log file will be created when the limit that has been defined here is reached.

The default value will be used when you set the value "0".

You can use one of the following suffixes with this value:

k...kilo, M...mega, G...giga

Examples: 100k corresponds to 100 kilobytes, 20M to 20 megabytes and 1G to 1 gigabyte.

The parameter "max_logging_kb" is used for log-file changes if this parameter is not specified or the value is "0".

Default:

The directory in which the spool lists produced from SAP ABAP programs should be stored.

This parameter affects all SAP JCL commands which are capable of downloading SAP spool lists, for example "R3_ACTIVATE_REPORT".

The spool lists are stored in plain text and following filename pattern is used:

<SAP job count>_<step number>_<spool number>.txt

The agent's temp directory is used if this parameter is not defined.

Default:

The path and the file name of the trace file.

Any file name for a text file with several place holders for current system information:

$$ is replaced by server process type (WP or CP) in the context of a server process.

* is replaced by the three-digit process number in the context of a server process.

## is replaced by 00 after the available trace files' corresponding numbers have been raised by one during startup of a trace.

xxx is replaced by the three-digit abbreviation of the respective unix version (unix agent only).

z/OS components only:

The following parameters can be added (after the dataset name and separated by semicolons) if the log is written to a dataset:

"recfm" = (all 27 record formats of z/OS plus * and A are valid)

"lrecl" = (0, each positive number up to 32760 and X for each reclen)

"blksize" = (0, each positive number up to 32760)

"space" = ([CYL,TRK],(prim,sec,directory))

AE and Java components only:

Tracing to standard output can be enabled by setting the value to CON:

Currently the External Monitoring Interface (EMI) does not produce any trace regardless of the settings here.

For BS2000/OSD the name might be specified with or without user ID. If without the trace file is written to the user ID under which the component has been started.

Default: ..\temp\ucxjr3x_trace_##.txt

Number of stored trace files

Default: 10

The maximum size of the trace file.

A new trace file will be created when the limit that has been defined here is reached.

You can use one of the following suffixes with this value:

k...kilo, M...mega, G...giga

Examples: 100k corresponds to 100 kilobytes, 20M to 20 megabytes and 1G to 1 gigabyte.

Default:

traceflag

Default: 0

traceflag

Default: 0

traceflag

Default: 0

traceflag

Default: 0

Connection Parameter: Address of the endpoint used to connect to the AE system.

Allowed formats:

DNS Name:Port number

TCP/IP Address:Port number

Default: jcphost:8443

IP address the component uses to connect.

Use this parameter if the connection should be established via a particular IP address (for example, the computer has more than one network interface card).

Alternately, you can also specify the IP address or host name in PORT= (Format: PORT=IP address:port or DNS name:port). Specifications made in BINDADDR= are then ignored.

In a distributed server environment, this value must be adapted with a valid IP address that is available to that specific host.

Default:

The time interval in seconds for the reestablishment of connections after a loss of connection.

For the Automation Engine: reconnect between Server Processes

For Agents: reconnect to the Engine

For the zOS Event Monitor: reconnect to the Agent

For the Proxy: reconnect to Automation Engine or Server Proxy

For Agents: This parameter is only effective until the first successful logon to the AE system. Afterwards, you can use the parameter RECONNECT_TIME in the host characteristics.

For z/OS Event Monitor: The Console command "MODIFY ..., EX=<addr>,:<port> serves to facilitate a new connection immediately. In this case, the attempt to re-connect to the specified agent is made immediately. A reconnection is established, even if the Event Monitor already has a connection to another agent. A new connection is then established. The old connection is ended if the new connection has successfully been established.

Default: 60

The time interval in seconds in which an Agent sends or the Automation Engine saves the logging to the database.

Default: 60

The name and the path of the file that includes the authentication package (company-key file).

This parameter must be specified if you use the authentication methods "Server" or "Server and Agent". Authentication will not succeed if the company-key file is missing.

When the agent starts, it reads the company-key file. The file is deleted after successful authentication.

Default:

The path to the folder where additional trusted certificates are stored (optional). Certificates must be PEM encoded.

Default:

The path to the folder where the agent can store security related files needed for authentication. E.g., private key, signed certificate, root certificate.

If the folder does not exist, it will be created when the agent starts for the first time. The folder should not be deleted, renamed or moved.

Default: ./security

The password used to encrypt the agent's private key.

The password can be obfuscated using the UCYBCRYP utility.

A random password will be generated at runtime if this is left empty.

Default:

The SAP system's software version.

This parameter is used to set the agent variable UC_HOST_SW_VERS.

The value that is specified here is shown in the System Overview's "SW version" column of the relevant agent.

Default: 0

BAPI_XBP_VARIANT_CHANGE parameter MERGE usage.

See SAP note 2340467, the MERGE parameter of BAPI_XBP_VARIANT_CHANGE was not used because of that bug.

Enable useMerge if that bug is fixed on your SAP system, or if you do not use R3_MODIFY_VARIANT with KIND=S.

Values

• 0: The MERGE parameter of BAPI_XBP_VARIANT_CHANGE is not used.
• 1: The MERGE parameter of BAPI_XBP_VARIANT_CHANGE is used.

Default: 0

BCA Interface usage.

Values

• 0: The interface is not used.
• 1: The interface is used.

Default: 0

BW Interface usage.

Values

• 0: The interface is not used.
• 1: The interface is used.

Default: 0

The URL of the Automic Web Interface.

To open the Automic Web Interface directly via the SAP Solution Manager, you must specify this parameter.

Default: http://localhost:8080/awi

XI Interface usage.

Values

• 0: The interface is not used.
• 1: The interface is used.

Default: 0

Format: user=START|NO_START

User has to be defined in the notation of the Operating System,

Windows: User/Domain

Unix : user

BS2000 : Userid TSOS

SAP : client number/user name

Examples:

Windows: ni/home=START

BS2000 : TSOS=NO_START

SAP : 001/NI=START

This section only affects Job objects. File Transfer or FILE Event Objects are not affected.

Role of the Agent, which is the name that can be used as a filter in Agent groups.

Default:

Suffix part of the UC_HOSTCHAR_<SUFFIX> variable which contains specific agent settings.

Default: DEFAULT

Connection object for the ABAP basis that should be used in the Agent object.

Default:

Connection object for the Java basis that should be used in the Agent object.

Default:

Connection object for the Process Integration that should be used in the Agent object.

Default:

Connection object for the Landscape Directory which should be used in the Agent object.

Default:

Path to Agent binaries

Default: .

Path to which the Agent writes job reports

Default: ..\temp

Path to which the Agent writes log and trace files

Default: ..\temp

The reference to Includes that are used when the job is generated. (JCL Variant)

These are generally the Includes HEADER.*, TRAILER.* and RESTART.* of the system client 0000. User-defined Includes can also be used.

Default: SAP

When an Agent starts using the value defined in the connection= parameter, it receives a list of all JCPs available from the Automation Engine. On connection attempts from that point forward the agent will connect to a random JCP from the JCPLIST.

You can also use the JCP_ENDPOINT parameter in the UC_SYSTEM_SETTINGS variable to define where to reach the JCPs. In this case, the Agent receives all entries from the JCP_ENDPOINT definition and stores the information in this section.

If the JCP_ENDPOINT points to the location of only one load balancer, the JCP sends this location to the connecting Agent. However, if the JCP_ENDPOINT points to more than one load balancer, the JCP sends the location of all the load balancers available to the connecting Agent.

Allowed formats:

JCP1=host-name:port

JCP2=host-name:port

...

or

JCP1=https://host-name:port/

JCP2=https://host-name:port/