Operation Parameters

Note

XTMT supports two options for specifying operation settings and running the operation:

  • An .XTO (XT Operation) configuration file in JSON format which is passed as a command line parameter to xtmt.exe. This will keep a copy of all settings used in a single file for future reference.

  • Enter command line parameters for all operation settings to define the execution of the operation. This is particularly useful for scripting multiple paths, combinations of metadata, and scripting automation.

Whether you're using an .XTO file or command line, only the first two parameters, Operation and Path, are required. All others are optional.

XTO Parameter Command line version and abbreviation Details
Operation

--operation

-o

 Represents a unique and descriptive name for the operation. Used as the name for log files, facilitating tracking and troubleshooting.
Path

--path

-p

 Specifies the path to the files to be uploaded. Must be a local drive or a mapped network drive.
Case

--case

-c

Identifies the case in Axon Evidence for organizing uploaded files. Use either CaseId (GUID ID) or CaseName (friendly name) to specify the case. This is required to maintain folder structures in Axon Evidence, and is required for certain other case settings.

In previous versions, this was CaseId or CaseName.
CreateCaseIfNew

--createCaseIfNew

-n

Determines if a new case should be created if CaseName doesn't exist. Useful for dynamic case creation during uploads. Default is false. If a case is created, it will be assigned to the user doing the XTMT operation.

Note There is a typo in the --help XTMT.exe v2.0.76 (Preview 2) parameter that shows this XTO option as "CreateIfNewCase" which is incorrect.
EvidenceID

--evidenceID

-e

 Applies a specific evidence ID to all files in the operation path. Links files to a specific evidence ID in Axon Evidence.
Categories

--categories

-t

Specifies one or more categories to apply to all evidence in the operation path. Categories must already exist in Axon Evidence.

XTO example fpr multiple categories (this will be simplified in a future release):

"Categories": [{"CategoryName": "Migration"}, {"CategoryName": "Pending Review"}]

Command line format for multiple categories:

--categories "Pending Review", "Closed"
Owner

--owner

-u

Set the evidence Owner account. By default, evidence will be assigned to the user signed in to upload. Override this by setting the Badge ID, User Name, or email address set in Axon Evidence. User must exist already in Axon Evidence.

XTO examples:

,"Owner": "badge123"
,"Owner": "jdoe"
,"Owner": "[email protected]"

Command line examples:

-owner "badge123"
-u "jdoe"
-u "[email protected]"
AutoRun

--autoRun

-a

 Bypasses confirmation prompts, allowing automated execution. Useful for scripting multiple operations. Default is false.
Duplicates

--duplicates

-d

Determines whether to allow uploading of files even if they already exist in Axon Evidence. Default is false. Set to false if you want to avoid redundant uploads.

In previous versions, this was AllowDuplicates.
Global

--global

-g

Controls whether XTMT uses global history for duplicate detection. Set to false by default; adjust as instructed by Axon. Note This setting only applies to evidence that has been uploaded on the current device. The global history is cleared if Upload XT is uninstalled.

In previous versions, this was UseGlobalHistory
SkipParent

--skipParent

-s

Excludes the file path folder from being created as a root folder in Axon Evidence. Useful for restructuring uploaded files at the case level. It is false by default. For example, if the operation path is "X:\2019\March\Case-190302-1", setting SkipParent to True will not create a folder called Case-190302-1 and instead will create folders in the case only for each of its child folders.

In previous versions, this was SkipParentFolder.
ReportOnly

--reportOnly

-r

 Generates log files without executing the operation, helpful for post-analysis. Useful in scenarios where an operation was terminated or canceled to determine what was successfully completed. Default is false.
Batch

--batch

-b

Specifies how many files are submitted at once during the upload. Default is 200; adjust for testing and operational needs.

In previous versions, this was BatchSize.
Accused

--accused

-ac

 Allows adding one or more names to the Accused value in Axon Justice. Multiple accused values can be added by separating the accused values by spaces or repeating this argument for each accused value. Note A Case must be specified to use this field.
CourtNumbers

--courtNumbers

-cn

 Allows adding a court number value in Axon Justice. Note A Case must be specified to use this field.
InternalNumbers

--internalNumbers

-i

 Allows adding internal number in Axon Justice. Note A Case must be specified to use this field.
metaData --metaData Custom Metadata (feature preview) — XTMT now supports defining custom metadata for both operations and individual files. This feature allows for richer, more tailored metadata configurations, ensuring that specific details related to files or operations can be captured and managed effectively. See XTMT Use and Best Practices for examples and details.