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

Organization of this subsection

(1) TARGET section
(2) EXTRACTFILE section
(3) FORMAT section
(4) TRACE section
(5) CONNECT section
(6) Option section

(1) TARGET section

The TARGET section specifies information that identifies the CCMS alert information to be extracted.

Table 6‒1: Values permitted in the TARGET section
Label	Description	Permitted values	Default value
`MONITOR_SET`^#	Monitor set name (name displayed as `CCMS monitor set` on the SAP system Alert Monitor (transaction code `RZ20`))	1 to 60 single-byte alphanumeric characters	SAP CCMS Monitor Templates
`MONITOR`^#	Monitor name (name displayed in the tree of the CCMS monitor set on the SAP system Alert Monitor (transaction code `RZ20`))	1 to 60 single-byte alphanumeric characters	Entire System

#: Specifying multiple targets is not permitted. To monitor multiple monitors, use the CCMS function of the SAP system to combine all the targets to be monitored into a single monitor, and then monitor this monitor from PFM - Agent for Enterprise Applications.

To Page Top

(2) EXTRACTFILE section

The EXTRACTFILE section specifies information about the file to which CCMS alert information is to be output.

Table 6‒2: Values permitted in the EXTRACTFILE section
Label	Description	Permitted values	Default value
`TYPE`	Format of file for storing CCMS Alert Information: `WRAP1` This file is in wraparound format, which means that data is overwritten when the amount of CCMS Alert 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, starting at the top, after all existing data is deleted from the second file. When all the files are full, new data is again written in the first file, starting at 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`	`WRAP2` Note that if there is no `TYPE` label for reasons such as upgrading from Version 9 or earlier, `WRAP1` is assumed.
`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 of 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	In Windows: `log\ALERT` In Linux: `log/ALERT`
`NUM`	Number of files to be stored in the `WRAP2` format. This is applicable only when `WRAP2` is specified in the `TYPE` label.	`2` to `9`	`5`

#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 ALERT is specified as the storage file name, a management file named ALERT.ofs is created in addition to the ALERT file.

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

#2

For details about the default value that is used 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 using 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

To Page Top

(3) FORMAT section

The FORMAT section specifies the output format of the CCMS alert information.

Table 6‒3: Values permitted in the FORMAT section
Label	Description	Permitted values	Default values
`COLUMN`	Output format of CCMS alert information	Field ID. For details about the field ID, see Output format and contents in the `jr3alget` command in Chapter 11. Commands.	Column 1: `<ALERTDATE>` Column 2: `<ALERTTIME>` Column 3: `<MTSYSID>` Column 4: `<MTMCNAME>` Column 5: `<OBJECTNAME>` Column 6: `<FIELDNAME>` Column 7: `<VALUE>` Column 8: `<SEVERITY>` Column 9: `<MSG>`
`TIMEZONE`	Time zone specification for the time information of the following field IDs `<ALERTDATE>` `<ALERTTIME>` `<STATCHGDAT>` `<STATCHGTIM>`	`UTC` The command will output time information in UTC (Coordinated Universal Time). `LOCAL` The command will output time information in the local time of the user who executes the command.	`UTC`

To Page Top

(4) TRACE section

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

Table 6‒4: Values permitted in the TRACE section
Label	Description	Permitted values	Default value
`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`
`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`
`MSGLOG_DIR`	Message log file (`jr3alget.log`) collection-target directory	(Cannot be changed)	`log`
`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`
`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`
`DATALOG_DIR`	Data log file (`jr3alget.dat`) collection-target directory	(Cannot be changed)	`log`

To Page Top

(5) CONNECT section

The CONNECT section specifies information needed to establish RFC connection with the SAP system.

Table 6‒5: Values permitted in the CONNECT section
Label	Description	Permitted values	Default value
`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
`CODEPAGE`	Code page used to convert character codes in the Unicode version of the SAP system at the destination	Value combined with the language code in the `LANG` label^#	None

#

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 6‒6: 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.

To Page Top

(6) Option section

The Option section specifies information that determines the base point for extracting CCMS alert information. If you do not set a label in this section, the default value is used.

For details about the recommended collection base time for remote monitoring, see 8.1 Notes on the collection base time.

Table 6‒7: Values permitted in the Option section
Label	Description	Permitted value	Default value
`SHIFTEXTRACTTIME`^#	The collection base time (units: seconds) that determines the base point for extracting CCMS alert information. Relative to the time at which to perform the collection, specify a value that indicates the amount of time by which to shift the time period (defined by two time points) for which to extract CCMS alert information.	0-600	5

#: If, due to the processing delay in the SAP system, the saved CCMS alert information does not correctly reflect the actual time at which it has arisen, set a value greater than the default value for this label.

The following example shows how to set the collection base time:

When 10 seconds is to be set as the collection base time
```
[Option]
SHIFTEXTRACTTIME=10
```

To Page Top