Hitachi

uCosminexus Service Platform Setup and Operation Guide


3.5.5 Definition files used with the Easy Setup functionality for the HCSC production environment

When performing setup by using the Easy Setup functionality for the HCSC production environment, use the template files to create the definition files. Also, when changing the set up information, change the created definition file. Note that the template files are stored in the following directory:

Template file for SOAP 1.1 mode:
<Service Platform installation directory>\CSC\config\manager\templates\hsetup\esb
Template file for SOAP 1.1/1.2 combined mode:
<Service Platform installation directory>\CSC\config\manager\templates\hsetup\esb_1.1_1.2mode

The following table describes whether the definition files and template files to be used with the Easy Setup functionality for the HCSC production environment are provided. Note that this subsection describes the items that are edited when the definition files are created or changed, and the items for which values different from default values are set up in the Easy Setup functionality for the HCSC production environment. For details on the items and definition files other than those described here, see the manual description locations listed in the "Reference manual" and "Reference section" columns in the table.

Table 3‒32:  Provision of definition files and template files used with the Easy Setup functionality for the HCSC production environment

No.

Definition file name

Creatability during setup

Changeability

Existence of template file

Reference manual

Reference section

SOAP 1.1 mode

SOAP 1.1/1.2 combined mode

1

Manager configuration file (manager.cfg)

M

--

Yes

Yes

Application Server Definition Reference Guide

8.2.9

2

Administration Agent property file (adminagent.properties)

M

--

Yes

Yes

8.2.1

3

Management Server environment configuration file (mserver.properties)

M

--

Yes

Yes

8.2.6

4

Client common settings property file (cmxclient.properties)

M

--

Yes

Yes

4.2.3

5

Client common definition file (mngsvrutilcl.properties)

M

--

Yes

Yes

8.2.16

6

Snapshot log primary delivery target definition file (snapshotlog.conf)

Y

--

No

No

10.2.1

7

Snapshot log secondary delivery target definition file (snapshotlog.2.conf)

Y

--

No

No

10.2.1

8

Server definition file (SOAP Communication Infrastructure) (c4websv.cfg)

M

--

Yes

No

SOAP Application Development Guide

10.2

9

Common definition file (SOAP Communication Infrastructure) (c4webcom.cfg)

M

--

Yes

No

10.4

10

HCSC-Manager definition file (cscmng.properties)

M

--

Yes

Yes

Service Platform Reference Guide

6.5.3 HCSC-Manager definition file

11

HCSC-Manager command definition file (csccmd.properties)

M

--

Yes

Yes

6.5.2 HCSC-Manager command definition file

12

HCSC server configuration definition file (cscsvsetup.xml)

M

--

Yes

Yes

6.4.2 HCSC server configuration definition file

13

HCSC server setup definition file (cscsvsetup.properties)

M

--

Yes

Yes

6.4.3 HCSC server setup definition file

14

HCSC server runtime definition file (cscsvconfig.properties)

M

--

Yes

Yes

6.5.6 HCSC server runtime definition file

15

User-defined reception runtime definition file (cscurcptnconfig_id.properties)

A

Y#

Yes

Yes

6.6.2 user-defined reception runtime definition file

16

Service-information change definition file (cscadpconfig.properties)

A

Y#

Yes

Yes

6.5.10 Service-information change definition file

17

Easy Setup definition file (SOA.xml)

M

Y#

Yes

Yes

Application Server Definition Reference Guide

4.3

18

HTTP Server definition file (httpsd.conf)

A

x

No

No

HTTP Server

Specific location not applicable.

19

cscsetup command definition file (cscsetup.properties)

Y

--

Yes

Yes

Service Platform Reference Guide

6.4.1 cscsetup command definition file

Legend:

M: Necessarily created.

Y: Created and changed as and when required.

A: Need not be created. Ignore even if created.

x: An error occurs if this file exists. Delete the file.

-: Do not change.

Yes: Template file is provided.

No: Template file is not provided.

Note#

The following table describes the mapping between the definition file to be changed and the information to be changed:

Information to be changed

Definition file to be changed

Remarks

Service information

Service-information change definition file (cscadpconfig.properties)

Do not rename the definition file.

Definition information for user-defined receptions

User-defined reception runtime definition file (cscurcptnconfig_id.properties)

--

Definition information for servers

Easy Setup definition file (SOA.xml)

Do not rename the definition file.

Operation in an environment that is already set up is not guaranteed if the SOAP mode is changed.

Legend:

--: Not applicable

Organization of this subsection

(1) Description format of the definition files

The format for describing the definition files in this subsection is as follows:

File name

