4.3.1 SAP NetWeaver 7.0 or later (Windows)
- Organization of this subsection
(1) Before installation
This subsection describes the prerequisites and required information for starting installation and setup.
(a) Prerequisites
To use PFM - Agent for Enterprise Applications in a cluster system, the following prerequisites must be satisfied.
■ Cluster system
Make sure that the following condition is satisfied:
-
The cluster system is controlled by cluster software.
Also, suppress error notification as described below.
- Suppressing error notification to Microsoft (executing and standby systems)
-
In Windows, a dialog box for reporting an error to Microsoft is displayed when an application error occurs. Because this dialog box might cause failover to fail, reporting of the error must be suppressed.
- Windows Server 2008 or Windows Server 2012
-
-
From Control Panel, select System and Security, Action Center, and then Maintenance.
-
In Check for solutions to problem reports, click Settings.
-
In the Choose when to check for solutions to problem reports dialog box, select the Never check for solutions (not recommended) radio button.
-
Click the OK button.
-
(b) Physical host names
Make sure that the following condition is satisfied:
-
Each physical host name must be unique in the system.
(2) Flow of tasks from installation to starting operation
The following figure shows the flow of tasks for installing and setting up PFM - Agent for Enterprise Applications.
|
For details about how to install and set up PFM - Manager and PFM - Web Console, see the chapter that describes installation and setup in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
(3) Installation
Install PFM - Agent for Enterprise Applications on both executing and standby nodes.
The installation target is the local disk. Do not install PFM - Agent for Enterprise Applications on a shared disk.
The installation procedure is the same as for a non-cluster system. For details about the installation procedure, see 3.1.3 Installation procedure in Windows.
(4) Setup
This subsection describes the setup required in order to operate PFM - Agent for Enterprise Applications using SAP NetWeaver 7.0 or later.
indicates a setup item that is required depending on the environment or an optional setup item for changing default settings.
(a) Registering PFM - Agent for Enterprise Applications
To achieve central management of PFM - Agent using PFM - Manager and PFM - Web Console, you must register PFM - Agent for Enterprise Applications into PFM - Manager and PFM - Web Console.
If the version of PFM - Manager is 09-00 or later, PFM - Agent is registered automatically, in which case there is no need to perform the procedure described here. However, any data model version of PFM - Agent that is not included in the Release Notes for PFM - Manager must be registered manually. For details about the data model version of PFM - Agent for Enterprise Applications, see I. Version Compatibility.
The following shows the procedure for registering a PFM - Agent.
|
- Notes
-
-
Register PFM - Agent before you set up instance environments.
-
If you are adding the same version of PFM - Agent for Enterprise Applications to a Performance Management system in which information about PFM - Agent for Enterprise Applications has already been registered, there is no need to register the PFM - Agents.
-
If you install a different version of PFM - Agent for Enterprise Applications on a separate host, set up the old version first and then the new version.
-
If you have installed PFM - Agent on the same host as PFM - Manager, the jpcconf agent setup command executes automatically and the message KAVE05908-I New agent setup (Pfm-Agent-service-key) ended successfully. (version=version) is output to the common message log. Check the result; if the command did not execute correctly, re-execute it. For details about executing commands, see the chapter that describes commands in the manual Job Management Partner 1/Performance Management Reference.
-
■ Copying the setup files for PFM - Agent for Enterprise Applications
Copy the setup files from the host where PFM - Agent for Enterprise Applications was installed to the host where PFM - Manager and PFM - Web Console were installed.
To copy the setup files:
-
Stop PFM - Web Console if it is running.
-
Copy the PFM - Agent setup files in the binary mode.
The table below shows the source and target locations of the files to be copied.
Table 4‒2: Setup files to be copied Setup files for PFM - Agent
Target
PFM program name
OS
Target folder or directory
installation-folder\setup\jpcagtmw.EXE
PFM - Manager
Windows
PFM-Manager-installation-folder\setup
installation-folder\setup\jpcagtmu.Z
UNIX
/opt/jp1pc/setup/
installation-folder\setup\jpcagtmw.EXE
PFM - Web Console
Windows
PFM-Web-Console-installation-folder\setup
installation-folder\setup\jpcagtmu.Z
UNIX
/opt/jp1pcwebcon/setup/
■ Executing the setup command at the PFM - Manager host
To use PFM - Manager to set up PFM - Agent for Enterprise Applications, execute the following command:
jpcconf agent setup -key EAP
- Note
-
An error might occur if the jpcconf agent setup command is executed at a local host where Performance Management programs and services have not stopped completely. If an error occurs, check that all Performance Management programs and services have stopped completely and then re-execute the jpcconf agent setup command.
After completing this step, you can delete the PFM - Agent setup files from the PFM - Manager host.
(b) Creating the SAP users that are to be used by PFM - Agent for Enterprise Applications
To collect performance information, PFM - Agent for Enterprise Applications uses RFC (communication protocol of SAP AG) to execute the external management interfaces defined in the SAP system. Therefore, you must prepare in advance the SAP system users who are to be used by PFM - Agent for Enterprise Applications.
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
Define passwords for the SAP users. A password can 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 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)
As the value of each authorization, assign a value shown in the tables below or use the built-in configurations (S_RFC_ALL and S_XMI_ADMIN) that specify an asterisk (*) for all items.
(c) Setting up instance environments
You must set instance information for each SAP system that is to be monitored by PFM - Agent for Enterprise Applications. You perform the instance information setting at the PFM - Agent host.
The table below lists and describes the instance information items that are to be specified. Check this information before you start the setup procedure. For details about the instance information for an SAP system, see the SAP system documentation.
Item |
Description |
Permitted value |
Default value |
---|---|---|---|
SID |
ID of the SAP system that is to be monitored |
Character string (up to 8 bytes) |
-- |
SERVER |
SAP instance name that is to be monitored (the SAP instance name that has a dialog service, and which can be verified by transaction code SM51) |
Character string (up to 20 bytes) |
Instance name specified in -inst in the jpcconf inst setup command |
ASHOST |
Host name of the connection-target application server (the SAP local host, which can be verified by transaction code SM51) |
Character string (up to 100 bytes) |
Local host name |
SYSNR |
System number of the SAP system |
Numeric characters (up to 2 bytes) |
00 |
CLIENT |
Name of client to which the SAP user belongs (system number assigned to the connection-target dialog instance) |
Numeric characters (up to 3 bytes) |
000 |
USER |
SAP user name |
Character string (up to 12 bytes) |
-- |
EXTPWD |
Whether to use an extended password to connect to the SAP system |
Y or N
|
Y |
PASSWD |
Password of the SAP user |
|
-- |
DELAYCONNECT |
Timing of the connection to the SAP system |
Y or N
|
N |
Store Version# |
Store version to be used. For details about the Store version, see 3.6.2 Updating the Store version to 2.0. |
{1.0 | 2.0} |
2.0 |
- Legend:
-
--: None
- #
-
This setting is required when the version of PFM - Agent for Enterprise Applications is 09-00 or later, and the version of PFM - Base or PFM - Manager on the same host is 08-11 or later, and you are setting up an instance environment for the first time.
- Note
-
-
If no instance environment has been set up, the PFM - Agent for Enterprise Applications service cannot be started.
-
You use the jpcconf inst setup command to construct an instance environment.
To construct an instance environment:
-
Execute the jpcconf inst setup command with the service key and instance name specified.
For example, to construct an instance environment for the instance named o246bciSD500 for PFM - Agent for Enterprise Applications, execute the following command:
jpcconf inst setup -key EAP -inst o246bciSD500
Although you can use any instance name in PFM - Agent for Enterprise Applications, to simplify management we recommend that you use an instance name that identifies the SAP system that is to be monitored. Normally, a name in the format host-name_SAP-system-ID_system-number is assigned to an instance for an SAP system.
Note that no underscore (_) is allowed in the jpcconf inst setup command. For example, if the instance name of SAP system is o246bci_SD5_00, specify o246bciSD500 as the instance name of PFM - Agent for Enterprise Applications.
-
Specify instance information for the SAP system.
Enter the information shown in Table 4-5 Instance information for PFM - Agent for Enterprise Applications, in accordance with the command's instructions. You cannot omit any requested items. To use a displayed value (which is the default) press the Enter key.
Once you have entered all items, the instance environment is constructed. The following describes constructed instance environments:
-
Organization of folders for instance environments
Instance environments are constructed in the following folder:
-
When running a physical host: installation-folder\agtm
The following table shows the organization of the folders for instance environments.
Table 4‒6: Organization of folders for instance environments Folder and file names
Description
agent
instance-name
jpcagt.ini
Agent Collector service startup initialization file
jpcagt.ini.model#
Model file for the Agent Collector service startup initialization file
jpcMcollect.ini
Environment parameters file for SAP communications process
jr3alget.ini
Environment parameters file for CCMS Alert Monitor Command (PD_ALMX) records
jr3slget.ini
Environment parameters file for System Log Monitor Command (PD_SLMX) records
log
Storage folder for log files
store
instance-name
jpcsto.ini
Agent Store service startup initialization file
jpcsto.ini.model#
Model file for the Agent Store service startup initialization file
*.DAT
Data model definition file
dump
Export folder
backup
Backup folder
import
Import folder (for Store version 2.0)
log
Storage folder for log files
partial
Partial backup folder (for Store version 2.0)
STPD
Performance data storage folder for the PD record type (for Store version 2.0)
STPI
Performance data storage folder for the PI record type (for Store version 2.0)
STPL
Performance data storage folder for the PL record type (for Store version 2.0)
-
- #
-
You can use this file to restore the settings that were in effect before the instance environment was constructed.
-
Service ID for an instance environment
The service ID for an instance environment is a character string that consists of a product ID, function ID, instance number, instance name, and host name. For example, service ID MA1o246bciSD500[host01] represents the following instance environment:
-
Product ID: M
-
Function ID: A
-
Instance number: 1
-
Instance name: o246bciSD500
-
Host name: host01
For details about the service ID, see the appendix in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
-
-
Windows service name for instance environments
The following are the Windows service names for instance environments:
-
Agent Collector service: PFM - Agent for R/3 instance-name
-
Agent Store service: PFM - Agent Store for R/3 instance-name
For details about the Windows service names, see the appendix in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
-
(d) Specifying network settings ![[Figure]](GRAPHICS/ZUICON01.GIF)
You must specify network settings only when you change the network configuration where Performance Management is used.
You can set the following two network settings items:
-
IP addresses
Set this information to use Performance Management in a network that is connected to multiple LANs. To set multiple IP addresses, define the host names and IP addresses in the jpchosts file. Make sure that the settings in the jpchosts file are consistent throughout the entire Performance Management system.
For details, see the chapter that describes installation and setup in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
-
Port numbers
You can set the port numbers used by Performance Management. To avoid confusion during operation, make sure that the specified port numbers and service names are consistent throughout the entire Performance Management system.
For details about setting port numbers, see the chapter that describes installation and setup in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
(e) Changing the log file size ![[Figure]](GRAPHICS/ZUICON01.GIF)
Performance Management's operating status is output to a log file unique to Performance Management. This log is called the common message log, which consists of two files with a default size of 2,048 kilobytes each. This setting is required only when you wish to change this file size.
For details, see the chapter that describes installation and setup in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
(f) Changing the performance data storage locations ![[Figure]](GRAPHICS/ZUICON01.GIF)
These settings are required only when you wish to change the storage location, backup folder, export folder, partial backup folder, or import folder for the database that stores the performance data managed by PFM - Agent for Enterprise Applications.
The default storage locations for the performance data are as follows:
Storage location |
Folder name |
---|---|
Database storage location |
installation-folder\agtm\store\instance-name\ |
Backup location |
installation-folder\agtm\store\instance-name\backup\ |
Export location |
installation-folder\agtm\store\instance-name\dump\ |
Partial backup location (for Store version 2.0) |
installation-folder\agtm\store\instance-name\partial\ |
Import location (for Store version 2.0) |
installation-folder\agtm\store\instance-name\import\ |
For details, see 3.6.1 Changing the performance data storage location.
(g) Specifying the connection-target PFM - Manager for PFM - Agent for Enterprise Applications
On the host where a PFM - Agent is installed, you must specify the PFM - Manager that manages that PFM - Agent. You use the jpcconf mgrhost define command to set the connection-target PFM - Manager.
- Notes
-
-
There can be only one PFM - Manager as the connection destination even when multiple PFM - Agents are installed on the same host. Different PFM - Managers cannot be specified for the various PFM - Agents.
-
If a PFM - Agent and PFM - Manager are installed on the same host, that PFM - Manager on the local host is automatically the connection-target PFM - Manager; you cannot change the connection-target PFM - Manager to some other PFM - Manager.
-
To specify the connection-target PFM - Manager:
-
Stop all Performance Management programs and services.
Before you start the setup procedure, you must terminate all Performance Management programs and services that are running on the local host. For details about stopping services, see the chapter that describes starting and stopping services in the Job Management Partner 1/Performance Management User's Guide.
If a Performance Management program or service remains active during execution of the jpcconf mgrhost define command, a message is displayed that asks you to terminate the program.
-
Execute the jpcconf mgrhost define command with the host name of the connection-target PFM - Manager specified.
For example, if the connection-target PFM - Manager is on host host01, specify the command as follows:
jpcconf mgrhost define -host host01
(h) Specifying the settings for outputting action log data ![[Figure]](GRAPHICS/ZUICON01.GIF)
You can log information into the action log when, for example, PFM services start and stop, or when the status of the connection to PFM - Manager changes. The action log stores historical information that is output in conjunction with the alarms for thresholds related to system load and other conditions.
For details about how to set up the action log, see J. Outputting Action Log Data.