File Upload | Yext Hitchhikers Platform
Overview
With the File Upload Generic Source you can upload Excel, CSV, and JSON files within the Connectors framework. This new source allows users to take advantage of the data cleansing capabilities of the Connectors workflow for ingesting and updating data.
Although you can continue to use the Entity Upload tool to upload entities, Connectors offers additional functionality.
Supported File Types
- Excel (.xlsx)
- CSV (.csv, .tsv, .txt, .psv, or any delimited file)
- JSON
File Settings
Based on the type of your uploaded file, you’ll need to configure your file settings. The uploaded file type must match that of the chosen file type in the connector.
Excel
Extract Sheets: Specify the sheets you would like to extract from your workbook.
- If you want to extract the entire workbook, you can choose Entire Workbook.
- If you want to extract a specific sheet or set of sheets, click Specific Sheet(s) and enter the individual sheet or range of sheets.
- Note: the first sheet in your workbook is 0. To extract a range of sheets, you can use a comma to separate individually specified sheets, and a dash to represent an inclusive range. For example, and input of 0,2-5,7-9 will extract sheets 0,2,3,4,5,7,8,9.
Merge Sheets: Designate how to merge your workbook sheets, should you choose to extract multiple sheets.
- NOTE: If you are only extracting a single sheet, choosing to merge horizontally vs. vertically is irrelevant, but it still must be set. You may arbitrarily choose to leave the value as the default, and it will not have any impact on your upload.
- Horizontally
- Each new sheet’s columns will be appended to the right of the previous sheet. This works well when the same entities’ data is represented in each sheet, just with additional data added per entity (i.e. row 2 in Sheet1 represents the same entity as row 2 in Sheet2).
- Each new sheet’s columns will be appended to the right of the previous sheet. This works well when the same entities’ data is represented in each sheet, just with additional data added per entity (i.e. row 2 in Sheet1 represents the same entity as row 2 in Sheet2).
- Vertically
- Each new sheet’s columns will be appended below the previous sheet. This is intended for sheets containing the data for different sets of entities (i.e each row in each sheet is a new row in the table).
Has Header Row: Specify whether your Sheets have or do not have a header row.
- If the first row of data is your column headers (with cell values like Name, Address, Description, for example) then toggle on “Has Header Row”. This will help properly generate selectors in the next step and ensure that the header row is not considered an actual data point.
- If you do now have a header row, and the first row contains actual data, toggle off “Has Header Row”. This will ensure that the first row of data is included and help properly generate selectors in the next step.
CSV (Or Any Delimited File)
Specify Delimiter: Specify the character used to delimit your columns.
By default this will be set to Comma as it is highly likely that a comma will be your delimiter. Should your file use something different, you can specify that value by choosing “Custom” delimiter. Note that we automatically delimit rows by a new line.
The extension of your file can be .csv, or it can be the extension of any delimited file such as .tsv, .psv, or .txt.
Has Header Row: Specify whether your file has a header row.
- If the first row of data is your column headers (with values like Name, Address, Description, for example) then toggle on “Has Header Row”. This will help properly generate selectors in the next step and ensure that the header row is not considered an actual data point.
- If you do now have a header row, and the first row contains actual data, toggle off “Has Header Row”. This will ensure that the first row of data is included and help properly generate selectors in the next step.
JSON
If uploading a JSON file, you’ll be prompted to continue and select whether your file contains data for a single entity or multiple entity.
When you look at the file you will be able to see this. If the file contains a list of entities, you will need to add the JMESPath Syntax for that entity container so we can identify and select the nested data for each.
Notes on Handling Files
- Invisible sheets are skipped
- Formulas are not executed by the connector. If the cell value is ‘=A1+B2’, the value in the connector will be the string ‘=A1+B2’, and not the computed value.