Administration Guide > Configuration > Structure of the Configuration Files > JMX Agent

JMX Agent

Default values have been specified for most parameters. They can be changed if required. Parameters which must be adjusted to your system environment are written in red letters.

Structure of UCXJJMX.INI

Section/Parameter

Description

[GLOBAL]

 

name=

Name of the agent

The agent name is limited to 32 of the following characters: "A-Z", "0-9", "_", ".", "$", "@", "-" and "#".

Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects.

system=

AE system name
This entry must be identical to the Automation Engine's INI-file entry.

language=

Language for the logging

Allowed values: "E" (default value), "D" (German), "F"

logging=

Path and file name of the log file

The number signs serve as placeholders for a series in numerical order. When starting the agent, the log files are renamed so that the most current log file is always the one with the number "00".

logcount=

Number of stored log files

max_logging_kb=

Maximum size of the log file

A new log file is created when the size specified here has been reached.

helplib=

Path and name of message file

logToFile=

Creating log files

Allowed values: "0", "1" (default values)

"0" = No log files are created.
"1" = Log files are created.

loadOnStartup=

Start specification for the agent

Allowed values: "0", "1" (default value)

"0" - The agent must be started manually.
"1" - The agent starts when the Oracle WebLogic Server is started.

[AUTHORIZATION]  
InitialPackage=

The name and the path of the file that includes the authentication package (company-key file).

This parameter must be specified if you use the authentication methods "Server" or "Server and Agent". Any attempt to log in fails if the company-key file cannot be found.

When the agent starts, it reads the company-key file and stores its information in the file that is specified in the parameter KeyStore=. The first file is deleted afterward.

KeyStore=

The name and the path of the file that includes the information of the authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending *.kstr) or the path of the agent's INI file. If you define a file name, the ending *.kstr is not automatically appended.

The KeyStore file is created when the agent starts for the first time. You must not delete, rename or move it subsequently. Regardless of the authentication method that you use, any attempt to log in will fail if the agent cannot find this file when it starts. In this case, you must open the menu item "Renew transfer key" in the affected agent's System Overview.

Java agents (SAP, RA, databaseA database is an organized collection of data including relevant data structures. and JMX) that run under UNIX create a keystore file with the following right: "-rw-r--r—". In doing so, other OS users can also access this file.

[JMX]

 

type=

Type of the JMX agent

Allowed values: "JBOSS", "NETWEAVER", "TOMCAT", "WEBLOGIC" and "WEBSPHERE".

Enter one of the above values, depending on your license. The JMX agent is used in mode "stand alone" (default value)  if this parameter remains undefined.

search_all=

Consideration of local MBean Servers

Possible values: "0" (default) and "1"

"0" - The agent only searches the MBeans of the Server to which it is connected (to be specified in the Job object's JMX tab). 
"1" - The agent searches all local MBean Servers if the functions JMX_INVOKE, JMX_GET_ATTRIBUTE, JMX_SET_ATTRIBUTE and JMX_GET_INFO are used. JMX_QUERY_NAMES (including the Mbean Browser) only supply the MBeans of the current MBean Server. The first hit is taken if an MBean of the same name is available on several MBean Servers.

Note that this parameter is ineffective when a remote connection is established to the MBean Server.

[WEBSPHERE]  
soapTimeout=

Use this parameter to specify the seconds to wait for an MBean call response. The job aborts if this time span is exceeded.

The agent uses WebSphere's default value if no value or "0" has been specified.

[TRACE]

 

file=

Path and file name of the trace file

The number signs serve as placeholders for a series in numerical order. When starting a trace, the trace files will be renamed so that the most current trace file is always the one with the number "00".

trccount=

Number of stored trace files

max_trace_kb=

Maximum size of the trace file

A new trace file is created when the size specified here has been reached.

tcp/ip=

Trace flags of the agent

Allowed values: "0" (default value) to "9"

Set trace flags only in close cooperation with our support team.

[TCP/IP]

 

bindaddr=

IP address or host name for communication process connection

Use this parameter when the connection should be established via a particular IP address (e.g. the computer has more than one network interface card).

connect=

Time interval in seconds in which the agent attempts to establish connection to the Automation Engines. Effects the connection setup for a restart or after a lost connection.

Default value: 60 seconds

This parameter is only effective until the first successful logon to the AE system. Afterwards, the parameter RECONNECT_TIME can be used in the host characteristics.

cp=

Address of the communication process in the AE system to which the agent should connect itself.

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number

[VARIABLES]

This section contains agent variables with agent information and settings.

[CP_LIST]

List of communication processes

This list is created when the agent starts and extended when new communication processes are activated. More detailed information about establishing a connection is provided in the chapter Multi-Server Operation.

The communication process which has been defined in the parameter cp= (section [TCP/IP]) is not included in the cp list.

Format:
Port number
=DNS name
or
Port number
=TCP/IP address

Example of an INI File

[GLOBAL]
name=JMX01
system=UC4
language=E
logging=../temp/UCXJJMX_LOGG_##.TXT
logcount=10
max_logging_kb=1000
helplib=uc.msl
log_to_file=1
loadonstartup=0


[AUTHORIZATION]
InitialPackage=
KeyStore=


[JMX]
type=
search_all=0


[TRACE]
file=../temp/UCXJJMX_TRACE_##.TXT
trccount=10
max_trace_kb=1000
tcp/ip=0


[TCP/IP]
connect=60
cp=PC01:2217


[VARIABLES]
UC_HOST_JCL_VAR=JMX
UC_EX_PATH_JOBREPORT=.


[CP_LIST]
2218=PC01

 

See also:

Notes for Configuration-File Adjustments