Specifies the name of the definition file.

Description

Specifies the description of the definition file.

File storage destination

Specifies the storage destination of the definition file.

Items to be edited #

Specifies the items to be edited when the definition file is created and changed.

Items for which values different from default values are specified#

Specifies the items for which values different from default values are specified when the setup is performed by using the Easy Setup functionality for the HCSC production environment.

Note#

The table contents of these items are as follows:

Category

The items in the definition file are categorized.

Item name

Specifies the names of items to be edited when the definition file is created or changed, and the items for which values different from default values are specified in the Easy Setup functionality for the HCSC production environment.

Parameters to be specified (or specified) in <param-name>

Specifies parameters to be specified or that are specified in the <param-name> tag. Applicable only to the Easy Setup definition file (SOA.xml).

Default value

Specifies the default values for the definition file. If the value of an item is omitted, the default value is assumed.

Values specified in the Easy Setup functionality for the HCSC production environment

Specifies the values specified in the definition file when the setup is performed by using the Easy Setup functionality for the HCSC production environment.

Description

Specifies the description of the item.

Content specified in <param-value>

Specifies the contents to be set up in the <param-value> tag. Applicable only to the Easy Setup definition file (SOA.xml).

(2) Manager configuration file

File name

manager.cfg

Description

Specifies the common settings for the components and commands to be operated in Management Server and Administration Agent respectively.

Items to be edited

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

com.cosminexus.manager.log.dir#

<Manager installation directory>\log

--

Specifies the Manager log output directory.

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

com.cosminexus.manager.log.compatible

true

false

Specifies the upward compatibility of Manager log.

(3) Administration Agent property file

File name

adminagent.properties

Description

Specifies the settings related to Administration Agent.

Items to be edited

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

adminagent.adapter.port#

20295

20295

Specifies the port number used by Administration Agent. Must match the value of <agent-port> under <host> in the Easy Setup definition file (SOA.xml).

adminagent.snapshotlog.log_dir#

<directory specified in com.cosminexus.manager.log.dir of manager.cfg >\snapshot

--

Specifies the snapshot log output destination directory as a character string.

adminagent.j2ee.watch.interval

10

10

Specifies the operation confirmation interval for J2EE servers in seconds.

adminagent.hws.watch.interval

10

10

Specifies the operation confirmation interval for HTTP Server in seconds.

adminagent.j2ee.watch.retry_count

1

1

Specifies the retry count when the operation confirmation processing fails during the confirmation of J2EE server operations.

adminagent.hws.watch.retry_count

1

1

Specifies the retry count when the operation confirmation processing fails during the confirmation of HTTP Server operations.

adminagent.j2ee.watch.start_time

45

45

Specifies the time period from the execution of the start command to the start of operation confirmation when the J2EE server is started, in seconds.

adminagent.hws.watch.start_time

0

0

Specifies the time period from the execution of the start command to the start of operation confirmation when HTTP Server is started, in seconds.

adminagent.j2ee.watch.timeout

60

60

Specifies the time until timeout during the confirmation of J2EE server operations, in seconds.

adminagent.hws.watch.timeout

60

60

Specifies the time until timeout during the confirmation of HTTP Server operations, in seconds.

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

adminagent.adapter.allowedHosts

--

localhost

Specifies the host name or IP address that is allowed access to the server.

adminagent.adapter.bind_host

localhost

--

Specifies the host name or IP address to be used for communication with Administration Agent.

adminagent.hws.watch.method

HEAD

OPTIONS

Specifies the HTTP method for confirming the HTTP Server operations when 2 is specified in adminagent.hws.watch.level.

adminagent.snapshotlog.num_snapshots

10

4

Specifies the number of snapshot log files for each logical server, collected as primary data.

adminagent.snapshotlog.listfile.2.num_snapshots

10

4

Specifies the number of snapshot log files for each logical server, collected as secondary data.

adminagent.j2ee.process.console_log.enabled

false

true

Specifies whether to output the console output information of a J2EE server to the console log.

Legend:

-: None

(4) Management Server environment configuration file

File name

mserver.properties

Description

Specifies the settings for the port number used by Management Server, and the operations of commands for detecting errors.

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Settings for the port number used by Management Server

webserver.connector.ajp13.port#

--

28009

Specifies the port number for internal communication of Management Server.

webserver.connector.http.port#

--

28080

Specifies the HTTP port number for Management Server connection. This value must match the value of cmx.connect.host in the client common settings property file (cmxclient.properties), and the value of mngsvrutil.connect.host in the client common definition file (mngsvrutilcl.properties).

webserver.shutdown.port#

--

28005

