HCSC-Manager definition file

Format

cscmng.repository.root=root-directory-path-of-repository

cscmng.log.dir=path-of-directory-to-output-log
cscmng.log.channel-name.filesize=log-file-size
cscmng.log.channel-name.filenum=number-of-log-files

cscmng.manager.identifier-name-of-Manager.timeout=read-timeout-value

cscmng.pireexec.response.dir=path-of-directory-for-storing-response-messages
cscmng.pireexec.response.encoding=character-encoding-for-stored-response-messages

cscmng.server.HCSC-server-name.system=logical-server-name

cscmng.repctl.export.dir=path-of-directory-to-output-export-file

cscmng.envbackup.dir=path-of-directory-to-output-environment-backup
cscmng.envbackup.dir.envrestore=path-of-directory-to-output-environment-backup-before-restoration
cscmng.envbackup.dir.import=path-of-directory-to-output-environment-backup-before-import
cscmng.envbackup.autoget={ON|OFF}
cscmng.envbackup.autoget.off={envrestore|import|envrestore,import}

cscmng.precache.thread.maximum=maximum-number-of-threads-processed-in-parallel-with-cscprecache-command

cscmng.server.HCSC-server-name.hws.svstop={normal|wait}
cscmng.server.HCSC-server-name.hws.svstop.timeout=timeout-value-for-planned-stop-of-HTTP-Server

Function

Sets up the information required for operating HCSC-Manager.

File storage location

Service-platform-installation-directory\CSC\config\manager\cscmng.properties

Specifiable parameters

(1) Repository settings

cscmng.repository.root=root-directory-path-of-repository ~ <String of maximum 100 bytes> <<service-platform-installation-directory\CSC\repository>>

Specifies an absolute path for the root directory of the repository. Use the characters / or \\ as directory delimiters.

An error might occur if a relative path is specified. An error also occurs if a non-existent directory is specified, and if the specified string exceeds 100 bytes. Therefore, if the service platform installation directory exceeds 84 bytes, explicitly specify this property.

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\repository

(2) Log settings

cscmng.log.dir=path-of-directory-to-output-log ~ <String of maximum 100 bytes> <<service-platform-installation-directory\CSC\log\manager>>

Specifies an absolute path for the directory to output the log. Use the characters / or \\ as directory delimiters. An error might occur if a relative path is specified. An error also occurs if a non-existent directory is specified, and if the specified string exceeds 100 bytes. Therefore, if the service platform installation directory exceeds 84 bytes, explicitly specify this property.

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\log\manager

cscmng.log.channel-name.filesize=log-file-size ~ <Numeric character> ((4096 to 16777216)) <<1048576>> When the channel is maintenance <numeric character> ((4096 to 16777216)) <<4194304>>

Specifies the maximum size per log file in bytes. If you specify an invalid value, the default value is specified. Specify any one of the following in the channel name:

cscmng.log.channel-name.filenum=number-of-log-files ~ <Numeric character> ((1 to 16)) <<2>>

Specifies the number of log files. If you specify an invalid value, the default value is specified. Specify any one of the following in the channel name:

(3) Manager settings

cscmng.manager.identifier-name-of-Manager.timeout=read-timeout-value ~ <Numeric character> ((0 to 86400)) <<0>>

Specifies the read timeout in the connection with Manager in seconds. A timeout does not occur if you specify 0. If you specify an invalid value, the default value is specified. Set up the Manager name specified in the HCSC server configuration definition file as the identifier name for Manager.

(4) Settings for re-executing process instances

cscmng.pireexec.response.dir=path-of-directory-for-storing-response-messages ((1 to 100 bytes))

Specifies an absolute path for the response message storage directory that is used when response messages are received during the re-execution of process instances. Use the characters / or \\ as directory delimiters. An error might occur if a relative path is specified. If no path is specified, the response messages are not stored. An error occurs if you specify a non-existent path. Also, the file cannot be created if the length of the file that includes the path exceeds MAX_PATH for the OS.

