6.5.6 HCSC server runtime definition file
- Organization of this subsection
(1) Format
[methodtrace-filepath= Path-to-output-method-trace-and-exception-log]
[requesttrace-filepath=Path-to-output-request-trace]
[telegramtrace-filepath=Path-to-output-user-message-trace]
[methodtrace-filenum=number-of-method-trace-files]
[requesttrace-filenum=number-of-request-trace-files]
[telegramtrace-filenum=number-of-user-message-trace-files]
[bpacttrace-filenum=number-of-activity-trace-files-for-business-processes]
[methodtrace-filesize=size-of-method-trace-files]
[requesttrace-filesize=size-of-request-trace-files]
[telegramtrace-filesize=size-of-user-message-trace-files]
[bpacttrace-filesize=size-of-an-activity-trace-file-for-business-processes]
[bpacttrace-extend-item={NONE|PROCESSINSTANCEID}]
[telegramtrace-trigger={NORMAL|SYSERR|FAULT|DTERR}]
[telegramtrace-component-type-filepath=path-of-component-type-configuration-file-for-user-message-traces]
[telegramtrace-component-id-filepath=path-of-component-ID-configuration-file-for-user-message-traces]
[methodtrace-level={1|2|3|4|5}]
[requesttrace={ON|OFF}]
[telegramtrace={ON|OFF}]
[bpacttrace={ON|OFF}]
[bptrace-level={0|10|20|30}]
[bptrace-filenum=number-of-BP-trace-files]
[bptrace-filesize=BP-trace-size]
[bpexptrace-filenum=number-of-exception-log-files-for-business-process-infrastructure]
[bpexptrace-filesize=size-of-exception-log-files-for-business-process-infrastructure]
[cscexptrace-filenum=number-of-exception-log-files-for-messaging-infrastructure]
[cscexptrace-filesize=size-of-exception-log-files-for-messaging-infrastructure]
[request-ejb.instance.minimum=minimum-number-of-standard-synchronous-reception-(SessionBean)-instances]
[request-ejb.instance.maximum=maximum-number-of-standard-synchronous-reception-(SessionBean)-instances]
[request-ejb.ctm={true|false}]
[request-ejb.parallel.count=number-of-threads-prepared-to-invoke-applications-by-CTM]
[request-ejb.optional.name=optional-name-of-standard-synchronous-reception-(SessionBean)]
[request-soap.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap1_2.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-soap1_2.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-soap1_2.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-soap1_2.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-jms.instance.maximum=maximum-number-of-standard-asynchronous-reception-(MDB(WS-R))-instances]
[request-jms.rollback-count=rollback-warning-message-output-count-for-standard-asynchronous-reception-(MDB(WS-R))]
[receptionstop-monitor-timer=timeout-value-for-monitoring-reception-queue]
[csc-receptionstop-timeout=communication-timeout-value-to-wait-for-reception-termination]
[soapfault-targetnamespace-filepath=absolute-path-of-SOAP-fault-operation-definition-file]
[soapfault-handling-mode={DETAIL|FAULTCODE}]
[oa-adapter-character-code={SJIS|MS932}]
[formatdef-maxcache-num=number-of-cacheable-format-definitions]
[transformdef-maxcache-num=number-of-cacheable-data-transformation-definitions-for-servers]
[xmltelegram-maxcache-num=number-of-cacheable-XML-messages]
[telegram-validation={ON|OFF}]
[xmltelegram-namespace-complement={ON|OFF}]
[telegram-undefined-character-code={ERROR|REPLACE}]
[telegram-notfound-soapheader={ERROR|IGNORE}]
[validation-activity={ON|OFF}]
[transform-binary-error-check={ON|OFF}]
[code-table-root-path=absolute-path-of-root-path-of-code-conversion-table-storage-path]
[syserr-to-fault-convert={ON|OFF}]
[validate-fault-compatible={ON|OFF}]
[bp-reply-after-min-thread-pool-size=minimum-number-of-threads-used-for-executing-activities-after-response-activity]
[bp-reply-after-max-thread-pool-size=maximum-number-of-threads-used-for-executing-activities-after-response-activity]
[bp-reply-after-thread-pool-keep-alive=retention-time-of-threads-used-for-executing-activities-after-response-activity]
[service-emulate.enable={true|false}]
[service-emulate-def-filepath=absolute-path-of-definition-file-for-emulated-configuration-information]
[j2ee-stopapp-timeout=stop-monitoring-time-of-J2EE-applications]
[startcsc-timeout=start-monitoring-time-of-J2EE-servers]
[stopcsc-timeout=stop-monitoring-time-of-J2EE-servers]
[csc-command-timeout=command-timeout-value]
[csc-precache-timeout=timeout-value-for-EJB-communication-with-business-process-for-precache-processing]
[cookie-parsing={ON|OFF}]
[work-folder=absolute-path-of-work-folder]
[common-folder-common-folder-definition-name=absolute-path-of-common-folder]
[dba-separate-transaction={true|false}]
[common-uoc-prop-path=folder-for-storing-component-common-UOC-property-file]
[short-processid-servername=HCSC-server-name-identifier-to-be-used-with-process-instance-identifier]
[short-processid={ON|OFF}]
[xml-pooled-instance-minimum=minimum-number-of-pooled-instances-of-classes-used-in-XML-processing]
[xml-pooled-instance-maximum=maximum-number-of-pooled-instances-of-classes-used-in-XML-processing]
[request-id-separate-key={slash|atsign|period}]
[fileevent-reception.monitored-file.enabled={true|false}]
[fileevent-reception.monitored-folder=path-of-monitored-folder]
[fileevent-reception.monitor-interval=file-monitoring-interval]
[fileevent-reception.monitor-starting.delay=time-to-wait-before-file-monitoring-starts]
(2) Function
Specifies the definition information for a set up HCSC server from HCSC-Manager.
(3) File storage location
Service-platform-installation-directory\CSC\config\manager\templates\cscsvconfig.properties
(4) Specifiable properties
(a) Log trace
methodtrace-filepath=Path-to-output-method-trace-and-exception-log ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\csc\maintenance>>
Specifies an absolute path to output the method trace and the exception log of the messaging infrastructure and business process infrastructure.
Use the characters / or \\ as directory delimiters. If you specify a non-existent directory, the default value is used. The default value depends on the value set in the service platform.
requesttrace-filepath=Path-to-output-request-trace ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\csc>>
Specifies an absolute path to output the request trace. This property is valid only when you specify ON in the requesttrace property.
Use the characters / or \\ as directory delimiters. If you specify a non-existent directory, the default value is used. The default value depends on the value set in the service platform.
telegramtrace-filepath=Path-to-output-user-message-trace ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\csc>>
Specifies an absolute path to output the user message trace. This property is valid only when you specify ON in the telegramtrace property.
Use the characters / or \\ as directory delimiters. If you specify a non-existent directory, the default value is used. The default value depends on the value set in the service platform.
methodtrace-filenum=number-of-method-trace-files ~ <Numeric character> ((1 to 16)) <<8>>
Specifies the maximum number of method trace files.
requesttrace-filenum=number-of-request-trace-files ~ <Numeric character> ((1 to 16)) <<4>>
Specifies the maximum number of request trace files. This property is valid only when you specify ON in the requesttrace property.
telegramtrace-filenum=number-of-user-message-trace-files ~ <Numeric character> ((1 to 16)) <<4>>
Specifies the maximum number of user message trace files. This property is valid only when you specify ON in the telegramtrace property.
bpacttrace-filenum=number-of-activity-trace-files-for-business-processes ~ <Numeric character> ((1 to 16)) <<4>>
Specifies the maximum number of activity trace files for business processes. This property is valid only when you specify ON in the bpacttrace property.
methodtrace-filesize=size-of-method-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one method trace file in bytes.
requesttrace-filesize=size-of-request-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one request trace file in bytes. This property is valid only when you specify ON in the requesttrace property.
telegramtrace-filesize=size-of-user-message-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one user message trace file in bytes. This property is valid only when you specify ON in the telegramtrace property.
bpacttrace-filesize=size-of-an-activity-trace-file-for-business-processes ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one activity trace file for business processes in bytes. This property is valid only when you specify ON in the bpacttrace property.
bpacttrace-extend-item={NONE|PROCESSINSTANCEID} ~ <<NONE>>
Specifies whether to add output items to the activity trace for business processes. This property is valid only when you specify ON in the bpacttrace property.
-
NONE
No additional items are output to the activity trace.
-
PROCESSINSTANCEID
Process instance identifiers are output to the activity trace.
When activities are executed after a reply activity, the thread ID differs before and after the reply activity. In such cases, you can identify a request by outputting the process instance identifier.
telegramtrace-trigger={NORMAL|SYSERR|FAULT|DTERR} ~ <<NORMAL>>
Specifies the trigger that will output the user message trace. This property is valid only when you specify ON in the telegramtrace property.
-
NORMAL
Trace is output for a normal processing. Specify NORMAL in the test and debug environments by considering the effect on the processing performance of the HCSC server.
-
SYSERR
Trace is output when a system exception is detected.
-
FAULT
Trace is output when a fault is detected.
-
DTERR
Debug information is output when an error occurs during conversion processing of binary data.
The following table lists the combinations of output triggers for NORMAL, SYSERR, and FAULT and the messages that are output:
|
Output trigger |
Timing |
Message type |
||
|---|---|---|---|---|
|
Request message |
Response message |
Fault message |
||
|
NORMAL |
For a normal processing |
Y |
Y |
N |
|
When a system exception is detected |
N |
N |
N |
|
|
When a fault is detected (not caught) |
N |
N |
N |
|
|
When a fault is detected (caught) |
N |
N |
N |
|
|
SYSERR |
For a normal processing |
N |
N |
N |
|
When a system exception is detected |
Y |
N |
N |
|
|
When a fault is detected (not caught) |
Y |
N |
N |
|
|
When a fault is detected (caught) |
N |
N |
N |
|
|
FAULT |
For a normal processing |
N |
N |
N |
|
When a system exception is detected |
N |
N |
N |
|
|
When a fault is detected (not caught) |
Y |
N |
Y |
|
|
When a fault is detected (caught) |
Y |
N |
Y |
|
- Legend:
-
Y: Message is output.
N: Message is not output.
The following table lists the combinations of output trigger for DTERR and the information that is output:
|
Output trigger |
Timing |
Output information |
|---|---|---|
|
DTERR |
When binary data is read (transformation from binary to DOM) |
Information about the message (binary or DOM) that was processed before an error occurred |
|
When binary data is generated (transformation from DOM to binary) |
Information about the message (DOM) that was processed before an error occurred |
You can specify multiple values by using commas as delimiters. Even if you specify multiple triggers, the same information is not output repeatedly. For example, if a request message is already output for a normal processing, the message is not output when a system exception or a fault is detected.
telegramtrace-component-type-filepath=path-of-component-type-configuration-file-for-user-message-traces ~ <Character strings (including two-byte characters) and spaces>
If you want to output information for only the specific component types for the user message trace, specify the absolute path for the component-type configuration file in which the component types are specified. Use a forward slash (/) or two backslashes (\\) as a directory separator. An error occurs if you specify a non-existent file.
This property is valid only when you specify ON in the telegramtrace property and specify NORMAL in the telegramtrace-trigger property.
For details about how to define the component-type configuration file, see 6.5.9 Component-type configuration file.
There are the following two ways to specify the HCSC components for which the user message trace for normal processing is output. If you specify the same HCSC component in both the component-ID configuration file and the component-type configuration file, the setting of the component-ID configuration file will be applied.
-
Specify the component type (telegramtrace-component-type-filepath property).
-
Specify the HCSC component ID (telegramtrace-component-id-filepath property).
For details about the contents of the user message trace to be output with HCSC components specified, see 7.4.4 User message trace in the Service Platform Setup and Operation Guide.
telegramtrace-component-id-filepath=path-of-component-ID-configuration-file-for-user-message-traces ~ <Character strings (including two-byte characters) and spaces>
If you want to output information for only the specific HCSC components for the user message trace, specify the absolute path to the component-ID configuration file in which the HCSC component IDs and whether to output information are specified. Use a forward slash (/) or two backslashes (\\) as a directory separator. If you specify a non-existent file, an error occurs.
This property is valid only when you specify ON in the telegramtrace property and specify NORMAL in the telegramtrace-trigger property.
For details about how to define the component-ID configuration file, see 6.5.8 Component-ID configuration file.
There are the following two ways to specify the HCSC components for which the user message trace for normal processing is output. If you specify the same HCSC component in both the component-ID configuration file and the component-type configuration file, the setting of the component-ID configuration file will be applied.
-
Specify the component type (telegramtrace-component-type-filepath property)
-
Specify the HCSC component ID (telegramtrace-component-id-filepath property)
For details about the contents of the user message trace to be output with HCSC components specified, see 7.4.4 User message trace in the Service Platform Setup and Operation Guide.
methodtrace-level={1|2|3|4|5} ~ <<3>>
Specifies the output level for the method trace. The following table lists the output information and the output levels:
|
Output information |
Output level |
||||
|---|---|---|---|---|---|
|
1 |
2 |
3 |
4 |
5 |
|
|
Information about the input file and output file (file path, file format, file size, and number of records)#1 |
Y#1 |
Y#1 |
Y#1 |
Y#1 |
Y#1 |
|
Entrance and exit information for the standard reception method (class name, method name, argument, return value)#2 |
N#2 |
Y#2 |
Y#2 |
Y#2 |
Y#2 |
|
Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value) |
N |
N |
Y |
Y |
Y |
|
Entrance and exit information for the interfaces within the components (class name, method name, argument, return value) |
N |
N |
N |
Y |
Y |
|
Debug information (information such as the branching of processing) |
N |
N |
N |
N |
Y |
- Legend:
-
Y: Information is output.
N: Information is not output.
- #1
-
Output only for file transformation operations.
- #2
-
Not applicable to DB adapters.
requesttrace={ON|OFF} ~ <<ON>>
Specifies whether the request trace will be collected.
-
ON
The request trace will be collected.
-
OFF
The request trace will not be collected.
telegramtrace={ON|OFF} ~ <<OFF>>
Specifies whether the user message trace will be collected. Specify ON to output debug information.
-
ON
The user message trace will be collected.
-
OFF
The user message trace will not be collected.
bpacttrace={ON|OFF} ~ <<OFF>>
Specifies whether to collect activity traces for business processes. For details about activity traces, see 7.4.5 Activity trace in the Service Platform Setup and Operation Guide.
-
ON
Activity traces will be collected.
-
OFF
Activity traces will not be collected.
bptrace-level={0|10|20|30} ~ <<10>>
Specifies the output level of the method trace for the business process infrastructure. The following table lists the output information and the output levels:
|
Output level |
Output content |
|---|---|
|
0 |
Error information |
|
10 |
Error information, I/O and data of other programs# I/O and data of main functions Start and stop of communication executed by the business process debugging functions, Start and stop of debug processing |
|
20 |
Error information, I/O and data of other programs# I/O and data of functions |
|
30 |
Error information, I/O information of other programs# I/O and data of functions Point information for main locations |
- #
-
Also includes the messaging and data transformation infrastructures.
bptrace-filenum=number-of-BP-trace-files ~ <Numeric character> ((1 to 16)) <<16>>
Specifies the number of method trace files for the business process infrastructure.
bptrace-filesize=BP-trace-size ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the method trace size for the business process infrastructure in bytes.
bpexptrace-filenum=number-of-exception-log-files-for-business-process-infrastructure ~ <Numeric character> ((1 to 16)) <<16>>
Specifies the maximum number of exception log files for the business process infrastructure.
bpexptrace-filesize=size-of-exception-log-files-for-business-process-infrastructure ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one exception log file for the business process infrastructure in bytes.
cscexptrace-filenum=number-of-exception-log-files-for-messaging-infrastructure ~ <Numeric character> ((1 to 16)) <<16>>
Specifies the maximum number of exception log files for the messaging infrastructure.
cscexptrace-filesize=size-of-exception-log-files-for-messaging-infrastructure ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one exception log file for the messaging infrastructure in bytes.
(b) Associated with standard receptions
request-ejb.instance.minimum=minimum-number-of-standard-synchronous-reception-(SessionBean)-instances ~ <Numeric character> ((0, or 1 to value set in the request-ejb.instance.maximum property)) <<value set in the request-ejb.instance.maximum property >>
Specifies the minimum number of standard synchronous reception (SessionBean) instances in a pool. This property is valid only when you specify ON in the request-ejb property of the HCSC server setup definition file.
request-ejb.instance.maximum=maximum-number-of-standard-synchronous-reception-(SessionBean)-instances ~ <Numeric character> ((1 to 1024)) <<10>>
Specifies the maximum number of standard synchronous reception (SessionBean) instances in a pool. This property is valid only when you specify ON in the request-ejb property of the HCSC server setup definition file.
Specify at least 127 instances when you are using CTM and when you want to dynamically change the number of concurrent executions of CTM.
request-ejb.ctm={true|false} ~ <<false>>
Specifies whether the system will be integrated with CTM. This property is valid only when you specify ON in the request-ejb property of the HCSC server setup definition file.
-
true
The system will be integrated with CTM.
-
false
The system will not be integrated with CTM.
request-ejb.parallel.count=number-of-threads-prepared-to-invoke-applications-by-CTM ~ <Numeric character> ((1 to 127)) <<1>>
Specifies the number of threads prepared to invoke applications by CTM. This property is valid only when you specify true in the request-ejb.ctm property. Specify a value that is equal to or less than the value specified in the request-ejb.instance.maximum property.
request-ejb.optional.name=optional-name-of-standard-synchronous-reception-(SessionBean) ~ <Alphanumeric characters, underscores (_), periods (.), and forward slashes (/)> ((1 string length
255))
Specifies the optional name of the standard synchronous reception (SessionBean). Specify the same optional name with all the HCSC servers when you use a standard reception.
This property is valid only when the JavaVM system property ejbserver.cui.optionalname.enabled is set to true. For details on ejbserver.cui.optionalname.enabled, see 5.2.3 usrconf.properties (System property file for server management commands) in the Application Server Definition Reference Guide.
Note that a request reception cannot be invoked if the following names are specified:
-
Names duplicated with the following values (with the running status):
-
Service ID of a service adapter
-
Service ID of a business process
-
Reception ID of a user-defined reception
-
Other names, such as the value specified for optional-name of J2EE applications
-
-
Names beginning with HITACHI_EJB
-
Names with forward slashes (/) or periods (.) at the beginning or end
-
Names containing only forward slashes (/) or only periods (.)
-
Names containing a series of forward slashes (/)
-
Names containing a series of forward slashes (/) and periods (.)
Also, any spaces or linefeeds before and after a string are removed. An error occurs if a string contains a space or a linefeed character.
request-soap.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((0, or 1 to value set in the request-soap.instance.maximum property)) << value set in the request-soap.instance.maximum property>>
Specifies the minimum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.1) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.
request-soap.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((1 to 1024)) <<10>>
Specifies the maximum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.1) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.
request-soap.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((0 to 1024)) <<0>>
Specifies the number of dedicated threads for a standard synchronous reception (Web Service/ SOAP 1.1) in a pool. Specify a value that does not exceed the maximum number of concurrent executions (request-soap.instance.maximum). If you specify 0, no threads are dedicated.
Note that this value is set up for the WAR attribute thread-control-exclusive-threads. Therefore, you must specify this value after considering the maximum threads and the maximum number of connections for the entire Web container.
request-soap.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((0 to 2147483647)) <<8192>>
Specifies the size of the pending queue for a standard synchronous reception (Web Service/ SOAP 1.1) in a pool.
request-soap1_2.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((0, or 1 to value set in the request-soap1_2.instance.maximum property)) <<value set in the request-soap1_2.instance.maximum property>>
Specifies the minimum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.2) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.
request-soap1_2.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((1 to 1024)) <<10>>
Specifies the maximum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.2) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.
request-soap1_2.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((0 to 1024)) <<0>>
Specifies the number of dedicated threads for a standard synchronous reception (Web Service/ SOAP 1.2) in a pool. Specify a value that does not exceed the maximum number of concurrent executions (request-soap1_2.instance.maximum). If you specify 0, no threads are dedicated.
Note that this value is set up for the WAR attribute thread-control-exclusive-threads. Therefore, you must specify this value considering the maximum threads and the maximum number of connections for the entire Web container.
request-soap1_2.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((0 to 2147483647)) <<8192>>
Specifies the size of the pending queue for a standard synchronous reception (Web Service/ SOAP 1.2) in a pool.
request-jms.instance.maximum=maximum-number-of-standard-asynchronous-reception-(MDB(WS-R))-instances ~ <Numeric character> ((1 to 1024)) <<10>>
Specifies the maximum number of standard asynchronous reception (MDB(WS-R)) instances in a pool. This property is valid only when you specify ON in the request-jms property of the HCSC server setup definition file.
request-jms.rollback-count=rollback-warning-message-output-count-for-standard-asynchronous-reception-(MDB(WS-R)) ~ <Numeric character> ((1 to 2147483647)) <<0>>
Outputs a warning message (KDEC00049-W) for a MDB (WS-R) reception when the extraction and the rollback of the same message from the queue are executed more than the specified number of times. If you specify 0, no warning message is output.
receptionstop-monitor-timer=timeout-value-for-monitoring-reception-queue ~ <Numeric character> ((0 to 600)) <<0>>
Specifies the timeout value for the processing of messages of an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) in seconds.
From the maximum number of messages in the queue and the processing time per message, calculate the maximum time for which the in-process messages remain in the queue, and then specify a value in seconds that is greater than this value. To specify a value other than 0, you must also specify a value in the csc-receptionstop-timeout property.
Note that you can specify the default value (no timeout) if any of the following cases are applicable:
-
If an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) is not used
-
If a planned termination is not executed
A timeout does not occur if you specify 0. Note that if a dead message queue is not set in Reliable Messaging, an infinite loop might occur due to the rollback operation. Therefore, do not specify 0.
csc-receptionstop-timeout=communication-timeout-value-to-wait-for-reception-termination ~ <Numeric character> ((0 to 86400)) <<value set in the csc-command-timeout property>>
Specifies the timeout value for the communication processing of an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) in seconds. Specify a timeout value that is longer than the value set in the receptionstop-monitor-timer property.
Note that you can specify the default value (value set in the csc-command-timeout property) if any of the following cases are applicable:
-
If an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) is not used
-
If a planned termination is not executed
A timeout does not occur if you specify 0.
(c) Associated with service adapters
soapfault-targetnamespace-filepath=absolute-path-of-SOAP-fault-operation-definition-file ~ <Character string>
Specifies an absolute path for the SOAP fault operation definition file. Use the characters / or \\ as directory delimiters. Specify this property when you want the SOAP adapter to handle all the SOAP Faults from Web Services as faults.
For details about the SOAP fault operation definition file, see 6.6.1 SOAP fault operation definition file.
soapfault-handling-mode={DETAIL|FAULTCODE} ~ <<FAULTCODE>>
Specifies the operation mode in which the SOAP adapter determines whether to handle SOAP Faults from Web Services as faults. We recommend that you specify DETAIL in this property. If you want to emphasize the compatibility with 09-70 or earlier, specify FAULTCODE.
-
DETAIL
Whether to handle SOAP Faults as faults is determined based on the child element directly under the detail element of the SOAP Fault in SOAP1.1 (or under the Detail element of the SOAP Fault in SOAP1.2).
-
FAULTCODE
Whether to handle SOAP Faults as faults is determined based on the value of the faultcode element of the SOAP Fault in SOAP1.1. In SOAP1.2, SOAP Faults are not handled as faults.
oa-adapter-character-code={SJIS|MS932} ~ <<SJIS>>
Specifies the character code of messages that the Object Access adapters send to and receive from service components.
The specified character code is used by all Object Access adapters.
(d) Associated with data transformation
formatdef-maxcache-num=number-of-cacheable-format-definitions ~ <Numeric character> ((1 to 2147483647)) <<2147483647>>
Specifies the number of cacheable format definitions. The number of format definitions used in an HCSC server is the sum total of the following:
Even if you specify a value greater than the sum total, memory space exceeding the required size will not be used. If you want to cache all the format definitions in the repository, specify a large value.
-
Number of all message type variables defined in each business process
-
Number of all request message formats defined in each user-defined reception
-
Number of all response message formats defined in each user-defined reception
-
Number of all request message formats defined in each service adapter
-
Number of all response message formats defined in each service adapter
transformdef-maxcache-num=number-of-cacheable-data-transformation-definitions-for-servers ~ <Numeric character> ((1 to 2147483647)) <<2147483647>>
Specifies the number of cacheable data transformation definitions. To reuse the data transformation definitions, specify a value that is equal to or greater than the number of defined data transformations.
Even if you specify a value greater than the number of defined data transformations, memory space exceeding the required size will not be used. If you want to cache all the data transformation definitions in the repository, specify a large value.
xmltelegram-maxcache-num=number-of-cacheable-XML-messages ~ <Numeric character> ((0 to 2147483647)) <<0>>
Specifies the number of cacheable XML message objects. By reusing the cached XML message objects, you can reduce the time for processing the XML messages of the same format. To reuse the XML messages, specify a value that is equal to or greater than the following value:
(The-number-specified-for-the-service-adapter-or-business-process-data-transformation) + (The-number-specified-for-the-business-process-path-operations)
If you specify 0, the XML message objects are not cached.
Note that the processing time might be more for XML messages with less number of elements.
telegram-validation={ON|OFF} ~ <<OFF>>
Validates whether the message to be sent or received is appropriate for the specified message format (data validation function).
-
ON
The message format will be validated.
-
OFF
The message format will not be validated.
For details on the data validation function, see 6.2 Data validation function in the manual Service Platform Overview.
xmltelegram-namespace-complement={ON|OFF} ~ <<OFF>>
Specifies whether the namespace declaration corresponding to the namespace prefix that is specified in the attribute value existing in an XML message, for the XML messages that flow within an HCSC server, will be complemented.
-
ON
The namespace declaration corresponding to the namespace prefix will be complemented.
-
OFF
The namespace declaration corresponding to the namespace prefix will not be complemented.
Specify ON to use the QName type as the type of XML schema attribute values, for the user messages flowing within an HCSC server. However, note that if you specify ON, the message size becomes larger than when OFF is specified.
For details, see 4.5 Complementing the namespace prefixes specified for the attribute values in XML messages in the manual Service Platform Overview.
telegram-undefined-character-code={ERROR | REPLACE} ~ <<ERROR>>
Specifies the operations to be performed when an undefined character encoding is detected during the conversion of character encoding for binary data.
-
ERROR
An error occurs during the detection process and the processing ends.
-
REPLACE
The undefined part of the character code is replaced with a blank character code or a user-specified character code, and processing continues.
You can replace all the spaces with two-byte characters and also with two-byte or one-byte characters according to the shift or escape status. For details on how to specify the settings, see 1.3.1 Format dialog.
telegram-notfound-soapheader={ERROR|IGNORE} ~ <<IGNORE>>
Specifies whether the processing continues if the headers, specified for the messages to be sent and received, do not exist for the reception definition file, service adapter definition file, or business process definition file.
-
ERROR
If the headers specified in the definition file do not exist, an error message is displayed and the processing is canceled.
-
IGNORE
If the headers specified in the definition file do not exist, the specification is ignored and processing continues.
validation-activity={ON|OFF} ~ <<ON>>
Defines whether the message type variables (XML) will be validated with the validation activity. The validation activities of all the business processes in an HCSC server are targets for validation.
-
ON
The message type variables (XML) specified in the validation activity will be validated.
-
OFF
The message type variables (XML) specified in the validation activity will not be validated.
transform-binary-error-check={ON|OFF} ~ <<ON>>
Defines whether an error check will be implemented during binary data transformation. You can check whether the binary data generated due to the extension of the data transformation activity is in accordance with the binary format definition.
-
ON
An error check will be performed to check if the binary data is in accordance with the binary format definition. Specify ON to convert the data to binary data during data transformation.
-
OFF
An error check will not be performed to check if the binary data is in accordance with the binary format definition.
code-table-root-path=absolute-path-of-root-path-of-code-conversion-table-storage-path ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\\CSC\\userlib\\codetables>>
Specifies, as an absolute path, the root path of the code conversion table storage path. Use a forward slash (/) or two backslashes (\\) as a directory separator. If you specify a non-existent directory, the HCSC server fails to start.
(e) Associated with business processes
syserr-to-fault-convert={ON|OFF} ~ <<OFF>>
Defines whether a general fault will be generated when a system exception occurs in the data transformation activity, assign activity, or switch activity.
-
ON
A system exception will be caught and a general fault will be generated.
-
OFF
A general fault will not be generated when a system exception occurs.
validate-fault-compatible={ON|OFF} ~ <<ON>>
Defines whether the format of the fault message sent due to the validate fault will be the format used until 09-00 or earlier.
-
ON
The fault message will be sent in the format used in 09-00 or an earlier format.
-
OFF
The fault message will be sent in the new format that includes the process instance identifier and the activity name.
bp-reply-after-min-thread-pool-size=minimum-number-of-threads-used-for-executing-activities-after-response-activity ~ <Numeric character> ((1-2147483647)) <<16>>
Defines the minimum number of unused threads that are saved in a thread pool and that will be used for executing activities after a response activity.
The defined information takes effect for each HCSC server. Therefore, specify a value with consideration of the number of concurrent executions of a business process that has defined activities after a response was made within the HCSC server.
If you specify a value greater than the value of the bp-reply-after-max-thread-pool-size property, an error occurs during execution of the cscsvconfig command.
bp-reply-after-max-thread-pool-size=maximum-number-of-threads-used-for-executing-activities-after-response-activity ~ <Numeric character> ((1-2147483647)) <<32>>
Defines the maximum number of threads that can be created in a thread pool and that will be used for executing activities after a response activity.
The defined information takes effect for each HCSC server. Therefore, specify a value with consideration of the number of concurrent executions of a business process that has defined activities after a response was made within the HCSC server.
bp-reply-after-thread-pool-keep-alive=retention-time-of-threads-used-for-executing-activities-after-response-activity ~ <Numeric character> ((1-2147483647)) <<60>>
Defines the time, in seconds, to retain a thread by its end if the number of threads that have not been used for executing activities after a response activity exceeds the value specified for bp-reply-after-min-thread-pool-size.
The defined information takes effect for each HCSC server. Therefore, specify a value with consideration of the number of concurrent executions of a business process that has defined activities after a response was made within the HCSC server.
service-emulate.enable={true|false} ~ <<false>>
Specifies whether to enable the service emulation function.
-
true
The service emulation function is enabled.
-
false
The service emulation function is not enabled.
service-emulate-def-filepath=absolute-path-of-definition-file-for-emulated-configuration-information ~ <Character strings (including two-byte characters) and spaces>
Specifies the absolute path to the definition file for emulated configuration information when the service emulation function is enabled (service-emulate.enable=true is specified) in the execution environment. You can use a forward slash (/) or two backslashes (\\) as a directory separator.
If you omit this property when service-emulate.enable=true is specified, an error occurs during execution of the cscsvconfig command.
For details about how to configure the definition file for emulated configuration information, see 6.5.7 Definition file for emulated configuration information.
(f) Associated with J2EE
j2ee-stopapp-timeout=stop-monitoring-time-of-J2EE-applications ~ <Numeric character> ((0 to 2147483647)) <<60>>
Specifies the monitoring time for stopping the J2EE applications, issued by the commands for stopping request receptions and business processes or service adapters, in seconds. If a request is being processed, the system stands by for the specified time only.
After the timeout occurs, the request receptions, business processes, and service adapters will be forcefully stopped.
startcsc-timeout=start-monitoring-time-of-J2EE-servers ~ <Numeric character> ((1 to 2147483647)) <<180>>
Specifies the monitoring time to monitor the starting of J2EE servers with the HCSC server start command, in seconds. Even if the HCSC server start command times out, the J2EE server start processing continues.
Note that you need not specify this property because this property is disabled even if you specify it in 09-50 and later.
stopcsc-timeout=stop-monitoring-time-of-J2EE-servers ~ <Numeric character> ((1 to 2147483647)) <<180>>
Specifies the monitoring time to monitor the stopping of J2EE servers with the HCSC server stop command, in seconds. Even if the HCSC server stop command times out, the J2EE server stop processing continues.
Note that you need not specify this property because this property is disabled even if you specify it in 09-50 and later.
(g) Monitoring the communication timeout value for commands
csc-command-timeout=command-timeout-value ~ <Numeric character> ((0 to 86400)) <<300>>
Specifies the timeout value in seconds for reporting to the client when a J2EE server slows down or when there is a communication error between a J2EE server and the database with the following functions:
-
Commands beginning with csc
-
Management GUI (Eclipse)
-
Development window GUI (Eclipse)
A timeout does not occur if you specify 0.
csc-precache-timeout=timeout-value-for-EJB-communication-with-business-process-for-pre-cache-processing ~ <Numeric character> ((0 to 86400)) <<0>>
Specifies the timeout value for the pre-cache processing in business processes in seconds.
A timeout does not occur if you specify 0.
(h) Inheriting the Cookie information
cookie-parsing={ON|OFF} ~ <<OFF>>
Specifies whether the Cookie information will be inherited.
-
ON
The Cookie information will be implicitly inherited.
-
OFF
The Cookie information will not be implicitly inherited.
(i) Associated with folders
work-folder=absolute-path-of-work-folder ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\\CSC\\spool\\ftp\\work>>
Specifies an absolute path for the work folder root. Use the characters / or \\ as directory delimiters. The HCSC server fails to start if you specify a non-existent directory.
A path of 153 bytes is required for the product under the specified work folder. When you specify any work folder root, make sure that the path does not exceed the maximum path length of the OS.
common-folder-common-folder-definition-name=absolute-path-of-common-folder ~ <Character strings (including two-byte characters) and spaces> ((1 string length
64)) <<service-platform-installation-directory\\CSC\\spool\\ftp\\com>>
Specifies an absolute path of the common folder. You can specify the same directory by specifying different common folder definition names.
- common-folder-definition-name
-
-
You can specify alphanumeric characters and underscores (_) for the common folder definition name.
-
If you omit the specification, the common folder definition name will be default.
-
- Absolute path of the common folder
-
Use a forward slash (/) or two backslashes (\\) as a directory separator. If you specify a non-existent directory, the HCSC server fails to start.
When the common folder is used, a path of the following length is created under the common folder. Considering this path, specify the common folder so that the total path length does not exceed the maximum path length of the OS.
Length of the user-specified file name + 106 bytes
For HTTP adapters and mail adapters, the path length to be used differs depending on the function. The following table lists the path length required for each function:
Service adapter type
Function
Total path length#1
HTTP adapter
Sending files for an HTTP request
Total sum of the following in bytes:
-
Number of bytes in the path of the common folder root
-
Number of bytes in the path under the common folder (106 bytes#2)
-
Number of bytes in the file name to be used
Downloading files for an HTTP response
Total sum of the following in bytes:
-
Number of bytes in the path of the common folder root
-
Number of bytes in the path under the common folder (156 bytes#2)
Mail adapter
Sending a file used as the mail body
Total sum of the following in bytes:
-
Path of the common folder root
-
Number of bytes in the path under the common folder (106 bytes#2)
-
Number of bytes in the file name to be used
Sending email attachments
- #1
-
When a subfolder is used, the length of the relative path of the subfolder is also added.
- #2
-
When a subfolder is used, 1 byte is added to the path length.
-
(j) Associated with DB adapters
dba-separate-transaction={true|false} ~ <<false>>
Specifies whether to start DB adapter transactions separately from the business processes.
To start a DB adapter transaction separately from a business process, either specify true, or specify Y in the dba_separate_transaction attribute of the SQL operation definition file, and then change the value specified for the trans-attribute element of the HITACHI Application Integrated Property File for DB adapters from Required to RequiresNew.
-
true
A DB adapter transaction will be started separately from a business process.
-
false
The same transaction as a business process will also be used in the DB adapter as well.
(k) Associated with component-common UOC
common-uoc-prop-path=folder-for-storing-component-common-UOC-property-file ~ <String (including two-byte characters)>
Specifies an absolute path for the storage folder of the component-common UOC property file. Use the characters / or \\ as folder delimiters. Note that an exception occurs while the HCSC server runtime definition file is being read if you do not specify a storage folder and only specify the property name.
If you specify the component-common UOC property file, the component-common UOC function is used and the trace based performance analysis is output before and after a UOC class is invoked.
For details on how to specify the component-common UOC property file, see Appendix G. Component-common UOC in the Service Platform Basic Development Guide. Also, for details on the trace based performance analysis output with the component-common UOC function, see 7.4.3 Performance Analysis Trace in the uCosminexus Service Platform Setup and Operation Guide.
(l) Associated with HCSC servers
short-processid-servername=HCSC-server-name-identifier-to-be-used-with-process-instance-identifier ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters)) <HCSC-server-name>
Specifies the HCSC server name identifier to be used with the process instance identifier. Specify an identifier that is unique in the cluster. The operations might not function properly if you do not specify a unique value.
This property is valid only when you specify ON in the short-processid property.
short-processid={ON|OFF} ~ <<OFF>>
Specifies whether the process instance identifier will be shortened. If the local machine has an IPv6 address and the J2EE server name contains 111 bytes or more, an error might occur during generation of process instances. If such errors occur, specify ON.
-
ON
The process instance identifier will be shortened.
-
OFF
The process instance identifier will not be shortened.
(m) Instance pool
xml-pooled-instance-minimum=minimum-number-of-pooled-instances-of-classes-used-in-XML-processing ~ <Numeric character> ((0 to 2147483647)) <<0>>
Specifies the minimum number of instances to be cached for the classes to be used for processing requests and response messages. Specify a value that is equal to or less than the value specified for the xml-pooled-instance-maximum property. If you specify a value that is greater than the xml-pooled-instance-maximum property, an error occurs during the execution of the cscsvconfig command.
When an HCSC server starts, the number of instances specified in this property are generated and set up in a pool. If you specify 0, the instances are not cached when the HCSC server starts.
If the csc.dt.pool.DocumentBuilder.initialSize property is set in usrconf.properties (user property file for J2EE servers), specify the same value as that property.
xml-pooled-instance-maximum=maximum-number-of-pooled-instances-of-classes-used-in-XML-processing ~ <Numeric character> ((0 to 2147483647)) <<64>>
Specifies the maximum number of instances to be cached for the classes to be used for processing requests and response messages.
If the csc.dt.pool.DocumentBuilder.maxSize property of usrconf.properties (user property file for J2EE servers) is set, specify the same value as that property. If the csc.dt.pool.DocumentBuilder.maxSize property is not set up, specify a value that is equal to or greater than the total of the maximum number of executions of all the request receptions in an HCSC server.
If you specify 0, the instances are not cached.
If the received requests exceed the maximum specified number, you might have to wait for the requests to be processed.
(n) Associated with custom reception
request-id-separate-key={slash|atsign|period} ~ <<slash>>
Specifies a separate key of the request ID generated by an FTP reception or HTTP reception.
-
slash
A halfwidth forward slash (/) will be used as a separate key of the request ID.
-
atsign
A halfwidth at mark (@) will be used as a separate key of the request ID.
-
period
A halfwidth period (.) will be used as a separate key of the request ID.
- Important note
-
When changing the separate key of the request ID, make sure that there is no process instance in the Error or Executing status.
This modification applies to Service Coordinator 09-51-01 or later.
fileevent-reception.monitored-file.enabled={true|false} ~ <<false>>
Specifies whether to allow file monitoring.
-
true
The file monitoring function is enabled. When you use the file event reception, specify true.
-
false
The file monitoring function is disabled.
fileevent-reception.monitored-folder=absolute-path-of-monitored-folder ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\\CSC\\spool\\fileevent>>
Specifies the absolute path to the monitored folder. Use a forward slash (/) or two backslashes (\\) as a directory separator. Do not specify the same directory as the common folder.
If you do not specify the absolute path or specify a non-existent directory, the HCSC server fails to start.
When you monitor the files to be acquired, there is no need to specify this property. This property is disabled even if specified.
fileevent-reception.monitor-interval=file-monitoring-interval ~ <Numeric character> ((1 to 44640)) <<10>>
Specifies the file monitoring intervals in minutes.
fileevent-reception.monitor-starting.delay=time-to-wait-before-file-monitoring-starts ~ <Numeric character> ((1 to 44640)) <<10>>
Specifies the number of minutes that can elapse before the file monitoring starts after startup of the HCSC server.
The file monitoring will start when the time specified here elapses after the HCSC server startup command is executed.
(5) Example of coding
A sample file is as follows:
methodtrace-filepath=c:\\TMP requesttrace-filepath=c:\\TMP telegramtrace-filepath=c:\\TMP methodtrace-filenum=8 requesttrace-filenum=4 telegramtrace-filenum=4 methodtrace-filesize=2097152 requesttrace-filesize=2097152 telegramtrace-filesize=2097152 telegramtrace-trigger=NORMAL methodtrace-level=3 requesttrace=ON telegramtrace=ON bptrace-level=10 bptrace-filenum=16 bptrace-filesize=2097152 request-ejb.instance.minimum=10 request-ejb.instance.maximum=10 request-ejb.ctm=false request-ejb.parallel.count=1 request-soap.instance.minimum=10 request-soap.instance.maximum=10 request-jms.instance.maximum=10 receptionstop-monitor-timer=0
(6) Usage
Specify the HCSC server runtime definition file in the argument of the -propfile option of the cscsvconfig command. For details on how to do this, see 3.1.4 Setting up the HCSC server definition information in the uCosminexus Service Platform Setup and Operation Guide.
(7) Notes
Note the following when you specify the path:
-
Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).
-
Do not specify a path containing a symbolic link.
-
In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.