Specifies the port number for receiving the Management Server termination requests.

ejbserver.naming.port#

28900

28900

Specifies the port number to be used for internal management by Management Server.

webserver.connector.http.permitted.hosts#

When not defined: *

When not set up: localhost

*

Specifies the host that is allowed to access Management Server and IP address or host name of the Administration Agent operating host.

Settings for operations of error detection commands

com.cosminexus.mngsvr.management.port#

28099

28099

Specifies the external connection port number for the Management Server remote management function.

com.cosminexus.mngsvr.management.listen.port#

0

0

Specifies the port number for client connection, which is created during an external connection to the Management Server remote management function.

Settings for the HCSC operation mode

ejbserver.server.edition.settingforce

Smart

--

Specifies whether Management Server is to be used from HCSC-Manager.

  • Smart

    Management Server is not used from HCSC-Manager.

  • <Not specified>

    Management Server is used from HCSC-Manager.

If "Smart" is specified, the settings for ejbserver.naming.port are ignored.

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Settings for operations of error detection commands

com.cosminexus.mngsvr.management.enabled

false

true

Specifies whether to enable the Management Server remote management function.

com.cosminexus.mngsvr.management.connector.enabled

false

true

Specifies whether to enable the external connection to the Management Server remote management function.

com.cosminexus.mngsvr.management.host

--

localhost

Specifies the host name or IP address when fixing the host of the external connection to the Management Server remote management function.

java.rmi.server.hostname

--

localhost

Specifies the host name or IP address when fixing the host of the external connection to the Management Server remote management function.

Legend:

-: None

(5) Client common settings property file

File name

cmxclient.properties

Description

Specifies the default values for the common arguments of the commands provided with the Smart Composer functionality. This file is used to set up common default values for all the clients.

Items to be edited

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

cmx.apply_user#

--

SYSTEM, Administrator

Specify the user ID of the OS for the client that applies this file.

cmx.connect.host#

--

localhost: 28080

Specifies the host name and port number that is assumed when the -m option of the common arguments is omitted. This value must match the value of webserver.connector.http.port in the Management Server environment configuration file (mserver.properties), and the value of mngsvrutil.connect.host in the client common definition file (mngsvrutilcl.properties).

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

cmx.connect.userid

--

admin

Specifies the user ID that is assumed when the -u option of the common arguments is omitted.

cmx.connect.passwd

--

admin

Specifies the password that is assumed when the -p option of the common arguments is omitted.

cmx.verbose

false

true

Specify true to set the -verbose option of the common arguments as the default, and specify false to set the -noverbose option as the default.

cmx.websystem.name

--

SOA

Specifies the Web system name used when the -s option of the following commands is omitted:

  • cmx_build_system

  • cmx_delete_system

  • cmx_list_model

  • cmx_list_status

  • cmx_resume_lb

Legend:

-: None

(6) Client common definition file

File name

mngsvrutilcl.properties

Description

Specifies the default values of the options for the mngsvrutil command as the common definition.

Items to be edited

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

mngsvrutil.apply_user#

--

SYSTEM,Administrator

Specifies the user who applies the client common definition file in the OS user when executing the mngsvrutil command or adapter command.

mngsvrutil.connect.host#

--

localhost: 28080

Specifies the host name and port number of Management Server specified in the -m option of the mngsvrutil command. This value must match the value of webserver.connector.http.port in the Management Server environment configuration file (mserver.properties), and the value of cmx.connect.host in the client common settings property file (cmxclient.properties).

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

mngsvrutil.connect.password

--

admin

Specifies the password to be specified in the -p option of the mngsvrutil command.

mngsvrutil.connect.userid

--

admin

Specifies the user ID to be specified in the -u option of the mngsvrutil command.

mngsvrutil.target_name

--

J2EEServer

Specifies the logical server name or host name to be specified in the -t option of the mngsvrutil command.

Legend:

-: None

(7) Snapshot log primary delivery target definition file

File name

snapshotlog.conf

Description

Defines the target file of primarily sent data for collecting the snapshot log. No template file is provided for this file.

File storage destination

<Service Platform installation directory>\manager\config

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Directory to be collected

%val%#

--

--

Specifies the output destination of the HCSC-Manager log file.

If cscmng.log.dir is customized in cscmng.properties, the following two values must be added. If cscmng.log.dir is not customized, the log file output destination is already specified, so the values need not be added.

  • Value with "/.+" added to the definition value in cscmng.log.dir

  • Value with "/mmap/.+" added to the definition value in cscmng.log.dir

(Example of settings)

