Configure the Historian ETL Extract Settings

Before you begin

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

About this task

This topic describes how to configure the Historian ETL Extract tool to modify the default folders to store the extracted data, to specify whether data related to alarms and events must be extracted, and so on.
Note: These settings are saved in the HistorianETLExtract.exe.config file.

Procedure

  1. Run the Historian ETL Extract Configuration file located in the Historian ETL Extract folder.
    Tip: You can also enter ETL Historian Extract in Windows Run.
    The Historian ETL Extract Configuration window appears, displaying the Basic Configuration section.
  2. If the configuration details are stored in a file, select Import Config to import the settings. Otherwise, skip to the next step.
  3. Provide values as specified in the following table.
    Field Description Default Value
    Historian Server Enter the host name or IP address of the onsite Historian machine. If you leave it blank, the local host name is considered. Blank
    Historian User Enter the ID of the user to connect to the Historian server on the onsite Historian machine. A value is required only if security is enabled for the Historian server. Blank
    Historian Password Enter the password of the user to connect to the Historian server on the onsite Historian machine. A value is required only if security is enabled for the Historian server. Blank
    Unit ID Enter the unit ID of the machine from which you want to transfer data. OSMName
    Run Interval Enter the interval, in seconds, at which the Historian ETL Extract tool will extract data. You must enter a value greater than or equal to 60. 300 (that is, a text file is created for data that is extracted in 300 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)
    Alarms & Events Select False if you do not want to extract data related to alarms and events. True
  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 folder of Historian ETL>/Historian ETL Extract/HistFiles
    Tag Configuration File Enter the path to the tag configuration file that you have created. <Installation folder of Historian ETL>/Historian ETL Extract/OSM_OSMName.xml
    Zip Export Path Enter the path to the folder in which the compressed files must be stored. <Installation folder of Historian ETL>/Historian ETL Extract/ZipFiles
    State File

    Enter the path to the file that the Historian ETL Extract tool will create to store the timestamp of the last successful export. This timestamp is used to identify the start time for 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 Extract settings. It is updated each time .zip files are transferred to the destination Historian server or when the Historian ETL Extract tool is stopped. For a sample state file, refer to Example of a State File.

    		 <Installation folder of Historian ETL>/Historian ETL Extract/State.xml
    Regen File Enter the path to the regeneration file. You can use this field to extract historical data.

    If the Generate 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 folder of Historian ETL>\Regen.xml
  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
    Catch Up Interval Enter the catch up interval, in seconds, 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 Enter the maximum time, in hours, to go back when catching up after a restart.

    You can use this field to extract historical data.

    		 168
    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
    Sample Regen File Enter the path to the sample regeneration file that will be created if the Generate Sample Regen File field is set to True. You can modify this file as needed. <installation folder of Historian ETL>\Sample_Regen.xml
    Generate Sample Regen File Select True if you want to generate the sample regeneration file. You can then modify this file as needed. False
  6. Select Save.
    The changes to the settings are applied and saved in the HistorianETLExtract.exe.config file.

What to do next

Start the data extraction.