Job Management Partner 1/Performance Management - Agent Option for Enterprise Applications Description, User's Guide and Reference

jr3slget

Format

jr3slget    [RFC-connection-information]
            [target-information]
            [-lasttime timestamp-file-name]
            [output-destination]
            [-cnf environment-parameters-file-name]
            [-help]
            [-v]

Function

The jr3slget command extracts the system log information of the SAP system.

Host that can execute the command

PFM - Agent for Enterprise Applications

Execution permissions

In Windows:

None

In UNIX:

None

Command installation directory

In Windows:

installation-folder\agtm\evtrap\

In UNIX:

/opt/jp1pc/agtm/evtrap/

Arguments

RFC-connection-information

Specifies the information needed to establish RFC connection with the SAP system for command execution.

You can omit specification of this argument if you have specified the RFC connection information in the environment parameters file (CONNECT section). If the RFC connection information is specified in both the environment parameters file and the command, the command specification takes effect. For details about the environment parameters file, see 5.4.3 Environment parameters file for extracting system log information by command execution.

The following describes the RFC information argument:

-h application-server-host-name

Specifies as 1-100 single-byte alphanumeric characters the name of the connection-target application server host. You must specify one of the following:

Host name specified in the hosts file

IP address

SAP router address

You can verify the application server host name by transaction code SM51. When you specify this option, you must also specify the -s option.

-s system-number

Specifies the system number for identification by the application server host specified with the -h option. You must specify a value in the range 0-99.

When you specify this option, you must also specify the -h option.

-c client-name

Specifies as 1-3 bytes the client name of the user that is to be used for connection. You must specify a value in the range 0-999.

When you specify this option, you must also specify the -u option together with the -p or -p2 option.

-u user-name

Specifies as 1-12 single-byte alphanumeric characters the user name that is to be used for connection.

When you specify this option, you must also specify the -c option together with the -p or -p2 option.

For details about the SAP users that can be specified, see SAP users used for establishing connection.

-p password

Specifies the password for the user specified in the -u option. The permitted value is 1-8 single-byte characters.

This option and the -p2 option are mutually exclusive.

When you specify this option, you must also specify the -c and -u options.

For details about the characters permitted for the password, see SAP users used for establishing connection.

-p2 extended-password

If you are connecting to an SAP system that uses SAP NetWeaver 7.0 or later as its base system and that supports extended passwords, this option specifies the extended password for the user specified in the -u option. The permitted value is 1-40 single-byte characters.

This option and the -p option are mutually exclusive.

When you specify this option, you must also specify the -c and -u options.

For details about the characters permitted for the extended password, see SAP users used for establishing connection.

-l language

Specifies the language for the user specified with the -u option. You must specify a double-byte ISO ID or a single-byte language key used in the SAP system. For example, to use English, specify EN.

If you omit this option, the user's language used in the connection-target system is assumed.

When you specify this option, you must also specify the -c option, the -u option, and the -p or -p2 option.

-codepage code-page

Specifies the code page to be used when character encoding is converted in the Unicode version of the SAP system.

The code page must be specified together with a language in the -l option.

Specify the combination of language and code page as shown below. If any other combination of language and code page is specified, an encoding error may occur in the information acquired from the SAP system.

Table 10-7 Combination of language and code page specifications

Connection-target SAP system Connection language Language (-l) Code page (-codepage)

Unicode version English EN No need to specify. If you specify a code page, specify 1100.

Non-Unicode version English EN No need to specify. If you specify a code page, specify 1100.

To set the code page to be used to convert character codes at the connection-target SAP system (Unicode version), you can also use the SAP_CODEPAGE environment variable provided by the SAP system. If the code page setting is specified in both the SAP_CODEPAGE environment variable and in this option, this option takes effect.

If this option is omitted, the connection-target system's default code page is assumed. When you specify this option, you must also specify the -c option, the -u option, and the -p or -p2 option.

target-information

Specifies information that identifies the system log information that is to be extracted.

You can omit specification of this argument if you have specified the target information in the environment parameters file (TARGET section). If target information is specified in both the environment parameters file and the command, the command specification takes effect. For details about the environment parameters file, see 5.4.3 Environment parameters file for extracting system log information by command execution.

The following describes the target information argument:

-server SAP-instance-name

Specifies as 1-20 single-byte alphanumeric characters the name of the SAP instance that is collecting system log information. You can specify only one SAP instance name. To check the SAP instance name, use transaction code SM50 or SM66.

-lasttime timestamp-file-name

If only the system log information that was output after the previous command execution is to be extracted, this option specifies the name of the timestamp file used for managing the previous extraction time. The permitted value is 1-255 characters.

If you specify a relative path, make sure that it is relative to the work directory for the command. If you have not specified a work directory for the command in the WORKDIR label of the COMMAND section in the environment parameters file, specify the path relative to the current directory.

If you omit this option, the system assumes the period from 00:00:00 to 23:59:59 on the command execution date.

If the specified timestamp file does not exist the first time the command is executed with this argument specified, a new timestamp file is created. System log information is not output during such a first-time execution.

output-destination

Specifies the output destination of the system log information. When you omit this argument, system log information separated by linefeed codes is output to the standard output.

The following describes the output destination argument:

-x output-file-name

Specifies as a character string of 1-255 bytes the name of the file to which the system log information is to be output.

