NuixExportConcordance
Alias:NuixExportConcordance
Output:Unit
Requires Nuix.Version 7.2
Requires Nuix.Features: PRODUCTION_SET, EXPORT_ITEMS
Exports a production set in Concorfance format
Parameter | Type | Required | Position | Default Value | Example | Requirements | Summary |
---|---|---|---|---|---|---|---|
ExportPath ToDirectory | string | ✔ | 1 | The directory where the export will be created | |||
ProductionSetName ProductionSet | string | ✔ | 2 | The name of the production set to export. | |||
ExportOptions | entity | 3 | The ProductionSet profile is used | (native: (path: 'NATIVE' naming: 'document_id'), text: (path: 'TEXT' naming: 'document_id')) | An array of file types and associated options to produce. If this is not set, the ProductionSet must have a production profile. See Nuix API BatchExporter.addProduct() for more details on the available options. | ||
NumberingOptions | entity | 4 | Document ID numbering, starting with DOC-000000001 | (createProductionSet: false prefix: 'ABC' documentId: (startAt: 1 minWidth: 4)) | Set the numbering options for the export. This setting has no effect if the production set has numbering options defined. See Nuix API NumberingConfigurable.setNumberingOptions() for more details on the available options. | ||
LoadFileOptions | entity | 5 | Default options are used | (metadataProfile: 'Profile' loadFileEntryLimit: 5000) | The options to use for creating the load file. This parameter has no effect if the production set has a production profile. See Nuix API BatchExporter.addLoadFile() for more details on the available options. | ||
CasePath Directory | string | Use the current open case | C:/Cases/MyCase | The 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. | |||
Deduplication | ExportDeduplication | None | Method of deduplication when top-level item export is used. | ||||
ExportDescendantContainers | bool | false | Export descendant containers. Only works when TraversalStrategy includes descendants. | ||||
FailedItemsTag | string | Failed items are not tagged | Tag items that fail to export with this tag. | ||||
LoadFileType | LoadFileType | Concordance | The type of load file to export. This parameter has no effect if the production set has a production profile. | ||||
ParallelProcessingSettings | entity | Default processing settings used | (workerCount: 2 workerMemory: 4096) | Sets the parallel processing settings to use. | |||
SkipSlipsheetedNatives | bool | false | Version 7.6 | Skip export of slipsheeted items. | |||
SortOrder | ExportSortOrder | None | Method of sorting items during the export. | ||||
TraversalStrategy | ExportTraversalStrategy | Items | The method of selecting which items to export. |