Ecostruxure™ Power Monitoring Expert 9.0: Etl For 3Rd Party Billing - Administration Guide

EcoStruxure™ Power Monitoring Expert 9.
0
ETL for 3rd Party Billing – Administration Guide
7EN42-0170-00
08/2018
Legal Information
The Schneider Electric brand and any registered trademarks of Schneider Electric Industries SAS
referred to in this guide are the sole property of Schneider Electric SA and its subsidiaries. They
may not be used for any purpose without the owner's permission, given in writing. This guide and its
content are protected, within the meaning of the French intellectual property code (Code de la
propriété intellectuelle français, referred to hereafter as "the Code"), under the laws of copyright
covering texts, drawings and models, as well as by trademark law. You agree not to reproduce,
other than for your own personal, noncommercial use as defined in the Code, all or part of this guide
on any medium whatsoever without Schneider Electric's permission, given in writing. You also
agree not to establish any hypertext links to this guide or its content. Schneider Electric does not
grant any right or license for the personal and noncommercial use of the guide or its content, except
for a non-exclusive license to consult it on an "as is" basis, at your own risk. All other rights are
reserved.
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.
The addition of either symbol to a "Danger" or "Warning" safety label

indicates that an electrical hazard exists which will result in personal injury if
the instructions are not followed.
This is the safety alert symbol. It is used to alert you to potential personal
injury hazards. Obey all safety messages that follow this symbol to avoid
possible injury or death.
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.
Contents
Safety Precautions 5
ETL for 3rd Party Billing 6
Installing the ETL Administration Tool 7
Before using the ETL Administration Tool 8
ETL jobs 9
Opening the ETL Administration Tool 9
Creating a third party billing ETL job 9
Configuring the billing extract task 11
Configuring the billing load task 12
Configuring ETL for Third Party Billing mapping 13
Initializing the position counters 14
Resetting and resending the data (optional) 15
Running the ETL job as a Windows Service 16
Running the ETL job as a batch file using Windows Task Scheduler 17
Running the ETL job using the command line 18
Manage ETL jobs 19
Enabling ETL logging 19
Confirming the ETL job 19
Cloning an ETL job 19
Renaming an ETL job 20
Removing a task from an ETL job 20
Switching between ETL jobs 20
Page 4 CONTROLLED DISTRIBUTION 7EN42-0170-00

ETL for 3rd Party Billing – Administration Guide Safety Precautions
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.
Work with facility IT System Administrators to ensure that the system adheres to the site-specific
cybersecurity policies.
7EN42-0170-00 CONTROLLED DISTRIBUTION Page 5

ETL for 3rd Party Billing ETL for 3rd Party Billing – Administration Guide
ETL for 3rd Party Billing

The Extract Transform Load (ETL) Administration Tool transfers data from one application to
another using an ETL job.
ETL for Third Party Billing extracts data from Power Monitoring Expert and then transforms it into a
format that can be loaded into a third party billing application.
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.

ETL for 3rd Party Billing – Administration Guide Installing the ETL Administration Tool
Installing the ETL Administration Tool

NOTE: Install the ETL Administration Tool on the Power Monitoring Expert server using a
Windows Administrator account.
To install ETL for third party billing:
1. Download ETL: PME 9.0 DC Edition Billing Export from the PME Exchange Community.
2. (Optional) Depending on your system, before you can extract the ZIP file you might need to
mark the ZIP file as "trusted".
a. Right-click the ZIP file and click Properties > General.
b. Click Unblock and then OK.
3. Extract the package locally to your server.
4. Double-click SegApps_ETL_DC_Billing-xxx.exe.
(Where xxx is the build number.)
5. Application Language: Select English and then click Next.
NOTE: The ETL Administration Tool supports English only.
6. Welcome: Review the steps and click Next.
7. License Agreement: Read the End User License Agreement and if you accept the terms of
the agreement, click I Agree to proceed.
8. Setup Type: ETL: PME 9.0 DC Billing Export can only be installed with the Standalone
Server option. Click Next.
9. File Destination: Click Next to install the ETL tool to the default location. To select a different
location, click the ellipsis button and then select a new location. Click OK.
10. Check System: The installer checks the operating system. If a condition affecting installation
is detected, the installer notifies you to correct it. When verification is successful, click Next.
11. Ready to Configure: A summary of your configuration choices for the installation. Ensure
that all items are correct before proceeding.
12. Click Install to continue or click Back to move back through the installer and change any
items.
The Copy Files screen appears and the ETL files are copied to the system.
13. Configure System: The selected configuration settings are applied.
14. Click Next.
15. Complete: The Complete page appears after the install is successful. Click Installation Log
to view details recorded for the installation process.
16. Click Close to finish.

