pulse historian guide

8/16/2019 Pulse Historian Guide

1/17

Pulse Historian - Data Logger

Pulse 3SCADA/HMI

Pulse Historian

Data Logger

August 2014


2/17

Pulse Historian - Data Logger

Copyright

The information in this document is subject to change without prior notice and does not

represent a commitment on the part of AFCON Control and Automation Ltd., AFCONSoftware and Electronics Division.

No part of this document may be used or reproduced in any manner whatsoever withoutwritten permission from AFCON Control and Automation Ltd., AFCON Software andElectronics Division.

The software described in this document is furnished under a license agreement or a non-disclosure agreement.

The software may be used or copied only in accordance with the terms of the agreement.It is against the law to copy this software on any other medium for any purpose other than

the purchaser's personal use.

Copyright© 2014 AFCON Control and Automation Ltd., AFCON Software and ElectronicsDivision.

All rights reserved.

Pulse logos are registered trademarks of AFCON Control and Automation Ltd., AFCONSoftware and Electronics Division.

Windows

®

is a registered trademark of Microsoft Corporation in the United States and othercountries.


3/17

Pulse Historian - Data Logger 3

Table of Contents

Copyright.......................................................................................................2Pulse Data Logger..............................................................................................4

Data Logger Functionality.................................................................................4Data Logger Groups ........................................................................................4

Historical Group............................................................................... 4Report Group .................................................................................. 4

Activating the Data Logger ...............................................................................5Historical Data Collection for Database Blocks .....................................................6

Enabling Historical Data Collection .....................................................6Historical Logger Groups ..................................................................................7

Creating a Historical Logger Group .....................................................7Report Logger Groups.................................................................................... 10

Creating a Report Logger Group....................................................... 10Viewing the Historical and Report Logger Groups from the Item Manager

Window ................................................................................... 16


4/17


Pulse Data Logger

The Pulse Data Logger collects any item data and saves it to a compatible user databaseor to a spreadsheet such as Microsoft Excel. The data is collected through triggered or timeevents. It can then be retrieved from the database using standard SQL queries, which canbe used by the user for multiple purposes.

The Data Logger can be used as follows:

Generating reports

Creating graphs

Creating table lists, etc.

Data Logger FunctionalityThe user can gain multiple benefits from the Data Logger functionality:

Historical and report groups can be set from the Pulse Client within the DeveloperWorkstation.

Historical data (i.e., direct addresses) can be collected from any item and not just forblocks.

Users can save their data to external databases or spreadsheets and may use thirdparty applications to retrieve specific data.

Data Logger Groups

There are two types of Data Logger groups:

Historical Group

Report Group

Historical Group

The Historical Group data is logged to a pre-defined Pulse database. The user can definemultiple Historical groups and multiple tags added to each group. The collection of data isinitiated by pre-defining a logging function such as time intervals, value change and otherfunctions.

Items that are set in a Historical group are automatically integrated as groups in HistoricalTrends.

Report Group

The Report Group data is logged to a user-defined database. The user can define multipleReport groups and multiple tags added to each group. The data is collected by setting up

Item tags and then defining one or multiple triggers to initiate the collection. The triggermodes can be data capture at a certain scheduled time, change in value or a specific event.


5/17


Activating the Data Logger

When the Data Logger is enabled, it allows the user to save History data to any compatibleuser database or to a form of spreadsheet instead of just the default .HIS files used in priorversions of Pulse.

To activate the Data Logger functionality:

1 Open Project Setup and create a new project where you want to run the Data Loggeror select an existing project.

2 Set the new project as the default project.

3 Go to PCIM-Software > PCIM[x.x] > Projects > [Project Name - for DataLogger] > Settings > Historical Data > Historical Data - Enable Collection.

The Historical Data - Enable Collection window is displayed.

4 Select Data Logger History Enabled from the Enable Historical Data Collection drop-down list.

The Data Logger is enabled for the selected project. The Data Logger only collects datato a database or to spreadsheet from the moment this option is set.


6/17


Historical Data Collection for Database Blocks

The collected and saved of History values are saved to the default Pulse database.

Historical data collection can be used with the following blocks for previous and present

versions of Pulse:

Analog Value

Digital Value

Calculation

Boolean

Enabling Historical Data Collection

To enable Historical data collection

1 Log into the Developer Workstation and go to the Database Explorer.

