Configure the eDNA Data Extraction Settings

Before you begin

Specify the tags whose data you want to extract from an eDNA server. You can do so by using the utility, creating a configuration file manually, using a template, or using a blank spreadsheet.

About this task

This topic describes how to configure the settings for eDNA data extraction. These settings are saved in the eDNAHistorianETLExtract.exe.config file.

Procedure

  1. Run the HistorianETLeDNAExtractConfigTool file located in the <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract folder.
    Tip: You can also enter ETL eDNA Extract in Windows Run.
    The Historian ETL eDNA Extract Settings window appears, displaying the Basic Configuration section.
  2. If the configuration details are stored in a file, select Import Config to import the settings, and skip to step 6.
  3. Provide values as specified in the following table.
    Field Description Default Value
    Service Name Enter the service name used by the Historian ETL eDNA Extract tool to connect to the eDNA server. You can enter multiple values separated by commas.
    Tag Name Specify whether you want to use the extended ID or the long ID in the tag name. If you select ExtendedID, the name of the tag created in Historian will contain the extended ID (and the spare field of the tag will contain the long ID). Similarly, if you select LongID, the name of the tag created in Historian will contain the long ID (and the spare field of the tag will contain the extended ID).
    Run Interval (Seconds) Enter the interval, in seconds, at which the Historian ETL eDNA Extract tool will extract data. You must enter a value greater than or equal to 60. 150 (that is, a text file is created for data that is extracted in 150 seconds)
    Min # of Files to Compress Enter the number of files that must be compressed into a single .zip file. 6 (that is, a .zip file is created for every six text files)
    Extract Type Specifies whether you want to extract only the current data or historical data or both. Both (Historical and Current)
    OSM Name Enter a name to identify the Original Equipment/Sales Manufacturer (OSM). This name is included in the .zip files that are extracted on this machine. Host name of the local machine
    Zip TagConfig Select True if you want to create a .zip file of the metadata of eDNA tags.
  4. Select Files, and then provide values as specified in the following table.
    Field Description Default Value
    Historian Export Path Enter the path to the folder in which the text files containing the extracted data must be stored. <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract\Hist Files
    Tag Configuration File Enter the path to the tag configuration that you have created. You can create it automatically, manually, a template spreadsheet, or using a blank spreadsheet. <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract\TagConfiguration.xml
    Zip Export Path Enter the path to the folder in which the compressed files must be stored. <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract\Zip Files
    State File Enter the path to the file that the Historian ETL eDNA Extract tool will create to store the timestamp of the last successful export. This timestamp is used to identify the start time for the next iteration of extraction. This ensures that there is no loss of data during extraction.

    For example, suppose the current time is 11am, and data has been extracted only till 9am. The state file contains the timestamp for 9am. Therefore, when data extraction is resumed, it is extracted from 9am.

    The state file is created after you apply the Historian ETL eDNA Extract settings. It is updated each time .zip files are transferred to the destination Historian server or when the Historian ETL eDNA Extract tool is stopped. For a sample state file, refer to Example of a State File.

    		 <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract\State.xml
    Regen File Enter the path to the regeneration file. You can use this field to extract data.

    If the Gen Sample Regen File field is set to True, a sample regeneration file will be created after you apply the settings. You can modify this file as needed, and specify the path of the same file in the Regen File field. For a sample regeneration file, refer to Example of a Regeneration File.

    		 <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract\Regen.xml
    Gen Sample Regen File Specify whether you want to generate the sample regeneration file. You can then modify this file as needed. False
    Sample Regen File Enter the path to the sample regeneration file that will be created if the Gen Sample Regen File field is set to True. You can modify this file as needed. <installation drive>\Program Files\GE Digital\Historian ETL eDNA Extract\Sample_Regen.xml
    Tag Config File Select this button to generate a file with the list of tags from which you want to extract data. For instructions, refer to Specify Tags for the eDNA Data Extraction Using a Utility.
    Sample Tag Config Select this button to generate a sample tag configuration file. You can then include the list of tags from which you want to extract data. For instructions, refer to Specify Tags for eDNA Data Extraction Manually.
  5. Select Advanced Configuration, and then provide values as specified in the following table.
    Field Description Default Value
    Log Level Select the log level to indicate the amount of information to be logged. The following options are available:
    • Info
    • Error
    • Debug
    		 Info
    Delay Interval The duration, in seconds, by which the data retrieval time will be reduced. For example, if data will be retrieved for 10 minutes, and if you enter 60 in this field, data for the last 60 seconds will not be retrieved in that batch; it will be retrieved in the next batch. This will ensure the retrieval of any dynamic records that were updated in that duration. 60
    Catch Up Interval (Minutes) Enter the catchup interval, in minutes, used to size files when catching up to the current time. 10
    Save Limit Enter the number of files to be exported after which the State.xml file must be updated. 20
    Catch Up Time Limit (Hours) Enter the maximum time, in hours, to go back when catching up after a restart. If you want to extract historical data as well, enter the duration for which you want to extract the data. For example, if you want to extract data for the past one day, enter 24. 168
    Quality Conversion Good Enter the mapping details for good quality between eDNA hexadecimal codes and SCADA binary codes.

    For example, if the hexadecimal code for good quality is 8203, and if the binary codes in a SCADA system for good quality are 1, 27, and 30, enter 8203=1,27,30.

    Use a semicolon to separate multiple entries (for example, 8203=27,30,1;8003=30;203=34).

    If this field is blank, all the values are considered as bad quality, without storing any binary digits.
    Quality Conversion Bad Enter the mapping details for bad quality between eDNA hexadecimal codes and SCADA binary codes.

    For example, if the hexadecimal code for bad quality is C003, and if the binary codes in a SCADA system for good quality are 2, 4, and 6, enter C003=2,4,6.

    Use a semicolon to separate multiple entries (for example, C003=2,4,6;C406=8,9).

    If this field is blank, all the values are considered as bad quality, without storing any binary digits.
  6. Select Save.
    The changes to the settings are applied and saved in the HistorianETLeDNAExtract.exe.config file.

What to do next

Start the data extraction.