If cscmng.log.dir is D:/Home/log/Manager/HCSCManager

  • D:/Home/log/Manager/HCSCManager/.+

  • D:/Home/log/Manager/HCSCManager/mmap/.+

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

None

(8) Snapshot log secondary delivery target definition file

File name

snapshotlog.2.conf

Description

Defines the target file of secondarily sent data for collecting the snapshot log. No template file is provided for this file.

File storage destination

<Service Platform installation directory>\manager\config

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Directory for collection

%val%#

--

--

Specifies the output destination for the backup file of HCSC-Manager.

If cscmng.backup.dir is customized in cscmng.properties, the following two values must be added. If cscmng.backup.dir is not customized, the backup file output destination is already specified, so the values need not be added.

  • Value with "/.+" added to the definition value in cscmng.backup.dir

(Example of settings)

If cscmng.backup.dir is D:/Home/log/Manager/HCSCManager/backup

  • D:/Home/log/Manager/HCSCManager/backup/.+

%val%#

--

--

Specifies the location for allocating the repository.

If cscmng.repository.dir is customized in cscmng.properties, the following three values must be added. If cscmng.repository.dir is not customized, the repository allocation location is already specified, so the values need not be added.

  • Value with "/.+" added to the definition value in cscmng.repository.dir

  • Value with "/.+/.+" added to the definition value in cscmng.repository.dir

  • Value with "/.+/.+/.+" added to the definition value in cscmng.repository.dir

(Example of settings)

If cscmng.repository.dir is D:/Home/work/Manager/HCSCManager/repository

  • D:/Home/work/Manager/HCSCManager/repository/.+

  • D:/Home/work/Manager/HCSCManager/repository/.+/.+

  • D:/Home/work/Manager/HCSCManager/repository/.+/.+/.+

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

None

(9) Server definition file (SOAP Communication Infrastructure)

File name

c4websv.cfg

Description

Specifies the information required for server-side operations on SOAP Communication Infrastructure.

Items to be edited

None

Items for which values different from default values are specified

None

(10) Common definition file (SOAP Communication Infrastructure)

File name

c4webcom.cfg

Description

Specifies the information required for the common server and client operations on SOAP Communication Infrastructure.

Items to be edited

None

Items for which values different from default values are specified

Category

Item name

default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Log settings

c4web.logger.aplog_error_record

NONE

ALL

Specifies the settings for the output of application log when an error occurs.

(11) HCSC-Manager definition file

File name

cscmng.properties

Description

Specifies the information required for HCSC-Manager operations.

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Repository settings

cscmng.repository.root#

<Service Platform installation directory>\CSC\repository

--

Specifies the root directory of the repository with the absolute path.

Log settings

cscmng.log.dir#

<Service Platform installation directory>\CSC\log\manager

--

Specifies the log output destination directory with the absolute path.

Environment backup

cscmng.envbackup.dir#

Current directory

--

Specifies the output destination directory for the environment backup file when the environment is backed up with cscenvbackup.

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Settings for HCSC server operation

cscmng.server.HCSC.system

--

WebServer,PRF

Specifies the logical servers to be managed in the HCSC system.

Legend:

-: None

(12) HCSC-Manager command definition file

File name

csccmd.properties

Description

Specifies the default values for the command options used with Service Platform.

Items to be edited

None

Items for which values different from default values are specified

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Common command definitions

csc.all.user

--

admin

Specifies the default values for the arguments common to all the commands.

csc.all.pass

--

admin

csccompoconfig common definitions

csc.compoconfig.operation

--

get

csc.compoconfig.csc

--

HCSC

csccompodeploy common definitions

csc.compodeploy.csc

--

HCSC

csccompostart common definitions

csc.compostart.csc

--

HCSC

csccompostop common definitions

csc.compostop.csc

--

HCSC

csccompoundeploy common definitions

csc.compoundeploy.csc

--

HCSC

cscrcptnstart common definitions

csc.rcptnstart.csc

--

HCSC

cscrcptnstop common definitions

csc.rcptnstop.csc

--

HCSC

cscresinfo common definitions

csc.resinfo.csc

--

HCSC

cscstatus common definitions

csc.status.csc

--

HCSC

csc.status.type

--

system

cscsvconfig common definitions

csc.svconfig.operation

--

get

csc.svconfig.csc

--

HCSC

cscsvstart common definitions

csc.svstart.csc

--

HCSC

cscsvstop common definitions

csc.svstop.csc

--

HCSC

csc.svstop.force

--

Not set up

Legend:

-: None

(13) HCSC server configuration definition file

File name

cscsvsetup.xml

Description

Specifies the configuration information for the HCSC server.

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Definition of manager

<port>port number of Manager</port>#

