3.5.2 File operations adapter definition file
- Organization of this subsection
(1) Format
[csc.adapter.fileOperation.transform.splitLoad={ON|OFF}]
[csc.adapter.fileOperation.transform.input={non-xml|xml}]
[csc.adapter.fileOperation.transform.output={non-xml|xml}]
[csc.adapter.fileOperation.transform.format={fixed|separate}]
[csc.adapter.fileOperation.transform.outputTemplateXmlFile=File name of the template XML file for output]
[csc.adapter.fileOperation.transform.headerRecord={ON|OFF}]
[csc.adapter.fileOperation.transform.trailerRecord={ON|OFF}]
[csc.adapter.fileOperation.transform.header.inFormat=Binary format definition file name for header record input]
[csc.adapter.fileOperation.transform.header.outFormat= Binary format definition file name for the header record output]
[csc.adapter.fileOperation.transform.header.inElement=Path of an input XML file element of the corresponding header record]
[csc.adapter.fileOperation.transform.header.outElement= Path of an output XML file element of the corresponding header record]
[csc.adapter.fileOperation.transform.header.styleSheet=XSL file name for header record transformation]
[csc.adapter.fileOperation.transform.header.fixedSize=Fixed length of header record]
[csc.adapter.fileOperation.transform.header.batchSize=Top record number considered as header record during split processing]
[csc.adapter.fileOperation.transform.data.inFormat=Binary format definition file name for data record input]
[csc.adapter.fileOperation.transform.data.outFormat=Binary format definition file name for data record output]
[csc.adapter.fileOperation.transform.data.inElement=Path of an input XML file element corresponding to data code]
[csc.adapter.fileOperation.transform.data.outElement= Path of an output XML file element corresponding to data code]
[csc.adapter.fileOperation.transform.data.styleSheet=XSL file name for data record transformation]
[csc.adapter.fileOperation.transform.data.fixedSize=Fixed length size of data record]
[csc.adapter.fileOperation.transform.data.batchSize=Number of data record transformations at a time]
[csc.adapter.fileOperation.transform.trailer.inFormat=Binary format definition file name for trailer record input]
[csc.adapter.fileOperation.transform.trailer.outFormat=Binary format definition file name for trailer record output]
[csc.adapter.fileOperation.transform.trailer.inElement=Path of an input XML file element corresponding to trailer record]
[csc.adapter.fileOperation.transform.trailer.outElement= Path of an output XML file element corresponding to trailer record]
[csc.adapter.fileOperation.transform.trailer.styleSheet=XSL file name for trailer record transformation]
[csc.adapter.fileOperation.transform.trailer.fixedSize=Fixed length size of trailer record]
[csc.adapter.fileOperation.transform.all.inFormat=Binary format definition file name for the input during batch processing]
[csc.adapter.fileOperation.transform.all.outFormat=Binary format definition file name for the output during batch processing]
[csc.adapter.fileOperation.transform.all.styleSheet=XSL file name for transformation during batch processing]
[csc.adapter.fileOperation.transform.existFile={overwrite|error}]
[csc.adapter.fileOperation.copy.existFile={overwrite|error}]
[csc.adapter.fileOperation.move.existFile={overwrite|error}]
[csc.adapter.fileOperation.compress.existFile={overwrite|error}]
[csc.adapter.fileOperation.extract.existFile={overwrite|error}]
[csc.adapter.fileOperation.writeList.existFile={overwrite|error}]
(2) Function
Set the operating information of file operations adapter.
Create file operations adapter definition file with file name "cscFileOperation.properties".
The contents set in the file operations adapter definition file are enabled when file operations adapter starts.
(3) Specifiable properties
csc.adapter.fileOperation.transform.splitLoad={ON|OFF} ~<<ON>>
Specify if split processing is to be done for each record during file input and output.
-
ON
Split processing
-
OFF
Batch processing
If you specify a value other than ON or OFF, batch processing is performed.
csc.adapter.fileOperation.transform.input={non-xml|xml} ~<<non-xml>>
Specify the type of input file.
-
non-xml
Binary format
-
xml
XML format
If you specify a value other than non-xml or xml, binary format is considered as the type of input file.
csc.adapter.fileOperation.transform.output={non-xml|xml} ~<<non-xml>>
Specify the type of output file.
-
non-xml
Binary format
-
xml
XML format
If you specify a value other than non-xml or xml, binary format is considered as the type of output file.
csc.adapter.fileOperation.transform.format={fixed|separate} ~<<fixed>>
Specify the format of input file.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format) or, xml (XML format) in property csc.adapter.fileOperation.transform.input, the specification in this property is ignored.
-
fixed
Fixed length format
-
separate
Line feed separator format
If you specify any other value, line feed separator format will be taken as the format of input file.
csc.adapter.fileOperation.transform.outputTemplateXmlFile= File name of the template XML file for output ~<Character string><<cscOutputTemplate.xml>>
Specify the file name of the template XML file for output. You cannot specify a path in this property.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.output (Binary format output file), the specification in this property is ignored.
csc.adapter.fileOperation.transform.headerRecord={ON|OFF} ~<<ON>>
Specify if header record is to be used for file.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), the specification of this property is ignored.
-
ON
Use header record
-
OFF
Do not use header record
When you specify a value other than ON or OFF, header record is not used.
csc.adapter.fileOperation.transform.trailerRecord={ON|OFF} ~<<ON>>
Specify if trailer record is to be used for file.
When you specify OFF (Batch processing for input file format) in the property csc.adapter.fileOperation.transform.splitLoad, the specification in this property is ignored.
-
ON
Use trailer record
-
OFF
Do not use trailer record
If you specify a value other than ON or OFF, trailer record is not used.
csc.adapter.fileOperation.transform.header.inFormat=Binary format definition file name for header record input ~<Character string>
Specify the binary format definition file name for header record input.
When you specify ON (Use header record for file) in the property csc.adapter.fileOperation.transform.headerRecord, you cannot omit this property.
The specification in this property is ignored if you specify OFF (batch processing of input file format) in the property csc.adapter.fileOperation.transform.splitLoad or specify xml (XML format input file) in the property csc.adapter.fileOperation.transform.input.
csc.adapter.fileOperation.transform.header.outFormat=Binary format definition file name for header record output ~<Character string>
Specify the binary format definition file name for header record output.
When you specify ON in the property csc.adapter.fileOperation.transform.headerRecord (use header record for file), you cannot omit this property.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.output (XML format output file), the specification in this property is ignored.
csc.adapter.fileOperation.transform.header.inElement= Path of an input XML file element of the corresponding header record ~<Character string>
Specify the path of an input XML file element of the corresponding header record, in the following format.
Path of element ::= ( '/' [ '{' namespace URI '}' ] Element name)+You cannot omit this property when input file is in XML format and, you have specified ON in the property csc.adapter.fileOperation.transform.headerRecord (use header record for file).
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.input (Input file in binary format), the specification in this property is ignored.
Error occurs, if the path specified in this property overlaps with the path of the element specified in the properties, csc.adapter.fileOperation.transform.data.inElement or csc.adapter.fileOperation.transform.trailer.inElement.
csc.adapter.fileOperation.transform.header.outElement= Path of an output XML file element of the corresponding header record~<Character string>
Specify the path for the element in output XML file of the corresponding header record, in the following format.
Path of element::= ( '/' [ '{' namespace URI '}' ] element name)+You cannot omit this property if the input file is XML format and ON (use header record for file) is specified in the property csc.adapter.fileOperation.transform.headerRecord.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format) or, non-xml in the property csc.adapter.fileOperation.transform.output (Binary format output file), the specification in this property is ignored.
Error occurs, if the path specified in this property overlaps with the path specified in either of the properties, csc.adapter.fileOperation.transform.data.outElement or csc.adapter.fileOperation.transform.trailer.outElement.
csc.adapter.fileOperation.transform.header.styleSheet=XSL file name for header record transformation ~<Character string>
Specify XSL file name (user can specify any name) for header record transformation. You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.headerRecord (use header record for file).
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.header.fixedSize=Fixed length size of header record ~<Number>((from 1 to 2147483647))
Specify a fixed length for header record (Unit: bytes). You cannot omit this property when both of the following properties are set.
-
Value of property csc.adapter.fileOperation.transform.format is fixed (Input file format with fixed length)
-
Value of property csc.adapter.fileOperation.transform.headerRecord is ON (use header record)
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format) or, xml in the property csc.adapter.fileOperation.transform.input (Input file in XML format), the specification in this property is ignored. You can omit this property if separate (input file in linefeed separator format) is specified in the property csc.adapter.fileOperation.transform.format.
csc.adapter.fileOperation.transform.header.batchSize= Top record number considered as header record during split processing ~<Number>((0-524288000))<<0>>
Specify the number of records in the beginning which are to be considered as header record in the split processing method. When you specify 0, 1 record is considered as header record.
The treatment of linefeed characters is different when you specify 0 and when you specify a value between 1 and 524288000 in this property
-
When you specify 0 (also when you do not specify a value, or specify an invalid value or an outside of range value)
The end of header record is judged by line feed characters (LF: 0x0a or CRLF: 0x0d 0x0a). The part excluding the line feed characters from header record, is transformed as 1 record.
-
When you specify a value between 1 and 524288000
The header record separator is determined by line feed characters (LF: 0x0a or CRLF: 0x0d 0x0a). The header record is transformed including the line feed characters.
The specification in this property is ignored if any of the following conditions is applicable:
-
Value of the property csc.adapter.fileOperation.transform.splitLoad is OFF (batch processing of input file format)
-
Value of the property csc.adapter.fileOperation.transform.input is xml (input file in XML format)
-
Value of the property csc.adapter.fileOperation.transform.format is fixed (input file format is fixed)
-
Value of the property csc.adapter.fileOperation.transform.headerRecord is OFF (do not use header record)
csc.adapter.fileOperation.transform.data.inFormat=Binary format definition file name for data record input ~<Character string>
Specify the binary format definition file name for data record input.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format) or, xml in the property csc.adapter.fileOperation.transform.input (Input file in XML format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.data.outFormat=Binary format definition file name for data record output ~<Character string>
Specify the binary format definition file name for data record output.
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format) or, xml in the property csc.adapter.fileOperation.transform. output (output file in XML format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.data.inElement= Path of an input XML file element corresponding to data code ~<Character string>
Specify the path of the element in the input XML file corresponding to data record, in the following format.
Path of element ::= ( '/' [ '{' namespace URI '}' ] element name)+When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.input (binary format input file), the specification in this property is ignored.
Error occurs, if the path specified in this property overlaps with the path specified in either of the properties, csc.adapter.fileOperation.transform.header.inElement or csc.adapter.fileOperation.transform.trailer.inElement.
csc.adapter.fileOperation.transform.data.outElement= Path of an output XML file element corresponding to data code ~<Character string>
Specify path for the element in output XML file of the corresponding data record, in following format.
Path of element ::= ( '/' [ '{' namespace URI '}' ] element name)+When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.output (output file in binary format), the specification in this property will be ignored.
Error occurs, if the path specified in this property overlaps with the path specified in either of the properties, csc.adapter.fileOperation.transform.header.outElement or csc.adapter.fileOperation.transform.trailer.outElement.
csc.adapter.fileOperation.transform.data.styleSheet=XSL file name for data record transformation ~<Character string>
Specify the XSL file name for data record transformation (user can specify any name). When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.data.fixedSize=Fixed length size of data record ~<Number>((Between 1 and 2147483647))
Specify the fixed length for data record (Unit: bytes). When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property is ignored. You can omit this property if separate (input file in linefeed separator format) is specified in the property csc.adapter.fileOperation.transform.format.
csc.adapter.fileOperation.transform.data.batchSize=Number of one time data record transformations~<Number>((Between 0 and 524288000))<<0>>
Specify the count at which data records are to be transformed every time. If quantity of data per record is smaller and you transform multiple records concurrently, instead of transforming one record at a time, the transformation performance might improve. For details see "8.7.3 File conversion operation" in "Service Platform Overview".
When you specify 0, one record is transformed at a time (transformation process for small data)
When you specify 1 or more in this property, the transformation process is optimized for large scale data.
csc.adapter.fileOperation.transform.trailer.inFormat=Binary format definition file name for trailer record input ~<Character string>
Specify the binary format definition file name for trailer record input.
You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.trailer.outFormat= Binary format definition file name for trailer record output ~<Character string>
Specify the binary format definition file name for trailer record output.
You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.output (output file in XML format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.trailer.inElement= Path of an input XML file element corresponding to trailer record ~<Character string>
Specify path for the element in the input XML file of the corresponding trailer record, in following format.
Path of element ::= ( '/' [ '{' namespace URI '}' ] element name)+You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).
When if you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.input (input file in binary format), the specification in this property is ignored.
There will be an error if the path specified in this property overlaps with the path specified either of the properties csc.adapter.fileOperation.transform.header.inElement or csc.adapter.fileOperation.transform.data.inElement.
csc.adapter.fileOperation.transform.trailer.outElement= Path of an output XML file element corresponding to trailer record ~<Character string>
Specify the path for element in the output XML file of the corresponding trailer record, in the following format.
Path of element::= ( '/' [ '{' Namespace URI '}' ] Element name)+You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.output (output file in binary format), the specification in this property is ignored.
Error occurs if the path specified in this property overlaps with the path specified either of the properties csc.adapter.fileOperation.transform.header.outElement or csc.adapter.fileOperation.transform.data.outElement.
csc.adapter.fileOperation.transform.trailer.styleSheet=XSL file name for trailer record transformation ~<Character string>
Specify the XSL file name for trailer record transformation (user can specify any name).
You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.trailer.fixedSize=Fixed length size of trailer record ~<Number>((between 1 and 2147483647))
Specify a fixed length for trailer record (unit: bytes). You cannot omit this property when both of the following properties are set as follows:
-
Value of the property csc.adapter.fileOperation.transform.format is fixed (Input file format with fixed length)
-
Value of the property csc.adapter.fileOperation.transform.trailerRecord is ON (use trailer record)
When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property is ignored. You cannot omit this property when separate is specified in the property csc.adapter.fileOperation.transform.format.
csc.adapter.fileOperation.transform.all.inFormat=Binary format definition file name for input during batch processing ~<Character string)
Specify the binary format definition file name for input during batch processing, in the following format.
When you specify ON in the property csc.adapter.fileOperation.transform.splitLoad (Split processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property will be ignored.
csc.adapter.fileOperation.transform.all.outFormat= Binary format definition file name for output during batch processing ~<Character string)
Specify the binary format definition file name for output during batch processing, in the following format.
When you specify ON in the property csc.adapter.fileOperation.transform.splitLoad (Split processing of input file format), or xml in the property csc.adapter.fileOperation.transform. output (output file in XML format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.all.styleSheet=XSL file name for transformation during batch processing ~<Character string>
Specify XSL file name for transformation during batch processing (user can specify any name).
When you specify ON in the property csc.adapter.fileOperation.transform.splitLoad (split processing of input file format), the specification in this property is ignored.
csc.adapter.fileOperation.transform.existFile={overwrite|error} ~<<overwrite>>
If there is a file with the same name as that of the file to be output after file transformation, specify whether you want to overwrite.
-
overwrite
Overwrites to the existing contents of the file
-
error
Cancels file transformation and issues an exception
If you specify value other than overwrite or error, system aborts file transformation and issues an exception.
csc.adapter.fileOperation.copy.existFile={overwrite|error} ~<<overwrite>>
If a file with the same name exists at the time of copying a file, specify whether you want to overwrite.
-
overwrite
Overwrite to the existing contents of the file
-
error
Cancels copy operation and issues an exception
If you specify a value other than overwrite or error, system aborts the copy operation and issues an exception.
csc.adapter.fileOperation.move.existFile={overwrite|error} ~<<overwrite>>
Specify whether to overwrite any existing file that has the same name as that of the file to be output during the move file operation.
-
overwrite
Overwrites the existing contents of the file.
-
error
Cancels the move operation and issues an exception.
If you specify a value other than overwrite or error, the system cancels the move operation and issues an exception.
csc.adapter.fileOperation.compress.existFile={overwrite|error} ~<<overwrite>>
If there is a file with the same name as that of the file to be output during file compression operation, specify whether you want to overwrite.
-
overwrite
Overwrites with compression to the existing contents of the file
-
error
Cancels compression and issues an exception
If you have specified any value other than overwrite or error, the system aborts compression and issues an exception.
csc.adapter.fileOperation.extract.existFile={overwrite|error} ~<<overwrite>>
If there is a file with the same name as that of the file to be output during file extraction operation, specify whether you want to overwrite.
-
overwrite
Overwrites with extraction to the existing contents of the file
-
error
Aborts extraction and issues exception
If you specify a value other than overwrite or error, the system issues an exception.
csc.adapter.fileOperation. writeList.existFile={overwrite|error} ~<<overwrite>>
Specify whether to overwrite any existing file that has the same name as that of the file to be output during the file list write operation.
-
overwrite
Overwrites the existing contents of the file.
-
error
Cancels the list write operation and issues an exception
If you specify a value other than overwrite or error, the system cancels the list write operation and issues an exception.
(4) Example of coding
A description example is shown as follows:
csc.adapter.fileOperation.transform.splitLoad=on csc.adapter.fileOperation.transform.format=fixed csc.adapter.fileOperation.transform.header.inFormat=in_hdr.fdx csc.adapter.fileOperation.transform.header.outFormat=out_hdr.fdx csc.adapter.fileOperation.transform.header.styleSheet=trans_hdr.xsl csc.adapter.fileOperation.transform.header.fixedSize=64 :