(v22) Manage File Uploads in Composer

Manage File Uploads in Composer

Composer can visualize data from file uploads including CSV, JSON, and TSV files.

• The maximum supported file size is 500 MB
• Data from the file upload is stored in a PostgreSQL database

Before you can establish a connection from Composer to your file uploads storage, a connector server needs to be installed and configured. See Manage Connectors and Connector Servers for general instructions.

After the connector has been set up, create a data source configuration and upload your file or files to that source. See:

• Define a Data Source Configuration
• Upload a New File
• Edit an Existing File
• API Endpoints

Upload a New File

1. Log in as a user with the Administer Sources or Create New Data Sources privilege.

2. Create or edit an existing data source.

3. Select Add to add a new data entity, then select From File.

   

4. Add a unique Data Entity Name, then select Upload New File. The File Upload work area opens.

   

5. Enter File Details, such as a unique Display Name, and optional Description.

6. Use the Browse button to select a file to upload.

7. After you have selected a file, Composer may autofill the Single Quote Char. and Field Delimiter fields. Adjust if needed.

8. If needed, change the No. of records to display from 10 to up to 1,000 records.

9. Enable or disable the checkbox Column Headers in first row to match your file layout. If no column headers are in your data, Composer assigns numerical column headings, field_1, field_2, and so on.

10. Optionally, select Preview to preview your data.

11. Enable or disable the checkbox Use Only File Structure to create the file using only the existing file structure, no data.

12. Select Save to close the File Upload work area and continue creating or updating your data entity for this source.

Edit an Existing File

1. Log in as a user with the Administer Sources or Create New Data Sources privilege.

2. Edit an existing data source.

   

3. Select the data entity with the file you want to edit, then select Edit File. The File Upload work area opens.

4. Browse for a new file.

   • If you are replacing the existing file, your new file must use the same data file structure as the existing file. Enable the Replace checkbox in Upload Settings: previous data is replaced.

   • If you are adding data to the existing file, your new file must use the same data file structure as the existing file. Disable the Replace checkbox in Upload Settings: previous data is appended with new rows of data.

   

5. Select Preview to preview your data.

   • The Current Data tab shows the data of your existing file.

   • The New Data shows the replaced or amended data preview.

6. Select Save to Save your changes or Cancel to discard your changes. The File Upload work area closes.

API Endpoints

1. Log in as a user with the Administer Sources or Create New Data Sources privilege.

2. Edit an existing data source.

   

3. Select the data entity with the file you want to edit, then select API Endpoints. The API Endpoints dialog box opens.

   The dialog offers convenient example cURL requests but the APIs can be leveraged from your preferred development platform.

4. Copy and modify the example cURL requests to include your own Composer credentials, replacing the placeholders for username and password. Select Close to close the dialog.

   

Work with the Upload API

There are two operations that can be performed using the Upload API: appending additional data and clearing previously uploaded data. The source creation page offers convenient example cURL requests but the APIs can be leveraged from your preferred development platform. Select API Endpoints on the source creation tab to edit your data.

Modify the example cURL requests to include your own Composer credentials, replacing the placeholders for username and password.

curl -v --user <username>:<password> <YourServer>

Example: Append Data

In the following example, the Upload API accepts an array of JSON objects. Note that the object field types must match those used to create the Upload API source originally. For example, if the value of the price field is a number, you can not upload new rows in which the value of the price field is a string.

curl -v --user <username>:<password> 'https://<Your_Composer_Server>/ composer/api/upload/<YourDataSourceId>' -X POST -H "Content-Type: application/vnd.composer.v3+json" -d '[{"price":100.5,"venue_id":"V678","venue_name": "Pizza Barn"}]' --insecure

Example: Clear Previously Uploaded Data

In the example below, the Upload API will clear all previously uploaded data from the data source with the ID of <YourDataSourceId>.

curl -v --user <username>:<password> 'https://<Your_Composer_Server>/ api/upload/<YourDataSourceId>' -X DELETE --insecure

Composer Feature Support

File Upload support for specific Composer features is shown in the following table.

Key: Y - Supported; N - Not Supported; N/A - not applicable

Feature	Supported?
Admin-Defined Functions	Y
Box Plots	Y
Custom SQL Queries	Y
Derived Fields (Row-Level Expressions)	Y
Distinct Counts	Y
Fast Distinct Values	N/A
Group By Multiple Fields	Y
Group By Time	Y
Group By UNIX Time	Y
Histogram Floating Point Values	Y
Histograms	Y
Kerberos Authentication	N
Last Value	Y
Live Mode and Playback	Y
Multivalued Fields	N/A
Nested Fields	N/A
Partitions	N
Pushdown Joins for Fusion Data Sources	Y
Schemas	Y
Text Search	N/A
TLS	Y
User Delegation	N
Wildcard Filters	Y
Wildcard Filters, Case-Insensitive Mode	Y
Wildcard Filters, Case-Sensitive Mode	Y