28099

28099

Specifies the port number for connecting to the remote management function of Manager. This value must match the value of com.cosminexus.mngsvr.management.port in Management Server environment configuration file (mserver.properties).

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Definition of cluster

<name>Cluster name</name>

--

Cluster

Specifies the cluster name.

Definition of manager

<name>Manager name</name>

--

Manager

Specifies the HCSC-Manager-specific distinguished name used by HCSC-Manager to identify Manager.

<ip-address>IP address of Manager</ip-address>

--

localhost

Specifies the IP address where Management Server is started.

<id>Management User ID of Manager</id>

--

admin

Specifies the Management User ID of Management Server.

<password>Management User password of Management Server</password>

--

admin

Specifies the Management User password of Management Server.

Definition of csc-server

<name>HCSC server name</name>

--

HCSC

Specifies the HCSC server name.

<j2ee-server-name>Name of J2EE server that sets up the HCSC server </j2ee-server-name>

--

J2EEServer

Specifies the name of the J2EE server where HCSC server is set up.

<setup-properties>HCSC server setup definition file name</setup-properties>

--

cscsvsetup.properties

Specifies the name of the HCSC server setup definition file with the relative path, or absolute path.

Definition of soap-reception

<ip-address> IP address of %Web server</ip-address>

--

localhost

Specifies the IP address where the Web server is running.

<port>Port number of %Web server</port>

--

80

Specifies the reception port number of the Web server.

<protocol>Protocol type</protocol>

--

http

Specifies the Web server reception protocol.

Legend:

-: None

(14) HCSC server setup definition file

File name

cscsvsetup.properties

Description

Specifies the contents that can be set up when the HCSC server is set up.

Items to be edited

None

Items for which values different from default values are specified

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Related to setup configuration

db-use

--

OFF

Specifies whether to use a database with HCSC server.

rm-use

--

OFF

Specifies whether to use Reliable Messaging with HCSC server.

Related to standard receptions

request-ejb

--

OFF

Specifies whether to use the standard synchronous reception (SessionBean).

request-soap

--

ON

Specifies whether to use the standard synchronous reception (Web service).

request-jms

--

OFF

Specifies whether to use the standard asynchronous reception (MDB (WS-R)).

request-dbq

--

OFF

Specifies whether to use the standard asynchronous reception (MDB and (DB queue)).

Related to user-defined receptions

request-userdef-soap

--

ON

Specifies whether to use SOAP receptions.

Legend:

-: None

(15) HCSC server runtime definition file

File name

cscsvconfig.properties

Description

Specifies the post-setup HCSC server definition information from HCSC-Manager.

Items to be edited

None

Items for which values different from default values are specified

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Data transformation

xmltelegram-namespace-complement

--

ON

Specifies whether to complement the name space declaration corresponding to the name space prefix specified for the attribute values in an XML message for the XML messages flowing in the HCSC server.

Legend:

-: None

(16) User-defined reception runtime definition file

File name

cscurcptnconfig_id.properties

Description

Specifies the SOAP reception information.

When using the user-defined reception runtime definition file, change the file name to "cscurcptnconfig_<reception ID>.properties" and then execute the file. If the reception ID is "rcp1", change the file name to "cscurcptnconfig_rcp1.properties" and then execute. Note that if you want to change multiple SOAP receptions, create multiple files for each SOAP reception.

Items to be edited

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

user-defined-reception-soap.threads.maximum#

10

20

Specifies the maximum number of concurrent executions of the SOAP reception.

user-defined-reception-soap.exclusive.threads#

0

0

Specifies the number of dedicated threads of the SOAP reception.

user-defined-reception-soap.queue-size#

8192

10

Specifies the pending queue size of the SOAP reception.

Note#

Items to be edited during tuning.

Items for which values different from default values are specified

None

(17) Service-information change definition file

File name

cscadpconfig.properties

Description

Specifies the changes in the service information for the service adapter.

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Service information of the SOAP adapter

Cluster.<service ID>.WebService.url#1

Value specified during service adapter development

--

Specifies the URL to be used for invoking a service component.

Cluster.<service ID>.WebService.c4web.application.socket_read_timeout#2

300

--

This item is used in SOAP 1.1 mode.

Specifies the read timeout value for the service adapter socket in seconds.

Cluster.<service ID>.WebService.com.cosminexus.csc.request.timeout#2

300

--

This item is used in SOAP 1.1/1.2 combined mode.

This item specifies in seconds the read timeout value for the socket of the service adapter.

Legend:

-: None

Note#1

There are items to be edited during setup.

Note#2

Items to be edited during tuning.

Items for which values different from default values are specified

