SAP Agent

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

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

system=

The name of the AE system.
This entry must comply with the entry that is made in the Automation Engine's INI file.

The language that should be used for the logging. You can specify a primary and a secondary language.

Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a message in the secondary language.

logging=

The path and file name of the log file.

The number signs serve as placeholders for a series in numerical order. When you start the agent, the log files are renamed so that the most current log file is always the one with the number 00.

The number of stored log files.

Default value: 1

LogMaxSize=

The maximum size of the log file in bytes.

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

Default value: 10 MB

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

You can use one of the following prefixes 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 agent reads LogMaxSize, if a value is set, and is not 0, the value is used. If LogMaxSize doesn't exist, or is 0, the agent uses the max_logging_kb setting.

The maximum size of the log file.

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

Default value: 1000 KB

The agent reads LogMaxSize, if a value is set, and is not 0, the value is used. If LogMaxSize doesn't exist, or is 0, the agent uses the max_logging_kb setting.

Allowed values: ALL (default value), NONE, CONTROLS

ALL = The complete message file is held in the RAM.
NONE = Always read the message file from the hard drive.
CONTROLS = All language dependent strings that are required to display a dialog program are held in the RAM (does not apply to agents).

lower_case=

This parameter converts entries in the attributes of a workflow into uppercase letters.

Allowed values: "YES", "NO" (default value)

"YES" = Entries must be written in uppercase letters. Lowercase letters are not automatically converted to uppercase letter.
"NO" = Lowercase letters are automatically converted to upper case letters.

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

Default value: 600 seconds

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

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

joblog_blocksize=

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

Default value: 0 lines

Value 0 signals that the job report should be transferred as a whole.

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.

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

Allowed values: INCL, EXCL

INCL = Access must be granted to each individual user under [USERID].
EXCL = Users that are specified under [USERID] are excluded. All other users can start jobs.

You must re-logon to SAP if the language has been changed.

Allowed values: 0 (default value), 1

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.

The directory in which the spool lists should be stored.

This parameter affects the following script elements in which the spool-list request has been activated by using the parameter GET_SPOOL:

• R3_ACTIVATE_REPORT
• R3_ACTIVATE_JOBS
• R3_ACTIVATE_INTERCEPTED_JOBS
• BW_ACTIVATE_CHAIN
• BW_RESTART_CHAIN

The spool lists are stored as text files and the following file name is used:
<SAP job count>_<step number>_<spool number>.txt

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

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". Any attempt to log in fails if the company-key file cannot be found.

When the agent starts, it reads the company-key file and stores its information in the file that is specified in the parameter KeyStore=. The first file is deleted afterward.

The name and the path of the file that includes the information of the authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending *.kstr) or the path of the agent's INI file. If you define a file name, the ending *.kstr is not automatically appended.

The KeyStore file is created when the agent starts for the first time. You must not delete, rename or move it subsequently. Regardless of the authentication method that you use, any attempt to log in will fail if the agent cannot find this file when it starts. In this case, you must open the menu item "Renew transfer key" in the affected agent's System Overview.

Java agents (SAP, RA, databaseA database is an organized collection of data including relevant data structures. and JMX) that run under UNIX create a keystore file with the following right: "-rw-r--r—". In doing so, other OS users can also access this file.

Specification of authorized SAP users in the format:
Client number/User name=START

Specification of non-authorized SAP users in the format:
Client number/User name=NO_START

[SAP_BW]

The parameters for SAP BW.

Enabled=

Interface usage.

Allowed values: 0 (default value) and 1

0 - The interface is not used.
1 - The interface is used.

[SAP_XI]

Enabled=

Interface usage.

Allowed values: 0 (default value) and 1

0 - The interface is not used.
1 - The interface is used.

[SAP_BCA]

Enabled=

Interface usage.

Allowed values: 0 (default value) and 1

0 - The interface is not used.
1 - The interface is used.

The SAP system's software version.

By default, this parameter and section are not included in the INI file. 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.

For example: The agent runs on an SAP platform using the software version 7.0:

[SAP_BASIS]
Version=7.00

The URL of the Web application that includes the UserInterface.

To call the UserInterface directly via the SAP Solution Manager, you must specify this parameter. For more information about installing this functionality, see Integrating AE to the SAP Solution Manager.

The number signs serve as placeholders for a series in numerical order. When you start a trace, the trace files are renamed so that the most current trace file is always the one with the number "00".

The number of stored trace files.

Default value: 1

The maximum size of the trace file.

A new trace file is created when the size that is specified here has been reached.

Default value: 1000 KB

Allowed values: 0 (default value) to 9

rfc=

RFC trace.

Allowed values: 0 (default value) to 9

Use the following SAP parameter in order to prevent that the SAP system's trace is accepted:

rdisp/accept_remote_trace_level = 0

This parameter can also be of interest in this connection: gw/accept_remote_trace_level (see SAP note 357683).

[TCP/IP] 

The IP address or host name for Server-process connection.

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

bindaddr=

connect=

 The time interval in seconds in which the agent attempts to establish connection to the Automation Engines affects the connection setup for a restart or after a lost connection.

Default value: 60

This parameter is only effective until the first successful logon to the AE system. Afterwards, you can use the parameter RECONNECT_TIME of the host characteristics for this purpose.

report=

The time interval in seconds in which the agent sends the logging to the Automation Engine.

Default value: 60

CP=

The address of the primary communication process in the AE system to which the agent should connect itself.

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number

[VARIABLES]

This section includes agent variables that contain agent settings and information.

[CP_LIST]

A list of communication processes.

This list is created when the agent starts and extended when new communication processes are activated. You will find more detailed information about establishing a connection in the chapter Multi-Server Operation.

The communication process that has been defined in the parameter cp= (section [TCP/IP]) is not included in the cp list.

Format:
Port number=DNS name
or
Port number=TCP/IP address