Configure the ODBC Extract Settings

Before you begin

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

Procedure

Run the HistorianETLODBCExtractConfigTool_x64 file (for Windows 32 bit) or the HistorianETLODBCExtractConfigTool_x86 file (for Windows 64 bit) located in the <installation drive>\Program Files\GE Digital\Historian ETL ODBC Extract folder.

Tip: You can also enter ETL ODBC Extract_x64 or in Windows Run.

The Historian ETL ODBC Extract Settings window appears, displaying the Basic Configuration section.
If the configuration details are stored in a file, select Import Config to import the settings, and skip to step 6.

Provide values as specified in the following table.


Field	Description	Default Value
Data Source Name (DSN)	Enter the name of the data source from which you want to extract data. It is the saved collection of settings required to connect to the ODBC data source. You can use only a 32-bit or a 64-bit DSN depending on whether your application is 32-bit or 64-bit. If you do not have a DSN, select ODBC DataSource, and create a system DSN.	Blank
Username	Enter the username of the user to connect to ODBC data source. A value is required only if using SQL authentication.	Blank
Password	Enter the password of the user to connect to ODBC data source. A value is required only if using SQL authentication.	Blank
Unit ID	Enter the unit ID of the machine from which you want to transfer data.
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)
Run Interval (Seconds)	Enter the interval, in seconds, at which the Historian ODBC ETL 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)
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.

Select File Configuration, and then provide values as specified in the following table.


Field	Description	Default Value
Data Extract 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 ODBC Extract\Hist Files
Zip Extract Path	Enter the path to the folder in which the compressed files must be stored.	`<installation drive>`\Program Files\GE Digital\Historian ETL ODBC Extract\Zip Files
Tag Configuration File	Enter the path to the tag configuration file that you have created.	`<installation drive>`\Program Files\GE Digital\Historian ETL ODBC Extract\OSM_OSMName.xml
Table Configuration File	Enter the path to the table configuration file that you have created.	`<installation drive>`\Program Files\GE Digital\Historian ETL ODBC Extract\TableConfig.xml
State File	Enter the path to the file that the Historian ODBC 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 ODBC ETL Extract settings. It is updated each time .zip files are transferred to the destination Historian server or when the Historian ODBC ETL Extract tool is stopped. For a sample state file, refer to Example of a State File.	`<installation drive>`\Program Files\GE Digital\Historian ETL ODBC Extract\State.xml
Regen File	Enter the path to the regeneration file. You can use this field to extract 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 drive>`\Program Files\GE Digital\Historian ETL ODBC Extract\Regen.xml
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 drive>`\Program Files\GE Digital\Historian ETL ODBC Extract\Sample_Regen.xml

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
Extract Type	Specifies whether you want to extract only the current data or historical data or both. However, we recommend that you extract only current data.	Current Data
Generate Sample Regen File	Select True if you want to generate the sample regeneration file. You can then modify this file as needed.	False
Query Timeout	The time, in seconds, after which a query to the database times out.	30
Save Limit	Enter the number of files to be exported after which the State.xml file must be updated.	20
Catch Up Interval (Seconds)	Enter the catch up interval, in seconds, used to size files when catching up to the current time.	10
Catch Up Time Limit (Hours)	Enter the maximum time, in hours, to go back when catching up after a restart. You can use this field to extract data.	168

Select Save.
The changes to the settings are applied and saved in the HistorianETLODBCExtract.exe.config file.

What to do next

Start the data extraction.