3.2.2 usrconf.properties (User property file for batch servers)
- Organization of this subsection
(1) Format
J2SE property file format.
Specify the key as follows:
key-name=value
- How to specify:
-
-
The string up to the linefeed is a value.
-
The line beginning with a hash mark (#) is a comment.
-
If you define a line without a value, the line is ignored.
-
You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.
(Example) key-name=value#comment
-
Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.
-
Specify the path in CJBATCHUSRCONFDIR using an absolute path.
-
If the format does not conform to Java specifications, the batch server might fail to start.
(Example) When the format contains an invalid Unicode escape sequence (the string after \U is not an appropriate Unicode hexadecimal value).
-
(2) File storage location
-
In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\
-
In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/
(3) Functionality
Specify the system properties of the JavaVM that execute the batch servers.
If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.
If you change the contents of this file while the batch server is running, the changes become effective only when the batch server is started next.
(4) Keys reserved in batch servers
A batch server internally uses the keys beginning with the following prefixes. As a result, the keys beginning with these prefixes must not be used in applications.
-
ejbserver.*
-
webserver.*
-
appclient.*
-
j2eeserver.*
(5) Keys for customization of batch servers
You can customize the operations of the batch servers by setting the values in the following system property keys.
The keys are classified and explained as follows:
The following table gives an overview of the respective specifiable keys and the default values. For details about the keys, see 2.2.3 usrconf.properties (User property file for J2EE servers). Furthermore, when referencing, substitute J2EE server and J2EE application for Batch server and Batch application respectively.
(a) Keys beginning with ejbserver.application
(b) Keys beginning with ejbserver.batch
Key name |
Overview |
Default value |
---|---|---|
Specify operations of a batch server when VM end method is invoked from the batch application.
|
true |
|
Specify an integer from 0 to 100 (unit: %) for the threshold value of the memory usage for executing GC. GC is executed when any of the following conditions are met. If 0 is specified, GC is not monitored.
|
0 |
|
Specify a group name for the batch servers managed by CTM within 63 characters having alphanumeric characters and underscore (_). |
JOBGROUP |
|
Specify the value from 1 to 32767 as the length of the schedule queue created with CTM. |
50 |
(c) Keys beginning with ejbserver.client
Key name |
Overview |
Default value |
---|---|---|
Specify the priority (priority order) for extracting the request accumulated in the queues within CTM. |
4 |
(d) Keys beginning with ejbserver.connectionpool
Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.
(e) Keys beginning with ejbserver.connector
Key name |
Overview |
Default value |
---|---|---|
Specify the number of log files of a resource adaptor. |
4 |
|
Specify the size of the log files of a resource adaptor. |
2097152 |
(f) Keys beginning with ejbserver.container
Key name |
Overview |
Default value |
---|---|---|
Specify whether to enable the database audit trail linkage functionality. |
false |
(g) Keys beginning with ejbserver.ctm
Key name |
Overview |
Default value |
---|---|---|
When the scheduling functionality is enabled and a batch server starts, the CTM queue will be activated. In such a case, you specify the waiting time (unit: seconds) between 0 and 2147483647. If you specify 0, CTM continues to wait infinitely. |
180 |
|
This property is necessary for using the CTM functionality. Specify name of the CTM domain to which the batch server belongs. |
CTMDOMAIN |
|
This property is necessary for using the CTM functionality. You specify CTM identifier of the CTM daemon that controls the batch server. |
IP-address |
|
This property is necessary for using the CTM functionality. You specify the host name or IP address used by CTM in the node-switching environment that inherits multi-home or IP address. |
host-name-acquired-by-hostname-command |
|
When the scheduling functionality is enabled and the batch server stops, the CTM queue will be deactivated. In such a case, you specify the waiting time (unit: seconds) between 0 and 2147483647. |
180 |
|
Specify whether the scheduling functionality will be used.
|
false |
(h) Keys beginning with ejbserver.deploy
Key name |
Overview |
Default value |
---|---|---|
Specify the maximum wait time until the next response sent from the command is received, after completing the server processing. |
60 |
|
Specify whether to scramble the DD files related to DataSource, JavaMail, and ResourceAdapter that are expanded below the working directory. |
false |
(i) Keys beginning with ejbserver.ext
Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.
Key name |
Overview |
Default value |
Related information |
---|---|---|---|
If this property is set, it implies:
|
0 |
5. Operations of J2EE Applications in the Operation, Monitoring, and Linkage Guide |
(j) Keys beginning with ejbserver.http
Key name |
Overview |
Default value |
---|---|---|
Specify the port number of the management server. |
28080 |
(k) Keys beginning with ejbserver.instrumentation
Key name |
Overview |
Default value |
---|---|---|
Specify whether to integrate with the Management Server. |
true |
(l) Keys beginning with ejbserver.jndi
(m) Keys beginning with ejbserver.jta
Key name |
Overview |
Default value |
---|---|---|
Specify the default value of transaction time-out for the transaction started on the batch server. |
180 |
(n) Keys beginning with ejbserver.logger
Key name |
Overview |
Default value |
---|---|---|
Specify the number of log files of a batch server. |
|
|
Specify the size of the log files of a batch server. |
|
|
Specify the log level of a batch server. |
Error |
|
Specify the rotation method of the J2EE server log output file.
|
WRAP |
(o) Keys beginning with ejbserver.management
(p) Keys beginning with ejbserver.manager
Key name |
Overview |
Default value |
---|---|---|
Specify the settings required for integrating with the Management Server. |
None |
|
Specify the settings required for integrating with the Management Server. |
false |
|
Specify the path of the setup file for JP1 integration. |
None |
|
Specify whether to integrate with JP1. |
false |
|
Specify the property file for issuing the Management event. |
None |
|
Specify whether to enable the functionality for issuing the Management event. |
false |
(q) Keys beginning with ejbserver.naming
Key name |
Overview |
Default value |
---|---|---|
Specify the host name or the IP address that invoke the CORBA Naming Service that the batch server uses. |
localhost |
|
Specify a name when the name is added to the CORBA Naming Service that is invoked, when the CORBA Naming Service is used in the automatic invocation mode. |
None |
|
Specify the port numbers of the CORBA Naming Service that the batch server uses. |
900 |
|
If the CORBA Naming Service still does not start after the lapse of an invocation wait time of the CORBA Naming Service that is specified in ejbserver.naming.startupWaitTime, specify an iteration frequency to await invocation only for the number of seconds specified in ejbserver.naming.startupWaitTime. |
9 |
|
Specify the wait time until the CORBA Naming Service can be used when the batch server is started. |
1 |
(r) Keys beginning with ejbserver.rmi
Key name |
Overview |
Default value |
---|---|---|
Specify the host name or the IP address of the RMI registry and MBean server used by the batch server in a multi-homed host environment. |
None |
|
Specify the port numbers of the RMI registry that is used by the batch server. |
23152 |
|
Specify the port numbers of the remote object that is exported in to the batch server. |
0 |
|
Specify the communication timeout period between the client and the server. |
0 |
(s) Keys beginning with ejbserver.server
Key name |
Overview |
Default value |
---|---|---|
Specify the PRF identifier. |
PRF_ID |
|
Specify an upper limit of the number of files of thread dump when the batch server detects an error and voluntarily outputs the thread dump. |
256 |
(t) Keys beginning with ejbserver.stdoutlog
Key name |
Overview |
Default value |
---|---|---|
Specify whether to enable the automatic flush functionality of the user output log and user error log. |
false |
(u) Keys beginning with ejbserver.watch
Key name |
Overview |
Default value |
---|---|---|
Specify whether to enable the depletion monitoring of all the resources. |
true |
|
Specify whether to enable alert output of memory monitoring. |
true |
|
Specify the memory monitoring interval. |
60 |
|
Specify the threshold value for monitoring memory usage state. |
80 |
|
Specify whether to output the results of memory monitoring in a file. |
true |
|
Specify whether to enable the alert output for file descriptor monitoring. Note that file descriptor monitoring cannot be used in Windows and AIX. |
true |
|
Specify the file descriptor monitoring interval. Note that file descriptor monitoring cannot be used in Windows and AIX. |
60 |
|
Specify the threshold value for monitoring the usage of a file descriptor. Note that file descriptor monitoring cannot be used in Windows and AIX. |
2147483647 |
|
Specify whether to output the results of file descriptor monitoring in a file. Note that file descriptor monitoring cannot be used in Windows and AIX. |
true |
|
Specify whether to enable alert output of thread monitoring. Note that you cannot monitor the number of threads in Linux. |
true |
|
Specify the thread monitoring interval. Note that you cannot monitor the number of threads in Linux. |
60 |
|
Specify the threshold value for monitoring the thread usage state. Note that you cannot monitor the number of threads in Linux. |
2147483647 |
|
Specify whether to output the results of thread monitoring to a file. Note that you cannot monitor the number of threads in Linux. |
true |
|
Specify whether to enable alert output of thread dump monitoring. |
true |
|
Specify the time interval for thread dump monitoring. |
30 |
|
Specify the ratio of the threshold value for thread dump monitoring with respect to the maximum value. |
80 |
|
Specify whether to output the results of thread dump monitoring to a file. |
true |
|
Specify whether to enable alert generation for Rate2 in the memory depletion monitoring information that is output by the resource depletion monitoring functionality. |
true |
(v) Keys beginning with https
The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.
VR is the version of Application Server on which the keys are introduced or changed.
Key name |
Overview |
Default value |
---|---|---|
Specify the recommended coding suite to be used in HttpsURLConnection.# |
# |
|
Specify the protocol to be used in HttpsURLConnection.# |
# |
(w) Keys beginning with java
Key name |
Overview |
Default value |
---|---|---|
Specify the factory class for the implementation class of the context delegated by InitialContext of JNDI. |
com.hitachi.software.ejb.jndi.InsContextFactory |
(x) Keys beginning with vbroker
Key name |
Overview |
Default value |
---|---|---|
Specify whether to use the Smart Agent. When you start the batch server for using the scheduling functionality, true will be automatically set up. |
false |
|
Specify the port number of Smart Agent. |
14000 |
|
Specify whether the closing of the connection will be controlled when a timeout occurs during the invocation of the EJB method defined as the remote interface.
|
false |
|
Specify whether to invoke the thread for managing the reply receiving threads. To set up vbroker.ce.iiop.ccm.htc.readerPerConnection=true, specify true. |
false |
|
Specify an upper limit of the entry count for one communication trace file of the Cosminexus TPBroker. |
120000 |
|
Specify an upper limit value of the communication trace file count for Cosminexus TPBroker. |
3 |
|
Specify a value from 1 to 210 bytes for the output path of Cosminexus TPBroker trace files. |
|
|
Set the IP address of the EJB container for each batch server by specifying any optional value. |
None |
|
You can set a communication port for each batch server, by specifying any optional value. |
0 |