Historian Synchronization User Guide
Historian Synchronization User Guide
InFusion SCADA
Historian
Synchronization User's
Guide
B0750BX
Rev B
July 6, 2011
All rights reserved. No part of this documentation shall be
reproduced, stored in a retrieval system, or transmitted by any means,
electronic, mechanical, photocopying, recording, or otherwise,
without the prior written permission of the Invensys Systems, Inc. No
copyright or patent liability is assumed with respect to the use of the
information contained herein. Although every precaution has been
taken in the preparation of this documentation, the publisher and the
author assume no responsibility for errors or omissions. Neither is any
liability assumed for damages resulting from the use of the
information contained herein.
The information in this documentation is subject to change without
notice and does not represent a commitment on the part of Invensys
Systems, Inc. The software described in this documentation is
furnished under a license or nondisclosure agreement. This software
may be used or copied only in accordance with the terms of these
agreements.
Trademarks
Invensys, ArchestrA, InFusion, InSQL, Wonderware and the Invensys
logo are trademarks of Invensys plc, its subsidiaries and affiliates.
All other brand names may be trademarks of their respective owners.
iii
Contents
Before You Begin ................................................v
About This Book .................................................................................... v
Audience................................................................................................. v
Revision Information.............................................................................. v
Reference Documents ............................................................................ v
Related Wonderware Documentation ................................................ vi
InFusion-Specific Documentation ..................................................... vi
Document Conventions ......................................................................... vi
Formatting Styles............................................................................... vi
CHAPTER 1: Introduction...................................1
Overview ................................................................................................ 1
Working Principles ................................................................................. 2
Index ..................................................................37
Audience
The information in this document is intended for process operators and
engineers.
Revision Information
For this release of the document (B0750BX, Revision B), the following
changes were made:
Chapter 2, “Configuration”
• Updated section “Configuring Historian Sync” on page 5.
• Minor updates in section “FS Gateway” on page 8.
• Updated section “Creating IDAS on Historian Server” on page 11.
Chapter 3, "Execution of Historian Synchronization Application"
• Added section “OnDemand Synchronization” on page 26.
Chapter 4, “Supported Application Objects”
• Updated section “$HistorianIOServerService Object” on page 27.
Reference Documents
Since the InFusion SCADA software is based on the ArchestrA® architecture
and incorporates several Wonderware® products, much of the documentation
written by Wonderware is relevant. In addition, there are documents that
describe InFusion-specific features. Below is a list of documents that can
provide additional information that is beyond the scope of this document.
These documents can be accessed from IPS Global Client Support web site:
http://support.ips.invensys.com
InFusion-Specific Documentation
During InFusion SCADA software component installation, the documents
associated with the software components being installed are also installed.
These documents can be viewed by clicking Start > Programs > Invensys >
InFusionSCADA Documentation menu.
Document Conventions
This section describes the conventions followed in this document.
Formatting Styles
This documentation uses the following text formatting conventions:
C H A P T E R 1
Introduction
Contents
• Overview
• Working Principles
Overview
InFusion SCADA includes the facility to setup InFusion Historian Servers
through the Historian Synchronization software. This facility requires extra
setup tasks over the standard InFusion Historian, and provides for up to three
Slave Historians along with a Master Historian.
The InFusion SCADA Historian Synchronization software is useful only when
the IDAS version of the Historians is used.
Note The Historian Synchronization software is for the customers who want
to use more than One Historian. The Single Node Historian customers do not
need to install it.
• MDAS is not used; hence, there is some loss of “ease of use” while
specifying the object attributes to be stored into the history data
• There is no “Store & Forward” capability built into MDAS (although this
feature is generally not required if Historians already exist).
Working Principles
The following diagram illustrates the basic setup and flow of history data using
Historians:
C H A P T E R 2
Configuration
Contents
• Configuring Historian Sync
• FS Gateway
4. The next line represents the folder location where the backup history
blocks get stored.
<history_block_backup_dir>C:\InSQLSync\HistBackup</history_block_backup_dir>
5. The next line represents the folder location where the gaps in the data are
detected.
<manual_gap_info_dir>C:\InSQLSync\ManualGaps</manual_gap_info_dir>
6. The next line is the relative path for the new data blocks. It is
recommended to leave the default settings.
<new_block_temp_dir>.\NewBlocks</new_block_temp_dir>
7. The next line is the name of the tag used to mark the end of a data block.
The SysPulse is an Historian default tag which gets updated every minute.
<block_completion_check_tag>SysPulse</block_completion_check_tag>
8. The next line must be configured with one or more tag names of the
Galaxy, separated by commas. One or more tags can be configured in the
file for the data quality. The quality of these tags is considered for
detecting the data in the Historians for good and bad blocks. The user must
replace the default tags with the tags in the configured Galaxy. At any
given time, the value of at least one of the chosen tags must be “good”.
<quality_check_tag>R_MOH_UNIT_1_MW,R_MDS_NPC_DEVIATION_CURR,R_XDS
_ONLINE_MW_CAPACITY</ quality_check_tag >
9. The next line represents the tag name for any manual tag. You can leave it
blank.
<manual_edit_check_tag></manual_edit_check_tag>
10. The next line represents the tag name used to monitor the status of the
Inter-Control Center Communications Protocol (ICCP). It is used to
specify the communication status tag, when the system is using data from
the RTPAgent. This field can be left blank if not used.
<iccp_comm_check_tag></iccp_comm_check_tag>
11. The next line represents the geographical time zone. The users must
update their time zone as applicable. The string representation of the time
zone must be used.
<time_zone>Pacific Daylight Time</time_zone>
12. The daily_check field specifies whether the application has to check and
fill gaps on a daily basis.
<daily_check note=”true or false”>true</daily_check>
15. The task levels are listed in the XML file itself. The default value is 1. The
options 1 and 2 are used for troubleshooting and verifying the accuracy of
the data getting synchronized. Here:
• 1 indicates - Check Only Gaps
• 2 indicates - Build Blocks Only
• 3 indicates - Sync History
16. The next line represents the interval for the waiting time.
<wait_time>1000</wait_time>
17. The next part is the Server List configuration where the Historian machine
details must be entered. Depending on the level of redundancy, the server
must be matched.
The Historian Sync application can support synchronization of up to a
maximum of four Historians. The server list must contain the description
of the actual Historian servers only.
A typical configuration for a server is as follows:
<Server server_note=”server”>
<server_name>GOCRS1</server_name>
<user_name>wwAdmin</user_name>
<password>wwAdmin</password>
<database>Runtime</database>
<history_block_dir>\\GOCRS1\E$\InSQL\DATA\Circular\</history_block_dir>
<permanant_dir>\\GOCRS1\E$\InSQL\DATA\Permanent\</permanent_dir>
</Server>
In this text:
a. Leave the first line as it is.
b. The next line specifies the name of the Historian.
c. The next two lines represent the SQL Server login credentials of the
Historian machine.
d. The next line is the database name of the INSQL Historian, the
default value Runtime must not be altered.
e. The next line is the share path where the history blocks are stored.
f. The next line is the share path where the permanent history blocks are
stored.
Note The INSQL folder is created by the INSQL installation. This folder
must be shared with full access.
FS Gateway
4. Click Yes.
6. Rename the ArchestrA object to ArchestrA and leave the default settings
as such.
8. After the Server has been activated, the Diagnostic properties of the
ArchestrA object appear.
FSGateway is now configured. Follow the same procedure for all Application
Servers.
Note Before initiating the IDAs configuration follow the Winplatform and
Engine configuration. Please refer Chapter 4, “Supported Application Objects”
for more details.
3. Enter the primary application server name in the I/O Server Location
box. Select the FSGateway option in the I/O Server Type box. Select
SuiteLink as Protocol Type. Add description and enter the redundant
Appserver name in the Alt.ServerLocation box.
4. Click Finish.
6. Click OK.
10. Click OK to close the display and to return to the Commit Pending
Changes - Confirmation window.
11. Click Commit to confirm the changes.
12. Point to the server name in the navigational panel, right-click and select
New Topic.
13. In the next window, enter the Topic Name as ArchestrA or any other
name as given in the ArchestrA object in the FS Gateway in the App
Servers. Leave the other default values as they are.
20. On the next page, specify the Item Name (I/O point address) and click
Next.
21. On the next page, select the Storage Method, and click Finish.
22. Commit all the changes made to the system in the same way as explained
in steps 7 through 11.
23. Finally, re-initialize the topic to complete IDAS configuration. Open the
Management Console. Click Data Acquisition in the navigation pane. In
the right pane, right click the FSGateway object and select Re-initialize
Topic.
27. Repeat the same procedure for other Historian Servers in the
configuration.
C H A P T E R 3
Execution of Historian
Synchronization Application
Overview
If the Primary Historian server fails, for some time, and comes back again as
active, then a gap develops within the data. The Historian Synchronization
application, also known as the Historian Sync application, synchronizes daily
at a pre-defined time and collects data from the second Historian machine to
fill up the Primary Historian Server data gaps. While executing, the Historian
Sync application window appears as shown in Figure 3-1.
OnDemand Synchronization
To configure the OnDemand synchronization:
1. While the application is running, click Config > On Demand to open the
OnDemand.xml file.
2. In the OnDemand file, configure the start date, end date, and the task level
for synchronization as 3. Same start date and end date would indicate one
full day.
3. Configure the ondemand_check_time in HH:MM:SS format in the main
configuration file. The time entered must be a future time.
The Historian Sync application checks/reads the configuration file every 6
seconds.
The OnDemand synchronization process is required when the user experiences
gaps in the Historians. The OnDemand synchronization process must be
carried out on the present primary Historian node.
A sample OnDemand.xml file would look like the following:
<InSQLSyncOnDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
InSQLSync_key="ondemand">
<ondemand_start_date note="MM/DD/YYYY">04/30/2011</ondemand_start_date>
<ondemand_end_date note="MM/DD/YYYY">04/30/2011</ondemand_end_date>
<ondemand_task_level>1</ondemand_task_level>
</InSQLSyncOnDemand>
In this sample, the same start and end dates indicate that the synchronization
must be done for the full day on this date. The ondemand_task_level must be
changed to 3.
C H A P T E R 4
Supported Application
Objects
This chapter discusses the Application Objects that are supported by the
InFusion Historian Synchronization software and explains the procedure for
configuring them as per the requirements of the Historian Synchronization
application.
Contents
• $HistorianIOServerService Object
• $PrimaryHistPing Object
• $SecondaryHistPing Object
• $SCADAWinPlatform Object
• $SCADAEngine Object
$HistorianIOServerService Object
This object is an ArchestrA derived DDESuiteLink Object, which has been
customized to connect to the Historian.
The names of the instances of this object must be specified as aahIOSvrSvc,
aahIOSvrSvc1, and so on. The Primary Historian has to be aahIOSvrSvc and
others for backup. For each of the Historian, one Instance must be created.
The Object Server name is fixed as aahIOSvrSvc, and it should not be
changed. Only the Historian Server Node name has to be configured.
1. Enter or browse to the primary Historian machine from the Server node.
Note Ensure that the Historian Sync application is running while performing
the above actions. To run the application, click Start > Program Files >
Historian Sync > Shortcut to HistSync.bat.
Note The network path must be shared with full Read/Write permissions to
allow the execution of the above steps.
$PrimaryHistPing Object
This object plays a very important role in InFusion SCADA software. The
name of the instance of this object should be specified as Hist1Ping. The basic
function of this Object is to monitor the Network Status of the Primary
Historian and to create database tables for InFusion SCADA software. The
Object Health Status is coupled with SCADAWinPlatform.
The HistoryShares UDA in the NetworkMonitor.HIST1 object must be
mapped to a file share on each History Server, where the History File name is
to be saved. Typically this is mapped to a directory like:
\\SERVERNAME\Primary
For Example:
\\Hist1\primary
The History object maintains a “PRIMARY” file on each history server that is
used by the Historian Sync task. Hence, this path is used to specify a file share
where the file is located on each server. The file share MUST have read/write
permissions (that is, full control), but only on that single file.
Following is an example of Hist1Ping object configuration:
1. In Figure 4-3, there are two history servers (Hist1 and Hist2) along with
the file share for each. The remaining two servers (#3 and #4) do not exist.
Note In order for the PrimaryHistPing object to function properly, all the four
Historians (Hist1, Hist2, Hist3, and Hist4) should be configured.
$SecondaryHistPing Object
The Role and Purpose of this object is same as that of the $PrimaryHistPing
Object, but this object does not create Database Tables. The instance of this
object should be named as Hist2Ping.
The Server name must be entered in NodeName, and this is the only
configuration to be done.
Same procedure is to be followed to configure Hist3Ping (if required), and
Hist4Ping (if required) Objects.
$SCADAWinPlatform Object
fields be left blank. These changes are best done on the Project
$SCADAWinPlatform.
1. On the General tab of the Project $SCADAWinPlatform, clear the
History store forward directory field, and set the Lock on the directory
as shown Figure 4-4.
2. On the Engine tab, remove any reference to the Historian. Deselect the
check box Enable Storage to Historian and Lock the History control
group as shown in Figure 4-5.
UDA Description
SQLServerName The name of the primary Historian
SQLServerName1 The name of the first Historian
SQLServerName2 The name of the second Historian
SQLServerName3 The name of the third Historian
Each entry is the Network name of the SQL Server, or empty if there is no SQL
Server.
This would allow for a primary historian (Hist1) and a backup historian
(Hist2).
Also, be sure to configure the SQLUserID (the SQL Server User ID) and the
SQLUserPW (the SQL Server Password) in the Project
$SCADAWinPlatform.
Note that the historian requires that all servers have the same SQL User Name
(that is, “sa”) and password.
Figure 4-6 illustrates a typical setup of the Project $SCADAWinPlatform
Object:
Here:
1. SQLServerName should be Master Historian machine name. For example,
Hist1.
$SCADAEngine Object
1. On the Project Engine template, deselect the check box Enable Storage to
Historian, and lock the History control group, as shown in Figure 4-7.
A P P E N D I X A
Licensing
Contents
• InFusion Historian License
• InFusion SCADA Historian Synchronization License
Index
A
App Servers 17
Application Server 2
Audience v
B
Before v
C
Creating IDAS 11
D
Data Acquisition 21
DBLogger 3
DDESuiteLink 27
Diagnostic 11
E
Engineering Unit 19
Execution 25
F
failover 3
FSGateway 3, 8, 11
H
Historian Sync task 29
I
IDAS 8, 11, 15, 21, 30
Industrial Application Server 11
InSQL 12
IsHistory 18
L
License 35
M
Management Console 21
MDAS 11, 30
N
network path 28
Network Status 29
New I/O Server 13
O
On Demand file 6
OnDemand Synchronization 25
on-demand Synchronization 7
P
Parallel Collection 2
Primary File 6
Project $SCADAWinPlatform 31, 32, 33
S
SCADAAnalogDevice 18
SCADADiscreteDevice 18
SCADAEngine 34
SCADAWinPlatform 29
SMC 8
Storage Method 20
SuiteLink 13
T
timezone 6
W
Wonderware Documentation vi