CsvJsonExportEditor

Overview

The CsvJsonExportEditor is a WorkflowNode component within the Vantage analytics and data platform designed to facilitate the export of data in various formats, specifically CSV, JSON, or Excel (TSV). It provides users with an interactive interface to configure the export process, including defining the file format, filename, delimiter, and whether to include headers. This component ultimately acts as a terminator in a workflow, generating a downloadable file containing the processed data.

Purpose

The component is primarily intended for users who need to export data for reporting, data sharing, or further processing. Whether it's exporting large datasets or generating a report for management, the CsvJsonExportEditor allows for easy and customizable data exports suited to specific business needs.

Settings

1. Export Format

• Name: format
• Input Type: Dropdown
• Description: This setting allows the user to select the format of the exported file. The options include:
  • CSV: Comma-Separated Values (default)
  • JSON: JavaScript Object Notation
  • Excel (TSV): Excel-compatible Tab-Separated Values
• Default Value: csv
• Effect of Change: Changing the format determines the structure of the final file. For example, selecting JSON will change the output from a table-like structure to a key-value format.

2. Filename

• Name: filename
• Input Type: Text
• Description: Users can specify a name for the exported file. If left blank, the system will auto-generate a filename based on the current timestamp.
• Default Value: '' (empty string)
• Effect of Change: Inputting a custom name will override the auto-generated name. This can help in organizing exports by meaningful identifiers, whereas leaving it blank leads to timestamps being used.

3. Delimiter

• Name: delimiter
• Input Type: Dropdown
• Description: Available only when the CSV format is selected. It allows users to choose the character that separates the values in the outputted CSV file:
  • Comma (,)
  • Semicolon (;)
  • Tab
• Default Value: ',' (comma)
• Effect of Change: The delimiter chosen directly affects how the data is represented within the CSV file. For example, using a tab will create tab-separated values instead of comma-separated ones, impacting compatibility with other tools.

4. Include Headers

• Name: includeHeaders
• Input Type: Boolean
• Description: This checkbox determines whether the first row of the exported file includes column headers.
• Default Value: true (checked)
• Effect of Change: Unchecking this option will result in the first row of the output file being devoid of headers. This can be essential for specific use cases where header information is unnecessary or undesirable.

How It Works

The CsvJsonExportEditor functions as a form that collects user input regarding data export preferences. Upon interaction:

• Users select the desired file format, which adjusts available options and the overall functionality of the component.
• The filename can either be custom or autogenerated based on user needs.
• CSV-specific options like delimiter and header inclusion become relevant if CSV is the selected format.
• The exported file is generated when the workflow terminates, producing a downloadable file based on the configured settings.

Data Expectations

The CsvJsonExportEditor expects data configurations from the selected node to pass necessary parameters:

• At minimum, a valid configuration object that provides the default settings.
• Depending on the selections made by the user, the component will prepare the data for the output format specified.

AI Integrations

Currently, the CsvJsonExportEditor does not specifically integrate with AI functionalities within the Vantage platform. Its focus is on facilitating clean, manual data exports with user-defined parameters for reports or data analysis needs.

Billing Impact

The CsvJsonExportEditor operates as a part of the data handling capabilities of the Vantage platform. While it does not have direct costs associated with its use per se, the exporting functions can lead to data usage that may influence billing depending on the number of exports and the volume of data processed.

Use Cases & Examples

Use Case 1: Generating Weekly Sales Reports

A retail business can use the CsvJsonExportEditor to automate the data export of weekly sales. By configuring the file format to CSV, they can specify the filename to "Weekly_Sales_Report", include headers, and utilize commas as delimiters.

Use Case 2: Sharing Customer Data with Partners

An organization might need to send customer information to a partner for joint marketing efforts. The CsvJsonExportEditor can be set to export the needed data in JSON format for easy integration with the partner's systems.

Use Case 3: Preparing Data for Business Intelligence Tools

An analyst may require tab-separated values (TSV) for importing into a BI tool. By selecting the TSV format and a custom filename like "Q1_Data_Analysis", they can prepare data in an efficient format.

Detailed Example Configuration

{
    "format": "csv",
    "filename": "Weekly_Sales_Report",
    "delimiter": ",",
    "includeHeaders": true
}

In this example, the user configures the CsvJsonExportEditor to create a CSV file named "Weekly_Sales_Report" that includes headers and uses a comma as the delimiter. The output will provide a clear and organized export that can be easily shared with stakeholders.