5.4.3 Environment parameters file for extracting system log information by command execution

If you specify an environment parameters file as an argument in the jr3slget command, the command extracts the system log information of the SAP system based on the settings in the file.

You create this environment parameter file as a text file.

Organization of this subsection

(1) Setup procedure
(2) Settings
(3) Notes

(1) Setup procedure

To set up the environment parameters file:

Before you edit the environment parameters file, make sure that the jr3slget command is not running.
To create a new environment parameters file, copy the sample environment parameters file under the name jr3slget.ini.

This jr3slget.ini becomes the default environment parameters file. The sample environment parameters file is as follows:

In Windows:

installation-folder\agtm\evtrap\jr3slget.ini.sample

In Linux:

/opt/jp1pc/agtm/evtrap/jr3slget.ini.sample
Open the jr3slget.ini file.
Edit the settings.

The settings in the default environment parameters file are as follows; for details about the settings, see (2) Settings:

In the case of an item that begins with a semicolon (;), the setting is disabled by default, because the semicolon indicates that it is a comment line. To enable the setting, remove the semicolon.
Save the environment parameters file.

By specifying the -cnf option in the jr3slget command, you can extract the system log information of the SAP system based on the settings in the environment parameters file.

To Page Top

(2) Settings

Specify the settings in the environment parameters file in the following format:

[section]
label=value
label=value
...
...
[section]
label=value
label=value

Notes

Do not specify any unneeded characters, such as spaces at the beginning of a line or before and after an equals sign (=).
The values specified in section and label are not case-sensitive.
A line beginning with a semicolon (;) is treated as a comment.

The following tables describe the contents of each section in the environment parameters file. In a table, the Argument column indicates the argument that is specified in the jr3slget command, if applicable. N/A means that the item cannot be specified with the command.

(a) CONNECT section

The CONNECT section specifies information needed to establish RFC connection with the SAP system at the time of command execution.

Table 5‒7: Values permitted in the CONNECT section
Label	Description	Permitted values	Default value	Argument
`ASHOST`	Host name of the connection-target application server (which can be verified by transaction code `SM51`)	1-100 single-byte alphanumeric characters in one of the following formats: Host name specified in the `hosts` file IP address SAP router address	`localhost`	`-h`
`SYSNR`	System number that can be identified by the connection-target application server host	0-99	`00`	`-s`
`CLIENT`	User's client name used for establishing connection	0-999	`000`	`-c`
`USER`	User name used for establishing connection^#1	1-12 single-byte alphanumeric characters	`CPIC`	`-u`
`PASSWD`	User's password used for establishing connection^#2	1-8 single-byte characters^#3	`ADMIN`	`-p`
`PASSWD2`	User's extended password used for establishing connection^#2	1-40 single-byte characters^#3	`ADMIN`	`-p2`
`LANG`	User language used for connection	Japanese and English are supported. 2-byte ISO ID or 1-byte language key that is used in the SAP system: Japanese: `JA` or `J` English: `EN` or `E`	None	`-l`
`CODEPAGE`	Code page used to convert character codes in the Unicode version of the SAP system at the destination	Value combined with the language in the `LANG` label^#4	None	`-codepage`

#1

The user specified in this label must have already been granted the following authorizations:

Table 5‒8: Authorizations required by the 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 5‒9: Authorizations required for use of 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	`XAL`

You can use the following user types for the user specified in this label:

Dialog
System
Communication
Service

#2

Specify the PASSWD label if the SAP system is applying conventional password rules. Specify the PASSWD2 label if the SAP system is applying extended password rules. The PASSWD and PASSWD2 labels are mutually exclusive.

#3

A user's password or extended password that is used for establishing connection 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:

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

#4

Set the LANG and CODEPAGE labels in the applicable combination shown below. If any other combination of language and code page is specified, an encoding error might occur in the information acquired from the SAP system.

Table 5‒10: Combination of language and code page specifications
Connection-target SAP system	Connection language	Language (LANG)	Code page (CODEPAGE)
Unicode version	Japanese	`JA`	`8000`
Unicode version	English	`EN`	No need to specify. If you specify a code page, specify `1100`.
Non-Unicode version	Japanese	`JA`	No need to specify. If you specify a code page, specify `8000`.
Non-Unicode version	English	`EN`	No need to specify. If you specify a code page, specify `1100`.

If you omit specification of the LANG label, the user language defined in the connection-target system is assumed.

If you omit specification of the CODEPAGE label, the default code page in the connection-target system is assumed.

(b) COMMAND section

The COMMAND section specifies information about the work directory for the jr3slget command.

Table 5‒11: Values permitted in the COMMAND section
Label	Description	Permitted values	Default value	Argument
`WORKDIR`	Work directory for the command	1 to 255 single-byte alphanumeric characters. If a relative path is specified, it is treated as the path relative to the current directory.	Current directory	N/A

(c) TRACE section

The TRACE section specifies information about the message log and data log that store the history of system log information extraction.

