3.14.1 Data-transformation command properties file

Organization of this subsection

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

(1) Format

  csctransform.xsl=path-of-XSL-file-(mapping-definition)
  csctransform.input.formatn=path-of-input-format-definition-file
  csctransform.input.datan=path-of-input-file
[csctransform.input.namen=logical-name-of-input-schema]
  csctransform.output.format=path-of-output-format-definition-file
  csctransform.output.data=path-of-output-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.validate={true|false}]
[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 csctransform command in the property format. The file that has been set up can be specified in the -f option of the csctransform command. For details about the csctransform command, see csctransform (Testing data transformation).

Correspondence with the arguments of the csctransform command

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

No.	Property key name	Corresponding command argument	Settings
1	`csctransform.xsl`	`-xsl`	Path of the XSL file (mapping definition)
2	`csctransform.input.format<n>`	`-informat`	Path of the input format definition file
3	`csctransform.input.data<n>`	`-infile`	Path of the input file
4	`csctransform.input.name<n>`	None	Logical name of the input-schema
5	`csctransform.output.format`	`-outformat`	Path of the output format definition file
6	`csctransform.output.data`	`-outfile`	Path of the output file
7	`csctransform.uoc.class`	`-uocclass`	Class name of the character code conversion UOC
8	`csctransform.uoc.property`	`-uocproperty`	Path of the self-defined file for the character code conversion UOC
9	`csctransform.code.table.root.path`	`-codetablerootpath`	Root path of the code conversion table storage path
10	`csctransform.validate`	`-validate`	Whether to validate the schema for input files or output files
11	`csctransform.debugtrace`	`-debugtrace`	Whether to output debug information
12	`csctransform.debugtrace.filepath`	`-debugtracefilepath`	Output destination path of debug information
13	`csctransform.system.properties`	`-cscdtsysprop`	Path of the system properties file for data transformation
14	`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_csctransform.properties

To Page Top

(3) Specifiable properties

csctransform.xsl=path-of-XSL-file-(mapping-definition)

Specify the path of the XSL file (mapping definition) as an absolute or relative path.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.input.formatn=path-of-input-format-definition-file

Specify the path of the input format definition file (extension: .xsd or .fdx) as an absolute or relative path.

For n, specify 1 or greater integer (halfwidth) as a sequential number starting from 1. If you specify duplicate integers for n, which property is valid is not guaranteed.

The following settings are interpreted that sequential numbers from 1 to 5 are specified for n.

csctransform.input.format1 = c:\\temp\\format1.xsd
csctransform.input.format2 = c:\\temp\\format2.xsd
csctransform.input.format3 = c:\\temp\\format3.xsd
csctransform.input.format4 = c:\\temp\\format4.xsd
csctransform.input.format5 = c:\\temp\\format5.xsd

The following settings, in which the values of n are not sequential (5 is missing), are interpreted that numbers from 1 to 4 are specified.

csctransform.input.format1 = c:\\temp\\format1.xsd
csctransform.input.format2 = c:\\temp\\format2.xsd
csctransform.input.format3 = c:\\temp\\format3.xsd
csctransform.input.format4 = c:\\temp\\format4.xsd
csctransform.input.format6 = c:\\temp\\format6.xsd

The following settings, in which 1 is not specified for n, are determined to be invalid and an error occurs.

csctransform.input.format2 = c:\\temp\\format2.xsd
csctransform.input.format3 = c:\\temp\\format3.xsd
csctransform.input.format4 = c:\\temp\\format4.xsd

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

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

For n, specify 1 or greater integer (halfwidth) as a sequential number. If you specify duplicate integers for n, which property is valid is not guaranteed.

csctransform.input.namen=logical-name-of-input-schema

Specify the logical name of input schema when N-to-one transformation is to be performed. If you omit this property, an error occurs during data transformation.

For n, specify 1 or greater integer (halfwidth) as a sequential number starting from 1. If you specify duplicate integers for n, which property is valid is not guaranteed.

For one-to-one transformation, there is no need to specify this priority. If specified, this priority is ignored.

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

Specify the path of the output format definition file (extension: .xsd or .fdx) as an absolute or relative path.

If you specify the same property multiple times, which property is valid is not guaranteed.

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

Specify the path of an output 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.

If you specify the same property multiple times, which property is valid is not guaranteed.

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	Data-transformation command properties file	`csctransform.uoc.class`
3	`csctransform` 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 csctransform command, see csctransform (Testing data transformation).

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 valid only when the csctransform.uoc.class property (class name of the character code conversion UOC) is specified.

If you specify the same property multiple times, which property is valid is not guaranteed.

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.validate={true|false} ~ <<false>>

Specify whether to perform schema validation.

true

The following schema validation is performed:
- Schema validation for input files (XML) is performed by using an input format definition file (XML Schema).
- Schema validation for output files (XML) is performed by using an output format definition file (XML Schema).
false

Schema validation is not performed.

If you specify the same property multiple times, which property is valid is not guaranteed.

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 csctransform 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 csctransform 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.

If you specify the same property multiple times, which property is valid is not guaranteed.

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

Specifies 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 is converted to a blank character code, and the processing continues.

If you specify the same property multiple times, which property is valid is not guaranteed.

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