cscmng.pireexec.response.encoding=character-encoding-for-stored-response-messages ~ <<UTF-8>>

Specifies the JavaVM-supported encoding for the character encoding that is output when response messages are stored. If you specify a non-existent character encoding, the default value is specified.

(5) Settings for HCSC server operations

cscmng.server.HCSC-server-name.system=logical-server-name

Specifies the logical servers to be managed by the HCSC system. When the HCSC system manages the logical servers, this enables you to perform various logical server operations (starting and stopping logical servers with an HCSC server and referencing the statuses).

Specify logical server names by using commas (,) as delimiters, as follows: logical-server-name,logical-server-name, .... The one-byte spaces and tab characters before and after the commas are ignored. The logical servers are started and stopped in the order specified in Manager. If the HCSC servers are also to be simultaneously started, the order for starting the J2EE servers is followed.

(Example of specification )
To simultaneously start and stop the logical performance tracer (PRF) and the logical Web server (WebServer) on the HCSC server (HCSC):
cscmng.server.HCSC.system=PRF,WebServer

(6) Exporting the repository

cscmng.repctl.export.dir=path-of-directory-to-output-export-file ~ ((1 to 100 bytes))

Specifies the directory to output the export file when the cscrepctl command is used to export the repository.

(7) Backing up the environment

cscmng.envbackup.dir=path-of-directory-to-output-environment-backup ~ ((1 to 100 bytes)) <<current directory>>

Specifies the directory to output the environment backup file when the environment is backed up with the cscenvbackup command.

cscmng.envbackup.dir.envrestore=path-of-directory-to-output-environment-backup-before-restoration ~ ((1 to 100 bytes))

Specifies the directory to output the pre-restoration environment backup file when the environment is restored with the cscenvrestore command. The specification of this parameter has higher priority than the specification of the cscmng.envbackup.dir parameter. If you omit this parameter, the pre-restoration environment backup file is output to the directory specified with the cscmng.envbackup.dir parameter. If the cscmng.envbackup.dir parameter is also omitted, the file is output to the following directory:

Service-platform-installation-directory\CSC\spool\manager\

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\spool\manager

cscmng.envbackup.dir.import=path-of-directory-to-output-environment-backup-before-import ~ ((1 to 100 bytes))

Specifies the directory to output the pre-import environment backup file when a repository is imported by specifying the -import option with the cscrepctl command. The specification of this parameter has higher priority than the specification of the cscmng.envbackup.dir parameter. If you omit this parameter, the pre-import environment backup file is output to the directory specified with the cscmng.envbackup.dir parameter. If the cscmng.envbackup.dir parameter is also omitted, the file is output to the following directory:

Service-platform-installation-directory\CSC\spool\manager

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\spool\manager

cscmng.envbackup.autoget={ON|OFF} ~ <<ON>>

Specifies whether an automatic backup will be taken.

cscmng.envbackup.autoget.off={envrestore|import|envrestore,import}

Specify this parameter if you do not want to take an automatic backup when an environment is being restored or when a repository is being imported. If you do not want an automatic backup when the environment is restored and when the repository is imported, specify envrestore and import by using commas (,) as delimiters. The space characters before and after the commas are ignored.

(Examples of specifications)
  • If you do not want to take an automatic backup when an environment is restored
    cscmng.envbackup.autoget.off=envrestore
  • If you do not want to take an automatic backup when a repository is imported
    cscmng.envbackup.autoget.off=import
  • If you do not want to take an automatic backup when an environment is restored and when a repository is imported
    cscmng.envbackup.autoget.off=envrestore,import

Hint
Whether an automatic backup will be taken when an environment is being restored or when a repository is being imported differs depending on the specified combination of the parameters cscmng.envbackup.autoget and cscmng.envbackup.autoget.off. The following table describes the relationship between the parameters cscmng.envbackup.autoget and cscmng.envbackup.autoget.off.

