utled (Command to execute data processing)
This command processes the input file data according to the content of data processing information or a parameter file, and generates the designated output files.
Grade |
User type for DataMagic |
Business group settings for management information |
Execution right |
Executability |
---|---|---|---|---|
DataMagic Server |
Superuser |
- |
- |
Executable |
General user |
Omit specification of rights (#1) |
- |
Executable |
|
Specify rights |
Executable |
Executable |
||
Not executable |
Not executable |
|||
DataMagic Desktop |
- |
- |
- |
Executable |
#1 |
: |
Indicates that user rights are not specified for business groups but they will be used as filtering conditions. |
Commands
utled {-f filename [-resultfile filename]|-i id} [-n|-m|-r] [-restore] [-infile filename] [-matchfile{001-101} filename] [-vttablefile{01-20} filename] [-outfile{001-101} filename] [-mergefile{01-20} filename] [-errfile filename] [[-errdatfile filename] [-errcausefile filename [-errcausekeys numbers]] [-errovrwr] [-errdatmax max]] [-tracefile filename [-tracelevel level]] [-dstr{01-20} parm] [-dnum{01-20} parm] [-thread {on|off}]
Parameters
-f filename [-resultfile filename]|-i id
Parameter file to be executed or the data processing ID. (This parameter cannot be omitted.)
-f filename
Parameter file name. (This parameter cannot be omitted.)
Specify the name of a parameter file created in Ver. 1.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
-resultfile filename
Dynamically specified result file name. (This parameter can be omitted.)
Specify the file name by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
The result file name is only valid if a parameter file name is specified. If you omit the result file name, the settings in the parameter file are applied.
-i id
Data processing ID. (This parameter cannot be omitted.)
Use 1 to 50 bytes of alphanumeric characters and symbols.
-n | -m | -r
Output method. (This parameter can be omitted.)
If the output method is not specified, the -n option is applied.
- -n:
-
Creates the output file specified in the data processing information and outputs the results.
If a file with the same name as the output file exists, the command results in an error.
- -m:
-
Appends the results to the output file specified in the data processing information.
If the output file does not exist, a new output file is created.
- -r:
-
Overwrites data currently in the output file specified in the data processing information with the results.
If the output file does not exist, a new output file is created.
-
If the output file is in XML format, you cannot specify "-m" as the Output method. For precautions regarding XML conversion, see DataMagic Operation Manual.
-
If the output file is in Excel format, output is generated as follows:
-
If "-r" is specified, the existing file is deleted and a new output file is created.
-
If "-m" is specified, the existing file is opened, and a new sheet is added or a cell is overwritten.
-
If the output file is in database table format, this parameter is ignored, and data is output according to the update method specified in the database table information or the settings specified in SQL statements.
For the update method specified in the database table information and SQL statement specification, see 3.8 Database table information.
-restore
Restore in case of error (This parameter can be omitted.)
If data processing ended unsuccessfully, the output file specified in the data processing information is restored to the state before data processing.
If you omit this parameter, the output file remains as it is at the time data processing ended unsuccessfully.
If the output settings meet any of the following conditions, you cannot specify this parameter:
-
Excel is specified for Format and appending "-m" is specified for the output method.
-
Enable output file changeover is selected.
-
"1" is specified for the XML record unit.
If Use field values is specified for Output location, the output file is not restored even if you specify this parameter.
If the output file is in database table format, this parameter is ignored, and data processing is always rolled back when processing ends unsuccessfully.
-infile filename
Dynamically specified input file name. (This parameter can be omitted.)
Specify the file name by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
You cannot specify the standard input.
If you omit this parameter, the settings in the data processing information are applied.
-matchfile001-101 filename
Dynamically specified matching file name. (This parameter can be omitted.)
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
Specify the matching number from 001 to 101 for the parameter.
You cannot specify the standard input.
If you omit this parameter, the settings in the data processing information are applied.
-vttablefile01-20 filename
Dynamically specified virtual table file name. (This parameter can be omitted.)
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
Specify numbers from 01 to 20 for the parameter according to the order of setup you performed on the Virtual Table Settings screen.
You cannot specify the standard input.
If you omit this parameter, the settings in the data processing information are applied.
-outfile001-101 filename
Dynamically specified output file name. (This parameter can be omitted.)
Specify the file name by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
Standard output is not available.
Specify an output file number from 001 to 101 for the parameter.
A maximum of 101 output files can be dynamically specified for each output file number. However, you cannot specify the same file name more than once.
If you omit this parameter, the settings in the data processing information are applied.
-mergefile01-20 filename
Dynamically specified merged file name. (This parameter can be omitted.)
Specify the file name by using the absolute path or relative path. You cannot specify the standard input.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
Specify a merge file number from 01 to 20 for the parameter.
If you omit this parameter, the settings in the data processing information are applied.
-errfile filename
Dynamically specified error file name. (This parameter can be omitted.)
Specify the file name by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
If you omit this parameter, the settings in the data processing information are applied.
By setting this parameter, error information can be obtained whenever the error file name cannot be acquired due to a data processing information read error or other causes. In such a case, the error file is always overwritten for output.
-errdatfile filename
This is the name of the file where records are output if an invalid record is detected. (This parameter can be omitted.)
When this is specified, the Skip Error Data function is enabled, and error data is output to the specified file.
Specify the file name by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
-errcausefile filename
This is the name of the file where the cause that triggered the Skip Error Data function is output if an invalid record is detected. (This parameter can be omitted.)
When this is specified, the Skip Error Data function is enabled, and the cause that triggered the Error Skip Data function is output to the specified file.
Specify the file name by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
-errcausekeys numbers
This is the input field number of the key field that is output to the Error Cause File. (This parameter can be omitted.)
A maximum of 10 input field numbers can be specified.
If multiple input field numbers are specified, separate them by using commas (,).
If multiple input field numbers are specified, errors are output in the Error Cause File in the order in which they are specified.
-errovrwr
When the Error Data File (the file specified in -errdatfile) and the Error Cause File (the file specified in -errcausefile) already exist, overwrite the files. (This parameter can be omitted.)
This parameter can be specified when the -errdatfile and -errcausefile are specified.
When this parameter is not specified and the files already exist, processing ends with an error.
-errdatmax max
This specifies the maximum number of records that the Skip Error Data function allows to be generated. (This parameter can be omitted.)
This can be specified when the -errdatfile or the -errcausefile is specified.
Processing stops when the number of error records exceeds this value.
You can specify a number in the range of 1 to 999,999,999. When no value is specified, the function operates as though the maximum number of error records were unlimited.
-tracefile filename
Trace log file name. (This parameter can be omitted.)
Specify the file to which the trace log should be output by using the absolute path or relative path.
Use a string of 1 to 200 bytes of characters (Windows) or alphanumeric characters and symbols (UNIX).
-tracelevel level
Output preference for trace log. (This parameter can be omitted.)
Specify the preference at which the trace log is output. The value can be from 1 to 3.
For details about output preference, see DataMagic Error Codes and Messages Manual.
If you specify the trace log file name for -tracefile and omit -tracelevel, the utled command is executed as though "2" were specified for -tracelevel.
-dstr01-20 parm
The dynamic character string specified as the comparison target value of a condition, the fixed value of an output field, the argument of a function, or a similar value. (This parameter can be omitted.)
Specify a dynamic character string number from 01 to 20 for the parameter.
Specify the dynamic character string in parm using a character string of 1 to 1024 bytes.
The dynamic character string number specified here should be pre-registered in the data processing information or the database table information. For details on how to register the dynamic character string number, refer to Chapter 2. Data Processing Information or Section 3.8 Database table information.
A maximum of 20 dynamic character strings can be dynamically specified for each dynamic character string number. To set a dynamic character string that includes one or more spaces, use double quotation marks (").
If you omit this parameter when the extraction condition includes a dynamic character string, the command results in a conversion error.
If a dynamic character string is used in output information, the default value corresponding to the field is output if the format is Format, Multi Format, Hierarchy Format, or Database Table (if the format is CSV or XML, a 0-byte character is output). If a dynamic character string is used in an argument of a function, null is set in the argument.
A character string specified in a dynamic character string is converted to UTF-8 encoding once.
Then depending on the location where the dynamic character string is specified, DataMagic converts the character string according to the following:
-
When a dynamic character string is specified in the data processing information
The Kanji code type of the input file is converted.
-
When a dynamic character string is specified in the database table information
The Kanji code type of the data processing information that specifies a database table ID is converted.
If external characters are included in a character string specified as a dynamic character string, DataMagic converts them into the default value of the Kanji code type for the conversion destination. For details about the default values, see DataMagic Operation Manual. Furthermore, the values in the external character table are not referenced; changing the external character table does not affect the conversion to default values.
-dnum01-20 parm
The dynamic value specified as the comparison target value of a condition, the numeric value of an input field, or a similar value. (This parameter can be omitted.)
Specify a dynamic character string number from 01 to 20 for the parameter.
For parm, specify a dynamic value. Specify up to 19 digits, excluding "-" (minus sign) and "." (decimal point). The plus symbol "+" cannot be specified.
The dynamic value number specified here should be pre-registered in the data processing information or the database table information. For details on how to register the dynamic value number, refer to Chapter 2. Data Processing Information or Section 3.8 Database table information.
Each dynamic value number can be used up to 20 times for specifying a dynamic value.
If you omit this parameter, 0 is output for the dynamic value.
-thread {on|off}
Information about whether to use multi-threading for execution. (This parameter can be omitted.)
- on
-
: Multi-threading is used for execution.
- off
-
: A single thread is used for execution.
If this parameter is omitted, the setting values in the Options tab for the Data Processing Settings screen are used for execution. If -thread is specified, this takes priority over the setting values in the Options tab for the Data Processing Settings screen.