With the Mindbreeze InSpire export interface, search results can be exported as a file. 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.
To use the export functionality, the Resource Persistence Settings must first be configured. See also Configuration - Alerts - Resource Persistence Settings.
The configuration includes:
Enabling/disabling the export functionality
Setting the properties and the maximum batch size
The export can be configured in the menu item “Configuration” in the Mindbreeze InSpire Management Center. There, go to the tab “Client Services”, expand the Client Service that you want to use and go to the section “Export Search Settings“.
Description | |
Export Search Results Enabled | Enables the export feature in the search page. |
Export Servlet Enabled | Enables the Export API endpoint. |
Default Exported Properties | The properties that are selected for exports per default. If this setting is left empty, the default properties that will be used, are:
|
Maximum Export Batch Size | By default, 250 results are retrieved and processed by the query service. Attention: It is not recommend to set a higher value as this could lead to resource exhaustion. |
Maximum Exports per Session in parallel | This setting determines how many parallel exports a user can perform simultaneously in a window. By default, 3 parallel exports are allowed per session. Attention: It is not recommend to set a higher value as this could lead to resource exhaustion. |
Default Export Format | Defines the format that will be used for exports. |
Export Sample Texting Enabled | Enables the possibility to partially export the contents of documents. |
Use Excel Native Data Types | Numbers and Dates are exported as the according Excel datatype. |
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.
This setting allows you to disable the export, but to display the table preview.
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.
With this setting, it is possible to change the batch size.
Attention: It is not recommended to set a higher value as this could lead to resource exhaustion. The default setting is already configured for typical use cases.
This setting determines how many parallel exports a user can perform simultaneously in one session.
Attention: It is not recommended to set a higher value as this could lead to resource exhaustion.
The following export formats are supported:
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. For more information, see Configuration - Collected Results - Resource persistence settings.
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.
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.
Setting | Description |
Remove Job after download | Export jobs are stored in Persisted Resources. If it is necessary to save the job for later analysis, the setting "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. Attention: It is not recommended to set a higher value as this could lead to resource exhaustion. |
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. |