Adding Exporting to a Display

About this task

To enable document exporting, you will need to add the Document Exporting display component.

Procedure

  1. Open the display associated with your project, and select the Components tab. Click Add Display Component. From the list, select Document Exporting and click Add.
  2. To change which formats are available to your end-users and manage other document export options, open your display's Settings tab and select the Results > Actions subsection. Click edit in the upper right to edit the configuration.
  3. To change the export formats that are available to the end user, scroll down to the Export Formats setting, switch the setting to be Modified and then use the checkboxes to enable or disable the export formats that you would like to offer to your end-users. By default, Email, HTML, Text, and XML are enabled.

Results

Note: Allowing your users to Email results is enabled or disabled in this menu, see the Adding Exporting via Email to a Display for more information.

The Enable Document Export All setting lets you configure what happens if the user clicks the select all results button and tries to export everything. If this setting is enabled, exporting all documents will create a.zip archive file containing all the results from any queried search collections. If this setting is disabled, exporting all documents will export the number of documents specified in your projects by the variable "Number of results requested (total)"

Note: If any of the sources have a parser that changes the document XML being returned, this parser will not be used when all documents are exported.
Attention: The Export All feature is not applicable to search results from federated sources.

If you would like to change any of the text on the end-user display pertaining to exporting, other settings in this subsection allow you to do that. Take a look at the end-user display (in particular the Actions menu) to find out where these labels appear.

Using Exporting - To export search results, select the checkbox by the result(s) that you want to export, and from the Actions menu, choose the export format: HTML, Text, XML, etc. From the File menu in your browser, choose Save as or Save page as to save the file to your computer.

The following sections will explain the out-of-the-box Export Formats, Adding Exporting via Email to a Display, and Adding Native Document Export to a Display (if you have the Discovery module installed).