6.12.1 Message Queue adapter runtime-environment property file

Organization of this subsection

(1) Format
(2) Function
(3) Specifiable properties

(1) Format

[message.level={0|10|20}]
[trace.level={0|10|20|30}]
[methodtracefile.size=method-trace-output-size]
[methodtracefile.num=number-of-method-trace-files-output]
[datatracefile.size=data-trace-output-size]
[datatracefile.num=number-of-data-trace-files-output]
 codetable.path=transformation-table-storage-path
[exptracefile.size=output-size-of-exception-log]
[exptracefile.num=number-of-exception-log-files-output]
[transaction.local={true|false}]

To Page Top

(2) Function

Defines the log and trace information that is output when you operate the Message Queue adapter in the execution environment.

To create the Message Queue adapter runtime-environment property file:

Define the Message Queue adapter runtime-environment property file based on the following template file:
```
Service-platform-installation-directory\CSC\custom-adapter\MQ\config\templates\adpmq.properties
```
Store the edited Message Queue adapter runtime-environment property file with the following file name:
```
service-platform-installation-directory\CSC\custom-adapter\MQ\config\service-ID.properties
```

The Message Queue adapter runtime-environment property file is applied to the execution environment when the Message Queue adapter starts.

To change the contents of the Message Queue adapter runtime-environment property file, stop the Message Queue adapter and then change the contents. After making the changes, restart the Message Queue adapter so that the changes are applied in the execution environment.

To Page Top

(3) Specifiable properties

message.level={0|10|20} ~ <<10>>

Specifies the output levels for the message log. The following table lists the output levels for the message log.

Table 6‒4: Mapping of the output levels and the output information
Information type	Output level
Information type	0	10	20
Error information	Y	Y	Y
Warning information	O	Y	Y
Information	O	O	Y

Legend:

Y: All the information is output.

O: Only important log messages are output.

trace.level={0|10|20|30} ~ <<10>>

Specifies the output levels for the method and data traces.

The following table describes the output levels for the method trace:

Information type	Output level
Information type	0	10	20	30
Information for the methods invoked externally and start and stop information for the I/O methods that send and receive messages	N	Y	Y	Y
Start and stop information for the public methods that are referenced from other components	N	N	Y	Y
Start and stop information for the internal methods (non-public methods) that are not referenced from other components	N	N	N	Y
Errors in the methods	Y	Y	Y	Y

Legend:

Y: Information is output.

N: Information is not output.

The following table describes the output levels for the data trace:

Information type	Output level
Information type	0	10	20	30
Request data information for sent and received messages	N	N	N	Y
Response data information for sent and received messages	N	N	Y	Y
`Detail` information for `Fault` information	Y	Y	Y	Y
Failure in sending a message and failure in XML conversion of a received message	Y	Y	Y	Y

Legend:

Y: Information is output.

N: Information is not output.

The following table describes the merits and the demerits of specifying 20 or more data trace output levels. Specify the output level after considering the merits and the demerits.

Table 6‒5: Merits and demerits of the data trace output levels
Merits/ demerits	Output level
Merits/ demerits	10	20 or more
Merits	The data trace is output only when an error occurs. Therefore, when compared to 20 or more output levels, the processing performance improves greatly. The disk size for the output of the data trace is equal to the number of times a request error occurs. Therefore, only a small disk size is sufficient.	If the receiving of messages or a message sending and receiving request fails, the user data might be lost. In such cases, the user data can be restored from the data trace.
Demerits	If the receiving of messages or a message sending and receiving request fails, the user data might be lost. In such cases, the lost user data cannot be recovered.	The user data is output to the data trace. Therefore, when compared to the output level 10, the processing performance greatly deteriorates. The disk size required to output the data trace depends on the amount of messages that are sent and received.

methodtracefile.size=method-trace-output-size ~ <unsigned number> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the method trace information collected by the Message Queue adapter, in bytes.

methodtracefile.num=number-of-method-trace-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the method trace information collected by the Message Queue adapter.

datatracefile.size=data-trace-output-size ~ <unsigned number> ((4096 to 2147483647)) <<1048576>>

Specifies the size of the files output for the data trace information collected by the Message Queue adapter, in bytes.

datatracefile.num=number-of-data-trace-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the data trace information collected by the Message Queue adapter.

codetable.path=conversion-table-storage-path ~ <path for storing the conversion table (user mapping file) for the code conversion function>

Specifies the path for storing the conversion table (user mapping file) for the code conversion function. In Windows, use \\ instead of \ as directory delimiters in the path.

Make sure that you specify this property when you want to specify the sending queue-specific information or receiving queue-specific information for a request message, when sending binary messages.

Specify the following paths depending on whether the user mapping file is customized:

When the user mapping file is used with default values and is not customized
```
Service-platform-installation-directory\CSC\lib\external\table
```

When the user mapping file customized by using the code conversion function is used

path-for-storing-the-conversion-table-(user-mapping-file)-for-code-conversion-function

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 ../), characters expressing a current directory (.\ or ./), and a symbolic link.
In Windows, do not specify a path containing a UNC format, an NTFS stream name, and a reserved device name. Also, the path characters are not case sensitive.
Specify the path length so that when converted to UTF-8, the length is 1 to 198 bytes.

exptracefile.size=output-size-of-exception-log ~ <Numeric character> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the exception information (stack trace) collected by the Message Queue adapter, in bytes.

exptracefile.num=number-of-exception-log-files-output ~ <Numeric character> ((1 to 16)) <<4>>

Specifies the number of files output for the exception information (stack trace) collected by the Message Queue adapter.

transaction.local={true|false} ~ <<true>>

Specifies whether the Message Queue adapter will perform a transaction conclusion process. Specify false if you want to specify XATransaction for the transaction support level for the resource adapter.

If you specify false and specify LocalTransaction for the transaction support level for the resource adapter, a transaction is concluded when the transaction of a business process is committed.

To Page Top