3.14.3 Binary-message-generation command properties file
- Organization of this subsection
(1) Format
csctransform.format=path-of-binary-format-definition-file csctransform.output.binary.data=path-of-output-binary-file csctransform.output.xml.data=path-of-output-XML-file [csctransform.input.xml.data=path-of-input-XML-file] [csctransform.generate.property=path-of-binary-message-generation-definition-file] [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}]
(2) Function
Specifies the arguments of the cscgenbinary command in the property format. The file that has been set up can be specified in the -f option of the cscgenbinary command that is to be executed. For details about the cscgenbinary command, see cscgenbinary (Generating binary messages from binary format definition files).
- Correspondence with the arguments of the cscgenbinary command
-
The following shows the correspondence between the properties specified in this file and the arguments of the cscgenbinary command.
No.
Property key name
Corresponding command argument
Settings
1
csctransform.format
-format
Path of the binary format definition file
2
csctransform.output.binary.data
-outbinfile
Path of the output binary file
3
csctransform.output.xml.data
-outxmlfile
Path of the output XML file
4
csctransform.input.xml.data
-inxmlfile
Path of the input XML file
5
csctransform.generate.property
-genproperty
Path of the binary-message-generation definition file
6
csctransform.uoc.class
-uocclass
Class name of the character code conversion UOC
7
csctransform.uoc.property
-uocproperty
Path of the self-defined file for the character code conversion UOC
8
csctransform.code.table.root.path
-codetablerootpath
Root path of the code conversion table storage path
9
csctransform.debugtrace
-debugtrace
Whether to output debug information
10
csctransform.debugtrace.filepath
-debugtracefilepath
Path to output debug information
11
csctransform.system.properties
-cscdtsysprop
Path of the system properties file for data transformation
12
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 save it with any file name.
- Location of the template file
service-platform-installation-directory\CSCTE\template\cscdt_cscgenbinary.properties
(3) Specifiable properties
csctransform.format=path-of-binary-format-definition-file
Specify, as an absolute or relative path, the path of the binary format definition file that has been validated in the editor.
The available file extension is .fdx only. The file extension is not case sensitive.
csctransform.output.binary.data=path-of-output-binary-file
Specify the path of the output binary file as an absolute or relative path. If the output destination directory does not exist, an error occurs.
You must specify either csctransform.output.binary.data (path of the output binary file) or csctransform.output.xml.data (path of the output XML file).
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.output.xml.data=path-of-output-XML-file
Specify the path of the output XML file as an absolute or relative path. If the output destination directory does not exist, an error occurs.
You must specify either csctransform.output.binary.data (path of the output binary file) or csctransform.output.xml.data (path of the output XML file).
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.input.xml.data=path-of-input-XML-file
Specify the input XML file as an absolute or relative path to generate a binary message from an XML file.
This property is invalid if specified along with csctransform.output.xml.data.
The specified input XML file must comply with the XML schema file generated by using the cscfdx2xsd command based on the binary format definition file (specified in csctransform.format). If the input XML file does not comply with the XML schema file, operations are not guaranteed.
csctransform.generate.property=path-of-binary-message-generation-definition-file
Specify the path of the binary-message-generation definition file as an absolute or relative path.
This property is invalid if specified along with csctransform.input.xml.data.
Create the binary-message-generation definition file if you want to change element values of a simple content element from the default values. For details about the binary-message-generation definition file, see 3.14.4 Binary-message-generation definition file.
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.
You can also specify the class name of the character code conversion UOC in the following files or command. The following shows the priority by which the value will be applied if specifications are duplicated.
Priority |
Property file or command name |
Relevant property or argument |
---|---|---|
1 |
System properties file for data transformation |
csc.dt.ownCodeConverter.className |
2 |
Binary-message-generation command properties file |
csctransform.uoc.class |
3 |
cscgenbinary 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 cscgenbinary command, see cscgenbinary (Generating binary messages from binary format definition files).
To use the character code conversion UOC, you need to set the JAR file of the character code conversion UOC in the system environment variable CSC_DATA_TRANSFORM_CLASSPATH. To invoke a class defined in an external JAR file from a custom function or character code conversion UOC, you also need to specify the relevant JAR file in the environment variable.
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. If you specify the csctransform.uoc.class property and omit this property, the class of the character code conversion UOC is executed without reading the self-defined file during data transformation.
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>>
Specify whether to output debug information.
-
ON
Output debug information.
-
OFF
Do not output debug information.
csctransform.debugtrace.filepath=path-to-output-debug-information ~ <<current directory in which the cscgenbinary command was executed>>
Specify the output destination path of debug information as an absolute or relative path.
This property is valid only when ON is specified for the csctransform.debugtrace property.
In the following cases, the default value is applied and the debug information is output to the current directory in which the cscgenbinary 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 specified 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. You can omit this argument.
-
ERROR
When an undefined character code is detected, an error occurs and the processing ends.
-
REPLACE
The character code of undefined portions is converted to a blank character code, and the processing continues.
(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.