Oracle TSAM Plus Agent

This chapter contains the following sections:

•	Prerequisites

•	Oracle TSAM Plus Agent APIs

•	Local Monitor Server (LMS)

•	Configurations for Oracle Tuxedo ART for CICS and Batch Monitoring

•	Configurations for Oracle PeopleSoft Applications Monitoring

•	Turning Oracle TSAM Plus On and Off

•	Oracle TSAM Plus Accounting and Chargeback

Prerequisites

To effectively and correctly use the Oracle TSAM Plus Agent, please note the following prerequisites:

•	The system clocks for all monitored Tuxedo machines and the Oracle TSAM Plus Manager are synchronized. A uniform time server is recommended.

•	Set each Tuxedo domain to a unique DOMAINID in the UBBCONFIG file.

Oracle TSAM Plus Agent APIs

The following APIs are used in conjunction with Oracle TSAM Plus:

•	tpgetcallinfo

tpgetcallinfo

User applications can take advantage of the monitoring attributes by using tpgetcallinfo. tpgetcallinfo is designed for call path monitoring. Using tpgetcallinfo, allows applications to make dynamic decisions based on application performance metrics.

For more information, see tpgetcallinfo() in the Oracle TSAM Plus Reference Guide.

Local Monitor Server (LMS)

Local Monitor Server (LMS) is a component of Oracle TSAM Plus Agent. It performs the following tasks:

•	Act as a data proxy server between Oracle TSAM Plus agent framework and Oracle TSAM Plus Manager

•	Accept policy and alert configuration request from Oracle TSAM Plus Manager and apply to Tuxedo domain

•	Send Tuxedo domain configuration to Oracle TSAM Plus Manager

•	Other help functionality

For more information, see LMS in the Oracle TSAM Plus Reference Guide.

Configurations for Oracle Tuxedo ART for CICS and Batch Monitoring

To use Oracle Tuxedo Application Runtime for CICS monitoring, an additional configuration file (Region-Group.mapping)is required. The file must be put in the directory specified by the KIXCONFIG environment variable. For more information, see Oracle Tuxedo Application Runtime for CICS Users Guide.

Note:

The KIXCONFIG environment variable is required for all ART applications.

Listing 2‑1 shows a Region-Group.mapping file format example.

Listing 2‑1 Region-Group.mapping File Format Example

[region]
name= REG1
tuxgroups=APPGRP1,APPGRP2
resources_group=resgroup1,resgroup2

[region]
name= REG2
tuxgroups=APPGRP3,APPGRP4
resources_group=resgroup3,resgroup4

 

Each region has a section in this file. The CICS region is called "name". The tuxgroups parameter is followed by the Oracle Tuxedo group name. The resources_group parameter is the CICS resource group in this region.

For more information, see the Oracle Tuxedo Application Runtime for CICS Reference Guide.

Note:

For Oracle Tuxedo Application Runtime for CICS running on Linux, the ARTMON server must be configured in order to enable TSAM Plus monitoring.

If you need to monitor Oracle Tuxedo Application Runtime for Batch ARTJES component, set the JESMONITOR environment variable to yes before you start the LMS server.

Configurations for Oracle PeopleSoft Applications Monitoring

Preparing a Configuration File

To monitor Oracle PeopleSoft Applications, you need to create a configuration file which is used to add necessary configurations required by TSAM Plus in the PeopleSoft ubx file. Listing 2‑2 shows the file format.

Listing 2‑2 Configuration File Format

TUXDIR=/home/Oracle/Applications/Tuxedo/tuxedo12.1.3.0.0

PS_UBX_PATH=/home/psadm2/psft/pt/8.54/appserv/APPDOM/psappsrv.ubx

ENABLE_LMS=yes

TSAM_MANAGER_HOSTNAME=<tsam_manager_host_name>

TSAM_MANAGER_PORT=5000

LMS_ADVANCED_OPTION=

ENABLE_TLISTEN=yes

TLISTEN_HOSTNAME=<tuxedo_domain_host_name>

TLISTEN_LISTEN_PORT=4000

TLISTEN_RMI_PORT=5000

TLISTEN_ADVANCED_OPTION=

JRE_HOME=/usr/java/jdk1.6.0_31/jre