None

(18) Easy Setup definition file

File name

SOA.xml

Description

Defines the Web system.

Items to be edited

Category

Parameters to be specified in <param-name>

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Content specified in <param-value>

Service unit definition/ HTTP Server definition/ common configuration definitions for logical servers

mstartup.force.watchtime

60

60

Specifies the forced-stop monitoring time for the logical servers in seconds.

mstartup.restartcnt

1

1

Specifies the auto-restart count for the logical servers.

mstartup.retrywait

60

60

Specifies in seconds the interval at which the logical server automatically attempts to restart.

mstartup.start.watchtime

60

60

Specifies in seconds the time before the logical server start monitoring times out.

mstartup.watchtime

60

60

Specifies in seconds the time before the logical server stop monitoring times out.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ Web server definitions

Listen#1

--

80

Specifies the IP address and port number that receives the request.

ThreadsPerChild#2

40

50

Specifies the number of server threads to be started.Specify this definition only in Windows.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ redirector operation definition for HTTP Server

JkLogFileDir#1

logs

--

Specifies the log file output destination directory. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

JkTraceLogFileDir#1

logs

--

Specifies the output destination directory for maintenance trace log files. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ worker definition

worker.default.cachesize#2

64

40

Specifies the number of worker connections that are reused by the redirector. Specify this definition only in Windows.

worker.default.port#1

--

8007

Specifies the worker port number. This value must match the value of webserver.connector.ajp13.port in the Easy Setup definition file (SOA.xml).

worker.default.receive_timeout#2

3600

3600

Specifies the communication timeout value in seconds.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ HTTP Server log output definition

CustomDivideFileNum#1

8

8

Specifies the number of divided log files.

HttpsdLogFileDir#1

logs

--

Specifies the output destination directory for the log output by the Web server. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

Service unit definition/ J2EE server definition/ common configuration definitions for logical servers

mstartup.force.watchtime

--

60

Specifies the forced-stop monitoring time of the logical server in seconds.

mstartup.restartcnt

--

1

Specifies the auto-restart count of the logical server.

mstartup.retrywait

--

60

Specifies the auto-restart retry interval of the logical server in seconds.

mstartup.start.watchtime

--

600

Specifies the start monitoring time for logical servers in seconds.

mstartup.watchtime

--

60

Specifies the stop monitoring time of the logical servers in seconds.

user.env.variable

--

Not set

Specifies the environment variables for starting the server.

JAVACOREDIR=%val%#1

--

--

Specifies the output destination for the JavaVM thread dump. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.http

ejbserver.http.port#1

28008

8080

Specifies the port number of the port used for the management server.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.management

ejbserver.management.JVM.stats_monitor.FullGCCount.interval

600

600

Specifies the threshold value monitoring interval, in the monitoring of the full garbage collection frequency, in seconds.

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold

10

10

Specifies the frequency that forms the threshold value, in the monitoring of the full garbage collection frequency.

ejbserver.management.statistics.interval

60

60

Specifies the statistics collection interval in seconds.

ejbserver.management.stats_file.dir#1

<work directory>\ejb\<server name>\stats

--

Specifies the output destination directory of the statistics file. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

ejbserver.management.stats_file.num#1

7

8

Specifies the number of statistics files.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.naming

ejbserver.naming.port#1

900

900

Specifies the port of the CORBA Naming Service that the J2EE server uses as a naming service.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.rmi

ejbserver.rmi.naming.port#1

23152

23152

Specifies the port number of the RMI registry used by the J2EE server.

ejbserver.rmi.remote.listener.port#1

23550

23550

Specifies the port for receiving requests when statistics is collected by a JMX client (such as Administration Agent, JP1/Performance Management - Agent Option for uCosminexus Application Server).

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.watch

ejbserver.watch.defaultRequestQueue.threshold

80

80

Specifies the threshold value that outputs an alert message.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/user property/ parameters beginning with vbroker

vbroker.se.iiop_tp.scm.iiop_tp.listener.port#1

0

0

Specifies the communication port to be set up for each J2EE server.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with webserver.connector

webserver.connector.ajp13.max_threads#2

10

20

Specifies the number of concurrent executions for the Web container to process requests.

webserver.connector.ajp13.port#1

8007

8007

Specifies the port number to be used for communication with the Web server. This value must match the value of worker.default.port in Easy Setup definition file (SOA.xml).

Service unit definition, J2EE server definition, J2EE server configuration definition, or Java VM start option definition

-Xms%val%#2

256m

1024m

Specifies the initial Java heap size.

-Xmx%val%#2

512m

1024m

Specifies the maximum Java heap size.

