3.14.5 Binary-parse command properties file

Organization of this subsection

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

(1) Format

  csctransform.format=path-of-binary-format-definition-file
  csctransform.input.data=path-of-input-data-file
  csctransform.output.data=path-of-output-data-file
[csctransform.inverse={true|false}]
[csctransform.uoc.class=class-name-of-character-code-conversion-UOC]
[csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC]
[csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path]
[csctransform.debugtrace={ON|OFF}]
[csctransform.debugtrace.filepath=path-to-output-debug-information]
[csctransform.system.properties=path-of-system-properties-file-for-data-transformation]
[csctransform.undefined.code={ERROR|REPLACE}]

To Page Top

(2) Function

Specifies the arguments of the cscbinaryparse command in the property format. The file that has been set up can be specified in the -f option of the cscbinaryparse command to be executed. For details about the cscbinaryparse command, see cscbinaryparse (Mutually transforming DOM and binary data).

Correspondence with the arguments of the cscbinaryparse command

The following shows the correspondence between the properties specified in this file and the arguments of the cscbinaryparse command.

No.	Property key name	Corresponding command argument	Settings
1	`csctransform.format`	`-format`	Path of the binary format definition file
2	`csctransform.input.data`	`-infile`	Path of the input data file
3	`csctransform.output.data`	`-outfile`	Path of the output data file
4	`csctransform.inverse`	`-inverse`	Transformation operation between binary and DOM data
5	`csctransform.uoc.class`	`-uocclass`	Class name of the character code conversion UOC
6	`csctransform.uoc.property`	`-uocproperty`	Path of the self-defined file for the character code conversion UOC
7	`csctransform.code.table.root.path`	`-codetablerootpath`	Root path of the code conversion table storage path
8	`csctransform.debugtrace`	`-debugtrace`	Whether to output debug information
9	`csctransform.debugtrace.filepath`	`-debugtracefilepath`	Output destination path of debug information
10	`csctransform.system.properties`	`-cscdtsysprop`	Path of the system properties file for data transformation
11	`csctransform.undefined.code`	`-undefinedcode`	Handling of undefined character codes

How to edit the file

Specify the file in the Java property file format. The available character code is UTF-8 only.

Edit the following template file, and then save it with any file name.

Location of the template file

service-platform-installation-directory\CSCTE\template\cscdt_cscbinaryparse.properties

To Page Top

(3) Specifiable properties

csctransform.format=path-of-binary-format-definition-file

Specify the path of the input format definition file as an absolute or relative path.

The available file extension is .fdx only.

csctransform.input.data=path-of-input-data-file

Specify the path of the input data file as an absolute or relative path.

You can specify any of the following types of data as the input data file:

Binary data
Either of the following DOM data (XML)
- DOM data generated from binary data by using DOM transformation
- DOM data that complies with the XML schema file generated by using the cscfdx2xsd command in which the binary format definition file (specified in csctransform.format) is specified

csctransform.output.data=path-of-output-data-file

Specify the path of the output data file as an absolute or relative path. If the output destination directory does not exist, an error occurs.

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

csctransform.inverse={true|false} ~ <<false>>

This property switches the transformation operation between binary data and DOM data.

true

DOM data is transformed to binary data.
false

Binary data is transformed to DOM data.

csctransform.uoc.class=class-name-of-character-code-conversion-UOC

Specify the class name of the character code conversion UOC by using a fully qualified name.

If the specified class name of the character code conversion UOC is duplicated, the specified value is applied according to the following priority.

Priority	Property file or command name	Relevant property or argument
1	System properties file for data transformation	`csc.dt.ownCodeConverter.className`
2	Binary-parse command properties file	`csctransform.uoc.class`
3	`cscbinaryparse` command	`-uocclass`

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation. For details about the cscbinaryparse command, see cscbinaryparse (Mutually transforming DOM and binary data).

csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC

Specify the path of the self-defined file for the character code conversion UOC as an absolute or relative path.

This property is invalid if the csctransform.uoc.class property is not specified.

csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path

Specify, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library.

csctransform.debugtrace={ON|OFF} ~ <<OFF>>

This property specifies whether to output debug information.

ON

Output debug information.
OFF

Do not output debug information.

csctransform.debugtrace.filepath=path-to-output-debug-information

Specify the output destination path of debug information as an absolute or relative path.

This property is valid only when the csctransform.debugtrace property is specified.

In the following cases, the default value is applied and the debug information is output to the current directory in which the ccscbinaryparse command was executed:

This property is not set.
The output destination is not specified for this property.
The specified directory does not exist.

csctransform.system.properties=path-of-system-properties-file-for-data-transformation

To enable the system properties for Service Platform specified in the system properties file for data transformation, this property specifies the path of the file as an absolute or relative path.

For details about the settings in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

csctransform.undefined.code={ERROR|REPLACE} ~ <<ERROR>>

Specify the operation to be performed when an undefined character code is detected during code conversion for binary data.

ERROR

When an undefined character code is detected, an error occurs and the processing ends.
REPLACE

The character code of undefined portions are converted to a blank character code, and the processing continues.

To Page Top

(4) Notes

If you use a wildcard to specify a path, operations are not guaranteed.
To use a backslash (\) as a path separator, add an escape character.

To Page Top