Egx300, Com'X 510 and Com'X 200/210 Ecostruxure™ Power Monitoring Expert 9.0
Egx300, Com'X 510 and Com'X 200/210 Ecostruxure™ Power Monitoring Expert 9.0
Electrical equipment should be installed, operated, serviced and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
As standards, specifications and designs change from time to time, please ask for confirmation of
the information given in this publication.
Safety Information
Important Information
Read these instructions carefully and look at the equipment to become familiar with the
device before trying to install, operate, service or maintain it. The following special
messages may appear throughout this bulletin or on the equipment to warn of potential
hazards or to call attention to information that clarifies or simplifies a procedure.
DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
Please Note
Electrical equipment should be installed, operated, serviced and maintained only by qualified
personnel. No responsibility is assumed by Schneider ElectricSiemens Industry for any
consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction, installation, and
operation of electrical equipment and has received safety training to recognize and avoid the
hazards involved.
ETL Data Migration Guide
Contents
Safety Precautions 6
Introduction 7
Additional information 7
Overview 7
Terminology 7
Before you begin 9
For new installations 9
EGX300 device configuration 9
Device Log Export 9
Time Zone Offset 10
Com'X 510 device configuration 10
Folders for CSV and ZIP files 10
Information to collect before you start 10
ETL job upgrade consideration 10
Upgrading previous setup types 11
Installing the EGX300 and Com'X 510 ETL Package 12
Configuring the File Upload Web application 14
Starting the Configuration tool 15
Creating and configuring a new EGX300 ETL job 16
Connections – Define database connections 16
Source Mappings – Define EGX sources 17
File Handling – Specify processing for valid and invalid files 19
Preview Mappings – Review the PME source names 20
Verify the Enable Recorder and Channel Creation setting 20
Start the ETL job and verify data 21
EGX300 to PME ETL user interface 22
Connections 22
Source Mappings 24
File Handling 26
Preview Mappings 27
Appendices 28
Appendix A: Default job settings 28
Appendix B: Supported device types and EGX topics 29
Device types 29
EGX topics 29
Appendix C: Unsupported device types and EGX topics 30
Appendix D: Logging options for ETL jobs 32
Appendix E: Choosing how to run your ETL job 34
Running the ETL job as a Windows Service 34
Running the ETL job as a batch file using Windows Task Scheduler 35
Running the ETL job using the command line 36
Safety Precautions
During installation or use of this software, pay attention to all safety messages that occur in the
software and that are included in the documentation. The following safety messages apply to this
software in its entirety.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software or devices for critical control or protection applications where human
or equipment safety relies on the operation of the control action.
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices to help prevent unauthorized access to the software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Work with facility IT System Administrators to ensure that the system adheres to the site-specific
cybersecurity policies.
Introduction
This document explains how to install and configure the necessary applications for migration of
PowerLogic™ EGX300 and Com'X 510 device data to EcoStruxure™ Power Monitoring Expert 9.0.
This document also explains how to start the data upload and verify that the files are being
processed.
This deployment guide covers the EGX300 to EcoStruxure Power Monitoring Configuration tool, the
ETL Engine, and the File Upload web application. Pertinent aspects of the ETL Management tool
are also described.
Additional information
l PowerLogic™ EGX300 Device Configuration Guide, 7EN42-0095-00
l Com'X 510 User Manual, fw 3.0. This guide is available on the Exchange Community; regis-
tration is required.
Overview
The ETL Engine is a software application that moves data from one data store to another using plug
ins. The ETL Engine supports moving data between many different data stores. This document
describes how to creating an ETL job that moves log data from EGX300 or Com'X 510 CSV files
into a Power Monitoring Expert database.
Before the ETL Engine can move data, you provide configuration information to describe the where,
what, and how of data migration. The precise details vary from system to system, but typically
include database connection strings, data source information, and frequency of data migration.
Collectively these configuration details are called a job and are stored in an XML file known as a job
file. You use the EGX300 to ION Enterprise Configuration tool to define the job for the ETL Engine to
process.
NOTE: The term ION Enterprise is used in several locations in this document. This is the product
name of previous versions of EcoStruxure Power Monitoring Expert and some references to it still
exist in the configuration tools.
For the EGX300 to Power Monitoring Expert data migration path, many of these configuration
variables are known ahead of time. The Configuration tool was developed to simplify the migration
process.
The Configuration tool supplements the full Tactical Solutions Admin Tool. The Configuration tool
does not fully duplicate the functionality of the Admin Tool. For example, it does not support
Quantity editing or Position Counter viewing.
NOTE: Do not run the Configuration tool and the Tactical Solutions Admin Tool simultaneously.
Terminology
The following terminology is used throughout this document.
EGX300 To ION Enterprise Configuration tool: An application that allows you to create and
configure ETL jobs that migrate EGX300 CSV log data into a EcoStruxure Power Monitoring Expert
system.
CSV files: Comma-separated value files. Text files that use a comma to separate field values
within each line. EGX300 and Com'X 510 gateways can be configured to export their log data to
CSV files. The ETL Engine reads the CSV files and extracts the device data to be loaded into
Power Monitoring Expert.
ETL Engine: A flexible interoperability tool that transfers data from one data store to another. The
ETL Engine executes ETL jobs that you create and configure.
ETL Job: An ETL job consists of one extract task and one load task. Transform tasks are optional.
An ETL job can also contain multiple transform tasks.
Each ETL job functions as an independent data adapter program and moves data from one data
store to another. ETL jobs are built from lower level building blocks called ETL tasks.
ETL Tasks: There are three types of tasks – extract, transform, and load.
l Extract tasks: Read data from a specific data store or format, and converts it to a common
format that can be understood by other tasks.
l Transform tasks: Transform tasks are optional tasks in an ETL job. They modify data in some
way, and perform operations on the data in the common format. Transform tasks are typically
not associated with any data store.
NOTICE
LOSS OF DATA
• Do not start the ION Log Inserter Service on an interval boundary if your system includes PC
Logging, otherwise data collection can be interrupted.
• Start the ION Log Inserter Service between interval boundaries.
Failure to follow these instructions can result in a loss of data.
1. Open Windows Services and then locate the ION Log Inserter Service.
3. Verify that Started appears in the Status column, and then close Windows Services.
NOTE: The EGX300 device must be fully configured before you can run ETL jobs to process CSV
files. Refer to the EGX300 Device Configuration Guide for instructions to configure the device.
The following sections highlight the critical parameters you need to set in the device’s web setup
application.
When configuring Device Log Export, take note of the Schedule parameter. This should be set to
use “Logging Interval.” This knowledge will help you choose the appropriate settings when you are
configuring the ETL job. For example, if the logging interval is set to 15 minutes, you might setup the
ETL job to sleep for 15 minutes between job runs.
Database connection strings for ION_Data and ION_Network – Note the server name that
hosts the ION_Data and ION_Network databases. If you plan on using SQL authentication, note
the username and password. If you are using Windows authentication you do not need a username
or password.
EGX300 or Com'X 510 File Directory – The full path of the directory containing the CSV or ZIP
files being exported by the EGX300 or Com'X 510 devices. Note the number of CSV or ZIP files
currently in the EGX300 File Directory.
Valid Directory – The full path of the valid CSV file directory you created.
Invalid Directory – The full path of the invalid CSV file directory you created.
EGX Device Logging Settings – Take note of the settings on the Device Logging page and the
Device Log Export page in the EGX300 web setup application. These settings provide an
approximate frequency of how often new CSV files will be generated and size of each CSV file. The
typical logging interval is 15 minutes.
Com'X 510 Device Logging Settings – Note the Publication settings on the Com'X 510. For more
information, refer to the Publication section in the Com'X 510 User Manual.
EGX Time Zone Offset– Note the Time Zone Offset of each EGX300 device. This will allow you to
choose the correct time zone when configuring the ETL job. All EGX300 devices communicating
with the Power Monitoring Expert system must be in the same time zone.
For Power Monitoring Expert 9.0 and 8.2, it is assumed that the previous setup type was Install
EGX300 to ION Enterprise ETL – Complete. If that is the case, run the Installer and specify the
same setup type. However, if the previous installation used either the No Website or Website only
setup type, use the Uninstall process in Programs and Features to uninstall the EGX300 to ION
Enterprise ETL program before running the Installer to reinstall one of these setup types.
Open Internet Information Services (IIS) Manager, right-click EGXFileUpload, and select
Properties.
Install EGX300 to ION Enterprise ETL – Complete. This is the recommended setup type
when installing ETL on the Power Monitoring Expert application server. Choosing this option
will install the full package, including ETL, the job configuration UI, and the web application.
Install EGX300 to ION Enterprise ETL – No Website. This option installs the ETL package
without the web application. This option is useful when installing ETL on a server that does not
have IIS installed.
Install EGX300 to ION Enterprise ETL – Website only. This option installs the web
application without the ETL component. This option is useful when ETL resides on another
server. Under this setup type, the web site would likely be configured to write CSV files to a
share folder that ETL can access.
6. Click Next.
The installer may notify you that the folder you have selected does not exist and ask for
permission to create the folder.
The Check System summary screen appears. All items should be marked with “Success” and
a check mark.
8. Review the selections, including the message describing the behavior of the Install button.
Once the installer completes the Copy Files step, it shows the “Configuration Complete” and
“Configuration successful” messages.
10. Click Next to go to the Complete page, which displays a message that the installation com-
pleted successfully.
After a successful installation, the following components are installed on your system:
l EGX File Upload web application hosted in IIS. This application receives incoming CSV files
from EGX300 devices via HTTP
1. Open Windows Explorer and browse to the folder containing the Web application’s files.
2. Locate the HttpFilePost.config file and then open the file in a text editor such as Win-
dows Notepad.
NOTE: Create a backup copy of this file if desired and move the backup to a separate folder.
3. Fill in a value for the SaveLocation setting. This is the full path to the folder to which the
EGX CSV files will be saved to.
4. If you are using a Com'X 510, change the value of the AllowedFileNameExtensions set-
ting to include zip files. For example, edit the setting to be either of the following:
<AllowedFileNameExtensions>.csv:.txt:.zip</AllowedFileNameExtensio
ns>
or
<AllowedFileNameExtensions>.zip</AllowedFileNameExtensions>
5. Review the values for the remaining settings, which can be left unchanged in the majority of
cases:
Ignore Do nothing. Leave the existing file intact and delete the new file.
Overwrite Replace the existing file with the new file.
Rename Rename the new file so that it no longer conflicts with another existing file.
6. Save the HttpFilePost.config file and exit the text editor program. The new settings will
be used automatically on the next POST.
1. Double-click EGX300ToIONEConfiguration.exe.
The EGX300 ETL tool contains four sections: Connections, Source Mappings, File
Handling, and Preview Mappings.
2. Navigate among the sections by clicking the section name in the list.
2. Enter an appropriate name for the ETL job, such as “EGX to PME Job 1.”
3. Click OK.
Refer to the EGX Device Log Export Settings you collected prior to installation to determine
how often new files arrive from the EGX devices.
5. Next to the EGX 300 File Directory box, click the Browse button and select the folder where
the EGX300 devices are exporting the CSV files.
6. Choose either the CSV or ZIP radio button. If reading files from an EGX300, click CSV. If read-
ing files from a Com'X 510, click ZIP.
7. Under ION Enterprise Data Database Connection, click Configure Connection to open the
SQL Server Configuration dialog.
8. Enter the server, database name, and authentication information for the ION_Data database.
11. Under ION Enterprise Network Database Connection, click Configure Connection.
12. Enter the server, database name, and authentication information for the ION_Network data-
base.
NOTE: The EGX300 File Directory must be created before you define the EGX300 or Com'X 510
sources.
2. From Source Time Zone, select the time zone that matches the UTC offset for the EGX300
or Com'X 510 sources being imported.
NOTE: Review the EGX Time Zone Parameters you collected prior to installation to
determine the time zone offset. You are limited to one time zone per job when editing jobs
using the EGX to ION Enterprise Configuration user interface.
The configuration tool performs a lookup of source names in the CSV or ZIP files in the
EGX300 File Directory.
You may be prompted for confirmation to proceed if the configuration tool detects a large
number of files in the input directory.
A status bar indicates the progress of the lookup. All discovered sources appear in the grid.
NOTE: The Configuration tool discovers sources only when CSV files for those sources are
in the EGX300 File Directory. Only devices on the supported device types list will be added
to the job. If sources are added to the EGX300 File Directory after you first run the tool, you
need to rerun it to permit discovery of the new files.
When importing data from a Twido PLC, refer to "Importing data from Twido PLCs to existing
logical devices" on page 37 for instructions on how to cause ETL to automatically discover
existing logical devices associated with the PLCs. These logical devices are configured in
the Power Monitoring Management Console component.
4. In the grid, fill in the ION Enterprise Group values for each EGX source:
a. Select a row in the grid for the source you want to update.
b. Click Edit ION Enterprise Group and enter the new group name in the text box dialog.
An ION Group name can be at most 90 characters in length and contain only alphanumeric
characters or underscores: a-z, A-Z, 0-9, __.
c. You can set the ION Enterprise Group value for multiple sources at once:
Select multiple rows with Shift-select or Ctrl-select and then click Edit ION Enterprise
Group.
NOTE: This is an important step as it allows you to give each source a unique name. Review
the group names you have chosen after filling them in. To avoid the need to correct source
names after they are created, it is recommended that you define the source names before the
job creates them in Power Monitoring Expert.
NOTE: Do not disable the file handling feature. File handling is a key feature of the ETL job and is
necessary to ensure proper behavior. The only reason to disable file handling is for troubleshooting
or test scenarios.
3. In the File Handling Strategy box, select the action to perform. See "File Handling" on page
26 for more information about the options.
NOTE: Any topics that are not on the supported topic list found in "Supported device types
and EGX topics" on page 29 will not be processed by the job. Be aware that if you choose to
delete files as part of your File Handling Strategy the data from these unsupported topics will
be lost. Also consider disk space if you choose to keep the files.
4. In the File Directory box, enter the folder or click the browse button to select the folder.
5. Under File Life Span, select the duration that the tool will keep files in the directory.
NOTE: Set the File Handling Strategy to “Move” if you want to keep all files that are
marked invalid. This strategy is useful for troubleshooting. It is not usually desirable to delete
invalid files, since you should investigate what caused them to be invalid.
8. Click Apply.
2. If any names are incorrect, click Source Mapping and change the names as appropriate.
1. Open TacticalSolutionsManager.
4. Select the load task. It will be one of Power Monitoring Expert Load Task or ION Enter-
prise Load Task V2.
The settings are in the Property grid at the right in the bottom-left pane.
5. Verify that the Enable Recorder and Channel Creation setting is set to False. If it is set to
True, change it to False.
2. Click Connections.
NOTE: The default logging options are appropriate for most installations. To customize the
logging options for the ETL job, refer to "Unsupported device types and EGX topics" on page
30.
4. Click OK to save the job. The configuration tool closes and the ETL job starts running as a
Windows service.
The ETL Engine processes the job and begins to move files to the valid folder you specified
above.
You should also be able to view the device data by creating Tabular and Load Profile reports
using the Reports application in the Web Applications component of Power Monitoring Expert.
Refer to the Web Applications online help for instructions about generating and viewing
reports.
NOTE: Do not run the Configuration tool and the Tactical Solutions Admin Tool simultaneously.
The user interface of the configuration tool contains four sections: Connections, Source
Mappings, File Handling and Preview Mappings. You can navigate among the sections by
clicking the section name in the list.
The following topics add more details about each section of the Configuration tool.
Connections
The Connections section deals with job management, such as where data is coming from and
where it is going.
Job Management
The first thing you should do is create a job file to store the configuration settings. This is done
through the job management controls at the top of the Connections section:
IMAGE
l Set the time between job runs. This corresponds to the length of time between job executions
when the job is run as a Windows Service.
By default the Windows Service for the job will not be started once the job editing has been
completed. This behavior can be controlled through the check box as shown:
EGX300 Data
Meter data is extracted from CSV files output by the EGX300. Before a job can run successfully,
the CSV drop file location must be specified:
l Authentication: Select the method to use. If using SQL Server Authentication, enter the User
Name and the Password.
NOTE: You should verify the connection string for the ION_Network database and the ION_Data
database before attempting to run the job.
Source Mappings
Source Mappings lets you add sources to the configuration, set the source time zone, and edit the
ION Enterprise group names and source names.
The configuration utility scans the EGX300 CSV File Directory configured in the Connections
section. This directory must be specified prior to clicking Add EGX Sources and CSV files from
the EGX300 device must be present in this directory.
The configuration tool adds sources for all the supported device types it finds and maps any
discovered EGX topics to their Power Monitoring Expert counterparts, if those topics are supported.
The configuration tool also enters suggested ION Source names.
If any ION Group names are missing, you must enter the name for each source prior to saving.
NOTE: The list of supported device types and supported topics are defined in "Supported device
types and EGX topics" on page 29. See "Unsupported device types and EGX topics" on page 30
for information on mapping unsupported devices and topics.
Indicator Meaning
Newly added row
Modified row.
When dealing with large mapping sets, you can filter the data by using the filters in the column
headers.
BCPM Devices
For BCPM devices, the configuration tool will automatically setup downstream sources for any
discovered circuits, if the circuits follow the naming convention “Circuit #”.
ION sources created for BCPM circuits have the suffix _1PH_Ch_ appended to their Power
Monitoring Expert source names. The main BCPM source has no suffix appended to its ION source
name.
Only the main BCPM sources are represented in the grid. You can view the linked circuit sources in
the Preview Mappings section.
If the source selected is a BCPM source, the editor updates the main source and the circuits
respectively. When you edit a BCPM source name, an alternative name editor appears showing the
generated main and circuit source names that will be created.
File Handling
During the ETL job run, the ETL Engine attempts to extract data from the EGX CSV files.
If the ETL Engine successfully extracted data without errors, the file is valid. Under normal
operating conditions the vast majority of EGX files should be valid.
If the ETL Engine did not successfully extract data, the file is invalid. Reasons for invalid files
include:
In the File Handling section, select the Enable Valid/Invalid File Handling option to force the
ETL Engine to perform additional processing on the files after the job run is complete.
If you enable file handling, the ETL Engine processes the files in the way that you define. Various
options for the File Handling Strategy exist, such as moving files to a specific folder or deleting
files. You can define one method for valid files and a different method for invalid files.
The following table explains the different options for the File Handling Strategy:
If you choose either “move” option, the ETL Engine can complete the next run more efficiently by
starting at the correct position without having to track too much state information.
Preview Mappings
Preview Mappings lets you inspect the full set of source quantity mappings the ETL job will
process.
The grid organizes the mappings according to the EGX source. If any circuit sources are present,
they are grouped underneath their main source.
Appendices
Appendix A: Default job settings
Many of the default settings for the Configuration tool are contained in the
EGX300ToIONEDefaultJobSettings.xml configuration file. By changing the settings in this
file you can change the behavior of the configuration tool and ultimately the underlying job.
EGX topics
Select the Device and Topic filter check boxes to display the devices on the supported device types
list. These devices will be added to a job configured in the supplemental UI. Device filtering is done
on Device Type ID.
When you edit a job in the Tactical Solutions Admin Tool (TacticalSolutionsManager.exe),
the quantity start name is on the Mappings tab in the bottom-right table. In the Source Quantity
Pairs section, the bottom-right table is labeled Associated Quantities, which contains a Start
Name column.
Quantity End Name: The name of the quantity as seen by the load task. In this case, Quantity End
Name refers to quantity names in Power Monitoring Expert.
When you edit a job in the Tactical Solutions Admin Tool (TacticalSolutionsManager.exe),
the quantity end name is on the Mappings tab in the bottom-right table. In the Source Quantity
Pairs section, the bottom-right table is labeled Associated Quantities, which contains an End
Name column.
2. Open the Tactical Solutions Admin Tool (TacticalSolutionsManager.exe) and edit the
job in question
4. in the bottom-left table, select the source row you want to work with.
The quantities associated with the source are shown in the bottom-right table.
These are the “parent” rows of the new mapping entries you are creating. (You can select
multiple rows by Ctrl+Click or Shift+Click on the row headers.)
6. Right-click one of the selected quantity rows to open the context menu and click Edit Quant-
ity End Name and Map to New Source.
The Bulk Add Downstream Mappings dialog opens. It shows the original source and quantity
start names. The New Source End Name and the New Quantity End Name are used for
new entries. The instructions at the top of the dialog provide information about its purpose.
7. Enter a value in each row under the New Source End Name column.
8. Enter a value in the Enter New Quantity End Name text box at the bottom of the dialog.
This is the quantity that you are targeting in Power Monitoring Expert.
9. Click OK.
New rows are added to the bottom-left table. These are “downstream” mapping rows that are
identified with an icon of two boxes connected by an arrow in the State field. The start names
in these rows link the child mapping row back to the parent mapping row. The end names
contain the names you entered in the dialog. No changes are required for these rows.
5. Right-click the selected quantity row and select Edit Quantity Name in the menu to open the
Edit Quantity End Name dialog.
NOTE: If a message indicates that there are unsaved mapping records in the job, go back
and proceed from step 2.
6. Determine which of the options Check for this Quantity Under Other Sources and Enforce
Rule: Quantity Names Must Be Unique within Each Source to select, based on the fol-
lowing considerations:
If you do not select this option, the dialog applies the Quantity End Name change only to
the selected quantity row. In this case, no other sources receive the quantity end name
change.
For Enforce Rule: Quantity End Names Must Be Unique within Each Source:
If you select this option, the dialog ensures that the same quantity end name appears only
one time within each source to which the rename operation applies.
If you do not select this option, the dialog allows multiple quantities within the same
source to have the same Quantity End Name.
The ETL Management tool is the full ETL User Interface for advanced users. The ETL Management
tool is a plug-in that runs in the Tactical Solutions Manager application.
NOTE: Do not open the ETL Management tool if you already have an ETL job open in the ETL
Configuration tool.
In the ETL Management tool, the Logging tab displays options on how the job will report various
messages such as error messages, warning messages, and trace messages
This will prevent the job from running as a service while you set the logging options.
3. Click OK to save the ETL job and close the configuration tool.
5. In the Job tab, select the ETL job that you want to edit, and then click Edit.
6. Select the Logging tab. This tab lists the logging options you can select for the ETL job.
7. Review the logging options and make changes as appropriate. Each option is explained
below.
In most cases, the Error Log and Windows Event Log are sufficient and the other logging
features can be ignored. Refer to the following section for details on each logging option.
8. After you configure the logging options, click OK to save the ETL job. This is the quantity that
you are targeting in Power Monitoring Expert.
Trace Log
The trace log feature is available for any ETL job. When enabled, this feature writes detailed trace
information to the trace.log file. This information includes how many source quantity pairs were
processed during the last run, and a count of data records for each pair.
Enabling this setting can slow down job performance in some cases. If the job has an extremely
large number of pairs to process, or if you do not require such detailed trace logging, then you can
leave this feature disabled.
The Data Trace Enabled option is useful in troubleshooting scenarios, or when verifying the correct
operation of a recently created ETL job. It does slow down job performance and should be disabled
under normal operating conditions.
When enabled, the Data Trace feature creates HTML files that show each pair and each data record
processed by the tasks in the ETL job. These HTML files appear in a job-specific sub-folder under
the DataTrace folder. The ETL Engine creates the DataTrace folder automatically in the ETL root
when the feature runs for the first time.
Error Log
ETL jobs report errors during execution to the error.log file. By default, this file is located in the Log
sub-folder under the ETL root folder. You can customize this location for each ETL job.
Multiple ETL jobs can report to the same error.log file. If this is undesired behavior, be sure to give
each ETL job its own error.log file using the settings shown next.
You can also specify other error log settings, such as a maximum log file size.
It is recommended to leave the Error Log feature enabled for all ETL jobs.
The Windows Event Logging feature is recommended in most cases. The Windows Event Log is a
well known location that many administrators are familiar with outside of ETL.
Of course this decision will come down to the specific needs of the installation, and the users that
will be examining the Windows Event Log on a regular basis. Enable or disable this feature as
appropriate.
This section describes how to schedule an existing ETL job to run in an unattended and repeated
fashion, or by running the ETL job from the command line.
Advantages:
This is desirable in cases where the administrator is already managing other services for related
systems.
Disadvantages:
l Very few scheduling features are available. The only configurable option in terms of scheduling
is the sleep time between executions.
l The service does not perform a true periodic execution of the job.
Each single run of the job takes a variable amount of time depending on many factors, such as
how much data it needs to process, or how much activity is taking place on the server during
the job run. The sleep time is fixed. This means that for each run the start time for the job drifts.
This may be undesirable in situations where you need to be sure that the job starts at a specific
time each day.
Running the ETL job as a service may not be optimal when you have many different ETL jobs. The
service remains in memory even when the underlying job is sleeping.
Running the ETL job as a batch file using Windows Task Scheduler
Create a batch file and use Windows Task Scheduler to schedule when the ETL job runs. The batch
file contains the command line entry to run the job.
Advantage:
l The scheduled task performs a true periodic execution of the job. Windows Task Scheduler
allows you to schedule the job to start at precise times.
Disadvantages:
l It is more difficult to set up than the services option because you must create and test the batch
file before scheduling it. There is currently no built-in feature to create a batch file automatically
for the job.
l You must have a fully configured ETL job that runs successfully. Follow these steps if you want
to run the ETL job using the Windows Task Scheduler.
1. Use your favorite text editor and create a command line batch file (.bat) that executes the ETL
job once (using the –SingleRun option).
Optional: View the list of available ETLEngine commands by entering the following:
ETLEngine.exe -?
Run your ETL job once using the following as an example, and substitute your ETL job’s
name:
ETLEngine.exe -SingleRun -job enterjobnamehere
NOTE: Your job name is listed on the Job tab in the ETL Administration Tool. If your job
name contains spaces, enclose the job name in double quotes on the command line.
3. After you determine the correct command line arguments to use, create a batch file containing
the full command.
Schedule that batch file for repeated execution using Windows Task Scheduler. Refer to the
Windows Task Scheduler documentation for details.
l Processing CSV files from a new serial device added to an existing EGX300.
l Processing data from newly added topics on a device that is known to ETL.
3. Open the Source Mappings section and click Add EGX Sources.
The Configuration tool examines all CSV files in the input directory and adds any new sources
of the supported device type.
All existing mapping information remains intact. The only change will be new mapping
information added.
4. Click Preview Mappings and confirm the new sources or topics are added to the ETL job.
For example, if you have configured your ETL job to use a Time Between Job Runs setting of one
day or less, it’s useful to know the total size of one day’s worth of CSV files sent by all EGX300
devices in your system.
The total size of a day’s worth of data can vary depending on how many topics are logged for each
device, and how many devices are connected to each EGX.
The best way to determine the total size in a time interval is to browse to the EGX300 File Directory
and examine the total size using Windows Explorer. Using the example above, do so after at least a
day’s worth of data has been sent to this directory by the EGX300 devices.
Be sure that there is enough free space on the hard drive containing the EGX300 File Directory to
allow for reasonably expected downtime, should someone manually stop the ETL service.
Reasonably expected downtime should be determined by the application engineer deploying the
product based on knowledge of the particular site.
NOTE: It is not recommended behavior to stop the ETL service, but it is good practice to setup
your server to allow for that case.
Also note that all components of the EGX300 to Power Monitoring Expert solution require server
resources (CPU and memory)to operate. The degree to which the components use these resources
can vary depending on the configuration settings you choose, including but not limited to the
following settings: logging frequency, and export frequency on the EGX300 and Time Between Job
Runs and start time in your ETL job.
It is important for the application engineer deploying the system to be aware of other activity on the
server hosting the EGX300 to Power Monitoring Expert ETL software. The application engineer can
use this information to configure the software appropriately and in a way that fits the installation.
To allow for this automatic detection functionality, several prerequisites must be satisfied:
l The EGX that is logging data on behalf of the Twido PLC must be added to Management Con-
sole as a Site. It must be fully configured and given the correct IP address
l The Twido PLC must be added to Management Console as a Serial Device on Ethernet Gate-
way site, and it must be fully configured and given the correct Unit ID. Its Site must be set to
the EGX site described above.
l A logical device is created in Management Console that includes an input register from the
Twido PLC. Refer to Power Monitoring Expert documentation for instructions on how to create
logical devices.
l Each Twido input must be a part of no more than one logical device. The scenario of a Twido
input being part of more than one logical device is not supported in the current version of the
EGX300 ETL package.
l The Twido’s “Weighted Input” topics must be enabled in the EGX300’s Device Logging page.
The recommended practice is to enable all Twido weighted inputs to allow for an easier work-
flow if the logical device configuration changes in the future.
l At least one CSV file containing data for the Twido must have arrived in the EGX300 File Dir-
ectory.
Once those prerequisites have been met, ETL will automatically discover the source and
measurement associated with the Twido inputs that appear in the incoming CSV files.
This automatic discovery happens during the "Source Mappings – Define EGX sources" on page 17
configuration steps.
In the EGX300 To EcoStruxure Power Monitoring Expert Configuration tool, each Twido with a
known logical device association will appear as a single row in the Source Mappings grid. This is
true even if the Twido’s weighted inputs are assigned to multiple different logical devices in
Management Console. The Preview Mappings grid displays a detailed view of each Twido
including:
l The EGX device and topic identifiers associated with each weighted input.
l The Power Monitoring Expert source and measurement associated with each weighted input.