4.6.2 Notes on setting up Easy Setup definition file (when using batch applications)
This section describes the notes on setting the Easy Setup definition file when creating a system for executing batch applications.
-
Settings for operating as batch server
You must specify the settings to set up and operate the server processes as a batch server. Define batch server as the logical J2EE server. Set the batch server in the configuration tag of the logical J2EE server (j2ee-server).
The following table describes various definitions related to the batch server:
Table 4‒34: Definitions related to a batch server Item
Parameter
Settings
Mandatory or Optional
Settings required for setting up the server as a batch server
batch.service.enabled
Specifies whether to configure a server as batch server. You must specify the parameter value as true.
Mandatory
Settings for not using the SecurityManager
use.security
Specifies whether to use the SecurityManager when starting the batch server. You must specify the parameter value as false.
Mandatory
Settings to enable the Light Transaction functionality
ejbserver.distributedtx.XATransaction.enabled
Specifies whether to use the global transaction. You cannot use the global transaction for batch server. Use local transaction instead. Use Light Transaction functionality that provides an optimized environment for local transactions. You must specify the parameter value as false. Do not make any changes as the default setting of this parameter is false.
Optional
Settings to disable Explicit Memory Management functionality
add.jvm.arg
Specifies whether to use Explicit Memory Management functionality.
If you do not intend to use Explicit Memory Management functionality in the batch server, we recommend that you disable the functionality. Specify the parameter value as -XX:-HitachiUseExplicitMemory to disable Explicit Memory Management functionality. By default, Explicit Memory Management functionality is enabled (-XX: +HitachiUseExplicitMemory).
Optional
Setting the real server name
realservername
Specify the real server name of the batch server. The real server name must be unique within the host. If you do not specify the name, logical server name is used.
Optional
Settings for JavaVM operations when Exit Jave VM method is called
ejbserver.batch.application.exit.enabled
Specify whether to end the JavaVM when following Exit JavaVM methods are called by batch applications:
-
java.lang.System.exit(int)
-
java.lang.Runtime.exit(int)
-
java.lang.Runtime.halt(int)
Default is true (exits the batch application thread without exiting JavaVM.). If you specify the parameter value as false, JavaVM exits along with the batch server when Exit JavaVM method is called. For details, see 2.3.7 Implementing a batch application (Batch application creation rules) in the uCosminexus Application Server Expansion Guide.
Optional
-
-
Settings for using the Scheduling functionality of batch applications
To use the Scheduling functionality of batch applications, define ctm-tier as the physical tier type. In addition to the settings to operate the server as batch server, you must also set the Scheduling functionality of batch applications. Specify these settings in the configuration tag of each logical server.
The following table describes definitions for the batch server and the Scheduling functionality of batch applications:
Table 4‒35: Definitions related to batch server and the Scheduling functionality of batch applications Logical server type
Item
Parameter
Contents
Mandatory or Optional
Logical CTM (component-transaction-monitor)
Settings for using the ORB Gateway functionality
ctm.Agent
Specifies whether to use ORB Gateway functionality of CTM Regulator.
When using the Scheduling functionality, use ORB Gateway functionality of CTM Regulator. You must specify the parameter value as 1.
Mandatory
Settings for identifying CTM
ctmid
Specifies CTM identifier.
You must set a unique value in the Operation Management Domain. You can omit the settings of CTM identifier.
Optional
Logical J2EE Server (j2ee-server)
Settings required for setting up a server as the batch server
batch.service.enabled
Specifies whether to set up a server as the batch server. You must specify the parameter value as true.
Mandatory
Settings for not using SecurityManager
use.security
Specifies whether to use the SecurityManager for starting the batch server. You must specify the parameter value as false.
Mandatory
Settings to enable the Light Transaction functionality
ejbserver.distributedtx.XATransaction.enabled
Specifies whether to use the global transaction. You cannot use the global transaction for the batch server. Use local transaction instead. Use Light Transaction functionality that provides an optimized environment for local transactions. You must specify the parameter value as false. Do not make any changes as the default setting of this parameter is false.
Mandatory
Settings for using Smart Agent
vbroker.agent.enableLocator
Specifies whether to use Smart Agent.
If you want to use the Scheduling functionality, you must also use Smart Agent. You must specify the parameter value as true.
Mandatory
Settings to disable Explicit Memory Management functionality
add.jvm.arg
Specifies whether to use Explicit Memory Management functionality.
If you do not intend to use Explicit Memory Management functionality in the batch server, we recommend that you disable the functionality. Specify the parameter value as-XX:-HitachiUseExplicitMemory to disable Explicit Memory Management functionality. By default, Explicit Memory Management functionality is enabled (-XX: +HitachiUseExplicitMemory).
Optional
Setting the real server name
realservername
Specifies the real server name of the batch server. The real server name must be unique within the host. If you do not specify the name, logical server name is used.
Optional
Settings for JavaVM operations when Exit Jave VM method is called
ejbserver.batch.application.exit.enabled
Specifies whether to end the JavaVM when the following Exit JavaVM methods are called by batch applications:
-
java.lang.System.exit(int)
-
java.lang.Runtime.exit(int)
-
java.lang.Runtime.halt(int)
Default is true (exits the batch application thread without exiting JavaVM.) If you specify the parameter value as false, JavaVM exits along with the batch server when Exit JavaVM method is called. For details, see 2.3.7 Implementing a batch application (Batch application creation rules) in the uCosminexus Application Server Expansion Guide.
Optional
Schedule Group name settings
ejbserver.batch.schedule.group.name
Specifies the schedule group name of the batch server group managed by CTM.
The default group name is JOBGROUP.
CTM schedules the execution of batch applications for every schedule group.
When you want to use multiple schedule groups and divide the schedule queues, you need to specify a schedule group name for every batch server.
Optional
Schedule queue length settings
ejbserver.batch.queue.length
Specifies the length of the schedule queue created by CTM. The default value is 50.
Optional
-
-
Notes on allocating multiple batch servers
While using batch application Scheduling functionality, define the number of batch servers to be allocated to one host in the physical tier definition; in order to allocate the multiple batch servers.
Even when allocating multiple batch servers, you can define the server configuration within the physical tier and service unit definitions. The following figure shows the applicability of the configuration definition of the batch server.
Figure 4‒11: Applicability of configuration definition of the batch server The following table describes the configuration definition applied to each batch server within a service unit; in case of the above figure.
Table 4‒36: Configuration definition applied to each batch server of the service unit Service unit
Batch server
Applicable configuration settings
unit1
Batch server(1A)
-
Service unit definition (definition of a specific batch server)
-
Physical tier definition (definition common to all the batch servers)
Batch server(1B)
Physical tier definition (definition common to all the batch servers)
As described in the table above, when t multiple configuration definitions are applied to each batch server and when you specify the same parameter in each of the definitions, the definitions are applied in the following priority order:
-
Service unit definition (definition of a specific batch server)
-
Physical tier definition (definition common to all the batch servers)
-
-
Definitions that are not used in the batch server
Load Balancer (load-balancer tag) is not used in the batch server.