Skip to main content
Version: v0.17.0

NuixAddToProductionSet

Alias:NuixAddToProductionSet, NuixCreateProductionSet

Output:Unit

Requires Nuix.Version 7.2

Requires Nuix.Features: PRODUCTION_SET

Run a search query in Nuix and add all items found to a production set. Will create a new production set if one with the given name does not already exist.

ParameterTypeRequiredPositionDefault ValueExampleRequirementsSummary
SearchTerm
Search
string1*.txtThe Nuix search query. For more details on the supported syntax, please see the Nuix Workstation Search Guide.
ProductionSetName
ProductionSet
string2The production set to add results to. Will be created if it doesn't already exist.
ProductionSetDescription
Description
string3No descriptionDescription of the production set.
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.
ImagingOptionsentityNone(imageExcelSpreadsheets: true slipSheetContainers: true tiffFormat: 'GREYSCALE_LZW')Sets the imaging options for a production set. This option only works if the ProductionSet is created by this Step. Cannot be used at the same time as using a profile. See Nuix API ImagingConfigurable.setImagingOptions() for more details on the available options.
ItemSortOrder
SortItemsBy
ItemSortOrderUnsorted or by relevance. See SortSearch.Sort items before adding them to the production set.
NumberingOptionsentityDocument ID numbering, starting with DOC-000000001(createProductionSet: false prefix: 'ABC' documentId: (startAt: 1 minWidth: 4))Set the numbering options for the production set. This option only works if the ProductionSet is created by this Step. See Nuix API NumberingConfigurable.setNumberingOptions() for more details on the available options.
ProductionProfileName
Profile
stringNo profile setMyProcessingProfileVersion 7.2The name of the Production profile to use. Cannot be used at the same time as ProductionProfilePath. This option only works if the ProductionSet is created by this Step.
ProductionProfilePath
ProfilePath
stringNo profile setC:/Profiles/MyProcessingProfile.xmlVersion 7.6The path to the Production profile to use. Cannot be used at the same time as ProductionProfileName. This option only works if the ProductionSet is created by this Step.
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.
StampingOptionsentityNone(footerCentre: (type: 'document_number'))Sets the stamping options to use when exporting a production set. This option only works if the ProductionSet is created by this Step. Cannot be used at the same time as using a profile. See Nuix API StampingConfigurable.setStampingOptions() for more details on the available options.
TextOptionsentityNone(lineSeparator: '\n' encoding: 'UTF-8')Sets the text settings for a production set. This option only works if the ProductionSet is created by this Step. Cannot be used at the same time as using a profile. See Nuix API ProductionSet.setTextSettings() for more details on the available options.