Hitachi

uCosminexus Service Platform Reference Guide


6.11.1 Object Access adapter runtime-environment property file

Organization of this subsection

(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]
[exptracefile.size=output-size-of-exception-log]
[exptracefile.num=number-of-exception-log-files-output]

(2) Function

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

To create the Object Access adapter runtime-environment property file:

  1. Define the Object Access adapter runtime-environment property file based on the following template file:

    Service-platform-installation-directory\CSC\custom-adapter\OA\config\templates\adpoa.properties
  2. Store the edited Object Access adapter runtime-environment property file with the following file name:

    service-platform-installation-directory\CSC\custom-adapter\OA\config\service-ID.properties

The Object Access adapter runtime-environment property file is applied in the execution environment when the Object Access adapter starts.

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

(3) Specifiable properties

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

Specifies the output levels for the message log.

The following table lists and describes the specifiable output levels and the output information corresponding to the output levels:

Information type

Output level

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 lists and describes the specifiable output levels and the output information corresponding to the output levels:

Information type

Output level

0

10

20

30

Information for the methods invoked externally

N

Y

Y

Y

Information for invoking the methods with arguments, or communication methods, from amongst the external methods

N

Y

Y

Y

Information for the methods invoked externally, and 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.

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 Object Access 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 Object Access adapter. We recommend that you specify at least two files.

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 Object Access 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 Object Access adapter. We recommend that you specify at least two files.

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

Specifies the size of the files output for the exception trace information collected by the Object Access adapter, in bytes.

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

Specifies the number of files output for the exception trace information collected by the Object Access adapter.

(4) Example of coding

To omit the specified value, omit the value including the key name. You cannot code only the key name and omit the value. An example of coding when trace.level is omitted is as follows:

Correct coding method

 ... 
message.level=20
methodtracefile.size=4194304
 ... 

Incorrect coding method (value of trace.level is not specified)

 ... 
message.level=20
trace.level=
methodtracefile.size=4194304
 ...