The "ReferenceList" tool
The "ReferenceList" tool creates a list of document references for export, deletion, and other actions.
Notice
If you do not use the Query parameter and the combination of the MetaKey, MetaOp and MetaValue1 parameters, the tool will create a reference list with all documents in an archive.
Parameters | Description |
|---|---|
File | Reference list from the file storage (output file) |
Query | Full-text query (optional) If this parameter is set, a full-text query will be used. The metadata parameters(MetaKeyMetaOp and MetaValue1) will not be executed. |
MetaKey | Metadata key (optional) You can select a value from the selection list. |
MetaOp | Permitted search operators in the metadata (optional) You can select a value from the selection list. |
MetaValue1 | Value to which the metadata field must correspond (optional) Alternatively, if the MetaValue2 parameter is set, MetaValue1 will indicate the start of a search range. |
MetaValue2 | End of a search range (optional) The MetaValue1 parameter marks the start of a search range. |
DocsPerFolder | Number of documents per export folder |
CSVHitlist | Creation of a hit list in CSV format (optional) If this parameter is activated, a CSV file will be generated instead of a reference list. The specified hit list is used for the columns. This parameter can only be used in conjunction with the Query parameter. |
Locale | Locale for formatting dates and numbers in a CSV file (optional) Example: |
LegalHoldMarker | Legal hold marker If this parameter is set, only documents that have the LegalHoldMarker will be selected. The selection will only be made in combination with other parameters. Enter the value * to select all documents that have been provided with a LegalHoldMarker. NoticeIn conjunction with a full-text search (parameter Query), the selection process can lead to a significant increase in the runtime of the tool. |