2 Create a new block by right-clicking on a block type and selecting New Block from thepop-up menu

or

use a block that was previously created.

Collecting historical data can also be applied to old blocks but they have to beconfigured to do so first. Previous history are not migrated.

3 In the Create New dialog box, define the block parameters.

4 Click to select the Enable History checkbox option in the History area to enablecollecting historical data from the block.

When enabling the History option for an Analog Value or Calculation block, the user canalso define the following parameters otherwise default values are set:

Logging Interval - The time interval between data recordings

Logging Dead Band - The range of the value the user sets that is

considered as a 'dead band'. The dead band is the value range that is notlogged.

For example, if the value set by the user is '1', then the data recorded is from'2' or '-1', values like .5 or 1.5 are not logged.

Use Logging Average - Select this checkbox option to display the averagelog value between the logging intervals.


7/17


Historical Logger Groups

The Historical Logger Group is defined from the Pulse Developer Workstation. The user candefine a historical group collection for a specific set of items that can be used in HistoricalTrends (Historical Trend Graphs and Smart Information) or any third party application forvarious purposes. Any item's history data can be collected without the need for blocks, i.e.,direct addresses.

Creating a Historical Logger Group

To create a Historical Logger Group

1 Go to the Data Logger Explorer and expand the Groups folder.

2 Create a new Historical group by going to the tree and right-clicking on Groups >Historical and selecting New from the pop-up menu option.

The Historical Logger Group dialog box is displayed. It consists of the General andTags tabs. The user can set the actions and values range in the General tab and setthe tag parameters in the Tags tab.


8/17


3 Enter a description for the Historical Logger Group in the Description field.

4 Define the following parameters in the General tab:

Log On Failed checkbox - Select this Action option to log when a failure isrecorded.

Action On Failed - Set the required action from the Action Selector whena failure is recorded.

Enable Log Values Range checkbox - Select this checkbox option toenable the parameters for logging the values that are within or out of range.

Log In Range - Select this option to log values that are within the specifiedrange; this parameter is only active when the Enable Log Values Range option is selected.

Log Out of Range - Select this option to log the values that are out of thespecified range; this parameter is only active when the Enable Log ValuesRange option is selected.

From - Provide the lowest value in this field.

To - Provide the highest value in this field.

5 Define the following parameters in the Tags tab:

Dead Band - Data Logger only logs the value when it is equal or greaterthan the dead band value.

Logging Function drop-down list - Select the AnyChange, CurrentValue,Average, Lowest, or Highest option from the drop-down list.


9/17


When the CurrentValue, Average, Lowest, or Highest option is selected,the Logging Interval parameter is displayed.

Logging Interval - Define the logging interval period between loggingsessions.

Import from TSV button - Click this button to browse for the *.tsv file toimport.

Export to TSV button - Click this button to export the list to a *.tsv file.

Tag Name - The name of the tag.

Address - The address designated to the tag, i.e., AV1 or 1:1:40001.

Description - Provide a tag description.


10/17


Report Logger Groups

Report logger are defined from the Pulse Developer Workstation. The user can define aReport group collection for a specific set of items, save the data to any user-defineddatabase or spreadsheet that can be used by any third party application for various uses.

Item history data are collected for blocks and for other items such as direct addresses.

Creating a Report Logger Group

To create a Report Logger Group

1 Go to the Data Logger Groups tree, right-click on Reports and select New from thepop-up menu.

The Report Logger Group dialog box is displayed.

2 Enter a description for the Report Logger Group in the Description field.

The Report Logger Group dialog box consists of the following tabs:

General tab - Where the general parameters such as timeouts, description,actions and log parameters are defined.

Triggers tab - Where triggers and their parameters are defined.

Connection tab - Provide the connection parameters here.

Tags tab - Define the tag and tag parameters here.

3 Define the following parameters in the General tab:

Tags Timeout (0 - 60 seconds) - Provide the timeout period for the taghere.

Tags Loading Wait (0 - 60 seconds) - Provide the waiting time whenloading a tag in this field.

Load Tags before Report checkbox - Check this option to load tag databefore capturing the report tag values.

Log on Success checkbox - Select this Action option to log the successfulevent to the Data Logger event log.

Action on Success - Set an action to execute, from the Action Selectorwhen an event is successful.

Log on Failed checkbox - Select this Action option to log a failed event tothe event log.

