Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

eDNA to PI Migration Utility

List of parameters for the Map command

  • Last UpdatedDec 19, 2024
  • 3 minute read

The map command is used to create a CSV file that can be opened in Microsoft Excel and then imported using PI Builder to generate PI tags. There are both required and optional parameters you can use with this command.

Required parameter

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.

Optional parameters

Parameter name

Description

-d or --diagnostics

Displays diagnostic information about the map file generation. This information is shown in the same console window in which the migration utility is run.

--errorLog [folder location]

Specifies an alternate folder to output the error logs of the mapping process.

When specifying folder paths, use forward slashes (/) instead of backward slashes in both relative and absolute file paths.

Example:

edna2pi map [eDNA History Service Name] --errorlog “C:/Windows/Temp/log.txt”

--help

Displays a full list of parameter options for the map command.

--log [folder location]

Specifies an alternate folder to output the debugging logs of the mapping process.

When specifying folder paths, use forward slashes (/) instead of backward slashes in both relative and absolute file paths.

Example:

edna2pi map [eDNA History Service Name] --debuglog “C:/Windows/Temp/log.txt”

--output

Sets the output folder for the generated mapping file.

When specifying folder paths, use forward slashes (/) instead of backward slashes in both relative and absolute file paths.

Example:

edna2pi map [eDNA History Service Name] -- debuglog “C:/Windows/Temp/log.txt”

--pointSource

Can be used to specify the desired point source for destination PI tags.  The default is "L".

--prefix

Specifies that a prefix string be added to each eDNA point name, when generating the mapping file that is used to generate the corresponding PI tag.

Example:

edna2pi map [eDNA History Service Name] --prefix “eDNA.”

Produces a CSV file of eDNA point data and inserts “eDNA” before each eDNA point name. For example, the eDNA point name “Test001”, becomes the future PI tag named "eDNA.Test001" in the CSV file. The new point name is listed in the Name column.

Things to note:

  • An error is issued if the prefix string does not adhere to PI tag naming conventions. See Overview of tag naming conventions for these guidelines.

  • If the combined eDNA point name and prefix exceed 1,000 characters, the utility removes or shortens the prefix to ensure that the PI tag is created with the eDNA point name intact.

--quality

Specifies what, if any, quality attribute in the source eDNA point that should be retained when building the mapping file.  Value can be 'Status' or 'RawStatus'.

If –quality is set to “Status”, a second PI tag row will be added to the CSV mapping file to store the Status information for the associated eDNA point. The suggested PI tag name for the Status tag is the same as the Value PI tag, but with a “.Quality” suffix appended.

If –quality is set to “RawStatus”, a second PI tag row will be added to the CSV mapping file to store the status information for the associated eDNA point. The suggested PI tag name for the Status tag is the same as the Value PI tag, but with a “.Quality” suffix appended.

--qualitySuffix

Specifies a custom suffix string to be applied to all Status or RawStatus PI tag rows, replacing the default “.Quality” suffix.

Example:

edna2pi map [eDNA History Service Name] --quality Status --qualitySuffix “.QualityInfo”

Produces a CSV file that generates two rows for each eDNA point—one for the eDNA point values, and one for the eDNA point Status information. The “Name” column for the Value tags will be the same as the eDNA point name, and the “Name” column for the Status tags will be the eDNA Point name with “.QualityInfo” suffixed to the end.

In This Topic
TitleResults for “How to create a CRG?”Also Available in