Before using the ETL Administration Tool ETL for 3rd Party Billing – Administration Guide
Before using the ETL Administration Tool

Before using the ETL Administration Tool for Third Party Billing, ensure the following:
l ETL is properly installed.
l All devices have been added to the system.
l Install and configure a data center hierarchy template.

ETL for 3rd Party Billing – Administration Guide ETL jobs
ETL jobs
Opening the ETL Administration Tool
NOTE: On Windows Operating Systems with restricted permissions, the ETL tool might not
initialize and load its plugins on start up. This is due to limited write permission on the ETL install
folder (for example: C:\Program Files\). The workaround is to install ETL to a custom folder
with write permission.
To open the ETL Administration Tool:
1. Double-click the ETL desktop shortcut. Depending on your operation system, you can also
open the ETL Administration Tool from the Start menu or by typing the name of the ETL.
The ETL Administration Tool opens:
Creating a third party billing ETL job

A third party billing ETL job consists of an extract and load task. You must add these tasks to the
third party billing ETL job.
To create a third party billing ETL job:
1. In the ETL for Data Centers (Billing Export), click New.
The Job page appears.
2. Enter the name of the job in the Name field.

ETL jobs ETL for 3rd Party Billing – Administration Guide
NOTE: The ETL job name has to be unique. Power Monitoring Expert can use several
different ETL release packages; make sure your ETL job name does not conflict with any
other ETL jobs on your system. This is particularly important to consider when registering
ETL jobs to run as Windows services.
3. (Optional) If you are running the job as a service, review the value for the Sleep Time
Between Execution. This value determines the length of time between ETL jobs when they
run as a service.
4. Click the Tasks tab.
The Tasks page appears.
5. From Select Category select Extract.
6. From Select Type select Energy by IT Customer Extract Task.
7. Click Add.
The Energy by IT Customer Extract Task appears under the Extract heading.
8. Configure the extract task settings. See "Configuring the billing extract task" on page 11 for
details.
9. From Select Category select Load.
10. From Select Type select EnergyCapPairsLoadTask.
11. Click Add.
The EnergyCapPairsLoadTask appears under the Load heading.

12. Configure the Load Task settings. See "Configuring the billing load task" on page 12 for
details.
13. Click Apply to save without exiting the job, or click OK to save and exit the job.
Configuring the billing extract task

Configure the extract task after you add it to the ETL job. Click the extract task to bring up the list of
configurable settings. Click on each setting name to change the value. Some settings are
configured by typing in a value, while others are configured by selecting an option from a drop-down
list.
Setting Parameters /
Setting Name Description
Recommended Values
Automatic Billing Export
The number of hours to wait
after the end of the billing Enter whole number value 0 or
Export Delay (Hours)
period before performing an higher.
export.
The maximum number of billing
Maximum billing periods per Enter whole number value
periods, per source that are
export greater than 0
exported in a single ETL run
Extract
The day of the month that
starts the billing period, if billing
Billing Day of the Month Enter number between 1-31.
period is monthly (Value is
between 1-31).