Table 6-2 Relationship between the parameters cscmng.envbackup.autoget and cscmng.envbackup.autoget.off

Specification of the cscmng.envbackup.autoget parameterSpecification of the cscmng.envbackup.autoget.off parameterWhen an environment is restoredWhen a repository is imported
NoNoYY
NoEnvrestoreNY
NoImportYN
Noenvrestore,importNN
ONNoYY
ONEnvrestoreNY
ONImportYN
ONenvrestore,importNN
OFFNoNN
OFFEnvrestoreNN
OFFImportNN
OFFenvrestore,importNN
Legend:
Y: Automatic backup will be taken.
N: Automatic backup will not be taken.

(8) Thread settings for commands

cscmng.precache.thread.maximum=maximum-number-of-threads-processed-parallely-with-cscprecache-command ~ <Numeric character> ((1 to 1024)) <<16>>

Specifies the maximum number of threads for sending parallel pre-parse requests with the cscprecache command. An error occurs if no value is specified or if an invalid value is specified.

If there is no target or only 1 target for sending the parsing request, the threads are not generated, and hence the value of this property is ignored.

(9) Settings for HTTP Server operations

cscmng.server.HCSC-server-name.hws.svstop={normal|wait} ~ <<wait>>

Specifies the operations for stopping the HTTP Server. If you specify an invalid value, the default value is specified. This parameter is valid when you want to stop logical servers in a batch, to stop logical servers of the HTTP Server, and to stop an HCSC server from an operating environment window.

cscmng.server.HCSC-server-name.hws.svstop.timeout=timeout-value-for-planned-termination-of-HTTP-Server ~ <Numeric character> ((0 or less, or 60 to 1800)) <<300>>

Specifies the timeout value for stopping the HTTP Server in a planned manner, in seconds. If you specify an invalid value, the default value is specified.

If you specify 0 or a lesser value, the stop monitoring time set up in Management Server is specified. If the specified stop monitoring time is 0, the timeout does not occur. For details on the stop monitoring time, see 11.12.1 Start and stop settings for Web servers in the uCosminexus Application Server Management Portal User Guide.

This parameter is valid when you want to stop logical servers in a batch, to stop logical servers of the HTTP Server, and to stop an HCSC server from an operating environment window.

Note that if a value other than 0 is specified in the HWSGracefulStopTimeout directive, the timeout will also be monitored by the value specified in the HWSGracefulStopTimeout directive. For details on the HWSGracefulStopTimeout directive, see 6.2.4 Directives beginning with E, F, G, H, and I in the uCosminexus Application Server HTTP Server User Guide.

Example of coding

cscmng.repository.root=C:/Program Files/Hitachi/Cosminexus/CSC/repository

cscmng.log.dir=C:/Program Files/Hitachi/Cosminexus/CSC/log/manager
cscmng.log.message.filesize=1048576​
cscmng.log.message.filenum=2
cscmng.log.exception.filesize=1048576​
cscmng.log.exception.filenum=2
cscmng.log.maintenance.filesize=4194304​
cscmng.log.maintenance.filenum=2

cscmng.manager.node1.timeout=180
cscmng.manager.node2.timeout=180

cscmng.pireexec.response.dir=C:/TMP
cscmng.pireexec.response.encoding=UTF-8

cscmng.server.HCSC.system=PRF, WebServer

cscmng.repctl.export.dir=C:/TMP/autoexport

cscmng.envbackup.dir=C:/TMP/enbbackup
cscmng.envbackup.dir.envrestore=C:/TMP/envrestore
cscmng.envbackup.dir.import=C:/TMP/import
cscmng.envbackup.autoget=ON
cscmng.envbackup.autoget.off=envrestore

cscmng.precache.thread.maximum=16

cscmng.server.HCSC.hws.svstop=wait
cscmng.server.HCSC.hws.svstop.timeout=300

Notes