Action on Failed - Set an action to execute from the Action Selector whena failure is recorded.

Log on Timeout checkbox - Select this Action option to log on a timeoutevent to the event log.


11/17


Action on Timeout - Set an action to execute from the Action Selector when a timeout is recorded.

4 Define the following parameters in the Triggers tab:

The collection of data is initiated by triggers. The Triggers tab is used to add and

specify the trigger's mode and properties to initiate the collection of data.


12/17


Trigger Name - The name of the Report trigger; the name is unique to eachgroup.

Trigger Mode - Select BySchedule, ByItemChange or ByEvent from thedrop-down list.

a.) Define the following parameters when the BySchedule option is selected:

Starts on Pulse Startup - Select this option to activate the trigger for theData Logger Report during Pulse startup.

Start at - Select this option and set the time schedule when the Data LoggerReport should start collecting data.

End Time - Set the time schedule when the Data Logger Report should end

logging data, if no end time is selected, the data is only logged at start time.

Select the day(s) when the Data Logger Report trigger is activated byclicking on the day of the corresponding checkbox(es): Sunday, Monday,Tuesday, Wednesday, Thursday, Friday, Saturday

Repeat Task Every checkbox - select this option to repeat the triggeraccording to the frequency set on the drop-down list (from 1 to 60) andselect the type of frequency time, i.e., by seconds, minutes or hours

b.) If ByItemChange is selected as the Trigger Mode, then the Data Logger Reportis triggered when the specified tag item value is changed.

c.) If ByEvent is selected as the Trigger Mode, then the Data Logger Report istriggered when an event occurs. Define the following parameters for this mode:

Event Mode - Select ByAnyChange, FromZeroToAny, orFromAnyToZero from the drop-down list to set the type of trigger for theevent mode.

Event Expression - Define the expression for the event.

Skip First Trigger Data checkbox - Click to select this checkbox option tocause Pulse to skip the first event Report trigger


13/17


5 Define the following parameters in the Connection tab:

Provider - Select one of the following type of database connection from thedrop-down list:

When SQL is selected, define the following parameters:

Data Source - Define the path of the data source location.

User - Enter the SQL user name.

Password - Enter the SQL password, the entry appears in asterisks.

SQL Structured Query Language, the programminglanguage for managing data held in RelationalDatabase Management System

Access A Microsoft Office data management system thatstores data in its own format based on the AccessJet Database Engine. It can import or link directly todata stored in the Pulse application and database

Oracle An object-relational database management system

ODBC Open Database Connectivity - accesses any userdefined Pulse database management system

CSV Comma-Separated Values - stores tabular data(numbers and text) in plain text form


14/17


Initial Catalog - Select tempdb, model, msdb or any of the availabledatabase from the drop-down list

Target Table - Set this parameter from the Item Manager window

Connection String - Displays the string of the connection

Test Connection button - Click this button to see if the connection isworking; if successful, a Connection Success message is displayed.

When Access is selected, define the following parameters:


Target Table - Set this parameter from the Item Manager window.

Connection String - Displays the string of the connection.


When Oracle or ODBC is selected, define the following parameters:


User - Enter the SQL user name, the default is 'sa'.

Password - Enter the SQL password, the entry appears in asterisks.


Connection String - Displays the string of the connection.


When CSV is selected, define the following parameters:



15/17


16/17


Allow DBNull checkbox - Select this option to show a null value in thedatabase field.

Auto Increment checkbox - Select this option to add a column withautomatically incremented values (row value); if this option is selected, theColumn Name field becomes active.

Column Name - This option is only available if the Auto Increment optionis selected, specify the column name of the automatically incrementalvalues.

Current Time - Select this option to use the current time, if this option isselected, the following parameters are available:

Current Time Index checkbox - Select this option to use a current systemindex for the time.

Current Time Column Name - Enter a name for the current index timecolumn that is added to the table.

Viewing the Historical and Report Logger Groups from the ItemManager Window

The Historical and Report Logger Groups can be viewed from the Item Manager window.

To view the Historical Logger Group

Go to the Item Manager and look under Hosts > Masterhost > Data Logger >History.

To view the Report Logger Group

Go to the Item Manager and look under Hosts > Masterhost > Data Logger >Report.


17/17

P l Hi t i D t L 17

pulse historian guide

Documents