Recommended Values
The hour of the day the billing
period starts (Value is between
Enter the hour. Use decimal
Billing Hour of the Day 0-23). Partial hours can use a
value for partial hours.
decimal value (for example,
10.5 represents 10:30)
Billing interval is either monthly
or daily. The value is Select Monthly or Daily from
Billing Interval
aggregated up to the billing the drop-down list
interval.
Sets the task mode. Manual
billing uses the Manual Billing Use the Manual Export to rerun
Export settings and position a bill, use the Automatic export
counters are not updated. to automatically export a bill on
Export Mode
Automatic mode uses a monthly basis. Select
Automatic Billing Export Manual or Automatic from the
Settings and position counters drop-down list.
are updated.
Manual Billing Export
The number of billing periods
Number of Billing Periods to Enter whole number, greater
(days or months) to export,
Export than zero
beginning at the Start Date.
Sets the start the range to
Enter date in YYYY-MM-DD
Start Date export in local time. This is an
format.
optional setting.
Misc
Extract and Load
Normally left on the
ThreadingMode ThreadingMode entries must
MultipleSQPairsPerThread
match.
Configuring the billing load task

After adding the EnergyCapPairsLoadTask, it must be configured. Click the load task to display the
list of configurable settings. Click on each description name to change the value. Some settings are
configured by typing a value, while others are configured by selecting an option from a drop-down
list.
The following table lists the name, description, and the setting parameters or recommended value
for each load task setting:
Recommended Setting
CSV Load

Recommended Setting
Include a header row with
Select True or False from drop-
Header Row standard names as part of the
down list.
CSV file.
Enter save location or click […]
Primary path to save the output
Primary Drop Box to browse for the location
to.
folder.
Enter save location or click […]
Secondary path to save a copy
Secondary Drop Box to browse for the location
of the output to
folder.
Select True or False from
Use UTC Date Output the dates in UTC format
drop-down list.
Misc
Load and Extract
ThreadingMode ThreadingMode entries must
match.
Configuring ETL for Third Party Billing mapping

The Mappings pane is used to determine which sources and quantities the ETL job should process
from the extract data store and which sources and measurements should receive that data in the
load data store.
The mapping process:
1. Retrieves the list of sources and quantities in the extract data store.
2. Maps these source quantity pairs to the load data store.
3. Adds the selected sources and quantities to the source quantity pairs grid.
To configure ETL for third party billing mapping:
1. Click the Mappings tab.
The Mappings page appears.

2. Under the Automatic Population heading, select the Use list of sources (allows aliasing)
option and click Populate.
This displays a list of customers under the Source Mappings section, and the three topics
(Consumption, Demand, and Current) in the Quantity Mappings section.
3. Select the customers to export, along with the topics, and click Add Selected Pairs. You can
also click Recommend Pairs to select all customers.
Consumption and Demand topics should always be selected, while the Current topic is optional. If
the Consumption and Demand topics are not selected, the export will not succeed.
Initializing the position counters

Position counters keep track of the data that is extracted from the source data store and then loaded
into the target data store. Each tag specified in ETL has a position counter associated with it. The
position counter represents a timestamp of the most recent data point loaded for each tag. When
ETL is run, only data after this timestamp value is extracted from the source data store.
1. Click the Positions tab.
The Mappings page appears.
2. Set the Initial Value to the date in the first billing period you want to export using the YYY-
MM-DD date format.
3. Click Initialize.

You should see a row for each customer selected in the Mappings panel. The Key is a long string
that represents the customer node in the hierarchy.
Resetting and resending the data (optional)

If you need to re-extract previously extracted data, or if you want to load data after a specific date,
you can manually update the position counter. Otherwise, manually updating the position counter is
not necessary.
To reset and resend mapped data:
1. Enter a specific value in the text box to set all position counters.
2. Click Initialize. Mapped data appear with associated timestamp data for each.
Now, the next time you run ETL, only data after the given timestamp is loaded.
You can run an ETL job by:
l Running the job as a Windows service. This is the default method.
l Running the job as a batch file using Windows Task Scheduler.
l Running the job from the command line.
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.

