Output Header Items (CSV)

Operation Name

Function Overview

Outputs header item names extracted from style file (XML style file and frm style file) to file.

Properties

For information about using variables, refer to "Variables".

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Data file	Required	Available	Inputs data file path that outputs header item. By clicking [Browse] button, file chooser launches and enables to select file.	Specify the absolute path of the DataSpider file system as the file path. Constrained characters of DataSpider File System except for path separator "/" cannot be used.
Delimiter mode	Required	Not available	Select how to specify delimiter. [Select from list]:(default) Select delimiter from list. [Input directly]: Input delimiter directly to field. [Input character code]: Input delimiter by character code to field.	Depending on the selected specification method, switches to the corresponding input field.
Select from list/Delimiter	Optional	Not available	Select delimiter. [Comma]:(default) Specifies Comma(,). [Tab]: Specifies Tab. [Space]: Specifies Space( ). [Semicolon]: Specifies Semicolon(;). [Slash]: Specifies Slash(/). [Vertical bar]: Specifies Vertical bar(\|).	Valid, if [Select from list] is selected to [Delimiter mode].
Enter directly/Delimiter	Required	Available	Input 1 character of delimiter.	Valid, if [Enter directly] is selected to [Delimiter mode]. Cannot specify double quotation to delimiter.
Input character code/Delimiter	Required	Available	Input character code. Entered character code will be converted to encode specified in [Encode]. Entering with Octal(prefix"0"<number zero>), Decimal(no prefix), Hexadecimal(prefix"0x"<number zero and alphabet x>or"#") will be available. If padding becomes multiple byte strings, enter by separating with comma. Ex:0x10,0x13	Valid, if [Input character code] is selected to [Delimiter mode]. Character code converted into 1 character can be input. Character code that is converted into line break code, double quotation cannot be specified.
Header item	Required	-	Specify a header item. Each header item can be operated by the following buttons. [Add]: Adds a header item. [Up]: Moves up the order of selected header item by one. [Down]: Moves down the order of selected header item by one. [Delete]: Deletes a header item.
Header item/Header item name	Required	Available	Input header item name.
Header item/Quotation	Optional	Not available	Select whether to enclose each header item name with double quotation. [Checked]: Encloses header item name with double quotation. [Not checked]:(default) Does not enclose header item name with double quotation.

Property action

Item name	Description	Remarks
Preview	Launch previewer and display the file contents specified in [Data file].	Invalid, if the specified file does not exist, or variable is set to [Data file]. Displayed with the encode specified in [Encode]. Editing file contents are not available. Maximum file size that previewer can show is 1MB. If the file size exceeds 1MB, contents up to 1MB will be shown from the beginning of the file.
Read header item name from style file	Select style file with file chooser and set header item name by extracting from the file.	If style file is not correct, or field/barcode is not defined to style file, [Header item] update will not be performed.

Write settings

Item name	Required/Optional	Use of variables	Description	Remarks
Encode	Required	Available	Select or input the writing file encode. If inputing, specifies the encode supported in Java SE Runtime Environment 8. For details, refer to "Supported Encodings"(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html)	Default value is "UTF-8".

Transaction

Item name	Required/Optional	Use of variables	Description	Remarks
Perform Transaction	Required	Not available	Select whether to perform transaction. [Checked]: Performs transaction. [Not checked]:(default) Does not perform transaction. For details, refer to "File adapter transaction".

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input schema

None.

Output schema

None.

Transaction

Transaction is supported.

Transaction is valid, if [Perform Transaction] of [Transaction] is checked.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
data_file_path	Stores the data file path specified in [Data file].	Default value is null.
message_category	Stores the category of message code corresponding to the occurred error.	Default value is null.
message_code	Stores the code of message code corresponding to the occurred error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occurred error.	Default value is null.
error_type	Stores the error type of occurred error.	Default value is null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The value may vary depending on the DataSpider Servista version.
error_message	Stores the error message of occurred error.	Default value is null. The value may vary depending on the DataSpider Servista version.
error_trace	Stores the trace information of occurred error.	Default value is null. The value may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

None.

Main Exceptions

Exception name	Cause	Solution
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify [<Property name>].
InvalidPropertyConfigurationException False delimiter is specified.	False character is input to [Delimiter].	Input correct character to [Delimiter].
PathIsNotAbsoluteException	Designated path is relative path.	Input absolute path.
FileIsDirectoryException	Path entered in [Data file] is directory.	Input file path to [Data file].
FileIsLockedException	File specified in [Data file] is locked.	Perform unlock from explorer or CLI.
java.io.FileNotFoundException Other process is in use.	File specified in [Data file] is used by other process.	Check whether this is used in other process.
java.io.UnsupportedEncodingException	Encode not supported in [Encode] is specified.	Specify the encode supported by Java SE Runtime Environment 8. For details, refer to "Supported Encodings"(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).