The search configuration components return a search configuration object that describes what search options are available. The object contains the following properties:
| search_type |
The type of search, which is document or event. |
| searchComponent |
The reference to the component that will perform the search, typically "search_documents" or "search_events". |
| title |
A title for the search. |
| dimensions |
An array of dimension object. Each object has:
| dimension_reference |
A reference for the dimension that will be used during the search. |
| dimension_name |
Name to show for the dimension. |
| dimension_type |
Type of the dimension, can be:
| text |
Match on text |
| dateRange |
Find a date between two dates. |
|
| items |
For text dimensions, a list of items to present in a drop-down, as an alternative to looking up possible items from the data. Follows the same format as items in Form Script (library.parts.FormScript) - an array of objects with name and value. |
| single |
Indicates that this dimension can only be used once in a search.
|
|
| resultMappings |
A list of mappings to turn the raw results into a results table.
The follow the format described in the Mapper Script. There are some built-in mappings which will be applied just be applying their references:
| Reference |
Applies to |
Description |
| documentLink |
Document |
Links to the document details. |
| processType |
Document |
Shows the process type. |
| documentType |
Document |
Shows the document type. |
| documentReceived |
Document |
The date and time the document was received. |
| downloadDocument |
Document |
Link to download the document. |
| workerLink |
Event |
Links to the event worker. |
| eventTimestamp |
Event |
The event timestsamp. |
| eventUser |
Event |
The user associated with the event. |
| eventStatus |
Event |
The status associated with the event. |
| eventDescription |
Event |
The text of the event. This is shown in an expanding section, so that long descriptions do not disturb the display. |
| eventAttachments |
Events |
Links to download the event attachments. |
|
| filters |
A list of pre-set filters. Each may contain:
| dimension_reference |
The dimension for which this is a filter. |
| dimension_type |
The type of the dimension. |
| value, to, from |
Pre-set values - from for normal values, to and from for date ranges. |
| hidden |
Do not show the user the filter. |
| fixed |
Show the user the filter, but do not let them change it. |
|