Running the ETL job as a Windows Service ETL for 3rd Party Billing – Administration Guide
Running the ETL job as a Windows Service

This is the default method and is appropriate for most installations. The ETL Administration Tool
provides a built-in way to create a Windows service from the ETL job. The ETL job runs and then
waits for a configurable duration before it runs again. You can define the amount of time between
each run.
Advantages:
l The ETL Administration Tool simplifies setting up the service.
l The ETL service appears in the Windows Services console.
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.

ETL for 3rd Party Billing – Administration Guide Running the ETL job as a batch file using Windows Task Scheduler
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.
To create the batch file:
1. Use your favorite text editor and create a command line batch file (.bat) that executes the ETL
job once (using the –SingleRun option).
2. To determine what to put in your batch file:

Try running your ETL job from the command line. Open a command prompt, and change
directories to your ETL Engine’s bin folder.
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.

Running the ETL job using the command line ETL for 3rd Party Billing – Administration Guide
Running the ETL job using the command line

The syntax for running an ETL job from a command line is:
ETLEngine.exe [OPTION] -Job JobName
Where OPTION can be one of the following values:
-?, -help Prints a help message and exits.

-SingleRun Performs one single run of processing and exits.
-Service Registers a specific job as a Windows service.
-UnregService Unregisters the service associated with a specific job.
-WaitSingleRun Useful for debugging only.

ETL for 3rd Party Billing – Administration Guide Manage ETL jobs
Manage ETL jobs

You can set up logging to help manage ETL jobs. You can also switch between ETL jobs, change
the order of ETL tasks, and remove ETL tasks from an ETL job.
Enabling ETL logging

Logging lets you enable the various logs where ETL writes the information regarding the status of
your ETL job. These logs can assist in tracking down the cause of an unsuccessful ETL job.
To enable the ETL logs:
1. Open the ETL Administration Tool.
2. In the Job Management list click the applicable ETL job and then click Edit.
3. Click the Logging tab. The Logging panel appears.
4. For Trace Log, Error Log, and Customer Log, click Enabled as required.
5. (Optional) Provide the location for the log file in the Log File field, or leave at the default loc-
ation.
6. (Optional) Set the Maximum Log File Size and Maximum Log Files for each log, or leave at
the default settings.
7. (Optional) Select the Enabled check box for Email Notifications and complete the fields for:
To Email Address, From Email Address, and SMTP Server Address.
8. Click OK when finished to exit the job.
After you run an ETL job, the Job Execution Complete dialog appears. You can click Open Log
Folder to review the log files.
Confirming the ETL job

If the ETL Administration Tool returns a Job execution failed message, click Open Log Folder to
open the error log. Locate the timestamp that corresponds to your job and review the log. Based on
this information, make the appropriate changes to the job and run the job again.
Cloning an ETL job

When creating a new job in ETL, you can clone an existing ETL job.
To clone an ETL job:
2. In the Job panel, change the name to define the new ETL job.
3. Click the Task tab and then edit the new ETL job as necessary.
4. Click Apply or OK.
The ETL job saves with the new name. Sources and quantities are carried over from the original ETL
job. It is recommended that you clear the mappings from the cloned ETL job.

Manage ETL jobs ETL for 3rd Party Billing – Administration Guide
Renaming an ETL job
1. In the Job Management list click an existing ETL job.
2. Click Edit.
3. In the Job panel, change the name to define the new ETL job.
4. Click OK.
5. (Optional) In the Job Management list, click the original ETL job and then click Delete.
Removing a task from an ETL job

2. Click the Tasks tab.
3. Highlight the task that you want to remove from the left pane.
4. Click Delete
5. Click OK to save and exit the job.
Switching between ETL jobs