PS_DOMAIN_LABEL=PS_DOMAIN

 

Table 2‑1 lists the keywords in the configuration file.

 

Table 2‑1 Configuration File Keywords

Keyword	Description
TUXDIR	Tuxedo installation home directory path. It is mandatory.
PS_UBX_PATH	The full pathname of the ubx file. It is mandatory.
ENABLE_LMS	Enables LMS. It is optional. Its value is yes or no (default) To monitor the PeopleSoft domains using TSAM Plus standalone, this option must be set. When specified, tsamadmin tool adds LMS server into the ubx file.
TSAM_MANAGER_HOSTNAME	Specifies the Oracle TSAM Plus manager hostname. It is mandatory when LMS is enabled.
TSAM_MANAGER_PORT	Specifies the Oracle TSAM Plus manager listening port. It is mandatory when LMS is enabled.
LMS_ADVANCED_OPTION	Specifies the advanced option for LMS. It is optional and will be ignored when LMS is not enabled.
ENABLE_TLISTEN	Enables tlisten. It is optional. Its values is yes or no (default) To monitor the PeopleSoft domains from Enterprise Manager console, this option must be set. When specified, tsamadmin tool adds the NETWORK section and EXT_MON option into ubx file. If you specify the -t option for tsamadmin, the tlisten process is started at the same time.
TLISTEN_HOSTNAME	The hostname which the PeopleSoft Tuxedo domain resides. Note that full hostname must be used. It is mandatory when tlisten is enabled.
TLISTEN_LISTEN_PORT	The port for tlisten listening. It is mandatory when tlisten is enabled.
TLISTEN_RMI_PORT	The listening port of the tlisten embedded JMX Agent. It is mandatory when tlisten is enabled.
TLISTEN_ADVANCED_OPTION	Specifies the advanced option for tlisten. Refer to tlisten doc. It is optional. When executing tsamadmin with -t option, it will be appended to tlisten command.
JRE_HOME	It must be JRE home. It is mandatory. The supported JRE versions are: • 7u85 and later • 8u60 and later
PS_DOMAIN_LABEL	A label for PeopleSoft domains. The default value is PS_DOMAIN. It can be used to identify multiple PeopleSoft domains. It is Optional. The maximum length of this field is 15 characters. The exceeded part will be truncated. If ENABLE_LMS is yes, the tsamadmin tool adds " -f $PS_DOMAIN_LABEL” to the LMS server in ubx file.

Executing tsamadmin

After the configuration file is created, run the tsamadmin command to execute the file. For example, if the configuration file name is template_file, run the following command:

tsamadmin template_file

Make sure tsamadmin is added to your PATH environment variable.

Particularly, if you want to start tlisten, run the command with the -t option:

tsamadmin template_file -t

Updating PeopleSoft Domain Configurations

Execute the PeopleSoft command psadmin in the Shell interface ( make sure it has been added to your PATH environment variable), then follow the prompt on the screen to configure the desired domain. After the domain is shut down, select “Load config as shown“ in the command line to create the new configuration. Finally, boot your PeopleSoft domain.

Note:

After the monitoring policy is automatically generated, you need to enable the policy in TSAM Plus Manager 12.2.2 console.

Turning Oracle TSAM Plus On and Off

Oracle TSAM Plus Agent provides a tmadmin command to turn on/off. If you want to turn off Oracle TSAM Plus temporally, this command can be used. The format is as follows:

changemonitor (chmo) [-m machine] on|off

The -m parameter specifies the logic machine name where the Oracle TSAM Plus collection is disabled. Without this option, monitoring on all machines is disabled. By default, monitoring is turned on. If monitoring is turned off, all data collection is stopped even if there is a monitoring policy defined.

Oracle TSAM Plus Accounting and Chargeback

TSAM Plus accounting and chargeback feature is used to collect data of all users and transactions during online processing and make offline analysis. For more information, see TSAM Plus Accounting and Chargeback in the Oracle TSAM Plus Reference Guide.

See Also

•	Oracle TSAM Plus Deployment Guide

•	Oracle TSAM Plus Console User Guide

•	Oracle Tuxedo Application Runtime for CICS and Batch documentation

•	Oracle TSAM Plus Reference Guide