HCSC server setup definition file
Format
[db-use={ON|OFF}] |
Function
Specifies the information that can be set up when an HCSC server is set up.
File storage location
service-platform-installation-directory\CSC\config\manager\templates\cscsvsetup.properties
Specifiable properties
(1) Associated with setup configuration
db-use={ON|OFF} ~ <<ON>>
Specifies whether a database will be used with the HCSC server.
rm-use={ON|OFF} ~ <<OFF>>
Specifies whether Reliable Messaging will be used with the HCSC server. An error occurs if OFF is specified for the db-use property, and you specify ON for this property.
hcscserver-data-filepath=output-destination-path-storing-System-Administrator-information-for-HCSC-server ~ <String of maximum 100 bytes> <<service-platform-installation-directory\CSC\spool\msg>>
Specifies an absolute path for the output destination to store the System Administrator information for the HCSC server. Use the characters / or \\ as directory delimiters. An error occurs if you specify a non-existent directory, and if the specified string exceeds 100 bytes. Therefore, explicitly specify this property when service-platform-installation-directory exceeds 84 bytes. Note that the byte length that can be specified is the length obtained after decoding the string with ISO-8859-1.
(2) Associated with standard receptions
request-ejb={ON|OFF}
Specifies whether a standard synchronous reception (SessionBean) will be used.
Specify ON in the following cases:
request-soap={ON|OFF}
Specifies whether a standard synchronous reception (Web Service) will be used.
Specify ON to invoke service components from a service requester by using Web Service.
request-jms={ON|OFF}
Specifies whether a standard asynchronous reception (MDB(WS-R)) will be used. An error occurs if OFF is specified for the rm-use property and you specify ON for this property.
Specify ON in the following cases:
request-jms.maxmessage=maximum-number-of-messages-in-standard-asynchronous-reception-(MDB(WS-R))-queue ~ <Numeric character> ((1 to 65535)) <<1024>>
Specifies the maximum number of messages set when the reception queue is created for a standard asynchronous reception (MDB(WS-R)). This value depends on the value set in Reliable Messaging. This property is valid only when you specify ON in the request-jms property.
request-dbq={ON|OFF}
Specifies whether a standard asynchronous reception (MDB(DBQueue)) will be used. An error occurs if OFF is specified for the rm-use property, and you specify ON for this property.
Specify ON to invoke service components from a service requester by using (MDB(DBQueue)).
request-dbq.maxmessage=maximum-number-of-messages-in-standard-asynchronous-reception-(MDB (DB queue))-queue ~ <Numeric character> ((1 to 65535)) <<1024>>
Specifies the maximum number of messages set when the reception queue is created for a standard asynchronous reception (MDB(DBQueue)). This value depends on the value set in Reliable Messaging. This property is valid only when you specify ON in the request-dbq property.
request-jms-rdarea=RD-area-name-of-standard-asynchronous-reception (MDB(WS-R)) ~ <Alphanumeric characters beginning with alphabetic characters, spaces, and underscores (_)> ((1 to 30 characters))
Specifies the RD area name of a standard asynchronous reception (MDB(WS-R)). This property is invalid when Oracle is used as the database. Because this value depends on the value specified for Reliable Messaging, you can specify this property only when using Reliable Messaging.
request-dbq-rdarea=RD-area-name-of-standard-asynchronous-reception (MDB(DBQueue)) ~ <Alphanumeric characters beginning with alphabetic characters, spaces, and underscores (_)> ((1 to 30 characters))
Specifies the RD area name of a standard asynchronous reception (MDB(DBQueue)). This property is invalid when Oracle is used as the database. Because this value depends on the value specified for Reliable Messaging, you can specify this property only when using Reliable Messaging.
request-dbq-maxlen=maximum-length-of-messages-in-standard-asynchronous-reception-(MDB(DBQueue)) ~ <Numeric character> ((1000 to 1048576)) <<33000>>
Specifies the maximum length of messages in a standard asynchronous reception (MDB(DBQueue)) in bytes. This value depends on the value set in Reliable Messaging.
(3) Associated with user-defined receptions
request-userdef-soap={ON|OFF} ~ <<OFF>>
Specifies whether a SOAP reception will be used.
(4) Associated with J2EE
naming-service-hostname=host-name-of-Naming-Service ~ <Character string> <<localhost name>>
Specifies the host name for Naming Service. The host name depends on the name specified in the service platform. If you do not specify this property, the cscsvsetup command automatically sets up the host name.
naming-service-port=port-number-of-Naming-Service ~ <Numeric character> ((1 to 65535)) <<900>>
Specifies the port number for the naming service. The port number depends on the value set in the service platform. If you do not specify this property, the cscsvsetup command automatically sets up the port number.
(5) Associated with Reliable Messaging
rm-systemname=system-name-of-Reliable-Messaging ~ <Uppercase alphabetic characters or numbers beginning with alphabetic characters> ((1 to 3 characters))
Specifies the RM system name of Reliable Messaging used by the HCSC server. You can specify this property only when using Reliable Messaging.
The system name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the rm-use property. An error occurs if you specify this property when OFF is specified for the rm-use property.
rm-displayname=display-name-of-Reliable-Messaging ~ <Alphanumeric characters and underscores (_)>
Specifies the value obtained by sanitizing (changing characters other than one-byte alphanumeric characters to underscores (_)) the display name of Reliable Messaging (resource adapter) used by the HCSC server. You can specify this property only when using Reliable Messaging.
The display name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the rm-use property. An error occurs if you specify this property when OFF is specified for the rm-use property.
(6) Associated with DB Connector
dbcon-xadisplayname=display-name-of-DB-Connector-for-XATransaction-or-LocalTransaction ~ <Alphanumeric characters and underscores (_)>
Specifies the value obtained by sanitizing (changing characters other than one-byte alphanumeric characters to underscores (_)) the display name of DB Connectors for XATransaction or LocalTransaction, which is used by the HCSC server. The display name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.
dbcon-nodisplayname=display-name-of-DB-Connector-for-NoTransaction
Specifies the value obtained by sanitizing (changing characters other than one-byte alphanumeric characters to underscores (_)) the display name of DB Connector for NoTransaction, which is used by the HCSC server. The display name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.
(7) Associated with databases
dbtype={HIRDB|ORACLE11G}
Specifies the type of the database to be used by the HCSC server. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.
jdbc-type={DBPSV|HIRDB-TYPE4|ORACLE-THIN}
Specifies the type of the JDBC driver to be used when the HCSC server is offline. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.
jdbc-url=database-URL-for-JDBC ~ <Character string>
Specifies the destination database URL specified for establishing a connection with the Driver.connect method, as the connection settings supporting each JDBC driver to be used when the HCSC server is offline. Make sure that you specify this property when ORACLE-THIN is specified as the JDBC driver type in the jdbc-type property.
jdbc-dbhostname=host-name-of-a- database ~ <Character string> ((maximum 2086 characters))
Specifies the host name or the IP address of HiRDB to be used by the HCSC server when the HCSC server is offline. Make sure that you specify this property when DBPSV and HIRDB-TYPE4 are specified as the JDBC driver types in the jdbc-type property. When ORACLE-THIN is specified in the jdbc-type property, the specification of the jdbc-dbhostname property is disabled.
jdbc-dbconnectinfo=database-connection-information ~ <Alphanumeric characters>
Specifies the connection information (the port number or the name of the environment variable group) to be used when the HCSC server is offline. Use the characters / or \\ as directory delimiters. This value depends on the value set in DABroker or HiRDB. Make sure that you specify this property when DBPSV and HIRDB-TYPE4 are specified as the JDBC driver types in the jdbc-type property.
db-character-sets={ASCII|Shift_JIS|UTF-8|EUC-JP}
Specifies the type of the character encoding specified in the database to be used.
This property is used to convert the length (number of bytes of a string that can be entered in the database) of NCName of XML schema definition to the specified character encoding and perform a check during the input check for a command reception (MBean) and standard reception.
Make sure that you specify this property when ON is specified in the db-use property. You can omit this property if no database is to be used. If you do not specify this property when OFF is specified for the db-use property, check by converting the characters to UTF-8. If a type other than UTF-8 is specified, check with the specified character encoding.
db-tbl-split-key={NONE|MONTH} ~ <<NONE>>
Specifies whether the range segmentation function of tables will be used based on the date data.
Define the segmentation method used for the range segmentation function of tables in the SQL script file specified in the sql-scriptfilename property. For details on the configuration of tables, see Appendix C. Information on database tables in the uCosminexus Service Platform System Setup and Operation Guide.
db-tbl-split-corcheck-use={ON|OFF} ~ <<OFF>>
Specifies whether the check for duplicates in correlation sets, will be strengthened. Specify ON when using the segmentation functions of the execution log information table in HiRDB.
To use the table segmentation function, define the segmentation method in the SQL script file specified in sql-scriptfilename. For details on the configuration of tables, see Appendix C. Information on database tables in the Service Platform System Setup and Operation Guide.
(8) Compatibility of business process statuses
bp-status-compatible={ON|OFF}
Specifies the following information. This property is valid when you use persistent business processes.
The transaction and the status transition of the invoke service activity differ depending on the combination of the properties bp-status-compatible and bp-invoke-status-compatible. For details, see 3.4.4 Transactions of the invoke service activity in the manual uCosminexus Service Platform Description.
The default value for a new installation of 08-10 or later is OFF. Also, the default value is ON when migrated from the version 08-00 or earlier.
(9) Compatibility of invoke service activity statuses
bp-invoke-status-compatible={ON|OFF}
Specifies whether to end or to start a transaction when the execution of the invoke service activity of a business process is successfully completed.
This property is valid when you specify OFF in the bp-status-compatible property. Also, this property is valid when you use persistent business processes.
The transaction and the status transition of the invoke service activity differ depending on the combination of the properties bp-status-compatible and bp-invoke-status-compatible. For details, see 3.4.4 Transactions of the invoke service activity in the manual uCosminexus Service Platform Description.
The default value for a new installation is OFF. Also, the default value is ON when migrated from the version 08-70 or earlier.
(10) RD area (table area) information for databases
cscserverinfo-tbl-area=table-area-for-basic-HCSC-information ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the table area that creates the basic HCSC information table. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
server-trans-tbl-area=table-area-for-HCSC-linkage ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the table area that creates the HCSC linkage directory. The value to be specified depends on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
location-tbl-area=table-area-for-locations ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the table area that creates the location directory. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
routing-tbl-area=table-area-for-routing ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the table area that creates the routing directory. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
cv-tbl-area=table-area-for-data-transformation ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the table area that creates the data transformation directory. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
exehistory-tbl-area=table-area-for-execution-log-information ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the table area that creates the execution log information table. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
exehistory-idx-area=area-for-storing-execution-log-information-table-index ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the execution log information table. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
process-tbl-area=area-for-storing-PROCESS-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the PROCESS table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
process-idx-area=area-for-storing-index-of-PROCESS-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the PROCESS table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
activity-tbl-area=area-for-storing-ACTIVITY-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the ACTIVITY table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
activity-idx-area=area-for-storing-index-of-ACTIVITY-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the ACTIVITY table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
link-tbl-area=area-for-storing-LINK-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the LINK table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
link-idx-area=area-for-storing-index-of-LINK-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the LINK table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
correlationset-tbl-area=area-for-storing-CORRELATIONSET-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the CORRELATIONSET table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
correlationset-idx-area=area-for-storing-index-of-CORRELATIONSET-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the CORRELATIONSET table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
string-variable-tbl-area=area-for-storing-STRING-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the STRING-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
string-variable-idx-area=area-for-storing-index-of-STRING-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the STRING-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
numeric-variable-tbl-area=area-for-storing-NUMERIC-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the NUMERIC-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
numeric-variable-idx-area=area-for-storing-index-of-NUMERIC-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the NUMERIC-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
boolean-variable-tbl-area=area-for-storing-BOOLEAN-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the BOOLEAN-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
boolean-variable-idx-area=area-for-storing-index-of-BOOLEAN-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the BOOLEAN-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
message-variable-tbl-area=area-for-storing-MESSAGE-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the MESSAGE-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
message-variable-idx-area=area-for-storing-index-of-MESSAGE-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the MESSAGE-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
message-variable-val-area=area-for-storing-VariableValue-string-of-MESSAGE-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the VariableValue string of the MESSAGE-VARIABLE table for the business process infrastructure.
If you omit this property, the table area is determined based on the database to be used.
message-relation-tbl-area=area-for-storing-MESSAGE-RELATION-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the MESSAGE-RELATION table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
message-relation-idx-area=area-for-storing-index-of-MESSAGE-RELATION-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the index of the MESSAGE-RELATION table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the index area is determined based on the database to be used.
clusterinfo-tbl-area=area-for-storing-cluster-information ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the table to store the cluster information that is set up in a cluster. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
haasyncadp-tbl-area=area-for-storing-service-IDs-of-asynchronous-adapters-deployed-within-a-cluster ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))
Specifies the area that creates the table to store the asynchronous-adapters service IDs deployed within a cluster. The value to be specified differs depending on the type of the database to be used.
If you omit this property, the table area is determined based on the database to be used.
sql-scriptfilename=path-for-SQL-script-file ~ <Character string>
Specifies an absolute path for the SQL script file used to create the database. Use the characters / or \\ as directory delimiters.
This property is an optional function. When you specify a user SQL file in this property, make sure that the TABLE name, INDEX name, and VIEW name of the SQL file are correct. The operations might not function properly if you specify incorrect names. Also, when you remove the HCSC server setup, the tables used by the HCSC server are deleted irrespective of the SQL file contents. However, the tables that can be shared within the HA cluster are deleted only when the setup of the last HCSC server in the cluster is removed. For details on the set of tables used by the HCSC server, see 7.5.3 Recovery method during the HCSC server setup and unsetup in the uCosminexus Service Platform System Setup and Operation Guide.
Also, for details on the SQL script file, see Appendix D. Setting up the SQL script file in the uCosminexus Service Platform System Setup and Operation Guide.
Note that the following properties will be disabled when you specify this property:
(11) Compatibility of the maximum number of activity instances
activitynumber-maximum-compatible={ON|OFF} ~ <<OFF>>
Specifies the upper limit for the activity instance ID numbers that can be generated with one process instance.
The default values are as follows:
(12) XML parsing
xmlanalyze-mode={standard|advanced} ~ <<standard>>
Selects the XML parsing mode from the following. Specify standard to emphasize the compatibility with 09-00 or earlier in the process of XML parsing.
The notes on specifying advanced are as follows:
Example of coding
The following is an example of coding when HiRDB is used:
db-use=ON |
Usage
Specify the HCSC server setup definition file in the setup-properties element of the HCSC server configuration definition file.
Notes
The operations might not function properly if the same property is specified multiple times.