NuixAddItem
Alias:NuixAddItem
, NuixAdd
, NuixImportItem
Output:Unit
Requires Nuix.Version 5.0
Requires Nuix.Features: CASE_CREATION
Adds a file or directory to a Nuix Case.
Parameter | Type | Required | Position | Default Value | Example | Requirements | Summary |
---|---|---|---|---|---|---|---|
Paths Directories Files | array<string> | ✔ | 1 | C:/Data/File.txt | The path of the file or directory to add to the case. | ||
Container ToContainer | string | ✔ | 2 | The name of the evidence container to add items to. | |||
Description ContainerDescription | string | 3 | No Description | The description of the evidence container. | |||
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. | |||
ContainerEncoding Encoding | string | Default system encoding | UTF-8 | Set the encoding for the evidence container. | |||
ContainerLocale Locale | string | Default system locale | en-GB | Version 7.2 | Set the locale for the evidence container. | ||
ContainerTimeZone TimeZone | string | Default system time zone | UTC | NuixVersion 0.9.0-11.0 | Set the time zone for the evidence container. If the time zone given is not known to Nuix, the GMT time zone will be used. | ||
Custodian ContainerCustodian | string | No custodian assigned | The custodian to assign to the new evidence container. | ||||
CustomMetadata | entity | No custom metadata will be added | Sets additional metadata on the evidence container. | ||||
MimeTypeSettings | array<entity> | Use default settings for all MIME types | ("mimeType": "application/pdf" "enabled": "true" "processEmbedded": false) | Version 8.2 | Special settings for individual mime types. Should have a 'mimeType' property and then any other special properties. | ||
ParallelProcessingSettings | entity | Parallel processing settings will not be changed | Sets the parallel processing settings to use. These settings correspond to the same settings in the desktop application, however the user's preferences are not used to derive the defaults. | ||||
PasswordFilePath PasswordFile | string | Do not attempt decryption | C:/Data/Passwords.txt | Version 7.6 | The path of a file containing passwords to use for decryption. | ||
ProcessingProfileName UsingProfile | string | The default processing profile will be used. | MyProcessingProfile | Version 7.6 | The name of the Processing profile to use. | ||
ProcessingProfilePath UsingProfilePath | string | The default processing profile will be used. | C:/Profiles/MyProcessingProfile.xml | Version 7.6 | The path to the Processing profile to use | ||
ProcessingSettings Settings | entity | Processing settings will not be changed | Sets the processing settings to use. These settings correspond to the same settings in the desktop application, however the user's preferences are not used to derive the defaults. | ||||
ProgressInterval | int | Every 5000 items | The number of items at which the Nuix processor logs a progress message. |