List of parameters for the Migrate command
- Last UpdatedJul 25, 2025
- 3 minute read
The Migrate command is used to transfer eDNA historical point data to placeholder PI tags on a target Data Archive server. There are both required and optional parameters you can use with this command.
Note: To see a full list of parameter options with descriptions, enter the following at a command prompt: edna2pi.exe migrate --help
List of required parameters
The following parameters are required to initiate the migration of eDNA data to PI using the Migrate command.
Important: When specifying folder paths, use forward slashes (/) instead of backward slashes in both relative and absolute file paths.
|
Parameter name |
Description |
|---|---|
|
-eDNA History Service Name |
Specifies the data source of the eDNA point data. The parameter value must follow the SITE.SERVICE format. If the service is unavailable or non-existent, the utility stops and logs the error. |
|
-map file path/filename |
Indicates the path and filename of the CSV map file. The CSV map file contains the configuration used to migrate eDNA data to the specified PI tags on the target Data Archive server. When specifying folder paths, use forward slashes (/) instead of backward slashes in both relative and absolute file paths. |
|
-startTime |
A required date/time string that specifies the start date and time for the migration operation to begin reading and transferring eDNA point data. The date/time string for startTime is interpreted as a local time relative to the machine running the eDNA to PI Migration Utility. This time is converted to UTC time by the utility during migration. |
|
-endTime |
A required date/time string that specifies the end date and time for the migration operation to finish reading and transferring eDNA point data. The date/time string for endTime is interpreted as a local time relative to the machine running the eDNA to PI Migration Utility. It is converted to UTC time by the utility during migration. Note: Non-US regions should specify the date/time string in IS-8601 format rather than local date-time format. See Code example 5 in List of code examples for the Migrate command. |
List of optional parameters
These additional parameters are optional.
|
Optional parameter name |
Description |
|---|---|
|
-maxBatchSize |
Specifies the number of events that will be collected before flushing data to the target Data Archive. The default value is 100,000. |
|
-d or diagnostic |
Displays diagnostic information about the migration process. This information is shown in the same console window that the migration utility is run from. |
|
-errorlog [Folder location] |
Specifies an alternate folder to output the error logs of the migration. Folder/file paths for errorLog should use forward slashes (/) instead of backward slashes for both relative and absolute folder paths. |
|
-log [Folder location] |
Specifies an alternate folder to output the debugging logs of the mapping process. Folder/file paths for errorLog should use forward slashes (/) instead of backward slashes for both relative and absolute folder paths. |
|
-output [Folder location] |
Sets the output folder to store information about the migrated PI data. Folder/file paths for errorLog should use forward slashes (/) instead of backward slashes for both relative and absolute folder paths. |
|
-setQuestionable |
A true/false parameter which is true by default. If set to true, when writing eDNA data to a Value PI tag, sets the Questionable bit on the target PI tag at the given timestamp, if the corresponding eDNA data has an “Unreliable” status at that time. |