Skip to main content
Version: v0.17.0

NuixSearchAndExclude

Alias:NuixSearchAndExclude

Output:Unit

Requires Nuix.Version 7.0

Requires Nuix.Features: ANALYSIS

Run a search query in Nuix and exclude all items found.

ParameterTypeRequiredPositionDefault ValueExampleSummary
SearchTerm
Search
string1*.txtThe Nuix search query. For more details on the supported syntax, please see the Nuix Workstation Search Guide.
ExclusionReason
Exclusion
string2The SearchTerm is used as the exclusion reasonThe exclusion reason
Tagstring3Items will not be taggedThe tag to assign to the excluded items
CasePath
Directory
stringUse the current open caseC:/Cases/MyCaseThe case path to use. If this is set, that case will be opened. If it is not set, the existing case will be used. If it is not set and no existing case is open this will result in an error.
SearchOptionsentityNo search options providedPass additional search options to nuix. For an unsorted search (default) the only available option is defaultFields. When using SortSearch=true the options are defaultFields, order, and limit. Please see the nuix API for Case.search and Case.searchUnsorted for more details.
SearchTypeSearchTypeItemsOnlyDefines the type of search that is done. By default only the items responsive to the search terms are tagged, but the result set can be augmented using this parameter.
SortSearchboolfalseBy default the search is not sorted by relevance which increases performance. Set this to true to sort the search by relevance and enabling additional SearchOptions.