6.10.1 File adapter runtime-environment property file
- Organization of this subsection
(1) Format
[message.level={0|10|20}]
[methodtrace.level={0|10|20|30}]
[methodtracefile.size=method-trace-output-size]
[methodtracefile.num=number-of-method-trace-files-output]
fileaccess.path1=I/O-permitted-file-path-1
[fileaccess.path2=I/O-permitted-file-path-2]
[fileaccess.path3=I/O-permitted-file-path-3]
[fileaccess.path4=I/O-permitted-file-path-4]
[fileaccess.path5=I/O-permitted-file-path-5]
[fileaccess.maxsize=maximum-size-of-input-file]
character.code={MS932|UTF8|UTF16_BIG|UTF16_LITTLE|JIS|KEIS+EBCDIC|KEIS+EBCDIK}
[codetable.path=transformation-table-storage-path]
(2) Function
The file adapter runtime-environment property file defines information such as the output levels of the message and trace logs for the operations of the file adapter in the execution environment.
The sample file is stored at the following location:
Service-platform-installation-directory-in-execution-environment\CSC\custom-adapter\File\config\templates\adpff_exe.properties
To create the file adapter runtime-environment property file:
-
Copy and store the sample file in the following directory:
Service-platform-installation-directory-in-execution-environment\CSC\custom-adapter\File\config
-
Rename the sample file as service-ID.properties.
-
Edit and save the defined information.
The file adapter runtime-environment property file is applied in the execution environment when you start the file adapter. To change the contents of the file adapter runtime-environment property file, stop the file adapter and then perform the operation. When you restart the file adapter, the changes are applied to the execution environment.
(3) Specifiable properties
message.level={0|10|20} ~ <<10>>
Specifies the output levels for the message log. The following table lists the output information and 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 message logs are output.
methodtrace.level={0|10|20|30} ~ <<10>>
Specifies the output levels for the method trace. The following table lists the output information and the output levels:
|
Information type |
Output level |
|||
|---|---|---|---|---|
|
0 |
10 |
20 |
30 |
|
|
Errors in the methods |
Y |
Y |
Y |
Y |
|
Information for the methods invoked externally and start or stop information for the file I/O methods |
N |
Y |
Y |
Y |
|
Start or stop information for the public methods that are referenced from other HCSC 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 |
- Legend:
-
Y: Information is output.
N: Information is not output.
methodtracefile.size=method-trace-output-size ~ <Numeric character> ((4096 to 2147483647)) <<4194304>>
Specifies the size of the files output for the method trace information collected by the file adapter, in bytes.
methodtracefile.num=number-of-method-trace-files-output ~ <Numeric character> ((1 to 16)) <<4>>
Specifies the number of files output for the method trace information collected by the file adapter. We recommend that you specify at least two files.
fileaccess.path ((1 to 5))=I/O-permitted-file-path
Specifies an absolute path for the directory in which file I/O is permitted. Thefile I/O can be done under the directories specified in these keys. You can also create sub-directories.
You can specify five absolute paths for the directories in which file I/O is permitted.
fileaccess.maxsize=maximum-size-of-input-file ~ <Numeric character> ((1 to 67108864)) <<4194304>>
Specifies the maximum size of the file to be read.
character.code={MS932|UTF8|UTF16_BIG|UTF16_LITTLE|JIS|KEIS+EBCDIC| KEIS+EBCDIK}
Specifies the character encoding of the binary data. When you specify this property, make sure that you specify the codetable.path property as well. Specify this property to execute the write mode functions in the fixed length, length tag, or separator file formats.
codetable.path=transformation-table-storage-path
Specifies the path for storing the conversion table (user mapping file) for the code conversion function. You can specify one of the following paths depending on whether the user mapping file is customized. Note that when you specify the path, use \\ as directory delimiters.
-
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 Code Converter is used
path-for-storing-the-conversion-table-(user-mapping-file)-for-Code-Converter
When you specify this property, make sure that you specify the character.code property. Specify this property to execute the write mode functions in the fixed length, length tag, or separator file formats.
(4) 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 ../), and characters expressing a current directory (.\ or ./).
-
Do not specify a path containing a symbolic link.
-
In Windows, you cannot specify a path containing a UNC format, an NTFS stream name, and a reserved device name. Also, the path characters are not case sensitive. Use \\ as directory delimiters in the path.
-
You can specify the path length from 1 to 198 bytes, when UTF-8 is used for conversion.