Uploading CSVs with data input tables

​

Requirements

• A configured Omni connection that supports upload tables
• Restricted Querier, Querier, or Connection Admin permissions
• To enable the Upload data ability. This setting must be enabled for the organization and, if a document is shared with others, also in the document’s settings.

​

Limitations

• Must be added in a workbook
• Are limited to 500,000 rows
• Can’t be used in joins unless the table is pushed to a database. Setting the connection’s Schema for table upload property enables this functionality. Refer to the setup guide for your database for more information.

​

Creating a data input table

• Omni UI
• API

Data input tables can be added in the workbook of any document.In a workbook, navigate to Edit > New blank table. A new tab with a blank data input table will display.To get data into the table, you can manually enter it or upload a CSV or XLSX:

Manually enter data

1. In the first row, add the names of the columns. The first row must be a header row to allow Omni to generate a schema for the table.
2. Enter data into the cells. To add line breaks, use Ctrl + Enter.
3. To add rows or columns, use the Add Row and Add Column options.
4. When you’re finished editing the table, click Save CSV near the top right corner of the page.
5. Enter a name for the table and click Save.

Use the Columns section in the properties panel to change a column’s data type. Changing a column’s type re-reads the file using the updated schema. If a value doesn’t match the new type, Omni highlights the row where it occurs.

Upload a CSV or XLSX file

To upload a CSV or XLSX:

• The first row must be a header row
• The file can’t exceed 500,000 rows

Additionally, if the XLSX file contains multiple tabs, only the first sheet will be uploaded.

1. Click the Upload CSV option near the top right corner of the page.
2. Browse for or drag the file you want to upload into the upload dialog.
3. Review each column’s detected type and format, and change them if needed. If you select Date or Timestamp, you’ll also need to select a Format. Note: Changing a column’s type re-reads the file using the updated schema. If a value doesn’t match the new type, Omni highlights the row where it occurs.
4. If you have Querier permissions or higher, you’ll see a Create topic checkbox. Checking this box will create a topic from the uploaded file. If you’re a Restricted Querier, a topic will automatically be created from the file.
5. Click Upload to upload the file.

Once there’s data in the table, click Query CSV to create a query using the data. The table will also become available in the field picker in other queries.

Use the Upload a CSV file endpoint to upload a CSV and create a new data input table as a view in the shared model:

curl --request POST \
   --url https://{your-omni-org}.omniapp.co/api/v1/uploads \
   --header 'Authorization: Bearer {token}' \
   --header 'Content-Type: multipart/form-data' \
   --form 'file=@example-file;type=text/csv' \
   --form modelId=880e8400-e29b-41d4-a716-446655440003 \
   --form branchId=990e8400-e29b-41d4-a716-446655440004 \
   --form branchName=my-branch \
   --form viewName=custom_view_name

​

Querying and joining data input tables

​

Modeling and promoting data input tables

• A view representing the data input table will be created. These views can be identified by the presence of an uploaded_table_name parameter:
  products.view

  # Reference this view as products
  uploaded_table_name: products.csv::1a3497f5-cba8-47c0-bab9-b2df84d1b141
  
• A topic based on the view representing the data input table will be created if:
  • Create topic was selected while uploading a CSV or XLSX, or
  • A Restricted Querier performed the upload

View "<view_name>" references an uploaded table. Uploaded tables cannot be used in joins.

​

Updating data input table data

• Changes must be promoted to the shared model to be accessible outside the workbook. This is necessary even if the table was previously promoted to the shared model.
• If table uploads (writebacks) are enabled for the connection, Omni will create a new table in the database each time the table is saved. You can manage previous versions of the table in the Upload management page.
• The Fields drawer lets you pick each column’s type. A type change applies when you click Save changes: Omni converts the column’s stored data to the new type, rather than just relabeling it. Timestamp with time zone is only offered as an option for a column that’s already stored as that type. For files above the editor’s preview row limit, column types in the Fields drawer are read-only.

1. In a workbook, locate the table in a query tab.
2. Click the options menu next to the table’s name, then Edit Table:
3. The data input table will open in a new tab where you can edit the data as needed.
4. To change a column’s data type, use the Columns section in the properties panel.
5. Click Save changes when finished.

​

Managing previous table versions

​

Querying previous table versions

​

Deleting table versions

1. Navigate to Settings > Uploads.
2. Locate the version you want to remove and click Delete.

• Remove views and topics built on the version from the model
• Update or remove queries using the version