CSV Formatter
In this article
Overview
You can use this Snap to read a document at the input, format it as CSV based on the specified parameters, and write CSV data to the output.
Snap Type
CSV Formatter Snap is a READ-type Snap that reads a document that contains data structured as key-value attributes and generates CSV data formatted using specifications provided in the Snap's settings.
Prerequisites
None.
Support for Ultra Pipelines
Does not work in Ultra Pipelines.
Limitations and Known Issues
The Snap ignores escape characters when used along with any quote characters. When this happens, the resultant data cannot be parsed correctly using CSV Parser Snap which can cause an error. See Apache CSV Format Issue for details.
The Snap prepares the column header for the output view (and hence the CSV file) using the keys defined in the first record. This may result in ignoring any additional key passed in the subsequent records. We recommend that you pass values for a comprehensive set of all keys used in the input view, for the first record.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document
|
|
| Any document that contains data structured as key-value attributes. |
Output | Document
|
|
| CSV data formatted using specifications provided in the Snap's settings. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: CSV Formatter | String | Specify a unique name for the Snap. | |
Binary header properties | Use this field set to add binary-header properties to the output data. These properties contain data related information that enables the system to interpret data. Binary headers in a document can be accessed and used in the expression-enabled properties of downstream Snaps. For example, you can use binary headers to specify custom statuses associated with the output data. Similarly, a 'content-location' property added to the binary header in this Snap can be referenced in the File name property of a File Writer Snap with the expression: $['content-location']. Expression-enabled fields in Binary header properties are evaluated against the first input document only. | ||
Expression Default Value: N/A | String | Specify the value to be associated with a specific binary header property. | |
Target Path Default Value: N/A | String | Specify the target JSON path where the value in the expression is written. | |
Quote character
Default Value: “ | String | The character that you want to use as the escape character in the CSV document. For example, if you use double quotes (") as the escape character, then commas in the actual data will need to be escaped using double-quotes on both sides. This property can be an expression. However, if the value associated with the expression contains more than one character, only the first character is used as the quote character. | |
Quote mode
Default Value: ALL | Dropdown list | Select an option to specify how the quote character should be used in formatting the CSV data. Available options are:
If the Quote character property is empty, the selection of this property is ignored and the Snap uses NONE for the Quote mode. | |
Delimiter Default Value:
| String/Expression | Specify the string or the character to be used as a delimiter in formatting the delimited data. Any combination of characters may be used, adhering to the following guidelines. The input must be submitted with any control characters escaped. For example, When using a single backslash ( | |
Use header Default Value: Deselected | Checkbox | Select this checkbox to indicate whether the column names in the Header fields property should be used to format the CSV data. If this checkbox is deselected, the key set of the first document data is used as a CSV header. | |
Header fields
| Use this field set to define the header values you want to use in the CSV output data. | ||
Field names
| String | Specify the field name for the header. | |
Write CSV header Default Value: Selected | Checkbox | Select this checkbox to indicate whether the header strings listed in the Header fields properties should be written to the output CSV data.
| |
Header size error policy Default Value: Default | Dropdown list | Select an option to handle any header size errors.
The header size error condition occurs when any subsequent input document has additional column names which are not present in the header. To handle header size errors, you can select any of the following options:
| |
Ignore empty stream Default Value: Deselected | Checkbox | This checkbox determines whether the Snap must or not ignore empty streams received at the input view during pipeline execution. Select this checkbox to ignore empty input data and not produce any output stream. Deselect this checkbox to write an empty array to the output stream. | |
Character set Default Value: UFT-8 | Dropdown list | Select the character set in which the input CSV data is encoded. The available options are:
| |
Write BOM Default Value: Deselected | Checkbox | This checkbox determines the behavior of the Snap when it starts to write the CSV output data. Select this checkbox to write the BOM (Byte Order Mark) for the character set selected in the Character-set encoding property; else, the Snap skips writing BOM. | |
Newline Default Value: LF | Dropdown list | Select an option to specify the newline characters that you want to use as a line break. The available options are: LF, CR+LF and CR. | |
Escape character Default Value: \ | String/Expression | Specify the escape character that is to be used when formatting rows. Only single characters are supported. You can also use the expression enabler to enter a value, which is evaluated with the values from the pipeline parameters. Leave this field empty if no escape character is used in the input CSV data. | |
Snap Execution Default Value: Validate & Execute | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Examples
Specify Line Feeds for Windows while Formatting Documents
Text files created on Windows have different line endings than files created on Linux. Windows uses the carriage return and line feed ("\r\n") as a line ending, while Linux uses just a line feed ("\n").
In this example, we create a Pipeline that reads CSV data and then formats it for Windows-style line feeds using the CSV Formatter Snap.
Download this pipeline.
Create Filenames Using the CSV Formatter Snap
This example demonstrates how to use CSV Formatter Snap to (documents that contain purchase-related details and, depending on the value of the purchases) to route them into two documents, picking up their names using the output of the CSV Formatter Snap.
Download this pipeline.
Pass Execution Status Codes through Binary Header Properties of the CSV Formatter Snap
In this example, we shall send CSV data from ServiceNow into SnapLogic using a Triggered Task. We shall then see how you can use the CSV Formatter Snap in the triggered pipeline to manipulate the execution status (error) codes generated during pipeline execution.
Download this Pipeline.