Skip to main content
Version: v0.17.0

NuixAddToItemSet

Alias:NuixAddToItemSet, NuixCreateItemSet

Output:Unit

Requires Nuix.Version 5.0

Requires Nuix.Features: ANALYSIS

Run a search query in Nuix and add all items found to an item set. Will create a new item set if one doesn't already exist.

ParameterTypeRequiredPositionDefault ValueExampleSummary
SearchTerm
Search
string1*.txtThe Nuix search query. For more details on the supported syntax, please see the Nuix Workstation Search Guide.
ItemSetName
Set
string2The item set to add results to. Will be created if it doesn't already exist.
ItemSetDeduplication
DeduplicateUsing
ItemSetDeduplication3MD5The means of deduplicating items by key and prioritizing originals in a tie-break. This parameter only has an effect if Item Set does not exist and is created by this step.
ItemSetDescription
Description
string4No descriptionThe description of the item set. This parameter only has an effect if Item Set does not exist and is created by this step.
DeduplicateByDeduplicateBy5IndividualWhether to deduplicate as a family or individual. This parameter only has an effect if Item Set does not exist and is created by this step.
CustodianRankingarray<string>6Do not rank custodiansA list of custodian names ordered from highest ranked to lowest ranked. If this parameter is present and the deduplication parameter has not been specified, MD5 Ranked Custodian is assumed. This parameter only has an effect if Item Set does not exist and is created by this step.
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.
ItemSortOrder
SortItemsBy
ItemSortOrderUnsorted or by relevance. See SortSearch.Sort items before adding them to the production set.
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.