Files Outbound Connector

About the Files Outbound Connector

You can use the files outbound connector to export enriched data from XM Discover to your organization’s SFTP server.

You can export data at the sentence and document levels, limit it to new and updated records, and choose which fields, enrichments, and classifications to export. Exported data is available in both CSV and JSON formats.

Setting Up a Files Outbound Job

1. On the Jobs page, click New Job.
   
2. Select Files Outbound.
   
3. Give your job a name so you can identify it.
   
4. Choose the project to load data into.
5. Give your job a description so you know its purpose.
6. Click Next.
7. Choose an SFTP account to use, or select Add New to add a new one.
   
8. If adding a new account, enter the following information for your SFTP account:
   • Connection Name: Give the connection a name so you can recognize it later.
   • SFTP Username: Enter the username to connect to your SFTP server.
   • SFTP Password: Enter the password to connect to your SFTP server.
   • SFTP Host: Enter your SFTP server host URL.
   • SFTP Port: Enter your SFTP Port. Usually this is 22.
   • Send Expiration Notifications: If you’d like your SFTP credentials to expire after a certain amount of time, select this option.
   • Days Prior Expiration: If enabling expiration notifications, enter how many days you’d like to be notified before the expiration. You may enter a value between 1 to 100 days.
   • Expiration Date: Set the date when the credentials will expire. Click on the box to open a calendar to pick the date.
9. Click Next.
10. Provide your XM Discover Export API endpoint.
    
11. Click Next.
12. Choose the level of data you’d like to export:
    
    • Sentences: Use sentence-level data.
    • Documents: Use document-level data.
      Qtip: The remaining steps on the Query Configuration page are optional and will help you narrow down the data that is exported.
13. Provide a search query to filter the outbound data by. Use the same syntax used to look up data in Designer. Leave this field empty to include all data.
    Example: You can specify one or more survey IDs to only update the selected survey records using the following syntax:surveyid:sv_01
14. Enter the name of the filter from your project that you’d like to be applied to the outbound data. Leave this field blank if you do not want to filter your data.
15. Choose which records you’d like to import:
    • Load new records: Records that were created since the last time the outbound job ran.
    • Load new and updated records: Records that were either created or updated since the last time the outbound job ran.
    • Load updated records: Records that were updated since the last time the outbound job ran.
16. Use the dropdown menu to choose which classification models you want included in your data. Select the All Models checkbox to include the classification data for all models available in the project.
17. Choose how you want classifications to impact data filtering:
    • Ignore: No filtering is applied based on the selected model(s).
    • Currently Classified: Returns the records that were classified by the selected model(s) during the most recent classification run.
    • Ever Classified: Returns the records that have been classified by the selected model(s) at any point in time.
18. Choose the additional export options you’d like to use:
    • Whether to return category IDs (true) instead of category names (false): Export category IDs instead of category names.
    • Filters results by applying filter query with all leaf nodes paths: Adds multiple models with the “leaf_only flag” parameter to the Export API call.
19. Click Next.
20. Choose the type of file you’d like to export:
    
    • Delimiter-separated “flat”: Format is a delimited text file, such as CSV or TSV.
    • JSON Files: Format is a JSON file.
21. If exporting to a delimiter-separated flat file, choose your file settings:
    • File encoding: Choose the file’s encoding, such as UTF-8 or ASCII
    • Delimiter character: The character used to separate entries, such as a comma or tab.
    • Enclosure character: The character used to enclose data. Leave this field empty if you do not want an enclosure.
    • No Enclosure: If you do not want your data enclosed in an extra character, enable this option.
22. Click Browse and choose your SFTP folder.
    
    Qtip: When choosing a folder path, you can click on a folder icon to expand that folder. Click on the folder name to select that folder, and then click Ok when done.
23. If you’d like exported files to have a prefix attached to them, enable Provide a file name for prefix and enter the desired prefix in the box.
    Qtip: The prefix cannot contain [ ] \ / and cannot exceed 100 characters.
24. If you’d like exported files to have a postfix attached to them, enable Provide a file name for postfix and enter the desired postfix in the box.
    Qtip: The postfix cannot contain [ ] \ / and cannot exceed 100 characters.
25. If you’d like to encrypt your data, enable Encrypt files delivered by XM Discover and enter your PGP/GPG key in the box.
    Qtip: Files will always be encrypted into a GPG file. You can enter a PGP/GPG key, but it will never encrypt into a PGP file.
26. Click Next.
27. Map fields from XM Discover to Qualtrics. Click the empty box and choose the XM Discover attribute you’d like to send to Qualtrics.
    
28. Select the data type the field should be exported as:
    • Do Not Map: No specified variable type.
    • Number Attribute: Number variable type.
    • Text Attribute: Text set variable type.
    • Date Attribute: Date variable type.
    • Verbatim: Text variable type.
29. Enter the Attribute Name for this field. This will be the field’s name when it is exported.
30. Use the plus ( + ) and minus ( – ) signs to add and remove fields as needed.
31. Click Next.
32. If desired, you can add a connector filter to filter the incoming data to limit what data is imported.
    
33. You can also limit the number of records imported in a single job by entering a number in the Specify Record Limit box. Enter “All” if you would like to import all records.
    Qtip: For conversational data, the limit is applied based on conversations rather than rows.
34. Click Next.
35. Choose when you’d like to be notified. See Job Notifications for more information.
    
36. Click Next.
37. Choose when your job runs. You can do either a one-time pull or set up a recurring data pull. See Job Scheduling for more information.
    
38. Click Next.
39. Review your setup. If you need to change a specific setting, click the Edit button to be brought to that step in the connector setup.
    
40. Click Finish to save the job.