-XX:MetaspaceSize=%val%#2

128m

128m

Specifies the initial size of Metaspace area.

-XX:MaxMetaspaceSize=%val%#2

128m

128m

Specifies the maximum size of Metaspace area.

ejb.public.directory#1

<work directory>\ejb\<server name>\logs

--

Specifies the work directory of the J2EE server. The J2EE server is started, considering the specified directory as the work directory. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

ejb.server.log.directory#1

<work directory>\ejb\<server name>\logs

--

Specifies the log file output destination directory. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

Service unit definition/ PRF definition/ common configuration definitions for logical servers

mstartup.force.watchtime

600

60

Specifies the forced-stop monitoring time for logical servers in seconds.

mstartup.restartcnt

1

1

Specifies the auto-restart count for logical servers.

mstartup.retrywait

0

0

Specifies the auto-restart retry interval for logical servers in seconds.

mstartup.start.watchtime

60

60

Specifies the start monitoring time for logical servers in seconds.

mstartup.watchtime

600

600

Specifies the stop monitoring time for logical servers in seconds.

Service unit definition/ PRF definition/ PRF configuration definition

prfspool#1

&{cosminexus.home}/PRF/spool

--

Specifies the PRF trace output directory. In Windows, use "\" as the path separation character. Note that forward slash (/) cannot be specified.

Host definition

--

20295

20295

Specifies the Administration Agent port number in <agent-port>#1#3 under <host>. This value must match the value of adminagent.adapter.port in the Administration Agent property file (adminagent.properties).

Legend:

-: None

Note#1

There are items to be edited during setup.

Note#2

Items to be edited during tuning.

Note#3

Specified in the tag mentioned in the table and not in <param-value>.

Items for which values different from default values are specified

Category

Parameters specified in <param-name>

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Content specified in <param-value>

Web system definition

--

--

SOA

Specifies the name for identifying the Web system in <name># under <web-system>.

Physical tier definition

--

--

combined-tier

Specifies the type of physical tier in <tier-type># under <tier>.

Service unit definition

--

--

Unit

Specifies the name for identifying the service unit, in <name># under <unit>.

--

--

localhost

Specifies the host name set in <name-name> in the host definition, the host name defined in the already set up Web system, or @myhost, in <host-ref># under <unit>.

--

--

combined-tier

Specifies the type of physical tier to which the host specified in <host-ref> belongs, in <hosts-for># under <unit>.

Service unit definition/ HTTP Server definition

--

cmx_<Web system name>_<service unit name>_<type>_<serial number>

WebServer

Specifies the name for identifying the logical server or cluster, in <logical-server-name># under <define-server>.

--

--

web-server

Specifies the type of logical server defining the configuration, in <logical-server-type># under <define-server>.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ Web server definitions

KeepAliveTimeout

15

3

Specifies the request waiting time for a KeepAlive connection in seconds.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ redirector operation definition for HTTP Server

JkMount