Table 5‒12: Values permitted in the TRACE section
Label	Description	Permitted values	Default value	Argument
`MSGLOG_LEVEL`	Message log collection level for saving application trace information: `0`: Do not collect `1`: Collect only errors `2`: Standard `3`: Details `4`: Debug	0-4	`2`	N/A
`MSGLOG_SIZE`	File size for collecting the message log: `0`: 2 GB (the maximum value that can be expressed by a 32-bit signed integer (`0x7FFFFFFF`)) `1`-`65535`: Wraparound within the specified size (in kilobytes)	0-65535	`512`	N/A
`MSGLOG_DIR`	Message log file (`jr3slget.log`) collection-target directory	1-255 single-byte alphanumeric characters. The total length, including file name `jr3slget.log`, must not exceed 255 bytes. If a relative path is specified, it is treated as the path relative to the work directory for the command.	Work directory for the command (or the current directory if it has not been changed by the `WORKDIR` label in the `COMMAND` section)	N/A
`DATALOG_LEVEL`	Data log collection level for saving various types of data information for applications: `0`: Do not collect `1`: Collect only errors `2`: Standard `3`: Details `4`: Debug	0-4	`2`	N/A
`DATALOG_SIZE`	File size for collecting the data log: `0`: 2 GB (the maximum value that can be expressed by a 32-bit signed integer (`0x7FFFFFFF`)) `1`-`65535`: Wraparound within the specified size (in kilobytes)	0-65535	`512`	N/A
`DATALOG_DIR`	Data log file (`jr3slget.dat`) collection-target directory	1-255 single-byte alphanumeric characters. The total length, including file name `jr3slget.dat`, must not exceed 255 bytes. If a relative path is specified, it is treated as the path relative to the work directory for the command.	Work directory for the command (or the current directory if it has not been changed by the `WORKDIR` label in the `COMMAND` section)	N/A

(d) TARGET section

The TARGET section specifies information that identifies the system log information to be extracted.

Table 5‒13: Values permitted in the TARGET section
Label	Description	Permitted values	Default value	Argument
`SERVER`	SAP instance name (the SAP instance name that has a dialog service, and which can be verified by transaction code `SM51`)	1 to 20 single-byte alphanumeric characters	None	`-server`

(e) FORMAT section

The FORMAT section specifies the output format of the system log information.

Table 5‒14: Values permitted in the FORMAT section
Label	Description	Permitted values	Default values	Argument
`COLUMN`	Output format of system log information	Field ID. For details about the field ID, see Output format and contents in the `jr3slget` command in 11. Commands.	Column 1: `<TIME>` Column 2: `<INSTANCE>` Column 3: `<USER>` Column 4: `<PROGRAM>` Column 5: `<MSGNO>` Column 6: `<MSGTEXT>`	N/A

(f) EXTRACTFILE section

The EXTRACTFILE section specifies information about the output file for the system log information.

Table 5‒15: Values permitted in the EXTRACTFILE section
Label	Description	Permitted values	Default value
`TYPE`	Format of file for storing system log information: `WRAP1` This file is in wraparound format, which means that data is overwritten when the amount of system log information reaches a specified value. `WRAP2` This format consists of the number of files specified in the `NUM` label. When the amount of data in the first file reaches a specified value, new data is written in the second file from the top after all existing data is deleted from the second file. When all of the files are full, new data is again written in the first file, starting from the top after all existing data is deleted from the first file. If you configure a new environment for PFM - Agent for Enterprise Applications, we recommend that you specify `WRAP2`. If you want to change the format of storage files after you have started system operations, first stop any products monitoring the storage files, and then delete the storage files and their management files^#1.	`WRAP1` or `WRAP2`	`WRAP1`
`SIZE`	Size of one storage file: `0`: 2 GB (the maximum value that can be expressed by a 32-bit signed integer (`0x7FFFFFFF`)) `1` to `65535`: Wraparound within the specified size (kilobytes)	`0` to `65535`	`10240`^#2
`X2PATH`	`WRAP1` specified in the `TYPE` label Specify the path to the storage file that is to be used when storage file output is specified in the `-x2` option.^{#1, #3} `WRAP2` specified in the `TYPE` label Specify the storage file that is to be used when storage file output is specified in the `-x2` option.^{#3, #4}	`WRAP1` specified in the `TYPE` label 1 through 251 bytes of single-byte alphanumeric characters^#5 `WRAP2` specified in the `TYPE` label 1 through 254 bytes of single-byte alphanumeric characters^#5	--
`NUM`	Number of files to be written to when using the `WRAP2` format. This field is applicable only when `WRAP2` is specified in the `TYPE` label.	`2` to `9`	`5`

Legend:

--: Not applicable

#1

If the WRAP1 format is used, a management file having the name storage-file-name.ofs is created in the same directory as for the storage file.

Example:

If SYSLOG is specified as the storage file name, a management file named SYSLOG.ofs is created in addition to the SYSLOG file.

If you delete the storage file, you must also delete the management file.

#2

For details about the default value that is applied when the product is upgraded from version 09-00 or earlier, see Appendix H. Migration Steps and Notes on Migration.

#3

If you do not use the default storage location, the storage and management files will not be collected when you use the jpcras command. Therefore, in the event of a problem, you need to manually collect the storage and management files.

#4

A value in the range specified in the NUM label (default: 1 through 5) is assigned to this value to obtain the file name.

#5

If a relative path is specified, the command's working directory (directory specified in the WORKDIR label in the COMMAND section) is assumed as the current directory. If no working directory is specified, the directory listed below is assumed as the current directory. The environment directory means a directory on the shared disk that was specified when the logical host was created.

In Windows:

Physical host environment: installation-folder\agtm\agent\instance-name

Logical host environment: environment-directory\jp1pc\agtm\agent\instance-name

In Linux:

Physical host environment: /opt/jp1pc/agtm/agent/instance-name

Logical host environment: environment-directory/jp1pc/agtm/agent/instance-name

(g) Option section

The Option section specifies information that determines the base point for system log extraction.

For details about the Option section, see 5.3.2 (5) Option section.

To Page Top

(3) Notes

If you change the time zone set for the SAP system (except when such a change is necessitated by the switch between standard time and daylight saving time), you have to delete the file storing the time stamps that are based on the previously set time zone. If the timestamp file specified for the -lasttime option of the jr3slget command exists, delete it before resuming command execution.

To Page Top