Using EQuIS Live File Processor Widget (Beta)
Step 2: Name this Configuration
Introduction
To load sensor logging data for processing by EQuIS Live, admin users must configure the Live File Processor Widget to determine how their data will be processed (via Regex). While thorough, this can be a complex and time-consuming process.
The Live File Processor Widget (Beta) (enabled for EarthSoft Beta users by using a feature flag) seeks to provide a simpler and quicker experience. This new functionality will:
•Create a template that can be used to import data from logger files.
•Use a data mapping configuration that users create.
•Import data from files in a user designated folder.
Notes: •Information on this page is for the Beta version of the Live File Processor Widget. •Users should choose (or create) a representative file with a simplified set of data to use when creating the template that the Live File Processor Beta widget will use when loading data into EQuIS Professional. •This feature is (currently) hidden behind a feature flag. Users must enable this feature flag to use the Live File Processor Widget (Beta). |
Getting Started
To enable the Live File Processor Widget (Beta) feature flag:
1.In EQuIS Enterprise, click the More Options 
button in the upper right.
2.Select the username.
3.In the User Information window, select the Application Settings tab.
4.Click the Add 
button.
5.Add the following information:
a.Section = live.fileprocessor
b.Key = useNewWizard
c.Value = true
6.Click the Update 
button.
7.Click the Save changes and close 
button.
To revert back to the Live File Processor Widget user interface, the feature flag added in the Getting Started section will need to be removed. To disable the Live File Processor (Beta) widget feature flag:
1.In Enterprise, click the More Options button in the upper right.
2.Select the username.
3.In the User Information window, select the Application Settings tab.
4.Select the Live File Processor Widget (Beta) feature flag setting.
5.Change the Value to false.
Using EQuIS Live File Processor Widget (Beta)
The following steps require that the Live File Processor Widget be added to the Enterprise dashboard (see Widget Chooser for more information).
Click the Add Device button to open the Live File Processor Widget (Beta) device configuration wizard. Step through the side menu options and follow the instructions to provide the information required to setup the device configuration. As each step in the configuration wizard is completed, the side menu options will be enabled. Users can click the Back button or select a tab on the side menu to return to previous steps.
Step 1: Select Data File
Click the Browse Files 
button to open the Windows file manager and select a (representative) text file (comma, tab, or pipe delimited) that contains a set of logger data. This file will be used to identify the main sections (e.g., logger name, table header for the logger data, etc.) of the data files. After the file has uploaded to the wizard, the file name will display in the text box.
If data files will be placed in a designated folder (i.e., the Folder Watcher Path), enter the Folder Watcher Path. See the Live File Processor Agent Folder article for more details.
Click the Continue button when done to move to the next step.
Step 2: Name this Configuration
For the uploaded comma, tab, or pipe delimited file, the program determines which character is most likely to be the file's delimiter. The grid displays the file contents based on the identified delimiter. The Delimiter field on the right indicates which delimiter was chosen. If the program accidentally identifies the wrong delimiter, this will be evident in the data grid because the values contained in each cell will appear skewed. If this happens, select the appropriate delimiter from the drop-down and the grid will automatically adjust.
To change the Delimiter, click the Delimiter drop-down to display the Delimiter options:
After verifying the data loaded appropriately, enter a Device Name and Device Code. These will be used to identify the Live logger data configuration file. The Continue button will then be enabled.
Click the Continue button when done to move to the next step.
Step 3: Identify Logger Code
Select the drop-down and choose from the following options to determine how the logger code will be identified within the logger data file:
•In a cell
•In the file name
•In a column (future option)
•In a row (future option)
•Entered manually (default)
In a Cell Option
When the "In a Cell" option is chosen, two display boxes will appear to the right of the drop-down entitled Position and Selected Value. Click on the cell in the data grid for the logger code. The Position will give the index of the selected cell and the value will be shown in the Selected Value display box.
In the File Name Option
When the "In the File Name" option is chosen, the file name for the uploaded data file will be parsed by the character(s) noted in the "Separate By" box, which defaults to a period (.). Change the separator if applicable. Once the file name is appropriately parsed, select the portion that contains the logger code. The selected text will be highlighted in blue.
Entered Manually Option
When the "Entered Manually" option is chosen, a text field is displayed to enter the logger code.
Click the Continue button when done to move to the next step.
Step 4: Pick Series & Units
On this tab, configuration of the data series (e.g., temperature, dew point, etc.) will be set. Data series are assumed to be in discrete columns in the data grid. By default, a single data series configuration box will be displayed.
To identify a data series for import, click the Target 
button and then select the cell in the data grid that has the desired header value (e.g., temperature). The targeted cell within the file will display above the selection and the name of the header row will populate in the text box. The text box is editable and can be changed as desired.
Once the data series has been set, chose the appropriate corresponding unit for the data series from the Units drop-down. Values in the Units drop-down menu are populated from the RT_UNIT table. To help users find the correct unit from a long list, users can enter text in the filter at the top of the Units drop-down list and the drop-down list reduces to items that match the entered text.
To add another data series, click the Add Data 
button and repeat the process.
To remove a data series, click the Remove Data 
button and the series will be deleted.
Note: The series will be removed without a warning message but can be added again before finishing. |
|---|
Click the Continue button when done to move to the next step.
Step 5: Identify Date & Time
The Date and Time format and header location(s) for the device configuration is set on this tab. The following date/time parameter options are available:
•Date/Time Column Header
•Date Column Header
•Time Column Header
•Start Date/Time Cell
•Added Time Column Header
For standard Date/Time formatting, users can select either the combined Date/Time Column Header option or both the separate Date and Time Column Header options. For logger files that contain a start date and a column containing added time, users can select the Start Date/Time Cell and Added Time Column Header options.
Click the Target button and then chose the appropriate parameter option. After choosing the desired option, click on the cell in the data grid that matches the selected option. The targeted column cell will display above the parameter box. Click the Format drop-down to choose the desired date/time format.
To add another date/time option, click the Add Date/Time button and repeat the process.
Notes: •If the selected parameter is a Date/Time Column Header and the user changes the parameter to the Date Column Header, then the wizard will automatically create two parameters: a Date Column Header parameter and a Time Column Header parameter. •If the user selects a Start Date/Time Cell parameter, the wizard will attempt to add an associated Added Time Column Header parameter. |
|---|
To remove a data series, click the Remove Data button and the series will be deleted.
Click the Continue button when done to move to the next step.
Step 6: Pick First Data Row
In this tab, select a single, complete row that will be used in the configuration file to indicate where in the data file to start loading data. The row will be highlighted.
Click the Continue button when done to move to the next step.
Step 7: Finish
Review the data selections and click the Back button or appropriate side menu tab to make any changes. Click the Finish button to write the mapping configuration to the template as a CSV file. This template will be available in the ST_CONFIG table when importing logger data into EQuIS Live.
To commit the current file to the database in addition to creating the configuration template file, click the Load current file into EQuIS? checkbox. The Finish button will change to "Finish and Load". Click the Finish and Load button. After the data file is loaded, a pop up shows the result of the load and if it was successful or if there were any errors.
Note: For the file upload to be successful, CSV must be a valid FILE_TYPE in the RT_FILE_TYPE table. |
After clicking the Finish button, the Live File Processor Widget (Beta) configuration wizard will close. In the Live File Processor widget, the newly created template will be listed with a name composed of the Device Name and Device Code. The template name will have "-CsvConfig" appended to it, which is required to load the report correctly.
Using the Configuration File
Once data is added to the folder indicated in the Folder Watcher path, it can be loaded into EQuIS Professional via the EQuIS Live File: Processor report.
1.In EQuIS Professional, open the EQuIS Live File: Processor report.
2.For File types, select a Live File Processor Widget (Beta) configuration template file.
3.Click the Go 
button to run the report.
4.A message will indicates that the data was correctly processed.