¶ Documentation: CSV Views in Planning
¶ Overview
This documentation provides instructions for creating, managing, and utilizing CSV Views in Planning application. CSV Views allow you to create virtual tables based on CSV data for easier analysis and reporting, offering a flexible approach to working with structured data.
¶ Prerequisites
- Access to Planning application
- Appropriate permissions to create CSV Views
¶ Creating a CSV View
¶ Step 1: Access CSV View Creation
Navigate to the Csv View section in Planning for creating new views.
¶ Step 2: Click "Create New" Button
Click on the "Create New" button to begin the CSV View creation process.
¶ Step 3: Complete the CSV View Creation Form
The creation form contains the following elements:
- Name: Enter a descriptive name for your CSV View (this will be the saved name of the view)
- CSV Selection: Select the CSV file(s) you want to use for your view
- You can select a single CSV file for simple views
- Alternatively, you can select multiple CSV files to combine their data
- Each selected CSV will be available as a data source in the generated SQL query
- SQL Query: After selecting CSV file(s), the system will auto-generate an SQL query
- The query will reference your selected CSV file(s)
- You can use the auto-generated query as-is for simple views
- You can edit this auto-generated query to customize the view according to your requirements
¶ Step 4: Review and Save
Review your selections and the SQL query, then click the Create View button to create your CSV View.
¶ Managing CSV Views
¶ Editing CSV Views
- Navigate to the CSV Views section in Planning
- Locate the CSV View you wish to edit in the list
- Click on the edit icon in the action column
- In edit mode, you can:
- Modify the SQL query to adjust the data structure
- Update the metadata associated with the view
- Change the name or description of the view
¶ Updating Metadata
When in edit mode, you have the option to update the metadata:
- Locate the "Update Metadata" option in the edit interface
- Upload a new CSV file with updated structure or data
- The system will analyze the CSV and generate new metadata
- You can manually edit and validate this metadata before saving
- This feature allows you to update the view structure without recreating it
¶ Validating SQL Queries
Before saving changes to your CSV View:
- Use the validation feature to check your SQL query syntax
- The system will verify that your query can execute correctly
- Review any errors or warnings displayed
- Make necessary adjustments to your query
- Re-validate until the query passes validation checks
¶ Deleting CSV Views
- Navigate to the CSV Views section
- Find the CSV View you want to remove
- Click on the delete icon in the action column
- Confirm the deletion when prompted
- Note: Deleting a CSV View does not delete the underlying CSV files
- Any reports or forms using this view as a data source will be affected
¶ Using CSV Views in Reports and Forms
¶ Integrating CSV Views as Data Sources
- Navigate to the Report/Form Builder section
- Create a new report or form, or edit an existing one
- In the data source configuration section:
- Select "CSV View" as the data source type
- Choose the desired CSV View from the dropdown list
- The system will load the schema of your selected CSV View
- You can now:
- Select columns to include in your report/form
- Apply filters to limit data displayed
- Configure grouping and aggregation as needed
- Set up visualizations based on the CSV View data
¶ Important Notes
- The auto-generated SQL works with both single and multiple CSV files
- The system creates appropriate SQL syntax based on your file selection
- Simple views with a single CSV require minimal editing of the auto-generated query
- More complex views may require customizing the SQL to achieve desired results