Exporting Results

Mindbreeze InSpire

Introduction

With the Mindbreeze InSpire export interface, search results can be exported as a CSV document. In the user interface, the information that is relevant for the application can be exploratively defined, and then all the information can be exported. Like in other application cases, the permissions and authorizations will be respected and the user will only have the information exported that he is actually allowed to read.

Configuration

The configuration includes:

Enabling/disabling the export functionality

Setting the properties and the maximum batch size

The export can be configured under “Client Services > Export Search Settings“.

The following configuration options can be found there:

• Export Search Results Enabled
• Export Servlet Enabled
• Default Exported Properties
• Maximum Export Batch Size
• Maximum Exports per Session in parallel
• Default Export Format
• Export Sample Texting Enabled
• Use Excel Native Data Types

Advanced Configuration

Remove Job after download: Export jobs are stored in Persisted Resources. If it is necessary to save the job for later analysis, "Remove Job after download" must be deactivated.

Maximum asynchronous Exports in Parallel: asynchronous exports such as the Excel export run in the background. You can limit the number of parallel exports to prevent the query service from being overloaded.

Download of asynchronous Export expires after: If an asynchronous export such as the Excel export is created by the user, it must be downloaded within this time before it is discarded.

Export search results enabled.

Enable this setting to be able to display your search results in a table preview. If enabled, an “export“ button appears next to the number of matches. If this functionality should not be provided, it can also be disabled with this setting.

Export servlet enabled

This setting allows you to disable the export, but to display the table preview.

Default exported properties

In this text box you can predefine your properties (comma separated). For example: title,mes:size,extension would display and export the name, the size (for example, 50 kB) and the respective file format (e.g. pdf) of the current search in the table preview.

Maximum export batch size

With this setting, it is possible to change the batch size. This setting should be used only when it is actually needed. The default setting is already configured for typical application cases.

Maximum Exports per Session in parallel

This setting determines how many parallel exports a user can perform simultaneously in a window.

Default Exported Format

This option selects the format used when pressing the export button.

The following export formats are supported:

• CSV: comma-separeted-values
• XLSX: Microsoft Excel
• JSON: machine readable format
• ZIP: Archive containing a file for each result.

If you want to use a format other than the standard CSV format (XLSX, JSON or ZIP), you must first configure the “Resource Persistence Settings”.

Export Sample Texting Enabled

In addition to primitive metadata, it is also possible to partially export the content of documents. The "Metadata" content must be added. By default, not the entire content of the document is exported, but only a part at the beginning of the document. If you want to export the content in the area of the search hit (the sample text), you can activate the option "Export Sample Texting Enabled". The behavior is similar to the normal search. Note: activating this option can affect the export performance.

Use Excel Native Data Types

If the export format "Microsoft Excel" is used, the values of metadata are saved as text by default. This has the disadvantage that you are not able to calculate with numbers and dates directly. With the option "Use Excel Native Data Types" such numbers and dates are saved directly in numeric or date format. Therefore, it is not only possible to calculate directly with such values, but Excel also displays the values in the appropriate format depending on the set language and region.

Note: Due to limitations of the export format, this feature only works with metadata containing a single number or date. Metadata with multiple numbers or dates (lists) or other, more complex metadata cannot be transferred and will be saved as text, as before.