Creating a data export and setting up delivery
How to create a data export, fill in the SFTP or email delivery details, test the connection and edit or delete an export.
How to create a data export, fill in the SFTP or email delivery details, test the connection and edit or delete an export.
This is for System Admins. Go to Settings, then the Compliance section, then Data Exports. For what Data Exports does overall, see "Data exports". In a group, pick the company in the selector at the top right first, because each export belongs to one company.
Create an export
- Select Create Export (shown when the list is empty) or Add Export below the list.
- Enter a Name, up to 255 characters. Save stays greyed out until you do. The name is also used in the file name.
- Choose the Delivery type: SFTP (the default) or Email.
- Choose the Format: CSV (the default) or Excel (.xlsx).
- Choose the Schedule: Not scheduled (the default), Daily or Weekly. "Scheduling, running and downloading a data export" explains what each does.
- Fill in the delivery details (see below).
- Tick the fields to include under Export fields. "Choosing the fields in a data export" explains the picker.
- Select Save. You see Saved successfully and the export appears in the list.
Delivery details
For SFTP, all five boxes are required:
- Host: the server name. Addresses on private or internal networks are refused with the message "Host is not allowed".
- Port: digits only, from 1 to 65535. It starts at 22.
- Username and Password. The password is hidden as you type; use the eye icon to show it.
- Remote directory: must start with a forward slash, for example /incoming/recruit. Anything else is rejected with "The remote directory must start with '/'."
A required box left empty shows "This field is required." A port that is not a number shows "Enter a number."
The Test connection button is greyed out on a new export (hover over it for "Save the export before testing the connection."). Save first, reopen the export with the pencil icon, then select Test connection. It tries to log in to the server and reports Connection succeeded or Connection failed, waiting up to 10 seconds. It tests the details as last saved, not what you have typed since opening the dialog, so save any change before testing. When you reopen an export, the saved password appears masked. Leave it as it is to keep the existing password, or type a new one to replace it.
For Email, enter the Email address that receives the file. You can list several addresses separated by commas or semicolons. The email carries the subject "Your requested data export" followed by the file name, with the file attached. If the file is too large to send as an attachment, the run fails with "This export is too large to send by email. Reduce the field selection or use SFTP delivery." Choosing fewer fields, or switching to SFTP, fixes it.
Edit or delete an export
Select the pencil icon to edit. You can change any setting, including the delivery type and the fields, then select Save. Changes apply from the next run.
Select the bin icon to delete. You are asked to confirm with "Delete '[name]'? This action can't be undone." Deleting removes the export, its schedule and its run history. Data export deleted. confirms it.