citecthistorian v4.2 r1 vol1
TRANSCRIPT
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
1/328
Schneider Electric (Australia) Pty Ltd
3 Fitzsimons LaneGORDON NSW 2072
PO Box 174
PYMBLE NSW 2073AUSTRALIA
Telephone: 61 2 9496 7300Fax: 61 2 9496 7399
Manual Release 1
Training Manual
CitectHistorian Configuration
Version 4.2
Volume 1
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
2/328
December 2009 Edition for Version 4.2Manual Release 1Written, Printed and bound in Australia
ii Version 4.2 December 2009
DISCLAIMER
Schneider Electric (Australia) Pty Ltd makes no representations or warranties with respect to this manual and, to the maximum extent permitted by law, expressly limits its liability for breach of any warranty that may be implied to the replacement of this manual with another.Furthermore, Schneider Electric (Australia) Pty Ltd reserves the right to revise this publication at any time without incurring an obligation tonotify any person of the revision.
Schneider Electric (Australia) Pty Ltd
ABN 4200 4969 304
CitectHistorian Configuration Training Manual
INTRODUCTION AND LEGAL NOTICE
Your purchase of this official CitectHistorian Configuration Training Manual entitles you to undertake the CitectHistorian Configurationtraining course. The number allocated to you on purchase of this manual is your key to complete the course evaluation.
Satisfactory completion of this evaluation is mandatory for you to obtain a certificate of completion of the training course.
The contents of this manual are proprietary to Schneider Electric (Australia) Pty Ltd and all rights, including copyright, are reserved bySchneider Electric (Australia) Pty Ltd. You must not copy any part of the manual in hard or electronic form or make any adaptation or othercommercial use of it without Schneider Electric''s prior written consent.
Schneider Electric (Australia) Pty Ltd will not accept any liability for action taken in reliance on this training manual.
COPYRIGHT
(c) Schneider Electric (Australia) Pty Ltd 2006-2009. All rights reserved. This material is copyright under Australian and international laws.Except as permitted under the relevant law, no part of this work may be reproduced by any process without the prior written consent ofSchneider Electric (Australia) Pty Ltd. Any authorised reproduction must acknowledge Schneider Electric (Australia) Pty Ltd as owner ofcopyright in work.
TRADEMARKS
Schneider Electric (Australia) Pty Ltd has made every effort to supply trademark information about company names, products and servicesmentioned in this manual. Trademarks shown below were derived from various sources.
CitectSCADA, CitectHMI, CitectFacilities, CitectHistorian and Ampla are registered trademarks of Schneider Electric (Australia) Pty Ltd
Windows, Windows NT, Windows 2000, Windows XP, Windows Vista, MSSQL Server and Excel are trademarks of Microsoft Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Novell and NetWare are registered trademarks of Novell Inc.
dBASE is a trademark of Borland Inc.
General Notice:
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective companies.
About Us
Members of Educational Services' team of Instructional Designers have tertiary qualifications in Education, Educational Course Developmentand are also experienced trainers in their own right; some are also published authors. Currently, the team is supporting a range of over 70courses in multiple languages and multiple software environments.
Authors
Alynda Brown, David Heath, Peter West
Contributors
David Mackay, Con Karantziounis, Craig Donnelly
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
3/328
CitectHistor ian Configur ation Manual Release 1 iii
Contents
CHAPTER 1: INTRODUCTION TO CITECTHISTORIAN ................................................1-1
Overview .................................................................................................................... 1-1Before You Begin.......................................................................................................1-2Course Overview ........................................................................................................1-3Conventions Used in this Manual...............................................................................1-5
CHAPTER 2: DATA SOURCES ......................................................................................2-1
Overview .................................................................................................................... 2-1Data Sources in this Course........................................................................................2-2SQL Database as a Data Source ...............................................................................2-21
CHAPTER 3: CITECTHISTORIAN AT A GLANCE .........................................................3-1
Overview .................................................................................................................... 3-1What is CitectHistorian?.............................................................................................3-2CitectHistorian System...............................................................................................3-5CitectHistorian Server Wizard ...................................................................................3-6Connect Data Sources...............................................................................................3-11Publish Data..............................................................................................................3-18Create a User ............................................................................................................3-20OPC as a Data Source...............................................................................................3-30
CHAPTER 4: HISTORIAN ............................................................................................. 4-1
Overview .................................................................................................................... 4-1What is Historian? ......................................................................................................4-2Database Schema........................................................................................................4-3Historian Data Manager ............................................................................................. 4-4Historian Database......................................................................................................4-8Historian Configuration............................................................................................4-12Configure Historian Tags ......................................................................................... 4-18Configure Alarms in Historian .................................................................................4-20Historian Item Properties.......................................................................................... 4-22SQL Databases used in CitectHistorian ...................................................................4-37Licencing ..................................................................................................................4-41Service Management ................................................................................................4-44
CHAPTER 5: PUBLISH INFORMATION.........................................................................5-1
Overview .................................................................................................................... 5-1Organise Published Data ............................................................................................ 5-2Access Data Sources...................................................................................................5-6Security.....................................................................................................................5-10Aliases ......................................................................................................................5-18
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
4/328
iv Version 4.2 December 2009
CHAPTER 6: BACKFILL MANAGER ............................................................................6-1
Overview .................................................................................................................... 6-1Backfill Manager ........................................................................................................6-2
CHAPTER 7: PROJECT MANAGEMENT ....................................................................... 7-1 Overview .................................................................................................................... 7-1Backup and Restore Projects ......................................................................................7-2Active Project ...........................................................................................................7-14Remove a Project......................................................................................................7-22
CHAPTER 8: TASKS .....................................................................................................8-1
Overview .................................................................................................................... 8-1Why Are Tasks Used? ................................................................................................8-2Task Properties ...........................................................................................................8-3
Data Transfer Tasks....................................................................................................8-7ActiveX Tasks ..........................................................................................................8-30Email Tasks ..............................................................................................................8-34Organise Tasks into Folders .....................................................................................8-37
CHAPTER 9: EVENTS...................................................................................................9-1
Overview .................................................................................................................... 9-1What is an Event? .......................................................................................................9-2The Event Service.......................................................................................................9-6Recipe Management via Tasks and Events ................................................................9-8
CHAPTER 10: THE EXCEL CLIENT.............................................................................10-1
Overview ..................................................................................................................10-1View Data in the Excel Client ..................................................................................10-2Customise the Excel Client ......................................................................................10-7Statistical Analysis - Optional Section ................................................................... 10-12
CHAPTER 11: CITECTHISTORIAN WEB CLIENT........................................................11-1
Overview ..................................................................................................................11-1
Set Up a Trusted Site................................................................................................11-2Internet Information Services - (IIS) ......................................................................11-10Connect to the CitectHistorian Server....................................................................11-11The CitectHistorian Web Client Interface..............................................................11-13Display Data ...........................................................................................................11-15Web Client Events ..................................................................................................11-16Snapshot Data .........................................................................................................11-22Time Series.............................................................................................................11-25Attributes ................................................................................................................11-29
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
5/328
CitectHistor ian Configur ation Manual Release 1 v
CHAPTER 12: INTRODUCTION TO CITECTHISTORIAN .............................................. 12-1
Overview ..................................................................................................................12-1Before You Begin.....................................................................................................12-2Course Overview ......................................................................................................12-3
Conventions Used in this Manual.............................................................................12-5
CHAPTER 13: INTEGRITY CHECKER ..........................................................................13-1
Overview ..................................................................................................................13-1Integrity Checker Tool ............................................................................................. 13-2
CHAPTER 14: HISTORIAN INTERPOLATION ...............................................................14-1
Overview ..................................................................................................................14-1Historian Interpolation..............................................................................................14-2
CHAPTER 15: PROCESS ANALYST ..............................................................................15-1
Overview ..................................................................................................................15-1The Process Analyst Client ......................................................................................15-2Properties of the Process Analyst.............................................................................15-9Display Tags in the Process Analyst ...................................................................... 15-10Pen Types ...............................................................................................................15-11Change the Properties of the Process Analyst........................................................15-18
CHAPTER 16: HISTORIAN REPORTS DEPLOYMENT MANAGER ................................16-1
Overview ..................................................................................................................16-1CitectHistorian Reporting Manager .........................................................................16-2Historian Database....................................................................................................16-7Install a Report Pack on the Historian....................................................................16-11Deploy Reports in Microsoft Reporting Services ..................................................16-23
CHAPTER 17: SAMPLE REPORTS................................................................................17-1
Overview ..................................................................................................................17-1Sample Reports.........................................................................................................17-2Developer Reports ....................................................................................................17-3
Alarm Management Reports.....................................................................................17-4Energy Reports .........................................................................................................17-9Browse a Deployed Report.....................................................................................17-11
CHAPTER 18: ENERGY REPORTS ...............................................................................18-1
Overview ..................................................................................................................18-1Sample Data..............................................................................................................18-2Reports Hierarchies ..................................................................................................18-8Run an Energy Report ............................................................................................ 18-13Create a New Hierarchy .........................................................................................18-20
Energy Tariffs.........................................................................................................18-33Connect Tariffs to Consumption ............................................................................18-38
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
6/328
vi Version 4.2 December 2009
CHAPTER 19: CASE STUDY......................................................................................... 19-1
Overview ..................................................................................................................19-1
CHAPTER 20: COURSE SUMMARY ..............................................................................20-1
Overview ..................................................................................................................20-1Summary - CitectHistorian Configuration ...............................................................20-2Course Evaluation ....................................................................................................20-3Further Training........................................................................................................20-4
APPENDIX A: MODIFY EXISTING REPORTS................................................................A-1
Overview ................................................................................................................... A-1SQL Server Reporting Services................................................................................. A-2Open a Report for Editing ......................................................................................... A-3Exercise - Open an Existing Report for Editing........................................................A-6
Review Editing Tools ................................................................................................ A-9
APPENDIX B: CITECTHISTORIAN IN A DOMAIN ......................................................... B-1
Overview ................................................................................................................... B-1
APPENDIX C: SQL SERVER 2005 REPORTING SERVICES ..........................................C-1
Overview ................................................................................................................... C-1Using this Chapter ..................................................................................................... C-2Toolbox Report Items................................................................................................ C-3
Group, Sort and Filter Tables .................................................................................. C-49Format Reports ........................................................................................................ C-64Customised Calculated Fields ................................................................................. C-76Format a Report with Expressions .......................................................................... C-88Drill Down............................................................................................................... C-97
Navigation ............................................................................................................. C-105Publish a Report .................................................................................................... C-117
APPENDIX D: SCHEDULE REPORTS.............................................................................D-1
Overview ................................................................................................................... D-1
Schedule Reports .......................................................................................................D-2
APPENDIX E: CITECTHISTORIAN INSTALLATION ...................................................... E-1
Overview ....................................................................................................................E-1System Requirements .................................................................................................E-2Additional Windows Components .............................................................................E-4Install CitectHistorian...............................................................................................E-13Configure CitectHistorian ........................................................................................E-22SQL Server Settings .................................................................................................E-26
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
7/328
Overview
CitectHistorian is a plant-wide reporting tool that allows traditionally disparate datatypes to be combined, compared and logged on a common platform. Bycommunicating with SCADA systems, Oracle, and SQL databases, CitectHistorianallows the collation and management of production data for delivery to a widerange of business applications.
The data collected by the CitectHistorian system can be published on a server andaccessed directly via client applications, or it can be logged as historical data to anSQL Server database, exposing it to a vast array of reporting tools including SQLServer 2005 Reporting Services.
This Chapter Covers These Topics:
Before You Begin..................................................................1-2
Course Overview ...................................................................1-3
Conventions Used in this Manual..........................................1-5
Chapter 1: Introduction to CitectHistorian
Introduction
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
8/328
1-2 Version 4.2 December 2009
Before You Begin
Please write the name of your Instructor here ____________________
Your Instructor will be spending the next three days with you, and will guide youthrough this training course. Your Instructor is an experienced CitectHistorian userso please feel free to ask questions.
This training manual is a supplement to the authorised training. In order to makefull use of the software you should also refer to the Online Help and CitectHistorianKnowledge Base.
The graphics displaying screen shots have been taken using the Windows XPoperating system using Classic mode display properties. If you are running adifferent version of Windows then your screens may differ slightly from the ones
shown in the training manual.
Some screen shots may have been taken from beta versions of the software and mayvary slightly from release screen shots.
Your Instructor
Defining the
Scope of this
Training Manual
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
9/328
CitectHisto rian Configuration Manual Release 1 1-3
Course Overview
By the completion of this training course you will:
Have a good understanding and be competent in the use of CitectHistorian
Understand how to communicate with CitectSCADA and SQL databases usingCitectHistorian
Be able to apply what you have learnt to your own application
Understand how to use the CitectHistorian Client applications
Be able to customise the CitectHistorian Client applications to develop yourown CitectHistorian environment
Be able to configure CitectHistorian Tasks and Events
Understand the Backfill, Interpolation and Integrity Checker tools
Be able to configure and use Energy Reports
Please take a few moments to have a look through your Training Pack. In additionto this manual, you will find the following items:
Compendium
Mouse Pad
Pen
Notepad
Memory Stick
The current version of CitectHistorian on CD or DVD Rom
For this course, in addition to the standard CitectHistorian software, you will needthe following files.
Aladdin.ctz The CitectSCADA project which will emulate a running plant to provide data for the Historian software.
SQLdatabase.bak An SQL database intended to emulate corporate ERPsystems to permit interaction with business systems.
Alarmbell.g if An example graphics file to demonstrate adding a graphicto a report. This may be substituted for any graphic file of
the trainer's or student's choosing.
ActiveX.txt Sample ActiveX code for an exercise in the course (to savetyping and potentially creating errors).
PDF_Report.pdf Sample PDF document for use in the Web Client.
The Instructor will advise on the location of these files as they are required.
Course
Objectives
Course Material
Course Assets
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
10/328
1-4 Version 4.2 December 2009
Course Overview (cont.)
The training course will take three days to complete. The following programoutlines the topics that will be covered on each day:
Day Topics1 Data Sources
CitectHistorian at a Glance
Historian
Historian Status Indicator
Publish Information
Backfill Manager
2 Manage Projects
Tasks
Events The Excel Client
CitectHistorian Web Client
3 Integrity Checker
Historian Interpolation
Process Analyst
Reports Deployment Manager
Sample Reports
Energy Reports
Case Study
Course Summary
Add'l
Info
CitectHistorian Installation
CitectHistorian in a Domain
Microsoft Reporting Services
Please be aware. This course covers the conf iguration and use ofCitectHistorian. It will not cover:
The SQL programming language
The administration of SQL Servers
The creation o f cus tom reports using SQL Server Reporting Services
To gain these skills, we recommend students attend appropriate Microsoftsanctioned training courses.
If you require support during training or would like additional information aboutany concepts or products in the course, please ask your Instructor.
Course Program
Support
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
11/328
CitectHisto rian Configuration Manual Release 1 1-5
Conventions Used in this Manual
These are the skills you will achieve by the end of each chapter. An overview providing a brief synopsis of the topic begins each section. Often, examples aregiven to illustrate the conceptual overview.
Example -
The CitectHistorian configuration environment consists of several toolbars, browserwindows and programming editors. This chapter introduces the user to theconfiguration environment using an example project with pre-defined elements.
After a concept is explained you will be given exercises that practise the skills you just learned. These exercises begin by explaining the general concept of eachexercise and then step-by-step procedures are listed to guide you through each
procedure.
Example -
Paste a genie from a library in the Include project onto a test page called Utility.
1 Run the Milk_Upgrade project then trigger and view some alarms.
i. Use the following template settings:
Whenever you are required to type information into a field or dialog box it will bewritten in this font
Example -
KETTLE_TEMP/ 25
Objectives
Exercises
User Input
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
12/328
1-6 Version 4.2 December 2009
Conventions Used in this Manual (cont.)
This heading will provide you with useful or helpful information that will makeconfiguring your project easier
Example -
Hints & Tips
To go to the next field, use the mouse cursor or press the TAB key.
A note will refer to a feature which may not be obvious at first glance butsomething that you should always keep in mind
Example -
Note:
Any events named GLOBAL are enabled automatically when events are enabled.
Text separated by the double arrow symbol “»” indicates that you are to select amenu
Example -
File » New…
Open a menu “File” then select the menu option “New…”
Text written this way indicates the Horizontal then the (Vertical) tab you are toselect.
Example -
Appearance (General)
Hints and Tips
Note
Menus and Menu
Options
Horizontal and
Vertical Tabs
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
13/328
CitectHisto rian Configuration Manual Release 1 1-7
Conventions Used in this Manual (cont.)
Text written in this way indicates further references about the current topic.
Example -
See Also:
For further information about Templates, see CitectHistorian Help - Using PageTemplates.
This heading describes topics that are covered in more advanced courses.
Example -
Further Training: Trend Table Maths is a topic in the CitectSCADA Customisation and DesignCourse.
This heading describes situations where the user needs to be careful.
Example -
Caution!
If you restore to the Current project, then the currently selected project in theCitect Explorer will be overwritten.
See Also
Further Training
Caution
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
14/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
15/328
Overview
CitectHistorian takes information from various data sources and prepares it for use by client applications. This chapter describes the data sources that will be usedduring this training course.
This Chapter Covers These Topics:
Data Sources in this Course...................................................2-2
SQL Database as a Data Source ..........................................2-21
Chapter 2: Data Sources
Introduction
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
16/328
2-2 Version 4.2 December 2009
Data Sources in this Course
The Aladdin Project has been created specifically to generate data for theCitectHistorian Training Course. This project is set in a fictitious mountain resortwhere guided tours are held through a cave system. The project consists of three
parts.
Aladdin’s Caves – A simulation of a Building Management System
Soft Drink Plant – A Plant that requires a Recipe Management System
Water Filtration Plant – A system that requires monitoring and storage of largeamounts of data
The purpose of the project is to demonstrate how CitectHistorian is able to take datafrom many disparate data sources and to then report information from all sources ina concise manner. CitectHistorian is able to perform different types of tasks and itmay be applied to many different scenarios. This project reproduces differentscenarios in order to demonstrate a variety of applications.
Further Training:
Detailed training in managing a CitectSCADA environment is covered in thevariety of CitectSCADA Courses.
The Aladdin
Project
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
17/328
CitectHisto rian Configuration Manual Release 1 2-3
Data Sources in this Course (cont.)
Aladdin’s Caves is a simulation of a building management system.
The SCADA system monitors tags and trends to provide a graphical representationof their values:
Number of people entering and leaving caves
Cave Temperature
Wind Speed
Alarms are triggered when:
Doors are left opened for more than five minutes
Building
Management
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
18/328
2-4 Version 4.2 December 2009
Data Sources in this Course (cont.)
In addition to localised data displays on the Building Management page, there arethree status pages for data monitoring of Cave Temperature, Carbon Dioxide levelsand Wind Speeds.
Building
Monitoring
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
19/328
CitectHisto rian Configuration Manual Release 1 2-5
Data Sources in this Course (cont.)
This fictitious cave system also has pure natural spring water. Hidden away fromthe view of the general public there is a small cottage industry creating flavouredspring water. This process requires a recipe management system.
The SCADA system:
Monitors the silo levels of all ingredients
Monitors the status of the bottling conveyor Controls the recipe values
Recipe
Management
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
20/328
2-6 Version 4.2 December 2009
Data Sources in this Course (cont.)
The Aladdin Cave System is located in a National Park and is therefore in anenvironmentally sensitive area. A water filtration system has been implemented inorder to take the waste water from the bottling plant and release clean water backinto the environment. Government health codes require that the treated water ismonitored for different chemical levels and that the historical data is kept for sevenyears.
The SCADA system:
Monitors the Tank Levels and Water Flow rates
Monitors the Oxygen, pH, and Chlorine Levels
Alarms are triggered when:
Valves or Pumps are off
Oxygen, pH and Chlorine Levels are outside the specified range
Tank Levels are High or Low
The Aladdin Project is run as one project for the purpose of the training course.However, in a real situation this is likely to be three separate data sources andmanagement would like to receive reports from all three systems. CitectHistorianwill be used to gather the data from the three areas and report the relevantinformation in a concise manner and also to implement a Recipe ManagementSystem.
Plant Monitoring
and Data
Management
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
21/328
CitectHisto rian Configuration Manual Release 1 2-7
Exercise - Examine the Aladdin SCADA Project
1 Restore the Aladdin SCADA project.
i. Your Instructor will provide the Aladdin project backup file. Restorethe project if it is not already installed on your computer.
2 View the "Operational" pages.
i. There are three pages in the Aladdin project which display theprimary operation of the Aladdin caves system.
Page Use
Cave_System Building Management
Flavouring Recipe Management
Filter Plant Monitoring
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
22/328
2-8 Version 4.2 December 2009
Exercise - Examine the Aladdin SCADA Project(cont.)
3 Open the Cave_System page.
Cave Name Tag prefix (cave-name below)
Main Entrance Main
Christopher's Lair Chris
Opera Theatre Opera
Central Core Central
Pixie's Retreat Pix
Depths of Tartarus Tar
Circe's Temple Circe
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
23/328
CitectHisto rian Configuration Manual Release 1 2-9
Exercise - Examine the Aladdin SCADA Project(cont.)
i. Examine these tags:
1. Temperature (cave-name _Temp)2. Air flow (cave-name _Air)
3. Person count (cave-name _Count)
4. Door status (cave-name _Door)
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
24/328
2-10 Version 4.2 December 2009
Exercise - Examine the Aladdin SCADA Project(cont.)
4 Open the Flavouring page.
Flavour name Tag prefix
Sugar Sugar
Salts Salts
Lemon Lemon
Lime Lime
Orange Orange
Raspberry Rasp
Kiwi Kiwi
Pineapple Pine
Water Water
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
25/328
CitectHisto rian Configuration Manual Release 1 2-11
Exercise - Examine the Aladdin SCADA Project(cont.)
i. Examine these tags:
1. Level (amount of ingredient in the storage tank) ( flavour _Level)2. Recipe values ( flavour PLC)
5 Open the Filter page.
i. Examine these tags:
1. Various Level tags.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
26/328
2-12 Version 4.2 December 2009
Exercise - Examine the Aladdin SCADA Project(cont.)
6 Open the "Status" pages.
i. In addition to the plant management pages, there are also three
status pages:
Page Use
Cave_Temp Cave temperature sensors in each of the sub-caves
Gas_Emission Carbon dioxide levels in each of the sub-caves
Wind_Speed Airflow at the doorway of each sub-cave
ii. Open these pages in the Graphic Builder and note theirconfiguration.
7 View the Variable, Alarm and Trend tags.i. Open the Project Editor .
ii. Select the menu item Tags » Variable Tags.
iii. Observe the list of variable tags that pertain to the objects seen onthe graphics pages.
iv. Similarly, note the Trend tags and on the Alarm menu, the variousAlarm tags.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
27/328
CitectHisto rian Configuration Manual Release 1 2-13
Exercise - Examine the Aladdin SCADA Project(cont.)
8 Configure the CitectSCADA Project to accept connections fromCitectHistorian
Note:
Theses steps are only required for CitectSCADA V7.1 to work with the tightenedsecurity restrictions - external connections are blocked by default; these instructionsopen the data connection.
i. Open the CitectSCADA Project Editor and select the menu item Tools» Computer Setup Editor .
ii. In the Parameter Reference field at the lower right, type ctapi andclick the Go button.
iii. Select the first search result CtAPI Parameters.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
28/328
2-14 Version 4.2 December 2009
Exercise - Examine the Aladdin SCADA Project(cont.)
iv. Select the first entry [CtAPI]AllowLegacyConnections. It will becopied to the Parameter Details section to the lower left. Set the
value to be 1.
v. Click the Add button.
vi. Repeat for the parameters [CtAPI]Remote and[CtAPI]AllowLegacyServices, also setting both to have a value of 1.
vii. Close the Computer Setup Editor , click OK to save the changeswhen requested.
9 Compile the Aladdin project.
i. From the Project Editor select File » Compile.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
29/328
CitectHisto rian Configuration Manual Release 1 2-15
Exercise - Start the CitectSCADA Data Source
1 Start the Aladdin project.
i. Open the Citect Explorer, click the Computer Setup Wizard button on the toolbar. Select Custom Setup and click the Next button.
ii. Select the Aladdin project from the menu. Click Next.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
30/328
2-16 Version 4.2 December 2009
Exercise - Start the CitectSCADA Data Source(cont.)
iii. Select Server and Control Client as the role of the computer. ClickNext to continue.
iv. Select No networking and click Next.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
31/328
CitectHisto rian Configuration Manual Release 1 2-17
Exercise - Start the CitectSCADA Data Source(cont.)
v. Continue to click Next until the Events Setup screen appears. Makesure the Events are enabled. The Events are used in this project to
generate the data that will be collected using CitectHistorian.
vi. Within the Startup Functions Setup window select the Client andServers item. Check that the function Startup() is listed under thecolumn heading Startup Function.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
32/328
2-18 Version 4.2 December 2009
Exercise - Start the CitectSCADA Data Source(cont.)
vii. If the Startup() function is missing or another item is listed, selectthe Client and Servers item then click the Modify button.
viii. Type StartUp() into the Modify Startup Function dialog box andselect OK.
Note:
The StartUp() function will set the initial values of all the tags and run the eventsthat automate the project.
ix. ClickNext
to continue.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
33/328
CitectHisto rian Configuration Manual Release 1 2-19
Exercise - Start the CitectSCADA Data Source(cont.)
x. The last screen to check is the General Options Setup. Make surethat the Startup Page: is !Cave_Startup. Proceed to the end of the
wizard by clicking the Next button and click the Finish button tocomplete the setup.
xi. Click the Run button to start the CitectSCADA runtime.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
34/328
2-20 Version 4.2 December 2009
Exercise - View the Running Aladdin Project
1 Access the main project page.
i. Once the project has started, the Home Page will be displayed.
ii. Observe that the six pages discussed in previous exercises areaccessible from this page (along with access to a trends page).
iii. Open each of these pages and note the data being displayed, thedata values changing as the automation scripts control the tags andthe fact that most values can also be manually changed.
2 Leave the project running.
i. This SCADA project will be the primary source of data to be used inthis course. Minimise the running project to the task bar and ensurethe CitectSCADA configuration environment is closed as it is nolonger needed.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
35/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
36/328
2-22 Version 4.2 December 2009
Exercise - Restore the SQL Database
1 Open the SQL Server Management Studio.
i. Go to Start » Programs » Microsoft SQL Server 2005 » SQL ServerManagement Studio.
ii. When the Connect to Server dialog appears click Connect.
iii. Right click the Databases folder and select Restore Database… from the menu.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
37/328
CitectHisto rian Configuration Manual Release 1 2-23
Exercise - Restore the SQL Database (cont.)
iv. Name the new database SQL Database. Select the option FromDevice as the Source. Click the ellipsis button to select the device.
v. When the Specify Backup dialog opens click the Add button.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
38/328
2-24 Version 4.2 December 2009
Exercise - Restore the SQL Database (cont.)
vi. Select the file SQLDatabase. This is a database that has been pre-prepared and contains tables that will be used in later chapters. YourInstructor will provide the location of the file.
vii. Click OK to close the Locate Backup File dialog, then OK to closethe Specify Backup dialog.
viii. Tick the Restore box:
ix. Click OK.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
39/328
CitectHisto rian Configuration Manual Release 1 2-25
Exercise - Restore the SQL Database (cont.)
x. When the database has been restored click OK.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
40/328
2-26 Version 4.2 December 2009
Summary
In this chapter you have covered the following topics:
Data Sources in this Course (page 2-2)
SQL Database as a Data Source (page 2-21)
The following questions are to check your understanding:
What is a data source?
Why were the CITECT.INI parameters configured in Exercise - Examine the Aladdin SCADA Project (page 2-7)?
What is the purpose of the SQLDatabase file?
Summary
Questions
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
41/328
Overview
CitectHistorian connects to information from various data sources and makes itavailable to client applications, in addition it creates a permanent store of thecollected data for later use. This chapter describes how to connect CitectHistorianServers to Data Sources and then to prepare the Data Items to be available to otherapplications.
This Chapter Covers These Topics:
What is CitectHistorian?........................................................3-2
CitectHistorian System ..........................................................3-5
CitectHistorian Server Wizard...............................................3-6
Connect Data Sources..........................................................3-11
Publish Data.........................................................................3-18
Create a User........................................................................3-20
OPC as a Data Source..........................................................3-30
Chapter 3: CitectHistor ian at a Glance
Introduction
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
42/328
3-2 Version 4.2 December 2009
What is CitectHistorian?
Traditionally SCADA applications were set up to control and monitor mining or plant operations. They can store data and report, however, in order to export thatdata into other business systems it was necessary to transfer the informationmanually. CitectHistorian provides connectivity to enable the transfer ofinformation between SCADA and other business systems. EssentiallyCitectHistorian performs three functions:
store captured data (Historian)
display either real-time or Historised data (Display Clients)
Transfer data to external locations
CitectHistorian provides a mechanism to distribute read-only data to clientapplications. The data is not actually stored on the CitectHistorian Server. Instead,the CitectHistorian Server acts as a portal between the client application and thedata source. When the CitectHistorian Server receives a data request from a client,
it retrieves the relevant data from the data source, turns it into a format the clientcan understand and then delivers the data to client applications for display.
Transfer
Information
Data Display
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
43/328
CitectHisto rian Configuration Manual Release 1 3-3
What is CitectHistorian? (cont.)
The Historian is a simple Data Store specifically designed to deal with long termstorage of data from a large number of SCADA tags and alarms, creating an easily-accessible, single point of reference for data analysis. Theoretically, data can belogged for any period of time, as long as the work is within the constraints of theavailable hard disk space on the CitectHistorian Server. The Historian makes use ofSQL Server 2005.
Tasks are used to automatically initiate a defined activity whenever an associatedevent occurs. Setting up a task involves a process of selecting the type of activity to
be executed, identifying the triggering event(s), and then configuring the details ofthe required action. The types of activities that can be implemented include:
transfers from SCADA data sources to connected databases
transfers from Historian to connected databases sending e-mails
executing ActiveX script
sending tag values to a SCADA data source from a database
Historian
Data Transfer
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
44/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
45/328
CitectHisto rian Configuration Manual Release 1 3-5
CitectHistorian System
There are various components that make up a CitectHistorian system. Theseinclude:
CitectHistorian Server
CitectHistorian Administration Tools
- Historian Data Manager
- Historian Status Indicator
- Configuration Backup and Restore
- Historian Reports Deployment Manager
- Historian Configuration Manager
- Report Development Tools
CitectHistorian Client Tools
- Excel Client
- CitectHistorian Web Client
SCADA connector
- CitectSCADA
- OPC
Other Connectors
- Oracle
- MS-SQL
A CitectHistorian system consists of a combination of these components.
CitectHistorian
Components
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
46/328
3-6 Version 4.2 December 2009
CitectHistorian Server Wizard
CitectHistorian was designed to allow runtime data to be viewed in clientapplications quickly and easily. After installation data may be viewed after a fewsimple steps.
The Historian Server Wizard is a tool that is designed to prepare your server toreceive information from your data sources quickly and easily. Once the computerhas been prepared to be a CitectHistorian Server, it needs to be added to theCitectHistorian Server Manager, which must run on that local machine, nowdesignated the server.
CitectHistorian
Server Wizard
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
47/328
CitectHisto rian Configuration Manual Release 1 3-7
Exercise - CitectHistor ian Server Wizard
1 Configure a CitectHistorian Server.
i. From the Windows Start menu, select Programs » Citect »CitectHistorian » Configuration Tools » Historian Configuration
Manager .ii. The first time the CitectHistorian Server Manager opens the Add
Historian Server Wizard will start. Click Next.
iii. The SQL Server instance will be selected by default. Click Next.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
48/328
3-8 Version 4.2 December 2009
Exercise - CitectHistorian Server Wizard (cont.)
iv. Set the Authentication Mode to be SQL Server Authentication.Click Next.
v. Provide authentication credentials. These will be provided by the
Instructor, but are likely to be SA and C1t ect r @1n.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
49/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
50/328
3-10 Version 4.2 December 2009
Exercise - CitectHistorian Server Wizard (cont.)
viii. When the Add Historian Server Wizard is complete the HistorianConfiguration Manager will open. Expand the tree to see the newlycreated server structure of the CitectHistorian Server .
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
51/328
CitectHisto rian Configuration Manual Release 1 3-11
Connect Data Sources
Once a CitectHistorian Server has been added to the tree, the list of Data Sources it exposes can be built. A Data Source is an object that CitectHistorian may accesseither to send or retrieve data. All connections must be defined as a Data Source
before CitectHistorian can use them. Connectors are currently available for:
SCADA systems (e.g. CitectSCADA)
OPC
Microsoft SQL databases
Oracle databases
The Historian Configuration Manager is the configuration environment ofCitectHistorian. It hosts tools that are used to administer the CitectHistorianenvironment. The Historian Configuration Manager tool uses MicrosoftManagement Console (MMC). This technology allows for inclusion of other
management tools into one simple application.
Build a Data
Source List
CitectHistorian
Configuration
Environment
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
52/328
3-12 Version 4.2 December 2009
Exercise - Add a Data Source
1 Use the Historian Configuration Manager to connect the Aladdinproject as a Data Source.
i. Return to the Historian Configuration Manager and right click Data
Sources. Select New » Data Source…
ii. Configure the following Data Source properties
Property Value
Name Aladdin
Type Control System
name or IP Address Name of student's PC
(this may also be localhost for computersrunning both CitectHistorian andCitectSCADA)
User name Engineer
Password citect
Note:
The term Control System is used to refer to a CitectSCADA plant managementsystem. All other systems must be connected as an OPC connection; this isdiscussed later in the course.
Note:
If CitectSCADA Alarms are to be accessed then CitectHistorian must be connectedto a CitectSCADA Alarm Server.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
53/328
CitectHisto rian Configuration Manual Release 1 3-13
Exercise - Add a Data Source (cont.)
Complete the dialog box to look like this:
Note:
The SCADA User must have a password configured. If the User has a blank password they will not be able to connect using CitectHistorian. Also, if theSCADA system is CitectSCADA Version 7.1, the CTapi security must have been
properly configured, else the connection will fail.
iii. Test the connection then click OK to close the window.
iv. Click OK to close the New Data Source Propert ies windows.
Note:
The Aladdin project must be running in order for the connection test to besuccessful.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
54/328
3-14 Version 4.2 December 2009
Exercise - Add a Data Source (cont.)
v. As soon as CitectHistorian begins creating the new Data Source it will
import the Data Source Schema. The Schema is the structure ofthe source database.
vi. A second dialog box will appear asking to run the Integrity CheckerTool. This tool will be examined at length in I n t e g r i t y C h e ck e r (page 13-1). Select No.
vii. The Historian Configuration Manager will display the Data Items ina tree layout. All data items are ordered into a folder structureimported directly from the source database.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
55/328
CitectHisto rian Configuration Manual Release 1 3-15
Exercise - SQL Database as a Data Source
1 Add the SQL Database as a Data Source.
i. Check the name of the SQL Server . The simplest way to do this isto open the CitectHistorian Status Indicator . Double click on the
Status Indicator icon in the System Tray. The Server name isdisplayed in the Database Server field.
ii. Close the CitectHistorian Status Indicator window.
iii. Return to the Historian Configuration Manager . Right click DataSources and select New » Data Source… from the menu.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
56/328
3-16 Version 4.2 December 2009
Exercise - SQL Database as a Data Source(cont.)
iv. Name the new data source SQL Database.
v. This time the Type is SQL Server .
vi. Type the server name identified earlier in the "Select or enter aserver name" field.
vii. Select the SQL Database from the lower drop-down list.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
57/328
CitectHisto rian Configuration Manual Release 1 3-17
Exercise - SQL Database as a Data Source(cont.)
viii. Click OK. Just as it did with the CitectSCADA data source,CitectHistorian will import the Data Source Schema of the SQL Data
Source.
ix. Open the new data source. The tables have been ordered into afolder structure imported directly from the source database.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
58/328
3-18 Version 4.2 December 2009
Publish Data
Once the CitectHistorian Server has connected to the required data sources, theitems that will be available to the client applications need to be made visible. This
process is referred to as Publishing Data. CitectHistorian is able to publish allitems from the data sources or only the items selected. The simplest way to adddata items is to drag and drop the whole data source into the Published Informationnode.
Data is Available
to Clients
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
59/328
CitectHisto rian Configuration Manual Release 1 3-19
Exercise - Publish Data
1 Publish the data in the Data Source.
i. Drag the Aladdin folder from Data Sources into the PublishedInformation folder.
ii. Open the Published Information node. The items from the originaldata source have been copied in their original folder configuration.
Note:
In the displayed hierarchy, AladdinsCaves refers to the ClusterName of theCitectSCADA project.
See Also:
For further information about Publishing Data, see CitectHistorian Help -Publishing Data » Publishing Data.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
60/328
3-20 Version 4.2 December 2009
Create a User
The last step necessary to allow users to gain access to the data sources is to createa User and to assign Permissions to the user. CitectHistorian security allows eachUser to have specific data assigned as accessible and to determine the constraints ofeach user's access (i.e. READ, WRITE, VIEW, etc.). These constraints are knownas Permissions.
Users and
Permissions
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
61/328
CitectHisto rian Configuration Manual Release 1 3-21
Exercise - Create a New User
1 Create a new User.
i. In the CitectHistorian Configuration Manager, expand the Security branch. Right Click Users and select New User… from the menu.
ii. Type in the Name and Password of the new User (here Name andPassword are both John). Click OK.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
62/328
3-22 Version 4.2 December 2009
Exercise - Create a New User (cont.)
2 Assign the User permission to view the Published Items. This willallow the User to gain access to the data items from Clientapplications.
i. Select the Aladdin folder under Published Information. Right click Aladdin and select Properties from the menu.
ii. Go to the Permissions tab and Add the User to the FolderProperties . Click OK.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
63/328
CitectHisto rian Configuration Manual Release 1 3-23
Exercise - Create a New User (cont.)
iii. When the Confirm Changes dialog appears apply the changes to allsub-items and attributes. Click OK to apply the changes.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
64/328
3-24 Version 4.2 December 2009
Exercise - Examine the New User in SQL(Optional)
1 Open the SQL Server Management Studio
i. From the Windows Start menu, select Programs » Microsoft SQLServer 2005 » SQL Server Management Studio.
ii. Click the Connect button.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
65/328
CitectHisto rian Configuration Manual Release 1 3-25
Exercise - Examine the New User in SQL (cont.)
2 View the User record.
i. Expand the tree in the left pane. Databases » CitectHistorian »Security » Users » John.
ii. Observe that CitectHistorian users are defined in the SQL back-endlike any SQL user.
3 Close the Microsoft SQL Server Management Studio.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
66/328
3-26 Version 4.2 December 2009
Exercise - View Data in the Excel Client
Now that the data connections have been created in the CitectHistorian Server and aUser has been given permission to view the Published data, it is possible to viewthe data in the Client tools.
1 The Macro Security settings in Excel may need to be reset.
i. Go to Start » Programs » Citect » CitectHistorian » Clients » ExcelClient.
ii. If you are using Office XP or Office 2003 and are still using thedefault macro security settings, you will get a security warning that
looks like this. Select OK.
Note:
Equivalent information for Microsoft Office 2007 is contained in theCitectHistorian Help.
iii. Go to Tools » Macro » Security… Set security level to LOW.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
67/328
CitectHisto rian Configuration Manual Release 1 3-27
Exercise - View Data in the Excel Client (cont.)
iv. Open the Trusted Publishers tab. Enable the Visual Basic Projectoption. Click OK.
2 Re-open the Excel Client and connect to the Server.
i. Close Excel then reopen the Excel Client.
ii. When the Excel Client opens you will see that the newCitectHistor ian toolbar is disabled.
iii. Click the New button to open a new spreadsheet. When thespreadsheet opens the first button on the CitectHistorian toolbar willbecome enabled.
iv. Click the CitectHistorian Connection button to open theconnection dialog.
v. Click the Refresh button to populate the server list then select yourComputer Name. If nothing appears, type in the Computer Name.Select the CitectHistorian database and then enter the User Name and Password of the User that was defined in the CitectHistorianConfiguration Manager . Click OK to continue.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
68/328
3-28 Version 4.2 December 2009
Exercise - View Data in the Excel Client (cont.)
Note:
The database name in the previous screen ("Historian") refers to an in-built namederived from the name of the product rather than specifically being a Historian.
3 View the selected tag data in the Excel Client.
i. Click the CitectHistorian Data Selection button to open the dataselection dialog.
Note:
This action may trigger a Windows installation message. Simply wait for it tocomplete.
ii. Expand the Aladdin folder to display its subfolder in the PublishedData pane. Expand the AladdinsCaves folder to display itssubfolders.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
69/328
CitectHisto rian Configuration Manual Release 1 3-29
Exercise - View Data in the Excel Client (cont.)
iii. Select the Digital Alarms folder then click the right-pointing arrow to
move them into the Selected Data pane. Change the Duration to 15mins. Click Next > to continue.
iv. Change the default Name of the Report to CurrentDigitalAlarms.Select the option Refresh data on File Open. Click Finish togenerate your report.
v. When the report is generated it will display the alarm records for thelast 15 minutes.
4 Shut down Excel.
i. There is no need to save the sheet if prompted.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
70/328
3-30 Version 4.2 December 2009
OPC as a Data Source
The final Data Source type to be included is OPC (as there is no Oracle serveravailable in the training environment, this option will not be investigated).
CitectHistorian can connect to any OPC DA server compliant with OPC DA 2.05aor with OPC DA3.
Note:
If you connect to Schneider Electric's OPC Factory Server (OFS) as a data source,you can only import the schema for one connected OPC device. This means youmust configure a separate Historian data source for each device connected to OFS,
and set the browse root at the device level.
In the following exercises a demonstration version of the Cogent OPC server will be used as a temporary data source.
OPC-HDA is a server mode of operation which permits Manufacturing ExecutionSystem (MES) packages (Ampla, for instance) to source data from the plant inorder to determine long-term operational parameters such as plant Key PerformanceIndicators, Overall Equipment Effectiveness etc.
OPC Data
Sources
OPC-HDA
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
71/328
CitectHisto rian Configuration Manual Release 1 3-31
Exercise - Install the Cogent OPC Server
1 Install the Cogent OPC Datahub server.
i. Locate the OPC Datahub installation package; the trainer will advisewhere it is.
ii. Double click to launch the installer.
iii. The first screen recommends closing all other applications before
continuing; please don't do this. Click Next > to continue.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
72/328
3-32 Version 4.2 December 2009
Exercise - Install the Cogent OPC Server (cont.)
iv. Click I Agree to accept the licence.
v. Accept the default of anyone using the computer . Click Next > tocontinue.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
73/328
CitectHisto rian Configuration Manual Release 1 3-33
Exercise - Install the Cogent OPC Server (cont.)
vi. The default Destination Folder is fine. Click Next > to continue.
vii. Accept the offered Start Menu Folder of Cogent. Click Install tocommence the software installation.
viii. Click Finish to complete the process. The installer will have createdthree icons on the desktop.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
74/328
3-34 Version 4.2 December 2009
Exercise - OPC as a Data Source
1 Run the Cogent OPC Server.
i. From the Windows Start menu, select Programs » Cogent » OPCDataHub » OPC DataHub. Alternately, there should be a desktop
icon.
ii. Acknowledge the demonstration-mode warning. The server willminimise to the System Tray.
iii. Launch a data simulation task. From the Windows Start menu, selectPrograms » Cogent » Simulated Data » DataSim. Again, thereshould also be a desktop icon.
iv. Minimise this window.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
75/328
CitectHisto rian Configuration Manual Release 1 3-35
Exercise - OPC as a Data Source (cont.)
v. Right click the Cogent System Tray icon .
vi. Select Properties ..
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
76/328
3-36 Version 4.2 December 2009
Exercise - OPC as a Data Source (cont.)
vii. Select the Web Server option in the left-side icon column.
viii. The Cogent web server can interfere with the web components of theHistorian environment and must be disabled. Ensure that the check
box Act as web server (in the upper-left corner) is cleared.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
77/328
CitectHisto rian Configuration Manual Release 1 3-37
Exercise - OPC as a Data Source (cont.)
ix. Click the View Data button (to the lower-left of the screen) to seethe tag values being generated by the DataSim simulation module.
x. Select any value in the list of tags and observe that manual valuesmay be provided.
xi. Don't change anything. Close the Data Browser and the Properties
window.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
78/328
3-38 Version 4.2 December 2009
Exercise - OPC as a Data Source (cont.)
2 Connect the OPC data source.
i. Open the Historian Configuration Manager.
ii. Right click the Data Sources object. Select New » Data Source...
iii. Complete the Data Source Propert ies dialog box as follows:
Name Cogent
Type OPC
iv. Click the Add button, configure the OPC dialog box as follows:
Host Name Training
OPC AppID Cogent.OPCDataHub.1
Test Connection Successful
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
79/328
CitectHisto rian Configuration Manual Release 1 3-39
Exercise - OPC as a Data Source (cont.)
v. Click OK.
vi. Click OK. The Import Schema task will launch automatically.
vii. Decline the invitation to run the Integrity Checker.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
80/328
3-40 Version 4.2 December 2009
Exercise - OPC as a Data Source (cont.)
3 Inspect the OPC data source.
i. Expand the hierarchy Data Sources » Cogent » DataSim. Note thesame eight tags are visible as were noted in the Cogent properties
pages.
ii. OPC tags cannot be viewed in the same fashion as SCADA tags. Thesystem has not yet been configured to be able to display the data ina client, the OPC connection will be re-visited when conditions areready.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
81/328
CitectHisto rian Configuration Manual Release 1 3-41
Summary
In this chapter you have covered the topics:.
What is CitectHistorian? (page 3-2)
CitectHistorian System (page 3-5) CitectHistorian Server Wizard (page 3-6)
Connect Data Sources (page 3-11)
Publish Data (page 3-18)
Create a User (page 3-20)
The following questions are to check your understanding.
What is the benefit of CitectHistorian?
Name the three functions of CitectHistorian?
Name the tool used to prepare the server to receive information from the datasources.
Describe the CitectHistorian Configuration Manager function.
Name two data source connectors.
Why “Publish Data”?
Summary
Questions
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
82/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
83/328
Overview
The Historian is a simple Data Store specifically designed to provide long termstorage of tags and alarm data from a number of SCADA sources, creating aneasily-accessible, single point of reference for data analysis. Theoretically, data can
be logged for any period of time, as long as it works within the constraints of theavailable hard disk space on the CitectHistorian Server.
The Historian is a Microsoft SQL Server 2005 database with schema optimised forwriting Tag/Alarm data, and interfaces for retrieving the data. The Historian DataManager allows users to import/export data. When used with a broader archivingstrategy to CD or network, export creates a sustainable method of permanentstorage for plant data.
This Chapter Covers These Topics:
What is Historian? .................................................................4-2
Database Schema ...................................................................4-3
Historian Data Manager.........................................................4-4
Historian Database.................................................................4-8
Historian Configuration .......................................................4-12
Configure Historian Tags.....................................................4-18
Configure Alarms in Historian ............................................4-20
Historian Item Properties.....................................................4-22
SQL Databases used in CitectHistorian...............................4-37
Licencing .............................................................................4-41
Service Management............................................................4-44
Chapter 4: Histor ian
Introduction
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
84/328
4-2 Version 4.2 December 2009
What is Historian?
Historian is a SQL 2005 database designed to store and gain access to largeamounts of data over long periods of time. Trend files by their nature consumelarge amounts of disk space. This makes it difficult to store and consequently toretrieve contiguous data over large periods of time. A system that has many trendsmay create large amounts of network traffic unnecessarily by polling for data thatchanges infrequently. By contrast, Historian works by exception. A sample of datais stored only when there has been a change in the tag value.
A trend value is sampled overa regular time period orwhenever an event occurs.This will happen regardless ofwhether there has been a
change in the Tag value.
Historian records a sample ofdata only when a significant
change in the Tag value hasoccurred. In this example thesource data is polled every100ms and the data is onlyrecorded if it differs by at least0.01
See Also:
For further information about Historian Data Fields, see CitectHistorian HelpTopics - Index » Historian » Data Fields.
Data Repository
Trend Values
Historian
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
85/328
CitectHisto rian Configuration Manual Release 1 4-3
Database Schema
The size of data samples taken by Historian are based on the tag type. The table below shows the information that is stored with every Numeric sample.
Item Size (bytes)UTC time-stamp for data received to 100 nano-seconds(0.0000001seconds)
8
Data value (as a floating value) 8
Data quality 2
Data quality sub-status -
Data quality customised status -
The table below shows the information that is stored with every Digital sample.
Item Size (bytes)
UTC time-stamp for data received to 100 nano-seconds(0.0000001seconds)
8
Data value (as a floating value) 1
Data quality 2
Data quality sub-status -
Data quality customised status -
The table below shows the information that is stored with every String sample.
Item Size (bytes)
UTC time-stamp for data received to 100 nano-seconds(0.0000001seconds)
8
Data value (as a floating value) variable
Data quality 2
Data quality sub-status -
Data quality customised status -
The table below shows the information that is stored with every Alarm sample.
Item Size (bytes)
UTC time-stamp for data received to 100 nano-seconds(0.0000001seconds)
8
Data value (as a floating value) 2
Data quality 2
Data quality sub-status -
Data quality customised status 1
Numeric Data
Digital Data
String Data
Alarm Data
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
86/328
4-4 Version 4.2 December 2009
Historian Data Manager
The creation and management of an Historian database is achieved via theHistorian Data Manager , a component of CitectHistorian that controls theinteraction with SQL Server 2005. It allows the user to perform basic datamanagement tasks, such as exporting and importing, backup and restore, and
permanent archiving.
Before the Historian can be used it must be set up to connect to the SQL Server bythe Histor ian Data Manager .
Setting up the Historian for use is a multi-stage process.
Manage the
Historian
Database
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
87/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
88/328
4-6 Version 4.2 December 2009
Exercise - Historian Data Manager
1 Connect to the SQL Server.
i. Open the Historian Data Manager .
From the Windows Start menu select Programs » Citect »CitectHistor ian » Management Tools » Historian Data Manager.
ii. Click the New Server button. This will open the Historian ServerConnection dialog. In the Server Name field, add the name of theserver.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
89/328
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
90/328
4-8 Version 4.2 December 2009
Historian Database
The Historian data is stored in an SQL database. Once the Historian has connectedto the SQL Server the next task is to create the database itself.
By default the Historian database consists of two files, where representsthe name of the database.
File Description
_Log the database log file
_Data the numeric, digital and string samples, and the associatedconfiguration information
If the Advanced Table Conf iguration option is chosen the _Data file is split and
the numeric data is placed into a separate file, allowing faster seek times.
File Description
Numeric the numeric sample data
Digital & String the digital and string samples, and configuration data.
SQL Database
TableConfiguration
Advanced Table
Configuration
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
91/328
CitectHisto rian Configuration Manual Release 1 4-9
Historian Database (cont.)
Each of the database files has properties that may be configured by the user to suitthe individual application
Property Action
Name the name of the file
To change one of the default settings for the file group properties, selectthe relevant cell in the table, and then click it again to make the requiredvalue adjustments.
Initial Size the starting size of the file. The default is 3Mb for data files, 1Mb for thelog file.
MaximumSize
a cap on the file size. The minimum value you can use is that set for InitialSize, the maximum is 2,097,152MB
Grow By the growth rate for the database. This sets the percentage of the maximum
that the database will grow by when it runs low on space. The default is 10 percent
Mode The Mode column determines how the growth of a database file ismanaged. You have the option to automatically increase a file size by a percentage of the existing size (%), or via units measured in megabytes(MB). Selecting None switches automatic database growth off.
File the location of the file in relation to the SQL Server. The button to theright of the table cell allows you to select a location.
To create a new Historian Database:
Open the Historian Data Manager » General tab and select Create in the Databasesection
or
Click the Create Historian Database button.
Database Files
How to Create a
New Historian
Database
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
92/328
4-10 Version 4.2 December 2009
Exercise - Create a Historian Database
1 Create a new Historian Database.
i. Click the Create Historian Database button.
ii. When the New Database dialog opens, type Historian as the nameof the new database into the Name field. The name can be up to 123characters in length and must be unique on the connected SQLServer.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
93/328
CitectHisto rian Configuration Manual Release 1 4-11
Exercise - Create a Historian Database (cont.)
iii. The Collation field selects the collation mode that the server will usefor the Historian database. This determines how SQL Server 2005sorts and compares characters stored in non-Unicode data types. Set
this to (located at the top of the drop-down list).
iv. Click Create.
v. When the Historian Maintainer has created the new database a
success dialog box will appear. Click the OK button to close thedialog.
vi. The new database name will appear in the Active field.
vii. Close the Historian Data Manager.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
94/328
4-12 Version 4.2 December 2009
Historian Configuration
The Historian Configuration may be viewed and customised by right-clicking theHistorian node and choosing Properties from the menu.
See Also:
For further information about Historian Configuration, see CitectHistorian Help -Setting up a Historian Server .
Properties
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
95/328
CitectHisto rian Configuration Manual Release 1 4-13
Exercise - Historian Configuration
1 Configure the Historian.
i. Return to the Historian Configuration Manager .
ii. Right click the Historian node and select Properties from the menu.
iii. Select the server name from the list or enter the computer name andinstance name manually (generally, this list displays every visibleSQL server except your own).
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
96/328
4-14 Version 4.2 December 2009
Exercise - Historian Configuration (cont.)
iv. SQL Server Authentication must be used to ensure components later
in this course connect correctly. Select Use SQL Server Authentication and click the Default button when it appears to makeuse of the in-built CSRAdmin user.
v. Select the database. Select Historian from the drop down list. ClickOK.
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
97/328
CitectHisto rian Configuration Manual Release 1 4-15
Historian Configuration (cont.)
The second tab configures the Data Source properties in Historian. Each DataSource may be configured separately.
Historian Tags and Alarms are directly linked back to their plant-based data sourcesand are typically given matching names.
Time-Stamped data is connected to Trend Tags and thus comes complete withtiming information.
This information is used to define the generic parameters of the data connection.
Data Sources
Tags, Alarms and
Time-Stamped
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
98/328
4-16 Version 4.2 December 2009
Historian Configuration (cont.)
By default SCADA data sources are polled at 1 second intervals. The minimum poll rate is 100 ms. Every time the data is polled, Historian checks the values of alltags logged from that data source. If there has been a change then the new value isrecorded.
Polling large numbers of tags may slow down system performance. One of theadvantages of this system is that multiple data sources may be defined from thesame SCADA project. This means that the poll rate for tags that are less timecritical may be configured separately.
See Also:
Scanning too quickly may have an adverse affect on the SCADA system. Forfurther information regarding Historian Scan Rates, see CitectHistorian Help
Topics - Index » Historian » Data Sources scan rate.
Connection Timeout
The period of time the Historian will wait for a heartbeat response from a SCADAdata source before declaring that data source as offline. The default is 10 seconds.
Request Timeout
The period of time the Historian will wait for a data request response from a
SCADA data source before declaring that data source as offline, and marking therequest as failed in the event log. The default is 10 seconds and the maximum valueis 10 minutes (600 seconds).
Poll-Rate
Timeout
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
99/328
CitectHisto rian Configuration Manual Release 1 4-17
Historian Configuration (cont.)
Whenever the primary SCADA data source is offline, if a redundant SCADA datasource has been configured, the Historian Data Service will attempt to poll theredundant server. If no redundant server has been configured, or if the redundantserver is unavailable or unresponsive, the connection is marked as inactive in theevent log.
The Acquire Rate calls a CtAPI alarm log query for the specified period at that rate.By default this is 5 minutes. This means that Historian will request 5 minutes ofdata every 5 minutes.
Large amounts of data may slow system performance. If large numbers of alarmsoccur the system will limit the number of alarms requested. By default that numberis 1000. When that block has been transferred, Historian will then transfer the next
block.
Redundant
CitectSCADA
Servers
Acquire Rate
Limit Alarm
Requests
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
100/328
4-18 Version 4.2 December 2009
Configure Historian Tags
Tags are configured in Historian the same way as they are prepared in the PublishedInformation folder - by dragging them from the Data Source into the Historianfolder.
To Configure Historian Tags:
Drag the whole folder into Historian
or
Drag individual tags or a multiple selection of tags into a pre-existing folder in
Historian.
Note:
Like the Published Information folder, tags may not be dragged into the root of theHistorian node, they must be placed in a directory.
Note:
Dragging the whole folder into Historian will take less time than draggingindividual tags (even if grouped), because the back-end procedures can perform a
bulk insert, instead of individual inserts.
Drag from the
Data Source
How to
Configure
Historian Tags
-
8/18/2019 CitectHistorian V4.2 R1 Vol1
101/328
CitectHisto rian Configuration Manual Release 1 4-19
Exercise - Configure Historian Tags
1 Tags logged in the Historian do not sit in the root of the Historianfolder but in their own subfolder. This exercise will demonstratethe correct method of locating tags to be logged in the Historian.
i. Return to the Historian Configuration Manager .ii. Right click Historian and select New Folder… from the menu.
iii. Name the new folder Aladdin Data Source and click OK.
iv. Drag the Tags folder from the data source into the Aladdin DataSource folder in Historian.
v. Some of the tags automatically imported are essentially procedural tothe operation of the Aladdin project. These can be removed. Deletethese tags from the Historian tag list:
Al addi nsCaves. Bi t _1
Al addi nsCaves. DescPLC
Al addi nsCaves. Fi l eOf f set
Al addi nsCaves. NamePLC
Al addi nsCaves. Random_Number
Al addi nsCaves. WorkOr der PLC
Note:
Depending on the number of tags to be Historised, it would be more likely toidentify the specific tags required and move the