1. Click OK at the bottom right to save and exit the current job.
2. In the Job Management list select an ETL job and click Edit.

EcoStruxure™ Power Monitoring Expert 9.0
ION, ION Enterprise, Modbus, PowerLogic, EcoStruxure and

Schneider Electric are either trademarks or registered
trademarks of Schneider Electric in France, the USA and other
countries. Other trademarks used are the property of their
respective owners.
Electrical equipment should be installed, operated, serviced and
maintained only by qualified personnel. No responsibility is
assumed by Schneider Electric for any consequences arising
Schneider Electric out of the use of this material.
35 rue Joseph Monier
92500 Rueil Malmaison - France 7EN42-0170-00
www.schneider-electric.com © 2018 Schneider Electric. All Rights Reserved.

Ecostruxure™ Power Monitoring Expert 9.0: Etl For 3Rd Party Billing - Administration Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Ecostruxure™ Power Monitoring Expert 9.0: Etl For 3Rd Party Billing - Administration Guide

Uploaded by

Copyright:

Available Formats

EcoStruxure™ Power Monitoring Expert 9.

The addition of either symbol to a "Danger" or "Warning" safety label

Page 4 CONTROLLED DISTRIBUTION 7EN42-0170-00

7EN42-0170-00 CONTROLLED DISTRIBUTION Page 5

ETL for 3rd Party Billing

Page 6 CONTROLLED DISTRIBUTION 7EN42-0170-00

Installing the ETL Administration Tool

To install ETL for third party billing:

b. Click Unblock and then OK.

3. Extract the package locally to your server.

(Where xxx is the build number.)

5. Application Language: Select English and then click Next.

NOTE: The ETL Administration Tool supports English only.

6. Welcome: Review the steps and click Next.

13. Configure System: The selected configuration settings are applied.

14. Click Next.

16. Click Close to finish.

7EN42-0170-00 CONTROLLED DISTRIBUTION Page 7

Before using the ETL Administration Tool

l ETL is properly installed.

l All devices have been added to the system.

l Install and configure a data center hierarchy template.

Page 8 CONTROLLED DISTRIBUTION 7EN42-0170-00

To open the ETL Administration Tool:

The ETL Administration Tool opens:

Creating a third party billing ETL job

1. In the ETL for Data Centers (Billing Export), click New.

The Job page appears.

2. Enter the name of the job in the Name field.

7EN42-0170-00 CONTROLLED DISTRIBUTION Page 9

4. Click the Tasks tab.

The Tasks page appears.

5. From Select Category select Extract.

6. From Select Type select Energy by IT Customer Extract Task.

9. From Select Category select Load.

10. From Select Type select EnergyCapPairsLoadTask.

11. Click Add.

The EnergyCapPairsLoadTask appears under the Load heading.

Page 10 CONTROLLED DISTRIBUTION 7EN42-0170-00

Configuring the billing extract task

7EN42-0170-00 CONTROLLED DISTRIBUTION Page 11

Configuring the billing load task

Page 12 CONTROLLED DISTRIBUTION 7EN42-0170-00

Configuring ETL for Third Party Billing mapping

2. Maps these source quantity pairs to the load data store.

To configure ETL for third party billing mapping:

1. Click the Mappings tab.

The Mappings page appears.

7EN42-0170-00 CONTROLLED DISTRIBUTION Page 13

Initializing the position counters

1. Click the Positions tab.

The Mappings page appears.

Page 14 CONTROLLED DISTRIBUTION 7EN42-0170-00

Resetting and resending the data (optional)

To reset and resend mapped data:

You can run an ETL job by:

l Running the job as a Windows service. This is the default method.

l Running the job as a batch file using Windows Task Scheduler.

l Running the job from the command line.

7EN42-0170-00 CONTROLLED DISTRIBUTION Page 15

Running the ETL job as a Windows Service

l The ETL Administration Tool simplifies setting up the service.

l The ETL service appears in the Windows Services console.