Output Raw - Data360_Analyze - 3 - 3.12

Data360 Analyze Server Help

Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 Analyze
Version
3.12
Language
English
Product name
Data360 Analyze
Title
Data360 Analyze Server Help
Copyright
2023
First publish date
2016

Writes data from a string or Unicode field, possibly a MIME-encoded file, to files, with one file per record for the specified field.

This node takes data from a string or unicode field, possibly a filename to a MIME-encoded file, and writes out a file in a user specified directory based on that content, with one file per record for the specified field. The directory is an absolute pathname and a valid directory name. The node must have permission to create the directory if necessary, and have permission to save files in the directory. The node will remove the wrapped encodings produced by nodes such as the HTTP node.

If the data is base64 encoded, the node will base64 decode the data and store the resulting binary data in a file, otherwise, the node will store the data in a file as plain text.

If it is a MIME-encoded file, the node does no validation to verify the data conforms to expectation.The node will output the full pathname of the saved file in the output field that can be configured by the optional property FilenameFieldName, which defaults to "_Filename"

Properties

DataField

Specify the field used to provide the actual content for each of the files, one per record, to be written.

File

Optionally specify the file that stores the output data.

The filename can be an absolute path or relative path to the file. If blank, the node will automatically generate a filename whose file path is relative. If the file path is relative, the property Directory will be used as the base.

Example absolute path pathnames:

  • Windows: C:\\temp\\Data360Analyze.png
  • Windows: C:/temp/Data360Analyze.png
  • Linux: /tmp/Data360Analyze.png

Example relative path filenames:

  • Windows: Data360Analyze.png
  • Linux: com/Data360Analyze/Data360Analyze.png

If the destination directory does not exist, the behavior is governed by the MissingDirectoryBehavior property.

The generated filename will have the extension ".tmp". The node does not check for correctness of the user-provided filename, or whether the file extension matches the Mime type of the output data.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

Note: If you are using the server edition, the output file will be created on the Data360Analyze server. If you wish to open the file, and you don't have access to the file system on the server, you will need to download the file onto your local machine. Please see the topic Downloading data from the server for more details.

Directory

Optionally specify the directory where the generated file will reside. The directory must be an absolute pathname. If the directory does not exist, the node may create it, depending on the value of the property MissingDirectoryBehavior.

If not specified, the default directory will be under the server configured temp directory, {{%ls.brain.node.tempdir%}}/<user_name>/<graph_name>/<run_name>/Output Raw

Examples of an absolute directory:

  • Windows: C:\\temp
  • Windows: C:/temp/Data360Analyze
  • Linux: /tmp

FilenameFieldName

Optionally specify the output field name which contains full path and file name of each file written to disk.

The type of the field will default to Unicode. This will provide support in the off-chance that someone has put non-ASCII characters into the Directory property.

The default value is "_Filename".

PassThroughFields

Optionally specify which input fields will "pass through" the node unchanged from the input to the output, assuming that the input exists. The input fields specified will appear on those output records which were produced as a result of the input fields. Choose from:

  • All - Passes through all the input data fields to the output.
  • None - Passes none of the input data fields to the output; as such, only the fields created by the node appear on the output.
  • Used - Passes through all the fields that the node used to create the output. Used fields include any input field referenced by a property, be it explicitly (i.e., via a 'field1' reference) or via a field pattern (i.e., '1:foo*').
  • Unused - Passes through all the fields that the node did not use to create the output.

The default value is Used.

NullValueBehavior

Optionally specify how the node should handle situations in which the data field is NULL. Choose from:

  • Error - The node will throw an error and stop processing.
  • Log - The node logs that the situation occurs but allows the node to continue processing. Neither output file nor output record is produced.
  • Ignore - The erroneous situation will be ignored, and the node keeps on processing. Neither output file nor output record is produced.
  • Emit - The node will create an empty file.

The default value is Error.

DirectoryMissingBehavior

Optionally specify how the node should handle situations in which the directory for the output file does not exist. Choose from:

  • Error - The node will throw an error and stop processing.
  • Log - The node logs that the situation occurs but allows the node to continue processing. Neither output file nor output record is produced.
  • Ignore - The erroneous situation will be ignored, and the node keeps on processing. Neither output file nor output record is produced.
  • Create - The node will create the missing directories if possible, and erroring if unable to create them.

The default value is Error.

FileExistsBehavior

Optionally specify how the node should handle situations in which the output file existed. Choose from:

  • Error - The node will throw an error and stop processing.
  • Append - The node will append the contents to the existing file.
  • Overwrite - The node will overwrite the existing file with new contents.

Note that the node does not validate the correctness of contents to be appended or overwritten to a file. For example, an image file may be replaced by a XML file, or binary data like Microsoft spreadsheet may be appended to an image in a file.

The default value is Error.

Inputs and outputs

Inputs: inputData.

Outputs: FileDetails.