This article explains how to set up automatic delivery on a saved entity export via email or FTP/SFTP file transfer.
For more information about exporting entities from the Knowledge Graph, see Export Entities. To edit an existing saved export, see Edit a Saved Entity Export Configuration.
Edit your entity export configuration
-
Navigate to Knowledge Graph > Configuration. Scroll to the Entity Management section and click the Saved Entity Exports tile.
-
Click the Edit button on the entity export configuration you want to automate.
-
To create a new entity export configuration, click the Add Custom Export button in the upper right. See Export Entities for full steps.
-
To create a new entity export configuration, click the Add Custom Export button in the upper right. See Export Entities for full steps.
- On the Manage Saved Entity Export screen, click Edit on the Automated Delivery section.
- In the Type dropdown, choose how you want your entity export to be delivered: Email, or file transfer via FTP or SFTP.
Follow the steps below depending on your chosen delivery type.
Set up delivery via email
- In the Email Address field, enter the address(es) of your chosen recipients, separated by commas.
- Click Send to me to include your own email address (this will populate the email address under which you are currently logged into Yext).
- In the Subject Line field, you can enter a subject line for the automatic delivery email.
- Set the Frequency options depending on how often you want the export to be sent to your recipients:
- Choose from Hourly, Daily, Weekly, Biweekly, or Monthly.
- Select a start date, time, and time zone for the first delivery. Note that relative time zones are not an option, and all your recipients will receive the export at the same time, regardless of their location or time zone.
-
Ignore Empty File: choose how the export delivery should respond if there is no available data matching your export filters for your chosen time interval (for example, if you chose Weekly delivery, and this week's export does not contain any entities based on the filters in your saved export configuration).
-
- Yes: empty files are ignored, and the export delivery is skipped for that time interval
- No: empty files are not ignored, and the export delivery will be sent on schedule, containing a blank file.
-
- Click Save.
When your recipients receive the automated email, it will contain a link to download the file containing the export data, as in the example below. Download links are valid for seven days after they are sent.
After setting your email delivery preferences, you can send a test version of your export email. To do this, click the Send Test button on the Automated Delivery section of your saved entity export settings.
Set up delivery via FTP/SFTP
Reach out to your systems administrator or IT team in order to enter the correct host, username, password, and folder path for your organization.
- Host: enter the FTP or SFTP host address for your server. Do not include the protocol ("ftp://" or "sftp://").
- Port: the default port is 21 for FTP, and 22 for SFTP.
- Enter the username and password.
- Enter the folder path where you would like the file transfer to be delivered.
- Click the Delivery Option dropdown to choose how you would like your file transfer to be handled:
- Rename File Upon Transfer Completion: The file will be sent as a ".tmp" temporary file. Once the transfer is complete, the file will be automatically renamed to remove the temporary file extension.
- Send 'Done' File Upon Transfer Completion: Once the transfer is complete, Yext sends a file with a ".done" extension (e.g., "filename.csv.done").
- Transfer the File: Yext transfers the file with no extra indication that the transfer has been completed. Choosing this option may result in issues if a user attempts to open or read the file before the transfer is complete.
- Set the Frequency options depending on how often you want the export to be sent to your recipients:
- Choose from Hourly, Daily, Weekly, Biweekly, or Monthly.
- Select a start date, time, and time zone for the first delivery. Note that relative time zones are not an option, and all your recipients will receive the export at the same time, regardless of their location or time zone.
-
Ignore Empty File: choose how the export delivery should respond if there is no available data matching your export filters for your chosen time interval (for example, if you chose Weekly delivery, and this week's export does not contain any entities based on the filters in your saved export configuration).
- Yes: empty files are ignored, and the export delivery is skipped for that time interval
- No: empty files are not ignored, and the export delivery will be sent on schedule, containing a blank file.
- Click Save.
The files containing your entity export data will be named as follows: (Export Configuration Name)-(Date YYYY-MM-DD)-(Timestamp in milliseconds)
For example, the file name for a saved export called "Restaurant Review Generation URLs", exported to a CSV format on April 7th, 2025 at 10:52am (Eastern - New York time) would look like: "restaurant-review-generation-urls-20250407-1744037536284.csv".
View delivery history for saved exports
After setting up automated delivery, you can view the delivery history for a record of all deliveries of your saved exports, and the status of each delivery.
From the Saved Entity Exports screen, click View Delivery History in the upper right.
Here, you'll see a table of all automated entity export deliveries, including the Type (Email, FTP, or SFTP), the Status, and the Export Date.
Click the All Saved Exports dropdown to filter to deliveries for a specific saved export.
Comments
0 comments
Article is closed for comments.