4.7.2 Tags that can be specified in the system for executing batch applications
This subsection describes the tags that can be specified in the system for executing batch applications.
- Organization of this subsection
(1) Definition of Web system attributes
The following table describes the contents that can be defined as Web system attributes:
Tag names |
Contents |
Easy Setup definition file |
Configuration definition change file |
Default |
|
---|---|---|---|---|---|
P |
U |
||||
web-system |
Defines a Web system. For defining the multiple Web systems, specify the <web-system> tag for each Web system. |
O#1 |
O |
O#2 |
None |
name |
Specifies a name for identifying the Web system, within 32 characters. This name must be unique within the management domain. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). |
M |
M |
M |
None |
addition-mode |
Specifies the addition mode.
|
-- |
-- |
O |
NORMAL |
display-name |
Specifies the display name of the Web system within 128 characters. There are no restrictions on the permitted characters. |
O |
O |
-- |
None |
description |
Specifies a comment about the Web system within 1,024 characters. There are no restrictions on the permitted characters. |
O |
O |
-- |
None |
- Legend:
-
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a Web system is defined.
O: Optional.
--: Not applicable.
- #1
-
This tag can be omitted if the Web system to be used is already defined using the Smart Composer functionality.
- #2
-
This tag can be omitted if no service unit is to be added.
- #3
-
For applying these settings, you must import and start the resource adapter in a batch using the Smart Composer functionality commands beforehand. For details, see the uCosminexus Application Server System Setup and Operation Guide.
(2) Definition of physical tier
Define the physical tier under the <tier> tag.
Tag names |
Contents |
Easy Setup definition file |
Configuration definition change file |
Default |
|
---|---|---|---|---|---|
P |
U |
||||
tier |
Defines the physical tier. In the system for executing batch applications, specify j2ee-tier or ctm-tier in the physical tier. Each physical tier define j2ee-tier in the <tier> tag. |
M |
O#1 |
-- |
None |
tier-type |
Specifies the types of physical tiers. In the system for executing batch applications, specify j2ee-tier or ctm-tier. |
M |
M |
-- |
None |
configuration |
Defines the configuration to be applied to all the logical servers in the physical tier for each type of logical server. |
O#2 |
M#3 |
-- |
None |
logical-server-type |
Specifies the types of logical servers for defining the configuration. In the system for executing batch applications, define the batch server as the logical J2EE server. The following are the types of logical servers that can be specified in the tags:
The logical server that can define the configuration varies according to the physical tier type.
|
M |
M |
-- |
None |
param#4 |
Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag. |
M |
M |
-- |
None |
param-name#4 |
Specifies the name of the parameter used for setting up the environment for the logical server. |
M |
M |
-- |
None |
param-value#4 |
Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value. |
M |
O#5 |
-- |
None |
- Legend:
-
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a Web system is defined.
O: Optional.
--: Not applicable.
- Note:
-
In a physical tier definition, you cannot specify the logical server configuration included in the user server and free-tier configuration. Specify these logical server configurations using unit definitions.
- #1
-
This tag can be omitted if the physical tier definition is not changed.
- #2
-
This tag can be omitted if the environment settings assumed in the Management Server during creation of the logical server are used for operations.
- #3
-
This tag can be omitted if the cmx_trans_param command is used for expanding the abstract parameter to create the physical tier configuration.
- #4
-
The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.8 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.
- #5
-
This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.
(3) Definition of the service unit
Define the service unit under the <unit> tag. The following table describes the contents that can be defined:
Tag names |
Contents |
Easy Setup definition file |
Configuration definition change file |
Default |
|
---|---|---|---|---|---|
P |
U |
||||
unit |
Defines a service unit. For defining the multiple service units, specify the <unit> tag for each service unit to be defined. |
M |
O#1 |
M |
None |
name |
Specifies a name for identifying the service unit, as a maximum of 32 characters. This name must be unique within the Web system. Specify this name in the -unit option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). |
M |
O#2 |
M |
None |
display-name |
Specifies the display name of the service unit within 128 characters. There are no restrictions on the permitted characters. |
O |
O |
O |
None |
description |
Specifies a comment about the service unit within 1,024 characters. There are no restrictions on the permitted characters. |
O |
O |
O |
None |
allocated-host |
Defines the reference to the host that configures a service unit. Specify only one <allocated-host> tag. |
M |
M |
M |
None |
host-ref |
Specifies the host name specified in the <name> tag in the host definition, the host name defined in the already setup Web system, or @myhost. When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup. If there are multiple hosts, the same host cannot be shared in the same service unit. |
M |
M |
M |
None |
hosts-for |
Specifies the type of physical tier to which the host specified in the <host-ref> tag belongs. Specify j2ee-tier or ctm-tier in the system for executing batch applications. |
M |
M |
M |
None |
define-server |
Defines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag. For example, if j2ee-tier is specified in the <hosts-for> tag, you can define one logical server for each of the batch server and the performance tracer. For defining multiple logical servers, specify the <define-server> tag for each logical server. |
O#3 |
M |
O#3 |
None |
logical-server-name |
Specifies a name for identifying the logical server or cluster within 128 characters. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). |
O |
-- |
O |
cmx_Web-system-name_service-unit-name_type_serial-number |
display-name |
Specifies the display name of the logical server within 128 characters. There are no restrictions on the permitted characters. |
O |
O |
O |
None |
description |
Specifies a comment about the logical server within 1,024 characters. There are no restrictions on the permitted characters. |
O |
O |
O |
None |
logical-server-type |
Specifies the types of logical servers for defining the configuration. In the system for executing batch applications, define the batch server as the logical J2EE server. The following are the types of logical servers that can be specified in the tags:
The logical server that can define the configuration of the host varies according to the physical tier type.
|
M |
M |
M |
None |
configuration |
Defines the configuration to be applied for each logical server. If the environment settings defined in the physical tier definition are to be used for operation, there is no need to define the<configuration> tag. |
O |
O |
O |
None |
param#4 |
Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag. |
M |
M |
M |
None |
param-name#4 |
Specifies the name of the parameter used for setting up the environment for the logical server. For the specifiable parameter names, see 4.8 System configuration patterns and defined logical servers. |
M |
M |
M |
None |
param-value#4 |
Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value. For details on the parameter settings, see 4.8 System configuration patterns and defined logical servers. |
M |
O#5 |
M |
None |
- Legend:
-
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a Web system is defined.
O: Optional.
--: Not applicable.
- Note:
-
In the configuration change definition file you cannot set up the logical server configuration included in the free-tier configuration.
- #1
-
This tag can be omitted if the service unit definition is not changed.
- #2
-
Can be omitted when cmx.websystem.name is specified in the client setting properties file or common client setting properties file.
- #3
-
This tag can be omitted if the configuration is not defined for each logical server.
- #4
-
The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.8 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.
- #5
-
This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.
(4) Definition of host
Tag names |
Contents |
Easy Setup definition file |
Configuration definition change file |
Default |
|
---|---|---|---|---|---|
P |
U |
||||
host |
Defines a host. For defining multiple hosts, specify the host tag for each host. A host can be shared among multiple Web systems. |
O#1 |
-- |
O#2 |
None |
host-name |
Specifies a name or IP address for identifying the host within 32 characters. A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255. When specifying the host name for which the IP address cannot be changed, an error occurs during the system setup. You can also specify @myhost in the <host-name> tag. If you specify @myhost, the host name is automatically replaced with the host name for the management server machine in the destination environment during system setup. |
M |
-- |
M |
None |
display-name |
Specifies the host display name within 128 characters. There are no restrictions on the permitted characters. |
O |
-- |
O |
None |
description |
Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters. |
O |
-- |
O |
None |
agent-host |
Specifies the host name or IP address of the Cosminexus Administration Agent. Specifies the host name within 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255. You can also specify @myhost in the <agent-host> tag. When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup. |
O |
-- |
O |
Value specified in host-name |
agent-port |
Specifies the port number of the Cosminexus Administration Agent, in the range from 1 to 65535. |
O |
-- |
O |
20295 |
- Legend:
-
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a host is defined.
O: Optional.
--: Not applicable.
- Note:
-
The host definition is not output when @myhost is specified in the <host-ref> tag in the unit definition, and the values in the <display-name> tag, <description> tag, <agent-host> tag, or <agent-port> tag in the host definition are omitted. In such a case, the Management Server automatically generates a value in the <host-name> tag of the host definition, as and when required. The host name is the computer name automatically created in the Management Server in Windows, and is the host name set up using the hostname command in UNIX. If the host does not contain any logical servers, the Management Server automatically deletes that host.
- #1
-
This tag can be omitted if the host to be used is already defined using the Smart Composer functionality.
- #2
-
This tag can be omitted if the host definition is not changed.