Acquires a file and produces an output field containing the raw file contents.
This node receives a filename as input, and reads in the contents of the file. The file contents can be binary data (e.g. images) or textual data that contain commas, double quotes, non-printable ASCII characters like tabs or carriage returns (e.g. XML data).
If the content type of a file is binary (e.g. chart images or word documents), the user can set the property DataOutputFieldEncoding so that the node will Base64 encode the binary data. If property DataOutputFieldEncoding is set to None, the node will assume textual raw data and leave the data as is. If property DataOutputFieldEncoding is set to Auto, then the node will try to determine whether to encode the data based on the choices of properties Charset and DataOutputFieldType.
The output data will start with any Mime types in property MimeType, and a node generated Base64 Mime type if data is Base64 encoded.
Properties
File
Click the folder icon and browse to the file that you want to import.
Choose the (from Field) variant of this property to look up the value from an input field with the name specified.
The node does not check for correctness of the filename, or whether the file extension matches the Mime type in property MimeType.
Examples:
- Windows: C:\\temp\\Data360 Analyze.png
- Windows: C:/temp/Data360 Analyze.png
- Linux: /tmp/Data360 Analyze.png
A value is required for this property.
MimeType
Optionally specify the Mime type of the raw data.
Choose the (from Field) variant of this property to look up values from an input field with the name specified.
Examples:
- image/jpeg - Image file
- audio/mpeg - Audio file
- application/pdf - Portable Document Format file
- application/zip - ZIP Archive file
Charset
Optionally specify the character set used in the raw data. NULL values or empty strings are treated as ASCII.
Choose from:
- ASCII - Raw data contains the numbers from 0-9, the uppercase and lowercase English alphabet, and some special characters.
- UNICODE - Raw data contains unicode data.
- UTF8 - Raw data contains UTF-8 encoded data. UTF-8 is a variable-width encoding that can represent every character in the Unicode character set. A unicode character can be from 1 to 4 bytes long.
- UTF16 - Raw data contains UTF-16 encoded data. UTF16 is a character encoding for Unicode capable of encoding 1,112,064 numbers (called code points) in the Unicode code space from 0 to 0x10FFFF. The encoding is a variable-length encoding as code points are encoded with one or two 16-bit code units.
- UTF32 - Raw data contains UTF-32 encoded data. UTF-32 (or UCS-4) is a protocol to encode Unicode characters that uses exactly 32 bits per Unicode code point.
The default value is ASCII.
Choose the (from Field) variant of this property to look up values from an input field with the name specified.
DataOutputFieldEncoding
Optionally specify encoding options for the data when writing to the field specified by DataOutputField.
The input raw data can be either ASCII text, Unicode text, or binary. Since Data360 Analyze does not support binary data in output records, this data must be encoded, or put in a valid data format, before being output to a pin.
If the input raw data is Base64 encoded by this node, the node will insert a Base64 MimeType, "application/base64", at the end of the encoded data, following any user-specified MimeType in property MimeType.
Choose from:
- Auto - The node will attempt to correctly determine whether to Base64 encode the input data. It first looks at the MimeType property. If this property is set and begins with anything other than "text/", the data will be Base64 encoded. If the MimeType is not set or begins with "text/", The node inspects the property Charset value. If property Charset is set to ASCII, the data will not be Base64 encoded. Otherwise, the node further examines the field type chosen in property DataOutputFieldType. If property DataOutputFieldType is set to String, the node will Base64 encode the possible unicode data in order to avoid errors.
- Base64 - Encode all DataOutputField values using Base64 encoding. This is the safest option. This option should be chosen for binary data.
- None - Do not encode any of the output data. This option should only be used when the user can guarantee that the input raw data is not binary, and contains ASCII text only. If the node encounters non-ASCII text, an error will be thrown and the node will stop processing.
The default value is Auto.
Choose the (from Field) variant of this property to look up a value from an input field with the name specified.
DataOutputField
Optionally specify the field name in the output pin that contains the raw or Base64 encoded data read from the file, preceded by the contents in property MimeType, and Base64 MimeType if Base64 encoded.
The default value is "_RawData".
DataOutputFieldType
Optionally specify the type of the field named in property DataOutputField. Choose from:
- String - The data output field will be a Data360 Analyze string type.
- Unicode - The data output field will be a Data360 Analyze Unicode string type.
The default value is Unicode.
FilenameOutputField
Optionally specify the field name to be created in the output pin that contains the absolute path of the input raw data file. If blank, such field will not be created.
The default value is blank.
PassThroughFields
Optionally specify how to handle input fields to the node. Choose from:
- All - Outputs all fields that were input into the node along with any generated fields.
- None - Enables the node only to produce generated fields.
- Used - Limits the node output to only those fields that are used to produce the file, and the generated fields.
- Unused - Outputs all data that was not used to produce the file, and the generated fields.
The default value is Unused.
NullValueBehavior
Optionally specify how the node should handle situations in which the input file pathname is NULL. Choose from:
- Error - The node will throw an error and stop processing
- Log - The node simply logs that the situation occurs but allows the node to continue processing. No output record is produced
- Ignore - The erroneous situation will be ignored, and the node keeps on processing. No output record is produced.
The default value is Error.
Inputs and outputs
Inputs: 1 optional (input fields).
Outputs: output.