Configure the Historian ETL Load tool

About this task

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

Procedure

  1. Run the Historian ETL Load Configuration file located in the Historian ETL Load folder.
    Tip: You can also enter ETL Historian Load in Windows Run.
    The Historian ETL Load 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.
    FieldDescriptionDefault Value
    Historian ServerEnter the host name or IP address of the destination Historian server. If you leave this field blank, the local host name is considered.Blank
    Historian UserEnter the ID of the user to connect to the destination Historian server. A value is required only if security is enabled for the destination Historian server.Blank
    Historian PasswordEnter the password of the user to connect to the destination Historian server. A value is required only if security is enabled for the destination Historian server.Blank
    IH Status TagnameEnter the name of the tag that is used to check the state of the destination Historian server. This tag must exist in Historian.IHStatusTag
  4. Select Files, and then provide values as specified in the following table.
    FieldDescriptionDefault Value
    Historian File PathEnter the path to the folder in which the text files containing the extracted data are stored.<Installation folder of Historian ETL>/Historian ETL Load/ImportFiles
    Zip File PathEnter the path to the folder in which the compressed files are available.<Installation folder of Historian ETL>/Historian ETL Load/ZipImportFiles
    Error File PathEnter the path to the folder in which file that could not be loaded or deleted must be stored.<Installation folder of Historian ETL>/Historian ETL Load/ErrorFiles
  5. Select Alarms & Events.
  6. If you do not want to import data related to alarms and events, in the Enable Alarm and Event Import field, select False.
  7. Select Advanced Configuration, and then provide values as specified in the following table.
    FieldDescriptionDefault Value
    Write Batch SizeEnter the number of records to write to the Historian server at one time.
    Tip: A large batch size can produce faster tag value writes, but can lead to poor performance if multiple collectors share the same Historian server. A 1000 to 2000 batch size is ideal for a shared Historian server.
    1000
    Wait Interval (seconds)Enter the amount to time, in seconds, to wait to check for new files.90
    Wait For ReplySelect False if you do not want the Historian ETL Load tool to wait for the acknowledgement from Historian that files are transferred.True
    Error On ReplaceSelect True if you want an error to be logged if duplicate data is transferred.False
    Log LevelEnter the log level to indicate the amount of information to be logged. A value of 1 indicates the least information and 5 indicates the highest level of information.1
    Max RetriesEnter the maximum number of times the Historian ETL Load tool must try to resend data in case of an error or failure.2
    Retry Timeout (seconds)Enter the amount of time, in seconds, to wait before trying to resend data.5
    Error File Life Time (days)Enter the amount of time, in days, error files must be stored before deletion.3.5
    Add Tag Automatically Select True to create a tag automatically in the destination Proficy Historian server if the tag name that you entered does not exist in the server. False
  8. Select Save.
    The changes to the settings are applied and saved in the HistorianETLLoad.exe.config file.

What to do next

Load data into the destination Historian server.