/* [J2EE server name] (for combined-tier and http-tier)

/* default

Specifies the URL pattern which is to be transmitted to the Web container, during a request to HTTP Server.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ worker definition

worker.default.type

--

ajp13

Specifies the worker type.

worker.default.host

--

localhost

Specifies the host name or IP address of the worker.

worker.list

--

default

Specifies the list of worker names.

Service unit definition/ HTTP Server definition/ configuration definition for HTTP Server/ HTTP Server log output definition

HttpsdErrorMethod

Div

Wrap

Specifies the error log output format.

HttpsdRequestMethod

Div

Wrap

Specifies the request log output format.

Service unit definition/ J2EE server definition

--

cmx_<Web system name>_<service unit name>_<type>_<serial number>

J2EEServer

Specifies the name for identifying the logical server or cluster in <logical-server-name># under <define-server>.

--

--

j2ee-server

Specifies the type of logical server defining the configuration, in <logical-server-type># under <define-server>.

Service unit definition/ J2EE server definition/ common configuration definitions for logical servers

mstartup.no

--

80

Specifies an integer as the order for starting the servers during a batch start operation.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.ext

ejbserver.ext.method_observation.interval

--

10

Specifies whether to use the functionality for monitoring the business application execution time. Also, specifies the time interval for monitoring whether a running request has timed out, and the time interval for canceling a timed out request (method), in seconds.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.jndi

ejbserver.jndi.global.enabled

true

false

Specifies whether to register an object with the Portable Global JNDI name for the naming service, when the application starts.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.manager

ejbserver.manager.agent.MEventAgent.enabled

true

false

Specifies whether to enable the Management event issuing functionality.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.rmi

ejbserver.rmi.naming.host

--

localhost

Specifies the host name or IP address of the RMI registry to be used as the service provider by J2EE server, in a multi-homed host environment.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with ejbserver.server

ejbserver.server.threaddump.filenum

256

4

Specifies the maximum number of thread dump files to be used when the J2EE server detects an error and voluntarily outputs a thread dump.

Service unit definition, J2EE server definition, J2EE server configuration definition, user properties, parameters whose names begin with manager

manager.j2ee.compat

none

V9

Specifies the J2EE server compatibility mode. The operation mode required by the HCSC server is V9 compatibility mode.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ user properties/ parameters beginning with webserver.connector

webserver.connector.ajp13.bind_host

--

localhost

Specifies the IP address or host name to be used for Web server integration.

Service unit definition, J2EE server definition, J2EE server configuration definition, Java VM start option definition

add.jvm.arg

--

+

Specifies the output format of the extended verbosegc information in -XX:%val%HitachiCommaVerboseGC.

--

+

Specifies whether to use the Explicit Memory Management functionality in -XX:%val%HitachiUseExplicitMemory.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ JavaVMsystem property

ejbserver.container.security.disabled

false

true

Specifies whether to enable the Enterprise Bean access control functionality.

ejbserver.ctm.enabled

true

false

Specifies whether to use the CTM functionality.

ejbserver.rmi.stateless.unique_id.enabled

false

true

Specifies whether invocation is not needed for the invocation of the remove method of Stateless Session Bean.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ Extension parameter of J2EE container

add.class.path

--

&lt;cosminexus.home&gt;\c4web\lib\hitsaaj.jar

In SOAP 1.1 mode:

Specifies the SOAP Communication Infrastructure as the communication base.

&lt;cosminexus.home&gt;\jaxws\lib\cjjaxws.jar

In SOAP 1.1/1.2 combined mode:

This item specifies the JAX-WS engine as the communication infrastructure.

Service unit definition/ J2EE server definition/ J2EE server configuration definition/ SecurityManager

use.security

true

false

Specifies whether to use SecurityManager in the J2EE server startup options.

Service unit definition/ PRF definition

--

cmx_<Web system name>_<service unit name>_<type>_<serial number>

PRF

Specifies the name for identifying the logical server or cluster, in <logical-server-name># under <define-server>.

--

--

performance-tracer

Specifies the type of logical server defining the configuration, in <logical-server-type># under <define-server>.

Service unit definition/ PRF definition/ common configuration definitions for logical servers

mstartup.no

0

0

Specifies the order for starting the servers during a batch start operation.

Service unit definition/ PRF definition/ PRF configuration definition

PrfTraceLevel

STANDARD

00030000

Specifies the trace collection level of the performance tracer.

Host definition

--

--

localhost

Specifies the name or IP address for identifying the server, in <host-name># under <host>.

--

Value specified in <host-name>

localhost

Specifies the host name or IP address of Administration Agent in <agent-host># under <host>.

Legend:

-: None

Note#

Specified in the tag mentioned in the table and not in <param-value>.

(19) HTTP Server definition file

File name

httpsd.conf

Description

Specifies the information required for HTTP Server operations. After performing setup by using the Easy Setup functionality for the HCSC production environment, change the file directly, as and when required before you start HTTP Server.

File storage destination

<Service Platform installation directory>\httpsd\servers\HWS_WebServer\conf

Items to be edited

Category

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

Host that is permitted to connect to Web server

<Location %val%>#

--

/

Specified to define a directive for the requests to a location indicated by a specific URL.

Order %val%#

--

deny,allow

Specifies the evaluation order for setting up the Allow directive and Deny directive.

Deny from %val%#

--

all

Specified to control the clients that can access the Web server.

Allow from %val%#

--

localhost

Specified to control the clients that can access the Web server.

Legend:

-: None

Note#

There are items to be edited during setup.

Items for which values different from default values are specified

None

(20) cscsetup command definition file

File name

cscsetup.properties

Description

Specifies the information required for the operations of the cscsetup command. This definition file is only enabled in UNIX.

Items to be edited

Item name

Default value

Values specified in the Easy Setup functionality for the HCSC production environment

Description

owner#1#2

Superuser

--

Specifies the owner to be set up in Component Container Administrator.

group#1#2

Superuser

--

Specifies the group to be set up in Component Container Administrator.

Legend:

-: None

Note#1

There are items to be edited during setup.

Note#2

If the owner and group values are not specified, execute setup and unsetup with the following information.

Table 3‒33:  Set values when the owner and group values are not specified

OS

File owner

Group name

Linux

root

root

AIX

root

system