If you specify a relative path, make sure that it is relative to the work directory for the command. If you have not specified a work directory for the command in the WORKDIR label of the COMMAND section in the environment parameters file, specify the path relative to the current directory.

This is a wraparound file, which means that data is overwritten from the beginning of the file when the file capacity reaches a specified value. There is a header line of management information at the beginning of the file.

The default file size is 1024 kilobytes. To change the file size, use the SIZE label in the EXTRACTFILE section of the environment parameters file.

A management file named output-file-name.ofs is created in the same directory as the specified output file (e.g., if the output file name is SYSLOG, the SYSLOG.ofs file is created as a management file separately from the SYSLOG file). If you delete the output file, you must also delete this management file.

The -x and -x2 options are mutually exclusive.

-x2

Specifies that the system log information is to be output to the file that is specified with the X2PATH parameter in the EXTRACTFILE section of the environment parameters file.

The -x and -x2 options are mutually exclusive.

-cnf environment-parameters-file-name

Specifies as a character string of 1-255 bytes the name of the environment parameters file that is to be referenced by the command.

If you specify a relative path, make sure that it is relative to the current directory for the command.

If you omit this argument, the system assumes jr3slget.ini, which is the default environment parameters file in the current directory. If there is no default environment parameters file, PFM - Agent for Enterprise Applications assumes the default settings for an environment parameters file.

For details about the environment parameters file and the default settings, see 5.4.3 Environment parameters file for extracting system log information by command execution.

-help

Specified that the usage of the jr3slget command is to be displayed at the standard output.

-v

Specifies that a message indicating the processing status of the jr3slget command is to be output to the standard output. If you omit this option, no message indicating the processing status of the command will be output.

Connection-target SAP system	Connection language	Language (-l)	Code page (-codepage)
Unicode version	English	EN	No need to specify. If you specify a code page, specify 1100.
Non-Unicode version	English	EN	No need to specify. If you specify a code page, specify 1100.

SAP users used for establishing connection

To collect system log information, the jr3slget command executes the external management interfaces defined in the SAP system using RFC (communication protocol of SAP AG). Therefore, you must provide in advance the users who are to be used by the jr3slget command for establishing connection in the SAP system.

This subsection describes the user types, passwords, and authorizations for the SAP users who are created in the SAP system.

User types

The following types of SAP users can be used by PFM - Agent for Enterprise Applications:

Dialog

System

Communication

Service

Characters permitted for passwords

A password for an SAP user must consist of single-byte numeric characters (from 0 to 9), single-byte alphabetic characters (from a to z, A to Z), and the following single-byte symbols:

!, @, $, %, &, /, (, ), =, ?, ', `, *, +, ~, #, -, _, ., :, {, [, ], }, <, >, |

Required authorizations

You must set the following authorizations (authorization objects) for the SAP users:

Authorizations required for a user to establish RFC connection with function modules (S_RFC)

Authorizations required in order to use external management interfaces (S_XMI_PROD)

The authorization values are shown in the tables below or you can use the built-in configurations (S_RFC_ALL and S_XMI_ADMIN) that specifies XMB for all items.

Table 10-8 Authorizations required for a user to establish RFC connection with function modules (S_RFC)

Authorization Description Value

RFC_TYPE Type of RFC object to be protected FUGR (function group)

RFC_NAME RFC name to be protected *

ACTVT Activity 16 (execution)

Table 10-9 Authorizations required in order to use external management interfaces (S_XMI_PROD)

Authorization Description Value

EXTCOMPANY Company name of the external management tool HITACHI

EXTPRODUCT Program name of the external management tool JP1

INTERFACE Interface ID XMB

Authorization	Description	Value
RFC_TYPE	Type of RFC object to be protected	FUGR (function group)
RFC_NAME	RFC name to be protected	*
ACTVT	Activity	16 (execution)

Authorization	Description	Value
EXTCOMPANY	Company name of the external management tool	HITACHI
EXTPRODUCT	Program name of the external management tool	JP1
INTERFACE	Interface ID	XMB

Output format and contents

The command extracts the system log information (including parameter record rows) that can be verified by transaction code SM21 in the SAP system.

The following is the default output format for system log information, where < > enclose a field ID:

If the value of a system log information item is shorter than the predefined field length, the remaining area is padded with single-byte spaces. The following table lists and explains the values that are output:

Table 10-10 System log information that is output

Field ID Description Length (bytes)

<TIME> Time the message was recorded (HH:MM:SS) 8

<INSTANCE> Server that recorded the message 20

<USER> User who recorded the message 12

<PROGRAM> Program that recorded the message 8

<MSGNO> Message number 3

<MSGTEXT> Message text 255

Field ID	Description	Length (bytes)
<TIME>	Time the message was recorded (HH:MM:SS)	8
<INSTANCE>	Server that recorded the message	20
<USER>	User who recorded the message	12
<PROGRAM>	Program that recorded the message	8
<MSGNO>	Message number	3
<MSGTEXT>	Message text	255

Return value

0 Normal termination

1 or greater Abnormal termination

Example

This example outputs the system log information for the o246bci_SD5_00 SAP instance. The RFC connection information has already been defined in the environment parameters file.
jr3slget -server o246bci_SD5_00
The output example from this command is as follows:

[Contents][Back][Next]

[Trademarks]