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

[Contents][Glossary][Index][Back][Next]

6.4.3 Environment parameters file for extracting CCMS alert information by command execution

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

This is a text file created by the user.

Organization of this subsection
(1) Setup procedure
(2) Settings

(1) Setup procedure

To set up the environment parameters file:

  1. Copy the sample environment parameters file under the name jr3alget.ini.
    This jr3alget.ini becomes the default environment parameters file. The sample environment parameters file is as follows:

    In Windows:
    installation-folder\agtm\evtrap\jr3alget.ini.sample

    In UNIX:
    /opt/jp1pc/agtm/evtrap/jr3alget.ini.sample

  2. Open the jr3alget.ini file.

  3. Edit the settings.
    The settings in the default environment parameters file are as follows; for details about the settings, see (2) below.

    [Figure]

    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.

  4. Save the environment parameters file.
    By specifying the -cnf option in the jr3alget command, you can extract the CCMS alert information of the SAP system based on the settings in the environment parameters file.

(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 jr3alget 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 6-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 2-byte ISO ID or 1-byte language key that is used in the SAP system:
  • 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 6-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 6-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
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 6-10 Combination of language and code page specifications

Connection-target SAP system Connection language Language (LANG) 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.
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 jr3alget command.

Table 6-11 Values permitted in the COMMAND section

Label Description Permitted values Default value Argument
WORKDIR Work directory for the command 1-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 CCMS alert information extraction.

Table 6-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: Maximum value for the system#
  • 1-65535: Wraparound within the specified size (in kilobytes)
 0-65535 512 N/A
MSGLOG_DIR Message log file (jr3alget.log) collection-target directory 1-255 single-byte alphanumeric characters. The total length, including file name jr3alget.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 data log:
  • 0: Maximum value for the system#
  • 1-65535: Wraparound within the specified size (in kilobytes)
 0-65535 512 N/A
DATALOG_DIR Data log file (jr3alget.dat) collection-target directory 1-255 single-byte alphanumeric characters. The total length, including file name jr3alget.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

#
This is 0x7FFFFFFF (about 2 gigabytes), which can be expressed as a 32-bit signed integer.

(d) TARGET section

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

Table 6-13 Values permitted in the TARGET section

Label Description Permitted values Default values Argument
MONITOR_SET Monitor set name (for details, see the -ms option) 1-60 single-byte alphanumeric characters SAP CCMS Technical Expert Monitors -ms
MONITOR Monitor name (for details, see the -mn option) 1-60 single-byte alphanumeric characters All Monitoring Contexts -mn

(e) FORMAT section

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

Table 6-14 Values permitted in the FORMAT section

Label Description Permitted values Default values Argument
COLUMN Output format of CCMS alert information Field ID. For details about the field ID, see 10. 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>		 N/A
TIMEZONE Time zone for time information specified in field IDs <ALERTDATE>, <ALERTTIME>, <STATCHGDAT>, and <STATCHGTIM>
  • UTC
    Output in UTC (international time standard).
  • LOCAL
    Output in the local time at the location of the user who executed the command.
 UTC TIMEZONE

(f) EXTRACTFILE section

The EXTRACTFILE section specifies information about the output file for the CCMS alert information.

Table 6-15 Values permitted in the EXTRACTFILE section

Label Description Permitted values Default value Argument
SIZE Size of output file:
  • 0: Maximum value for the system#1
  • 1-65535: Wraparound within the specified size (in kilobytes)
 0-65535 1024 N/A
X2PATH Log file path that is used when log file output is specified with the -x2 option of the jr3alget command#2 1-255 single-byte alphanumeric characters. If a relative path is specified, it is treated as the path relative to the work directory for the command (or the current directory if it has not been changed by the WORKDIR label in the COMMAND section) ALERT N/A

#1
This is 0x7FFFFFFF (about 2 gigabytes), which can be expressed as a 32-bit signed integer.

#2
A management file named output-file-name.ofs is created in the same directory as the specified output file (e.g., if ALERT is specified as the output file name, ALERT.ofs is created as a management file in addition to the ALERT file.) If you delete this output file, make sure that you also delete the management file.

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2010, Hitachi, Ltd.