CitectHistorian V4.2 R1 Vol1

Manual Release 1
CitectHistorian Configuration
Training Manual
Version 4.2
Volume 1
Schneider Electric (Australia) Pty Ltd

3 Fitzsimons Lane
GORDON NSW 2072
PO Box 174
PYMBLE NSW 2073
AUSTRALIA
Telephone:
Fax:
61 2 9496 7300
61 2 9496 7399
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 to
notify 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 Configuration
training 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 by
Schneider Electric (Australia) Pty Ltd. You must not copy any part of the manual in hard or electronic form or make any adaptation or other
commercial 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 of
Schneider Electric (Australia) Pty Ltd. Any authorised reproduction must acknowledge Schneider Electric (Australia) Pty Ltd as owner of
copyright in work.
TRADEMARKS
Schneider Electric (Australia) Pty Ltd has made every effort to supply trademark information about company names, products and services
mentioned 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 Development
and are also experienced trainers in their own right; some are also published authors. Currently, the team is supporting a range of over 70
courses in multiple languages and multiple software environments.
Authors
Alynda Brown, David Heath, Peter West
Contributors
David Mackay, Con Karantziounis, Craig Donnelly
December 2009 Edition for Version 4.2

Manual Release 1
Written, Printed and bound in Australia
ii
Version 4.2
December 2009
Contents
CHAPTER 1:
INTRODUCTION TO CITECTHISTORIAN ................................................ 1-1
Overview .................................................................................................................... 1-1

Before You Begin....................................................................................................... 1-2
Course Overview ........................................................................................................ 1-3
Conventions Used in this Manual............................................................................... 1-5
CHAPTER 2:
DATA SOURCES ...................................................................................... 2-1
Overview .................................................................................................................... 2-1

Data Sources in this Course........................................................................................ 2-2
SQL Database as a Data Source ............................................................................... 2-21
CHAPTER 3:
CITECTHISTORIAN AT A GLANCE ......................................................... 3-1
Overview .................................................................................................................... 3-1

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 4:
HISTORIAN ............................................................................................. 4-1
Overview .................................................................................................................... 4-1

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 5:
PUBLISH INFORMATION ......................................................................... 5-1
Overview .................................................................................................................... 5-1

Organise Published Data ............................................................................................ 5-2
Access Data Sources................................................................................................... 5-6
Security..................................................................................................................... 5-10
Aliases ...................................................................................................................... 5-18
Manual Release 1
iii
CHAPTER 6:
BACKFILL MANAGER ............................................................................ 6-1
Overview .................................................................................................................... 6-1

Backfill Manager ........................................................................................................ 6-2
CHAPTER 7:
PROJECT MANAGEMENT ....................................................................... 7-1
Overview .................................................................................................................... 7-1

Backup and Restore Projects ...................................................................................... 7-2
Active Project ........................................................................................................... 7-14
Remove a Project...................................................................................................... 7-22
CHAPTER 8:
TASKS ..................................................................................................... 8-1
Overview .................................................................................................................... 8-1

Why Are Tasks Used? ................................................................................................ 8-2
Task Properties ........................................................................................................... 8-3
Data Transfer Tasks.................................................................................................... 8-7
ActiveX Tasks .......................................................................................................... 8-30
Email Tasks .............................................................................................................. 8-34
Organise Tasks into Folders ..................................................................................... 8-37
CHAPTER 9:
EVENTS................................................................................................... 9-1
Overview .................................................................................................................... 9-1

What is an Event? ....................................................................................................... 9-2
The Event Service....................................................................................................... 9-6
Recipe Management via Tasks and Events ................................................................ 9-8
CHAPTER 10:
THE EXCEL CLIENT ............................................................................. 10-1
Overview .................................................................................................................. 10-1

View Data in the Excel Client .................................................................................. 10-2
Customise the Excel Client ...................................................................................... 10-7
Statistical Analysis - Optional Section ................................................................... 10-12
CHAPTER 11:
CITECTHISTORIAN WEB CLIENT ........................................................ 11-1
Overview .................................................................................................................. 11-1

Set Up a Trusted Site................................................................................................ 11-2
Internet Information Services - (IIS) ...................................................................... 11-10
Connect to the CitectHistorian Server .................................................................... 11-11
The CitectHistorian Web Client Interface .............................................................. 11-13
Display Data ........................................................................................................... 11-15
Web Client Events .................................................................................................. 11-16
Snapshot Data......................................................................................................... 11-22
Time Series ............................................................................................................. 11-25
Attributes ................................................................................................................ 11-29
iv
Version 4.2
December 2009
CHAPTER 12:
INTRODUCTION TO CITECTHISTORIAN .............................................. 12-1
Overview .................................................................................................................. 12-1

Before You Begin..................................................................................................... 12-2
Course Overview ...................................................................................................... 12-3
Conventions Used in this Manual............................................................................. 12-5
CHAPTER 13:
INTEGRITY CHECKER .......................................................................... 13-1
Overview .................................................................................................................. 13-1

Integrity Checker Tool ............................................................................................. 13-2
CHAPTER 14:
HISTORIAN INTERPOLATION ............................................................... 14-1
Overview .................................................................................................................. 14-1

Historian Interpolation.............................................................................................. 14-2
CHAPTER 15:
PROCESS ANALYST .............................................................................. 15-1
Overview .................................................................................................................. 15-1

The Process Analyst Client ...................................................................................... 15-2
Properties of the Process Analyst ............................................................................. 15-9
Display Tags in the Process Analyst ...................................................................... 15-10
Pen Types ............................................................................................................... 15-11
Change the Properties of the Process Analyst ........................................................ 15-18
CHAPTER 16:
HISTORIAN REPORTS DEPLOYMENT MANAGER ................................ 16-1
Overview .................................................................................................................. 16-1

CitectHistorian Reporting Manager ......................................................................... 16-2
Historian Database.................................................................................................... 16-7
Install a Report Pack on the Historian.................................................................... 16-11
Deploy Reports in Microsoft Reporting Services .................................................. 16-23
CHAPTER 17:
SAMPLE REPORTS ................................................................................ 17-1
Overview .................................................................................................................. 17-1

Sample Reports......................................................................................................... 17-2
Developer Reports .................................................................................................... 17-3
Alarm Management Reports..................................................................................... 17-4
Energy Reports ......................................................................................................... 17-9
Browse a Deployed Report..................................................................................... 17-11
CHAPTER 18:
ENERGY REPORTS ............................................................................... 18-1
Overview .................................................................................................................. 18-1

Sample Data.............................................................................................................. 18-2
Reports Hierarchies .................................................................................................. 18-8
Run an Energy Report ............................................................................................ 18-13
Create a New Hierarchy ......................................................................................... 18-20
Energy Tariffs......................................................................................................... 18-33
Connect Tariffs to Consumption ............................................................................ 18-38
Manual Release 1
CHAPTER 19:
CASE STUDY ......................................................................................... 19-1
Overview .................................................................................................................. 19-1

CHAPTER 20:
COURSE SUMMARY .............................................................................. 20-1
Overview .................................................................................................................. 20-1

Summary - CitectHistorian Configuration ............................................................... 20-2
Course Evaluation .................................................................................................... 20-3
Further Training........................................................................................................ 20-4
APPENDIX A:
MODIFY EXISTING REPORTS ................................................................ A-1
Overview ................................................................................................................... A-1

SQL Server Reporting Services................................................................................. A-2
Open a Report for Editing ......................................................................................... A-3
Exercise - 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-1

Using this Chapter ..................................................................................................... C-2
Toolbox Report Items................................................................................................ C-3
Group, Sort and Filter Tables .................................................................................. C-49
Format Reports ........................................................................................................ C-64
Customised Calculated Fields ................................................................................. C-76
Format a Report with Expressions .......................................................................... C-88
Drill Down............................................................................................................... C-97
Navigation ............................................................................................................. C-105
Publish 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-1
System Requirements .................................................................................................E-2
Additional Windows Components .............................................................................E-4
Install CitectHistorian...............................................................................................E-13
Configure CitectHistorian ........................................................................................E-22
SQL Server Settings .................................................................................................E-26
vi
Version 4.2
December 2009
Chapter 1:
Introduction to CitectHistorian
Overview
Introduction
CitectHistorian is a plant-wide reporting tool that allows traditionally disparate data

types to be combined, compared and logged on a common platform. By
communicating with SCADA systems, Oracle, and SQL databases, CitectHistorian
allows the collation and management of production data for delivery to a wide
range of business applications.
The data collected by the CitectHistorian system can be published on a server and
accessed directly via client applications, or it can be logged as historical data to an
SQL Server database, exposing it to a vast array of reporting tools including SQL
Server 2005 Reporting Services.
This Chapter Covers These Topics:

Before You Begin ..................................................................1-2
Course Overview ...................................................................1-3
Conventions Used in this Manual..........................................1-5
Before You Begin

Your Instructor
Please write the name of your Instructor here
____________________
Your Instructor will be spending the next three days with you, and will guide you
through this training course. Your Instructor is an experienced CitectHistorian user
so please feel free to ask questions.
Defining the
Scope of this
Training Manual
This training manual is a supplement to the authorised training. In order to make

full use of the software you should also refer to the Online Help and CitectHistorian
Knowledge Base.
The graphics displaying screen shots have been taken using the Windows XP
operating system using Classic mode display properties. If you are running a
different 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 may
vary slightly from release screen shots.
1-2
Version 4.2
December 2009
Course Overview
Course
Objectives
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 using
CitectHistorian
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 your
own 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
Course Material
Please take a few moments to have a look through your Training Pack. In addition
to 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
Course Assets
For this course, in addition to the standard CitectHistorian software, you will need
the 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 ERP

systems to permit interaction with business systems.
Alarmbell.gif
An example graphics file to demonstrate adding a graphic

to 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 save

typing 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.
Manual Release 1
1-3
Course Overview (cont.)

Course Program
The training course will take three days to complete. The following program
outlines the topics that will be covered on each day:
Day
1
Topics
Data Sources
CitectHistorian at a Glance
Historian
Historian Status Indicator
Publish Information
Backfill Manager
Manage Projects
Tasks
Events
The Excel Client
CitectHistorian Web Client
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 configuration and use of
CitectHistorian. It will not cover:
The SQL programming language

The administration of SQL Servers
The creation of custom reports using SQL Server Reporting Services
To gain these skills, we recommend students attend appropriate Microsoft
sanctioned training courses.
Support
1-4
If you require support during training or would like additional information about
any concepts or products in the course, please ask your Instructor.
Version 4.2
December 2009
Conventions Used in this Manual

Objectives
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 are
given to illustrate the conceptual overview.
Example The CitectHistorian configuration environment consists of several toolbars, browser

windows and programming editors. This chapter introduces the user to the
configuration environment using an example project with pre-defined elements.
Exercises
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 each
exercise 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.
User Input
Use the following template settings:
Whenever you are required to type information into a field or dialog box it will be
written in this font
Example KETTLE_TEMP/25
Manual Release 1
1-5
Conventions Used in this Manual (cont.)

Hints and Tips
This heading will provide you with useful or helpful information that will make
configuring your project easier
Example -
Hints & Tips

To go to the next field, use the mouse cursor or press the TAB key.
Note
A note will refer to a feature which may not be obvious at first glance but
something that you should always keep in mind
Example -
Note:
Any events named GLOBAL are enabled automatically when events are enabled.
Menus and Menu

Options
Text separated by the double arrow symbol indicates that you are to select a
menu
Example File New
Open a menu File then select the menu option New
Horizontal and
Vertical Tabs
Text written this way indicates the Horizontal then the (Vertical) tab you are to
select.
Example Appearance (General)
1-6
Version 4.2
December 2009
Conventions Used in this Manual (cont.)

See Also
Text written in this way indicates further references about the current topic.
Example See Also:
For further information about Templates, see CitectHistorian Help - Using Page
Templates.
Further Training
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 Design

Course.
Caution
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 the
Citect Explorer will be overwritten.
Manual Release 1
1-7
Chapter 2:
Data Sources
Overview
Introduction
CitectHistorian takes information from various data sources and prepares it for use
by client applications. This chapter describes the data sources that will be used
during this training course.

Data Sources in this Course ...................................................2-2
SQL Database as a Data Source ..........................................2-21
Data Sources in this Course

The Aladdin
Project
The Aladdin Project has been created specifically to generate data for the
CitectHistorian Training Course. This project is set in a fictitious mountain resort
where guided tours are held through a cave system. The project consists of three
parts.
Aladdins 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 large
amounts of data
The purpose of the project is to demonstrate how CitectHistorian is able to take data
from many disparate data sources and to then report information from all sources in
a concise manner. CitectHistorian is able to perform different types of tasks and it
may be applied to many different scenarios. This project reproduces different
scenarios in order to demonstrate a variety of applications.
Further Training:
Detailed training in managing a CitectSCADA environment is covered in the

variety of CitectSCADA Courses.
2-2
Version 4.2
December 2009
Data Sources in this Course (cont.)

Building
Management
Aladdins Caves is a simulation of a building management system.

The SCADA system monitors tags and trends to provide a graphical representation
of 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
Manual Release 1
2-3

Building
Monitoring
2-4
In addition to localised data displays on the Building Management page, there are
three status pages for data monitoring of Cave Temperature, Carbon Dioxide levels
and Wind Speeds.
Version 4.2
December 2009

Recipe
Management
This fictitious cave system also has pure natural spring water. Hidden away from
the view of the general public there is a small cottage industry creating flavoured
spring 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
Manual Release 1
2-5

Plant Monitoring
and Data
Management
The Aladdin Cave System is located in a National Park and is therefore in an

environmentally sensitive area. A water filtration system has been implemented in
order to take the waste water from the bottling plant and release clean water back
into the environment. Government health codes require that the treated water is
monitored for different chemical levels and that the historical data is kept for seven
years.
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 and
management would like to receive reports from all three systems. CitectHistorian
will be used to gather the data from the three areas and report the relevant
information in a concise manner and also to implement a Recipe Management
System.
2-6
Version 4.2
December 2009
Exercise - Examine the Aladdin SCADA Project

1
Restore the Aladdin SCADA project.

i.
Your Instructor will provide the Aladdin project backup file. Restore
the project if it is not already installed on your computer.
View the "Operational" pages.

i.
There are three pages in the Aladdin project which display the
primary operation of the Aladdin caves system.
Page
Use
Cave_System
Building Management
Flavouring
Recipe Management
Filter
Plant Monitoring
Manual Release 1
2-7

(cont.)
3
2-8
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
Version 4.2
December 2009

(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)
Manual Release 1
2-9

(cont.)
4
2-10
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
Version 4.2
December 2009

(cont.)
i.
Examine these tags:
1. Level (amount of ingredient in the storage tank) (flavour_Level)

2. Recipe values (flavourPLC)
5
Open the Filter page.
i.
Examine these tags:
1. Various Level tags.
Manual Release 1
2-11

(cont.)
6
Open the "Status" pages.

i.
ii.
2-12
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
Open these pages

configuration.
in
the
Graphic Builder and note their
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 on
the graphics pages.
iv.
Similarly, note the Trend tags and on the Alarm menu, the various
Alarm tags.
Version 4.2
December 2009

(cont.)
8
Configure the CitectSCADA Project to accept connections from

CitectHistorian
Note:
Theses steps are only required for CitectSCADA V7.1 to work with the tightened
security restrictions - external connections are blocked by default; these instructions
open 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 and
click the Go button.
iii.
Select the first search result CtAPI Parameters.
Manual Release 1
2-13

(cont.)
iv.
Select the first entry [CtAPI]AllowLegacyConnections. It will be

copied to the Parameter Details section to the lower left. Set the
value to be 1.
v.
Click the Add button.
vi.
[CtAPI]Remote
and
Repeat
for
the
parameters
[CtAPI]AllowLegacyServices, also setting both to have a value of 1.
vii.
Close the Computer Setup Editor, click OK to save the changes

when requested.
Compile the Aladdin project.

i.
From the Project Editor select File Compile.
2-14
Version 4.2
December 2009
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.
Manual Release 1
2-15

(cont.)
2-16
iii.
Select Server and Control Client as the role of the computer. Click
Next to continue.
iv.
Select No networking and click Next.
Version 4.2
December 2009

(cont.)
v.
Continue to click Next until the Events Setup screen appears. Make
sure 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 and
Servers item. Check that the function Startup() is listed under the
column heading Startup Function.
Manual Release 1
2-17

(cont.)
vii.
If the Startup() function is missing or another item is listed, select

the Client and Servers item then click the Modify button.
viii.
Type StartUp() into the Modify Startup Function dialog box and
select OK.
Note:
The StartUp() function will set the initial values of all the tags and run the events
that automate the project.
ix.
2-18
Click Next to continue.
Version 4.2
December 2009

(cont.)
x.
The last screen to check is the General Options Setup. Make sure
that the Startup Page: is !Cave_Startup. Proceed to the end of the
wizard by clicking the Next button and click the Finish button to
complete the setup.
xi.
Click the Run
button to start the CitectSCADA runtime.
Manual Release 1
2-19
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 are

accessible from this page (along with access to a trends page).
iii.
Open each of these pages and note the data being displayed, the
data values changing as the automation scripts control the tags and
the fact that most values can also be manually changed.
Leave the project running.

i.
This SCADA project will be the primary source of data to be used in

this course. Minimise the running project to the task bar and ensure
the CitectSCADA configuration environment is closed as it is no
longer needed.
2-20
Version 4.2
December 2009
SQL Database as a Data Source

The SQL
Database
The second data source is the SQL Database. This database contains preconfigured
tables that will be used to transfer data between the database and the SCADA
system.
This database can be used to emulate the typical ERP system found in most larger
organisations. The database will be used as a destination for extracted data and as a
source of data for transient analysis.
Manual Release 1
2-21
Exercise - Restore the SQL Database

1
2-22
Open the SQL Server Management Studio.

i.
Go to Start Programs Microsoft SQL Server 2005 SQL Server

Management Studio.
ii.
When the Connect to Server dialog appears click Connect.
iii.
Right click the Databases folder and select Restore Database

from the menu.
Version 4.2
December 2009
Exercise - Restore the SQL Database (cont.)

iv.
Name the new database SQL Database. Select the option From
Device as the Source. Click the ellipsis button to select the device.
v.
When the Specify Backup dialog opens click the Add button.
Manual Release 1
2-23

vi.
Select the file SQLDatabase. This is a database that has been preprepared and contains tables that will be used in later chapters. Your
Instructor will provide the location of the file.
vii.
Click OK to close the Locate Backup File dialog, then OK to close

the Specify Backup dialog.
viii.
Tick the Restore box:
ix.
2-24
Click OK.
Version 4.2
December 2009

x.
When the database has been restored click OK.
Manual Release 1
2-25
Summary
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)
Questions
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?
2-26
Version 4.2
December 2009
Chapter 3:
CitectHistorian at a Glance
Overview
Introduction
CitectHistorian connects to information from various data sources and makes it

available to client applications, in addition it creates a permanent store of the
collected data for later use. This chapter describes how to connect CitectHistorian
Servers to Data Sources and then to prepare the Data Items to be available to other
applications.

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
What is CitectHistorian?
Transfer
Information
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 that
data into other business systems it was necessary to transfer the information
manually. CitectHistorian provides connectivity to enable the transfer of
information between SCADA and other business systems.
Essentially
CitectHistorian performs three functions:
store captured data (Historian)
display either real-time or Historised data (Display Clients)
Transfer data to external locations
Data Display
3-2
CitectHistorian provides a mechanism to distribute read-only data to client

applications. The data is not actually stored on the CitectHistorian Server. Instead,
the CitectHistorian Server acts as a portal between the client application and the
data 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 client
can understand and then delivers the data to client applications for display.
Version 4.2
December 2009
What is CitectHistorian? (cont.)

Historian
The Historian is a simple Data Store specifically designed to deal with long term
storage of data from a large number of SCADA tags and alarms, creating an easilyaccessible, single point of reference for data analysis. Theoretically, data can be
logged for any period of time, as long as the work is within the constraints of the
available hard disk space on the CitectHistorian Server. The Historian makes use of
SQL Server 2005.
Data Transfer
Tasks are used to automatically initiate a defined activity whenever an associated

event 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 of
the 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
Manual Release 1
3-3
What is CitectHistorian? (cont.)

How It All Fits
Together
This diagram demonstrates how the CitectHistorian Server is able to connect to

multiple Production Control Systems and Business Databases, and then act as a
gateway between those different data sources. Information from the Control
System is stored in Business Databases, such as Microsoft SQL Server, Oracle and
the Historian repository and used for future reporting and analysis purposes.
Data from all of the available data sources can be published to the CitectHistorian
clients, including Excel, Microsoft Reporting Services and the Web Client, for realtime ad-hoc reporting and analysis.
3-4
Version 4.2
December 2009
CitectHistorian System
CitectHistorian
Components
There are various components that make up a CitectHistorian system. These

include:
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
SCADA connector
-
CitectSCADA
OPC
Other Connectors
-
Oracle
MS-SQL
A CitectHistorian system consists of a combination of these components.
Manual Release 1
3-5
CitectHistorian Server Wizard

CitectHistorian
Server Wizard
CitectHistorian was designed to allow runtime data to be viewed in client

applications quickly and easily. After installation data may be viewed after a few
simple steps.
The Historian Server Wizard is a tool that is designed to prepare your server to
receive information from your data sources quickly and easily. Once the computer
has been prepared to be a CitectHistorian Server, it needs to be added to the
CitectHistorian Server Manager, which must run on that local machine, now
designated the server.
3-6
Version 4.2
December 2009
Exercise - CitectHistorian 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.
Manual Release 1
3-7
Exercise - CitectHistorian Server Wizard (cont.)
3-8
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 C1tectr@1n.
Version 4.2
December 2009

vi.
Select the Database Name from the drop-down list to which

CitectHistorian will connect and click Next.
vii.
Accept the default Registration Name and click Finish to complete

the registration.
Manual Release 1
3-9

viii.
When the Add Historian Server Wizard is complete the Historian

Configuration Manager will open. Expand the tree to see the newly
created server structure of the CitectHistorian Server.
3-10
Version 4.2
December 2009
Connect Data Sources

Build a Data
Source List
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 access
either 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
CitectHistorian
Configuration
Environment
The Historian Configuration Manager is the configuration environment of

CitectHistorian. It hosts tools that are used to administer the CitectHistorian
environment.
The Historian Configuration Manager tool uses Microsoft
Management Console (MMC). This technology allows for inclusion of other
management tools into one simple application.
Manual Release 1
3-11
Exercise - Add a Data Source

1
Use the Historian Configuration Manager to connect the Aladdin

project 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 computers
running both CitectHistorian and
CitectSCADA)
User name
Engineer
Password
citect
Note:
The term Control System is used to refer to a CitectSCADA plant management
system. All other systems must be connected as an OPC connection; this is
discussed later in the course.
Note:
If CitectSCADA Alarms are to be accessed then CitectHistorian must be connected
to a CitectSCADA Alarm Server.
3-12
Version 4.2
December 2009
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 the
SCADA 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 Properties windows.
Note:
The Aladdin project must be running in order for the connection test to be
successful.
Manual Release 1
3-13
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 of
the source database.
vi.
A second dialog box will appear asking to run the Integrity Checker
Tool. This tool will be examined at length in Integrity Checker
(page 13-1). Select No.
vii.
The Historian Configuration Manager will display the Data Items in

a tree layout. All data items are ordered into a folder structure
imported directly from the source database.
3-14
Version 4.2
December 2009
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 is
to open the CitectHistorian Status Indicator. Double click on the
Status Indicator icon
in the System Tray.
displayed in the Database Server field.
The Server name is
ii.
Close the CitectHistorian Status Indicator window.
iii.
Return to the Historian Configuration Manager. Right click Data

Sources and select New Data Source from the menu.
Manual Release 1
3-15

(cont.)
3-16
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 a

server name" field.
vii.
Select the SQL Database from the lower drop-down list.
Version 4.2
December 2009

(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 a
folder structure imported directly from the source database.
Manual Release 1
3-17
Publish Data
Data is Available
to Clients
3-18
Once the CitectHistorian Server has connected to the required data sources, the
items 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 all
items from the data sources or only the items selected. The simplest way to add
data items is to drag and drop the whole data source into the Published Information
node.
Version 4.2
December 2009
Exercise - Publish Data

1
Publish the data in the Data Source.

i.
Drag the Aladdin folder from Data Sources into the Published
Information folder.
ii.
Open the Published Information node. The items from the original
data source have been copied in their original folder configuration.
Note:
In the displayed hierarchy, AladdinsCaves refers to the ClusterName of the
CitectSCADA project.
See Also:
For further information about Publishing Data, see CitectHistorian Help Publishing Data Publishing Data.
Manual Release 1
3-19
Create a User
Users and
Permissions
3-20
The last step necessary to allow users to gain access to the data sources is to create
a User and to assign Permissions to the user. CitectHistorian security allows each
User to have specific data assigned as accessible and to determine the constraints of
each user's access (i.e. READ, WRITE, VIEW, etc.). These constraints are known
as Permissions.
Version 4.2
December 2009
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 and
Password are both John). Click OK.
Manual Release 1
3-21
Exercise - Create a New User (cont.)

2
Assign the User permission to view the Published Items. This will
allow the User to gain access to the data items from Client
applications.
i.
Select the Aladdin folder under Published Information.
Right click
Aladdin and select Properties from the menu.
ii.
3-22
Go to the Permissions tab and Add the User to the Folder

Properties. Click OK.
Version 4.2
December 2009
Exercise - Create a New User (cont.)

iii.
When the Confirm Changes dialog appears apply the changes to all
sub-items and attributes. Click OK to apply the changes.
Manual Release 1
3-23
Exercise - Examine the New User in SQL

(Optional)
1
3-24
Open the SQL Server Management Studio

i.
From the Windows Start menu, select Programs Microsoft SQL

Server 2005 SQL Server Management Studio.
ii.
Click the Connect button.
Version 4.2
December 2009
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-end

like any SQL user.
Close the Microsoft SQL Server Management Studio.
Manual Release 1
3-25
Exercise - View Data in the Excel Client

Now that the data connections have been created in the CitectHistorian Server and a
User has been given permission to view the Published data, it is possible to view
the 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 Excel

Client.
ii.
If you are using Office XP or Office 2003 and are still using the
default 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 the
CitectHistorian Help.
iii.
3-26
Go to Tools Macro Security Set security level to LOW.
Version 4.2
December 2009
Exercise - View Data in the Excel Client (cont.)

iv.
Open the Trusted Publishers tab. Enable the Visual Basic Project
option. Click OK.
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 new
CitectHistorian toolbar is disabled.
iii.
Click the New

button to open a new spreadsheet. When the
spreadsheet opens the first button on the CitectHistorian toolbar will
become enabled.
iv.
Click the CitectHistorian Connection

connection dialog.
v.
Click the Refresh button to populate the server list then select your
Computer 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 CitectHistorian
Configuration Manager. Click OK to continue.
Manual Release 1
button to open the
3-27
Note:
The database name in the previous screen ("Historian") refers to an in-built name
derived from the name of the product rather than specifically being a Historian.
View the selected tag data in the Excel Client.

i.
Click the CitectHistorian Data Selection

selection dialog.
button to open the data
Note:
This action may trigger a Windows installation message. Simply wait for it to
complete.
ii.
Expand the Aladdin folder to display its subfolder in the Published

Data pane. Expand the AladdinsCaves folder to display its
subfolders.
3-28
Version 4.2
December 2009
iii.
Select the Digital Alarms folder then click the right-pointing arrow to
move them into the Selected Data pane. Change the Duration to 15
mins. Click Next > to continue.
iv.
Change the default Name of the Report to CurrentDigitalAlarms.

Select the option Refresh data on File Open. Click Finish to
generate your report.
v.
When the report is generated it will display the alarm records for the
last 15 minutes.
Shut down Excel.

i.
There is no need to save the sheet if prompted.
Manual Release 1
3-29
OPC as a Data Source

OPC Data
Sources
The final Data Source type to be included is OPC (as there is no Oracle server
available in the training environment, this option will not be investigated).
CitectHistorian can connect to any OPC DA server compliant with OPC DA 2.05a
or 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 you
must 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
3-30
OPC-HDA is a server mode of operation which permits Manufacturing Execution

System (MES) packages (Ampla, for instance) to source data from the plant in
order to determine long-term operational parameters such as plant Key Performance
Indicators, Overall Equipment Effectiveness etc.
Version 4.2
December 2009
Exercise - Install the Cogent OPC Server

1
Install the Cogent OPC Datahub server.

i.
Locate the OPC Datahub installation package; the trainer will advise
where 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.
Manual Release 1
3-31
Exercise - Install the Cogent OPC Server (cont.)
3-32
iv.
Click I Agree to accept the licence.
v.
Accept the default of anyone using the computer. Click Next > to
continue.
Version 4.2
December 2009
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.

commence the software installation.
viii.
Click Finish to complete the process. The installer will have created
three icons on the desktop.
Click Install to
Manual Release 1
3-33
Exercise - OPC as a Data Source

1
Run the Cogent OPC Server.

i.
From the Windows Start menu, select Programs Cogent OPC

DataHub OPC DataHub. Alternately, there should be a desktop
icon.
ii.
Acknowledge the demonstration-mode warning.

minimise to the System Tray.
iii.
Launch a data simulation task. From the Windows Start menu, select
Programs Cogent Simulated Data DataSim. Again, there
The server will
should also be a desktop icon.
iv.
3-34
Minimise this window.
Version 4.2
December 2009
Exercise - OPC as a Data Source (cont.)

v.
Right click the Cogent System Tray icon
vi.
Select Properties..
Manual Release 1
3-35
3-36
vii.
Select the Web Server option in the left-side icon column.
viii.
The Cogent web server can interfere with the web components of the
Historian environment and must be disabled. Ensure that the check
box Act as web server (in the upper-left corner) is cleared.
Version 4.2
December 2009

ix.
Click the View Data button (to the lower-left of the screen) to see
the tag values being generated by the DataSim simulation module.
x.
Select any value in the list of tags and observe that manual values
may be provided.
xi.
Don't change anything. Close the Data Browser and the Properties
window.
Manual Release 1
3-37

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 Properties dialog box as follows:
iv.
3-38
Name
Cogent
Type
OPC
Click the Add button, configure the OPC dialog box as follows:
Host Name
Training
OPC AppID
Cogent.OPCDataHub.1
Test Connection
Successful
Version 4.2
December 2009

v.
Click OK.
vi.
Click OK. The Import Schema task will launch automatically.
vii.
Decline the invitation to run the Integrity Checker.
Manual Release 1
3-39

3
Inspect the OPC data source.

i.
Expand the hierarchy Data Sources Cogent DataSim. Note the

same 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. The
system has not yet been configured to be able to display the data in
a client, the OPC connection will be re-visited when conditions are
ready.
3-40
Version 4.2
December 2009
Summary
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)
Questions
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 data
sources.
Describe the CitectHistorian Configuration Manager function.
Name two data source connectors.
Why Publish Data?
Manual Release 1
3-41
Chapter 4:
Historian
Overview
Introduction
The Historian is a simple Data Store specifically designed to provide long term
storage of tags and alarm data from a number of SCADA sources, creating an
easily-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 the
available hard disk space on the CitectHistorian Server.
The Historian is a Microsoft SQL Server 2005 database with schema optimised for
writing Tag/Alarm data, and interfaces for retrieving the data. The Historian Data
Manager allows users to import/export data. When used with a broader archiving
strategy to CD or network, export creates a sustainable method of permanent
storage for plant data.

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
What is Historian?
Data Repository
Historian is a SQL 2005 database designed to store and gain access to large
amounts of data over long periods of time. Trend files by their nature consume
large amounts of disk space. This makes it difficult to store and consequently to
retrieve contiguous data over large periods of time. A system that has many trends
may create large amounts of network traffic unnecessarily by polling for data that
changes infrequently. By contrast, Historian works by exception. A sample of data
is stored only when there has been a change in the tag value.
Trend Values
A trend value is sampled over
a regular time period or
whenever an event occurs.
This will happen regardless of
whether there has been a
change in the Tag value.
Historian
Historian records a sample of
data only when a significant
change in the Tag value has
occurred. In this example the
source data is polled every
100ms and the data is only
recorded if it differs by at least
0.01
See Also:
For further information about Historian Data Fields, see CitectHistorian Help
Topics - Index Historian Data Fields.
4-2
Version 4.2
December 2009
Database Schema
Numeric Data
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
Digital Data
Size (bytes)
UTC time-stamp for data received to 100 nano-seconds

(0.0000001seconds)
Data value (as a floating value)
Data quality
Data quality sub-status
Data quality customised status
The table below shows the information that is stored with every Digital sample.
Item
String Data
Size (bytes)

(0.0000001seconds)
Data quality
The table below shows the information that is stored with every String sample.
Item
Size (bytes)

(0.0000001seconds)
Alarm Data
8
variable
Data quality
The table below shows the information that is stored with every Alarm sample.
Item
Size (bytes)

(0.0000001seconds)
Data quality
Manual Release 1
4-3
Historian Data Manager

Manage the
Historian
Database
The creation and management of an Historian database is achieved via the

Historian Data Manager, a component of CitectHistorian that controls the
interaction with SQL Server 2005. It allows the user to perform basic data
management 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 by
the Historian Data Manager.
Setting up the Historian for use is a multi-stage process.
4-4
Version 4.2
December 2009
Historian Data Manager (cont.)

How to Open
Historian Data
Manager
To open the Historian Data Manager:

From the Windows Start menu, select Programs Citect CitectHistorian
Management Tools Historian Data Manager.
or
Open the CitectHistorian Configuration Manager. Right click the Historian node
and select Properties from the menu. Click the Historian Data Manager... button.
Manual Release 1
4-5
Exercise - Historian Data Manager

1
Connect to the SQL Server.

i.
Open the Historian Data Manager.

From
the Windows Start menu select Programs Citect

CitectHistorian Management Tools Historian Data Manager.
ii.
4-6
button. This will open the Historian Server

Click the New Server
Connection dialog. In the Server Name field, add the name of the
server.
Version 4.2
December 2009
Exercise - Historian Data Manager (cont.)

iii.
Select the Authentication type to be SQL Server Authentication

and use the credentials provided by the Instructor (probably SA and
C1tectr@1n).
iv.
Optionally, click the Test button to confirm connectivity to the SQL

Database. Click OK to close the test dialog box.
v.
Click OK to continue.
vi.
After the connection has been made the Historian Data Manager will
display the name of the server.
Manual Release 1
4-7
Historian Database
SQL Database
The Historian data is stored in an SQL database. Once the Historian has connected
to the SQL Server the next task is to create the database itself.
Table
Configuration
By default the Historian database consists of two files, where <Name> represents
the name of the database.
Advanced Table
Configuration
4-8
File
Description
<Name>_Log
the database log file
<Name>_Data
the numeric, digital and string samples, and the associated

configuration information
If the Advanced Table Configuration 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.
Version 4.2
December 2009
Historian Database (cont.)

Database Files
Each of the database files has properties that may be configured by the user to suit
the individual application
Property
Action
Name
the name of the file

To change one of the default settings for the file group properties, select
the relevant cell in the table, and then click it again to make the required
value adjustments.
How to Create a
New Historian
Database
Initial Size
the starting size of the file. The default is 3Mb for data files, 1Mb for the
log file.
Maximum
Size
a cap on the file size. The minimum value you can use is that set for Initial
Size, 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 is

managed. 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 the
right 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 Database
section
or
Click the Create Historian Database
button.
Manual Release 1
4-9
Exercise - Create a Historian Database

1
4-10
Create a new Historian Database.

i.
Click the Create Historian Database
ii.
When the New Database dialog opens, type Historian as the name
of the new database into the Name field. The name can be up to 123
characters in length and must be unique on the connected SQL
Server.
Version 4.2
button.
December 2009
Exercise - Create a Historian Database (cont.)

iii.
The Collation field selects the collation mode that the server will use
for the Historian database. This determines how SQL Server 2005
sorts and compares characters stored in non-Unicode data types. Set
this to <Server Default> (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 the
dialog.
vi.
The new database name will appear in the Active field.
vii.
Close the Historian Data Manager.
Manual Release 1
4-11
Historian Configuration
Properties
The Historian Configuration may be viewed and customised by right-clicking the

Historian node and choosing Properties from the menu.
See Also:
For further information about Historian Configuration, see CitectHistorian Help Setting up a Historian Server.
4-12
Version 4.2
December 2009
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 and
instance name manually (generally, this list displays every visible
SQL server except your own).
Manual Release 1
4-13
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 make
use of the in-built CSRAdmin user.
v.
Select the database. Select Historian from the drop down list. Click
OK.
4-14
Version 4.2
December 2009
Historian Configuration (cont.)

Data Sources
The second tab configures the Data Source properties in Historian. Each Data
Source may be configured separately.
Tags, Alarms and

Time-Stamped
Historian Tags and Alarms are directly linked back to their plant-based data sources
and are typically given matching names.
Time-Stamped data is connected to Trend Tags and thus comes complete with
timing information.
This information is used to define the generic parameters of the data connection.
Manual Release 1
4-15

Poll-Rate
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 all
tags logged from that data source. If there has been a change then the new value is
recorded.
Polling large numbers of tags may slow down system performance. One of the
advantages of this system is that multiple data sources may be defined from the
same SCADA project. This means that the poll rate for tags that are less time
critical may be configured separately.
See Also:
Scanning too quickly may have an adverse affect on the SCADA system. For
further information regarding Historian Scan Rates, see CitectHistorian Help
Topics - Index Historian Data Sources scan rate.
Timeout
Connection Timeout
The period of time the Historian will wait for a heartbeat response from a SCADA
data 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 the
request as failed in the event log. The default is 10 seconds and the maximum value
is 10 minutes (600 seconds).
4-16
Version 4.2
December 2009

Redundant
CitectSCADA
Servers
Whenever the primary SCADA data source is offline, if a redundant SCADA data
source has been configured, the Historian Data Service will attempt to poll the
redundant server. If no redundant server has been configured, or if the redundant
server is unavailable or unresponsive, the connection is marked as inactive in the
event log.
Acquire Rate
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 of
data every 5 minutes.
Limit Alarm
Requests
Large amounts of data may slow system performance. If large numbers of alarms
occur the system will limit the number of alarms requested. By default that number
is 1000. When that block has been transferred, Historian will then transfer the next
block.
Manual Release 1
4-17
Configure Historian Tags

Drag from the
Data Source
How to
Configure
Historian Tags
Tags are configured in Historian the same way as they are prepared in the Published
Information folder - by dragging them from the Data Source into the Historian
folder.
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 the
Historian node, they must be placed in a directory.
Note:
Dragging the whole folder into Historian will take less time than dragging
individual tags (even if grouped), because the back-end procedures can perform a
bulk insert, instead of individual inserts.
4-18
Version 4.2
December 2009
Exercise - Configure Historian Tags

1
Tags logged in the Historian do not sit in the root of the Historian
folder but in their own subfolder. This exercise will demonstrate
the correct method of locating tags to be logged in the Historian.
i.
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 Data
Source folder in Historian.
v.
Some of the tags automatically imported are essentially procedural to

the operation of the Aladdin project. These can be removed. Delete
these tags from the Historian tag list:
AladdinsCaves.Bit_1
AladdinsCaves.DescPLC
AladdinsCaves.FileOffset
AladdinsCaves.NamePLC
AladdinsCaves.Random_Number
AladdinsCaves.WorkOrderPLC
Note:
Depending on the number of tags to be Historised, it would be more likely to
identify the specific tags required and move them into the Historian in small
groups.
Manual Release 1
4-19
Configure Alarms in Historian

Enable Logging
Prior to v6.0 of CitectSCADA, logging needed to be enabled within the

CitectSCADA system if Historian was to store CitectSCADA alarm data. By
default, the parameter [ALARMLOG]NumFiles is set to zero (0) within
CitectSCADA. A value needs to be applied to this parameter in order to commence
logging, otherwise there will be no log files available for the CitectHistorian Server
to access.
Note:
The
parameters
[ALARMLOG]DefaultSearchDays
and
[ALARMLOG]Format should be checked to ensure that they have not been
configured in a way that will impact the functionality of the Historian.
4-20
Version 4.2
December 2009
Exercise - Configure Alarms

1
(Complete this step only if required) Set the [AlarmLog]Numfiles

parameter in the citect.ini file.
i.
If the CitectSCADA configuration

Open the Citect Explorer.
environment is not open the Citect Explorer may be opened from the
CitectSCADA group in the Windows Start Menu.
ii.
Select the menu Tools Computer Setup Editor.
iii.
If the AlarmLog section does not exist in the citect.ini file, enter
these values in the Parameter Details then click Add.
Field
Value
Section
AlarmLog
Parameter
Numfiles
Value
Note:
This number is chosen arbitrarily. The number of files chosen will depend on how
large the files will become and how many days of data need to be stored.
iv.
Close the Computer Setup Editor and save all changes to the
Citect.ini file.
v.
Shutdown and Restart the Aladdin SCADA project.

Configure the Alarms to be logged in Historian.
i.
Select the Advanced Alarms, Analog Alarms and Digital Alarms

folders in the AladdinCaves data source and drag them into the
Aladdin Data Source folder in the Historian node.
Manual Release 1
4-21
Historian Item Properties

Properties
4-22
The properties of Historian items may be viewed in the same way as the items in
other folders. Right click the item then select Properties from the menu.
Version 4.2
December 2009
Historian Item Properties (cont.)

Logging
Logging is the important attribute tab in this property. It is enabled by default. If
the Logging Enabled box is ticked and the Historian Service is running then the
tags will be logged into the Historian. The Alarm items only have the Logging
Enabled box, whereas the Tag items have more options that are configurable.
Manual Release 1
4-23

Data Acquisition
Types
Data Acquisition - Real Time
Select this option to store tag data in the Historian database as it is logged. The
acquired tag data will be based on periodic polling of the SCADA system, with one
'real-time' value retrieved for each tag every time polling occurs.
This mode correctly implies that the Historian has direct and timely access to the
source data.
Data Acquisition - Historical
Select this option to store tag data in the Historian database using historical timestamped values. This option is required to retain the time-stamping associated with
data that is cached before it is passed to a SCADA system. In this mode, data is
acquired from the SCADA trend system based on the last read sample time for a
time-stamped tag.
This method of data acquisition is useful for data that is time-stamped and cached
before it is passed to a control system. For example, a device may be connected to a
control system for only an hour each day due to a periodic modem connection
(typically a RTU or similar device). As Historical acquisition reads back to the last
detected value change when polling occurs, a day's worth of data can be
successfully integrated into the Historian database despite the delay in it's
availability.
Note:
To acquire data for a tag in historical mode, the tag must be bound to a trend tag to
allow time-stamped data to be retrieved from the source.
4-24
Version 4.2
December 2009

Deadband
Historian is configured to ignore minor changes in tag values. The Deadband is

the change in value that a tag must undergo from the previously logged value,
before another sample is logged. The advantage in using a deadband is that it will
help to reduce the volume of logged data.
By default, tags will be allocated a deadband of 0.5% of their engineering range. It
is important to note that the deadband is in engineering units, NOT percentage. The
engineering range and units are supplied for information purposes only to allow
users to intelligently set the deadband to an appropriate value. The engineering
range and units cannot be adjusted from this form.
Note:
When the data is derived from an OPC source, the deadband is always expressed in
a raw percentage format (not converted to an Engineering Unit range).
Manual Release 1
4-25

Bind to Trend
Backfill, based on the bind to trend feature allows data to be inserted after the fact
when either:
The Historian Service has stopped
The connection to the Primary (and Standby Data Sources if they exist) has
been interrupted
The connection to the Historian database has been interrupted
Once the Historian can access the Data Source again, tags with trends bound to
them will request data for the missing period, and backfill. Other tags will not be
backfilled and will have a gap in their data. Backfilling operates in half-hour
chunks to both reduce the load on the SCADA source, and to provide a process
whereby if the backfill is interrupted, it will only restart from the last successful
period, not from the beginning of the entire backfill period.
The backfill function keeps track of multiple gaps, and works through them to
ensure that all gaps are captured and filled. For example, if a backfill operation is in
progress, and the network to the SCADA fails, two gaps will exist in the data, and
upon resumption, the backfill operation will fill in both of them. It does this by
keeping track of gaps in a database table in the CitectHistorian configuration
database called tb_BackfillHistory.
Backfill is covered in depth in Backfill Manager (page 6-1).
If a trend exists with the same name as the tag it will automatically be bound to that
tag in Historian. However if a trend of the same name does not exist a trend may
be configured from this tab.
See Also:
For further information about Backfill, see the CitectHistorian KnowledgeBase.
4-26
Version 4.2
December 2009
Exercise - Historian Item Properties

1
Some tags in Historian have been bound to trends automatically as

they have the same names. Some tags have not been bound. Bind
a trend to a tag in Historian.
i.
Select the Tags folder in Historian and open the Properties of the
Hom_Tank_Level tag. Select the Logging tab.
ii.
button next to the Bind to trend: field. This

Click the Ellipsis
will display a list of available trends. If there are many trends
wildcards can be used to filter the list (here *L_P is used).
Manual Release 1
4-27
Exercise - Historian Item Properties (cont.)

iii.
4-28
Select AladdinsCaves.HTL_P from the list and click OK to close the

Trend selection window. Click OK to close the Attribute Properties
dialog box. The trend will be bound to the Hom_Tank_Level tag.
Version 4.2
December 2009

iv.
Check the properties of the tag AladdinsCaves.Central_Air. This

tag should be bound to the AladdinsCaves.Central_Air trend
already as they have the same name.
Manual Release 1
4-29

2
Start the Historian & Data Services to begin logging data.

i.
CitectHistorian Management Tools Historian Status Indicator.
ii.
Select the Data Service tab.
iii.
If the Service Status is Stopped click the Start/Continue

button to start the Service.
Note:
The Automatic start box may optionally be ticked.
Note:
The use of the Historian Status Indicator to start and stop the Data Service is
covered in more detail in Service Management (page 4-44).
4-30
Version 4.2
December 2009
Exercise - Use SQL Server to Track Incoming

Data
1
Open SQL Server Management Studio

i.

Server 2005 SQL Server Management Studio
ii.
Within the Connect to Server dialog box, click the Connect button.
Once connected, the Management Studio window will open.
Manual Release 1
4-31

Data (cont.)
2
View the Historian Data structure

i.
Expand
the
tree
Databases Historian Tables
dbo.NumericSamples Columns to observe the table structure for
Numeric values.
4-32
Version 4.2
December 2009

Data (cont.)
3
Query the Historian

i.
Click the New Query
ii.
In the query pane, type select * from NumericSamples
iii.
Click the Execute button.
Manual Release 1
button.
4-33

Data (cont.)
4-34
iv.
The SQL Manager will create a new pane and display the data.
v.
Inspect the returned data to confirm the correct operation of the

Historian.
vi.
Wait for a minute or so and re-execute the query (this can be done
by simply re-clicking the Execute button). Observe that additional
data is now stored.
Version 4.2
December 2009

Data (cont.)
4
Query the other data stores.

SQL queries can be executed from anywhere within the database
hierarchy that is contained within the database name.
The
navigation step undertaken at the beginning of this exercise is
sufficient to give context to all these queries.
i.
Execute this query select * from AlarmSamples. This will return

all the Alarm data from the historian data store.
Manual Release 1
4-35

Data (cont.)
5
Use an alternate query method.

As an example of the variety of methods to extract data, this step
demonstrates another way of extracting data.
i.
Repeat the query to view the digital data in the Historian.
ii.
Right click the dbo.DigitalSamples table in the tree view and select
Script Table as SELECT To New Query Editor Window.
iii.
This will build a properly configured query in the right pane.
iv.
Execute the query and observe the output.
4-36
Version 4.2
December 2009
SQL Databases used in CitectHistorian

Databases
As part of a functioning CitectHistorian environment, the SQL 2005 Server will

host a number of databases which together will form a working system.
CitectHistorian
This database was created to store the

configuration and management rules for the
current instance of CitectHistorian.
Historian
This was created as part of the course to store the

captured data. Each configuration database must
be connected to its own unique historian
database.
ReportServer$CITECTHISTORIAN
This is the repository for all deployed report

definitions. these are used as part of the
Reporting Services package to deliver reports to
clients.
ReportServer$CITECTHISTORIANTempDB
This is a temporary storage environment for

report definitions. it is not for general use.
Reports deployed for operational use are stored
here.
Manual Release 1
4-37
Exercise - Tour of CitectHistorian SQL

Databases
1
4-38
Open SQL Server Management Studio.

i.

Server 2005 SQL Server Management Studio
ii.
On the Connect to Server dialog box, click the Connect button.
iii.
Once the Studio screen opens, expand the Databases folder.
Version 4.2
December 2009

Databases (cont.)
iv.
For each of the three relevant databases (listed below), expand the
tree structure and view the tables and the data contained therein.
CitectHistorian
Historian
ReportServer$CITECTHISTORIAN
v.
Expand the CitectHistorian database and view the list of Tables.
vi.
Select one of them (DataSources in the pictured example), right click

and choose Open Table.
Manual Release 1
4-39

Databases (cont.)
vii.
The screen will then show the data contained in that table.
Spend time looking at the structure and contents of all the

databases.
i.
The instructor will guide this as a class exercise.
4-40
Version 4.2
December 2009
Licencing
Licencing
Information
The functionality supported by CitectHistorian may be restricted by the licensing

agreement and the configuration purchased.
The components impacted by the license agreement may include:
A maximum Historian database point count
Oracle database connectivity
OPC connectivity
Task engine operation
Licensing restrictions are controlled by the hardware key(s) provided at the time of
purchase. While the software may be installed on any number of computers, only
those with a hardware key attached to their parallel or USB port will operate as a
fully licensed installation.
The hardware key confirms that the correct version of CitectHistorian is installed,
that the license is current, and that any chargeable components are enabled at the
appropriate level.
If a hardware key is removed, a message will appear in the Windows notification
area stating that current services will switch to a license-free mode of operation.
Operation will return to normal if a hardware key is reattached before the shutdown
occurs.
Manual Release 1
4-41
Licencing (cont.)
License-free
Modes of
Operation
CitectHistorian can run in one of two distinct modes when no hardware licence key
is present:
Demo mode
Historian Mini mode
Demo mode enables a system to run for a period of one hour with few limitations.
It is intended to be used for product evaluation. The demo mode time limitation is
enforced via the Historian Data Service and the Event Service, which cease to
operate after one hour. When this occurs, you will be informed via a message in the
Windows notification area. At this point, you may either restart for another demo
period, or insert a hardware key for continuous operation.
Backfilling is disabled while running in demo mode so data stored to the Historian
database is restricted to the evaluation period.
CitectHistorian Mini is a license-free mode of operation, intended to provide a

small-scale archiving solution that supports CitectSCADA. It enables
CitectHistorian to operate continuously while less than 10 tags are configured for
archiving to the Historian database.
Mini mode is enforced via the Historian Data Service. If the number of enabled
Historian tags exceeds 10, the Historian Data Service and the Event Service will
switch to demo mode and run for one hour. A message will appear in the Windows
notification area and will be added to the application event log when this occurs.
4-42
Version 4.2
December 2009
Licencing (cont.)
Activating a
Licence
An 'unlicensed' installation may be licenced at any time by simply inserting a

suitable hardware key (often referred to as a 'dongle').
Within a few seconds of plugging the hardware key into a PC, the Historian Status
Indicator will 'notice' the change and alter the state of the system to match the
attributes of the key.
Clicking on the blue message will load the Historian Status Indication with the
General tab selected, showing the current licencing information.
Manual Release 1
4-43
Service Management
Data Service
The Historian Data Service is an application that resides on a CitectHistorian Server

and manages access to the Historian database. When running, it acts on the
conditions specified by the configuration of the Historian database and its
attributes, and archives data accordingly. It also manages requests from client
applications for archived data.
To enable this activity, the Data Service must be running on a CitectHistorian
Server. For this reason, it is designed to function as a background service that can
run in tandem with the host computer's operating system.
The Data Service is controlled via the Historian Status Indicator, which is readily
accessible via the Windows system tray.
From within the running instance of the CitectHistorian Status Indicator, The Data
Service tab is used to monitor and control the Historian Data Service. It includes
two sections:
The Service Control section includes the following settings:
Start/
Continue
This button will Start the Data Service, or Continue its operation if it is currently
in a paused state.
Pause
If the Data Service is in a running state, this button will temporarily stop the
delivery of data to the Historian database without implementing a full shutdown
of the service. Use the Start/Continue button to return the service to a full
running state.
Stop
This button will Stop the Data Service.
Automatic
Start
Check this box to automatically start the Data Service whenever the host
computer's operating system launches.
Status
The Status field describes the current operational state of the Data Service.
The first part of the description is based on the current licensing conditions (see
Licencing (page 4-41)). It will state one of the following:
Licensed - a valid license key has been detected

Expired - an expired license key has been detected
Demo - no license key detected, the service is running in timerestricted demo mode
Mini - no license key detected, the service is running in Mini
mode
Exceeded - the number of tags currently configured for archiving
exceeds the amount specified on the detected license key
4-44
Version 4.2
December 2009
Service Management (cont.)

The Messages section of the dialog displays time-stamped messages regarding
the operation of the Data Service.
The table presents a list of messages, defined by their type. If you select a message
within this list, the details of the message appear within the viewing pane below.
After a reboot, the Status Indicator will appear like this. In this state, there will be
no data transferred from the data Sources into the Historian.
Manual Release 1
4-45

Clicking the green Start / Continue button will (after a few seconds) set the service
to be Running.
If a new Data Source is added to the CitectHistorian Server and the data configured
is to be logged in Historian, the Historian Service will need to be restarted before
the Historian can log data from that source. A restart allows the Historian Service
to revisit the list of connected data sources and identify any additions.
4-46
Version 4.2
December 2009

Event Service
The Historian Event Service is an application that resides on a CitectHistorian

Server and manages the detection and signaling of events. When running, it
monitors the CitectHistorian system for conditions specified by the events currently
configured in the active project, including any time-based events, and flags their
occurrence to the task engine. Events are covered in detail in Events (page 9-1).
From within the running instance of the CitectHistorian Status Indicator, The Event
Service tab is used to monitor and control the Historian Event Service. It includes
two sections:
The Service Control section includes the following settings:
Start/Contin
ue
This button will Start the Data Service, or Continue its operation if it is
currently in a paused state.
Pause
If the Event Service is in a running state, this button will temporarily stop events
being triggered without implementing a full shut of the service. Use the
Start/Continue button to return the service to a full running state.
Stop
This button will Stop the Data Service.
Automatic
Start
Check this box to automatically start the Data Service whenever the host
computer's operating system launches. This verifies the service automatically
becomes active again following a restart of the host computer.
Status
The Status field describes the current operational state of the Event Service.
The first part of the description is based on the current licensing conditions (see
Licencing (page 4-41)). It will state one of the following:
Licensed - a valid license key has been detected

Expired - an expired license key has been detected
Demo - no license key detected, the service is running in timerestricted demo mode
Mini - no license key detected, the service is running in Mini
mode
The Messages section of the dialog (the middle white area on the image on the
next page) displays time-stamped messages regarding the operation of the Event
Service.
The table presents a list of messages, defined by their type. If you select a message
within this table, the details of the message appear within the viewing pane below
(grey in the image as there are currently no messages to display).
Manual Release 1
4-47

After a reboot, the Status Indicator will appear like this. In this state, Events will
not be checked or launched.
4-48
Version 4.2
December 2009

Clicking the green Start / Continue button will (after a few seconds) set the service
to be running.
Manual Release 1
4-49

System Tray
Status Indicators
In accordance with the various licencing modes described in the section Licencing
(page 4-41), the Historian Status Indicator icon in the System Tray (bottom right of
the screen) can take on a number of appearances.
Fail to Start
By default, the Data Service and Event Service are allocated a maximum of 30
seconds to complete their startup sequence (by Windows).
If the service takes longer than the allocated time, an error message will be passed
back saying that the service "failed to start."
If this occurs, the following registry patch should be applied:
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control]
"ServicesPipeTimeout"=dword:000493e0
Note:
Please be very familiar with the use of RegEdit before attempting this update as
mistakes in the Registry can potentially render Windows inoperable.
4-50
Version 4.2
December 2009
Exercise - Manage Historian Services (optional)

This exercise summarises activities that are dealt with (in the most part) in other
sections of the course. It is presented as a useful summary of the tasks that may be
performed using the Historian Status Indicator.
1
Examine the current licence key.

i.
Ensure the hardware licence key is connected to the PC.
ii.
Double click the Historian Status Indicator icon (this will appear as
or
depending on whether any of the services are
either
running) in the System Tray.
iii.
Select the General tab and note the licence configuration.
iv.
Close the Historian Status Indicator.
Manual Release 1
4-51
Exercise - Manage Historian Services (cont.)
4-52
v.
Physically remove the key from the PC and wait a few moments for
the "Licence Changed" message in the lower right of the screen.
vi.
Click on the Click here to view..." message to re-open the Historian

Status Indicator; make sure the General tab is selected. This will
now show the configuration of an un-licensed installation.
vii.
Re-insert the hardware key and note the Licence Changed message
and the re-display of the correct licensing information.
Version 4.2
December 2009
Exercise - Manage Historian Services (cont.)

2
Start, Pause and Stop the Data and Event services.

i.
Select the Data Service tab in the Historian Status Indicator.
ii.
The Data Service should already be Started (this occurred in

Exercise - Historian Item Properties (page 4-27)). Click the
Pause button.
iii.
Once the Pause process is completed, a number of things will

happen.
1. A Status message will advise that the Data Service is Paused.

2. The orange Pause button will be coloured grey.
3. The green Start/Continue button will change colour to blue.
4. The status will change from "Licensed - Running" to "Licenses Paused."
iv.
Click the Start/Continue button to resume operation of the Data

Service. This button will resume its normal green colour once the
Data Service resumes.
v.
Stop and then Start the service to observe the shutdown / restart
process in operation.
vi.
Select the Event tab and repeat the previous few steps.
Note:
Pausing the Event Service may be used as a tool to temporarily stop the processing
of Events on a short-term basis - perhaps when unusual plant conditions would
normally trigger events, but those events are not currently relevant.
Manual Release 1
4-53
Summary
Summary

What is Historian? (page 4-2)
Database Schema (page 4-3)
Historian Data Manager (page 4-4)
Historian Database (page 4-8)
Historian Configuration (page 4-12)
Configure Historian Tags (page 4-18)
Configure Alarms in Historian (page 4-20)
Historian Item Properties (page 4-22)
Licencing (page 4-41)
Service Management (page 4-44)
Questions

What is the function of CitectHistorian?
How often are data sources polled?
What is the deadband?
4-54
Version 4.2
December 2009
Chapter 5:
Publish Information
Overview
Introduction
CitectHistorian takes information from various data sources and prepares itor use
by client applications. This chapter describes how to take the data made available
from the connected data sources and prepare it to be made available to other
applications.

Organise Published Data........................................................5-2
Access Data Sources..............................................................5-6
Security ................................................................................5-10
Aliases..................................................................................5-18
Organise Published Data

Drag and Drop
Items into
Published
Information
Once CitectHistorian Server has been connected to the required data sources, the
items that the client applications will use need to be made available. This process is
referred to as Publishing Data. CitectHistorian is able to publish all items from the
data source or only the items that have been selected.
As demonstrated in Publish Data (page 3-18) the simplest way to add data items is
to drag and drop the whole data source into Published Information.
The items will then be copied into Published Information.

When the items have been copied all items will appear in the Published
Information node in their original folders and subfolders.
5-2
Version 4.2
December 2009
Organise Published Data (cont.)

Create a Folder
Hierarchy
However, data items may also be published into folders that have more meaning
from a management point of view. Folders and sub-folders may be created to
organise the data in a manner that is more logical for specific users using client
applications.
Select Folders or
Individual Items
When selecting data items it may be necessary to only drag and drop complete
folders. It is also possible to select individual items from within each folder to
customise the information that is made available to different users.
The advantage of this system is that the data that is made available to different
users or groups of users is managed at the folder level rather than assigning security
to each item.
Secure Access to
Folders
Once Folders and items have been constructed, a permission structure may be
assigned to permit the fine-grained control of access. This will permit full access,
read-only access and denial of access at any level. Security will be covered in more
detail in the section Security (page 5-10) later in thishapter.
Manual Release 1
5-3
Exercise - Create a Published Information

Hierarchy
1
Create folders in the Published Information area for specific users.

i.
Right click Published Information and select New Folder from the
menu.
ii.
Name the new folder Guides then click OK.
iii.
Create another folder in the Published Information node called
Engineers.
Add items from the Data Sources to the Published Items folders.
i.
ii.
Select the AladdinsCaves folder under the Aladdin data source.

This will display all the data source folders in the right pane. Hold
the Control (Ctrl) key and click to select the Advanced , Analog and
Digital alarm folders and the Tags and Trend folders.
Drag the selected folders into the Engineers folder in Published
Information.
iii.
5-4
Drag the SQL Database data source into the Engineers folder in
Published Information.
Version 4.2
December 2009
Exercise - Create a Published Information

Hierarchy (cont.)
3
Published Information may be customised to show only the

specific data a group of users will be allowed to see. Prepare the
Published Information for the Guides.
i.
Select the Guides folder in Published Information and create four

new sub folders named Cave Temps, CO2 Levels, People Count
and Wind Speed.
ii.
Open the Aladdin Data Source and select the Tags folder beneath
AladdinsCave. Select Action Filter from the menu.
iii.
Use the Filter field to select all tags that end in _Temp.
iv.
Select all of the Tags that end in _Temp and drag them into the
Cave Temps folder.
v.
Copy the groups of tags listed in the table below from the Data
Sources folder into the corresponding sub folders in the Guides
folder.
Tags
Folder
*_CO2
CO2 Levels
*_Count
People Count
*_Air
Wind Speed
Manual Release 1
5-5
Access Data Sources

Identify Data
Connections
In order to present data to the client, all of the data paths in this diagram must be
explicitly defined.
At this stage, the connections from the plant-based data sources to the Historian
Server are all defined, as is the connection from the Historian Data Service to the
Historian database.
What has not yet been defined is the connection from the Historian database to the
Published items service. This is the next task.
Note:
While a connection from the data sources directly to the clients can only display
current data, connections from the Historian database are more complex and permit
the definition of time ranges and other data filters.
5-6
Version 4.2
December 2009
Exercise - Publish Historian Information

1
Once the items have been configured in the CitectHistorian

Configuration Manager it is necessary to publish the Historian tags
if the data is to be viewed from the Client applications.
i.
Create a new folder in Published Information and name the folder
Hist.
Note:
Currently, implementation rules prohibit this folder from being called 'Historian.'
ii.
Drag the Aladdin Data Source folder in Historian to this new folder
in Published Information.
The Published Information hierarchy
should look like this:
Manual Release 1
5-7
Exercise - Publish OPC Data

As has been mentioned previously, OPC Data Sources cannot be published 'raw,'
they must be written to the Historian database and then published from that
repository.
1
Historise and Publish the OPC Data Source.

i.
Drag the DataSim folder (under the Cogent Data Source) to the
Historian folder.
For a brief period, the system will display a dialog box showing the
establishment of the links to the Data Source tags. This will close
automatically.
ii.
Drag the newly created DataSim folder (in the Historian folder) to
the Published Information folder.
Again, for a brief period, the system will display a dialog box showing
the establishment of the links to the Historian tags. This will close
automatically.
iii.
5-8
Grant Everyone access to the new DataSim folder in Published

Information.
Version 4.2
December 2009
Exercise - Publish OPC Data (cont.)

2
View the published OPC data in the Excel Client.

i.
Launch the Excel Client.
ii.
Connect to the Historian. (This was covered previously in Exercise View Data in the Excel Client (page 3-26))
iii.
Expand the contents of the DataSim folder, confirm that all tags are
visible.
iv.
Highlight DataSim and click the right-facing arrow to add all tags to
the Selected Data list.
v.
Leave the Period at 30 seconds.
vi.
Click Next.
vii.
Optionally give the presentation a name and ensure that the Data
Layout is set to be Chart.

viii.
ix.
Click Finish to generate the chart.

After inspecting the result, close Excel.
Manual Release 1
5-9
Security
Groups and
Users
When the security system is configured users will only be able to gain access to the
data that they have been given permission to view. Each time a user connects to the
CitectHistorian Server, the Server will use their Login Name and Password to
determine which data they can view and to what extent they can modify or add to
that data. If a user does not have a profile they will not be able to gain access to
anything on the Server.
The configuration of CitectHistorian security is similar to the security in Windows.
A User profile may be created for each person who will have access to the system
and those Users can be organised into Groups. This adds the convenience of being
able to assign a Group of Users access to a particular item (or folder of items)
without the need to assign permissions to each individual User.
5-10
Version 4.2
December 2009
Security (cont.)
Add Users to
Groups
When the Groups have been created you may then add the Users to the Groups.
If a User is added to the system later, they may be added to a Group or to multiple
Groups.
Manual Release 1
5-11
Exercise - Create a Security System

1
Create new Users.

i.
5-12
Create at least six different Users in the same way as Exercise Create a New User (page 3-21). It is suggested that the following
names be used.
Engineers
Guides
Anne
Ruth
Bert
Stan
Carl
Tina
Create new Groups.

i.
Right click Groups and select New Group... from the menu. Create
two new groups named Engineers and Guides.
ii.
Right click Engineers and select Properties from the menu.
Version 4.2
December 2009
Exercise - Create a Security System (cont.)

iii.
In the Group Properties click the Add button. This will display the
User list. Add half of the Users to the Group. Use the CTRL key to
select more than one User at a time. Click OK once the users are
selected.
iv.
When the Users have been added to the Group the names will be
displayed in the Group Properties.
v.
Click OK to save the Engineer group definition.
vi.
Add the rest of the newly created Users to the Guides group.
Manual Release 1
5-13

3
5-14
Assign Users to the Published Items so that the Users will have
access to view the data items from Client applications.
i.
Open Published Information. Right click the Engineers folder and

select Properties.
ii.
Open the Permissions tab and Add the Engineers group to the
Folder Properties.
iii.
Click OK to continue. When the Confirm Changes dialog appears

apply the changes to all sub-items and attributes. Click OK to
continue.
Version 4.2
December 2009

iv.
Open the properties of the Guides folder in Published information.
v.
Add the Guides group to the Permissions in that folder.

Write Access from the group.
vi.
Add the Engineers group to the Guides folder but leave the
Permissions set to Full Access.
vii.
Open the properties of the Hist folder in Published information.
viii.
Add the Engineers group to the Hist folder and leave the
Permissions set to Full Access.
Remove
When a folder or item is moved into another folder that has

already had its permissions set, the new item will inherit the
permissions from the parent folder.
i.
Open the AladdinsCave folder in Data Sources and drag the Tags
and Digital Alarms folders into the Guides folder.
ii.
Check the Permissions of the Digital Alarms folder now residing in

the Guides folder.
The folder has inherited the Permissions from
the parent folder.
Manual Release 1
5-15
Exercise - Client Security Views

1
5-16
Use the Excel Client to view the data that has now been made
available to the client applications.
i.

CitectHistorian Clients Excel Client.
ii.
Connect to the CitectHistorian Server using the same process as

demonstrated in Exercise - View Data in the Excel Client (page
3-26). Log in as a User who has been placed in the Guides group.
iii.
Open the Data Selection screen and notice that the data is
presented in the way that has been organised for the Guides group
in the Server Manager. Select the tags in the Cave Temps folder
and click Next.
iv.
When the Data Presentation screen opens change the Name: to Cave
Temperatures.
v.
Finish the data selection and view the data in the spreadsheet. The
Excel Client displays the current cave temperatures as read only
data.
vi.
Close the worksheet without saving.
Version 4.2
December 2009
Exercise - Client Security Views (cont.)

2
Log in to the Excel Client as an Engineer and view the Digital

Alarms.
i.
Reconnect to the CitectHistorian Server as one of the Users in the

Engineers group.
ii.
This time when the Data Selection screen opens the data that has
been configured for the Engineers is available. Select the Digital
Alarm Tags. Since this is historical data there are parameters
available that give the user some choices. Leave the EndDateTime
and change the Duration to 1 Hour.
iii.
The worksheet will display the historical alarm information.
iv.
Close Excel without saving.
Manual Release 1
5-17
Aliases
User Friendly
Names
One of the main purposes of the CitectHistorian suite of programs is the ability to
extract information from available Data Sources without re-engineering the original
system. In a SCADA system such as CitectSCADA, the names of the Data Items
such as Variable Tags, Alarms and Trends follow a logical format for Plant
Operators and Engineers.
For Example
VALVE_2_CMD
BIT_8
PUMP_1_M
However, these names can be meaningless to people who work outside the system
such as some Managers and non-technical staff. The CitectHistorian Configuration
Manager will allow the renaming of Data Items for use in Client applications
without changing the original runtime system. The new name is called an Alias.
5-18
Version 4.2
December 2009
Exercise - Aliases
1
Create Aliases for some of the items in the Published Information

Folder.
i.
Open Published Information and in the Guides folder open the

Digital Alarms folder.
ii.
By default, the objects in the Digital Alarms folder (and all other
folders) represent the tag names defined in the CitectSCADA project.
These may convey meaning for those people closely associated with
the project but are generally incomprehensible to other users of the
information. Double click AladdinsCaves.Aer_P.
Manual Release 1
5-19
Exercise - Aliases (cont.)

iii.
The name of the Attribute does not need to be the same as the alarm
tag. When it has been changed, the new name will be used in all
client applications without affecting the original data source item.
In the screen shot on the previous page, it is clear that the
'Expression' contains the actual data source and the default name is
the same (obviously the alarm name). The screen shot below
demonstrates that the name may be changed as required.
5-20
Version 4.2
December 2009

iv.
To demonstrate that this techniques works correctly, change the

names of a selection of the Alarms in the Digital Alarm folder.
Digital Alarm Name
Alias
Aer_P
Aeration Pump OFF
Aer_V
Aeration Valve OFF
CentralDoor
Central Door Opened
Chlorin_V
Chlorine valve OFF
ChrisDoor
Christopher's Lair Door Opened
CirceDoor
Circe's Temple Door Opened
Homogen_P
Homogenisation Pump OFF
Homogen_V
Homogenisation Valve OFF
MainDoor
Main Door Opened
Nutrient_V
Nutrient Valve OFF
OperaDoor
Opera Theatre Door Opened
pH_P
pH Pump OFF
pH_V
pH Valve OFF
Sed_V
Sedimentation Valve OFF
Sludge_V
Sludge Valve OFF
TarDoor
Tartarus Door Opened
Treat_P
Treat Water Pump OFF
Truck_S
Truck Status OFF
Waste_V
Waste Valve OFF
Manual Release 1
5-21

2
View the data in this folder using the Excel client.

i.
Log in to the Excel Client as one of the Users in the Guides group.
ii.
Select the Digital Alarms folder and generate the report.
iii.
Compare the Alarm names to the report generated using the digital
alarms from the Engineers folder during Exercise - Client Security
Views (page 5-16). This time the Alarm names are displayed using
the aliases that were configured for the Guides.
5-22
Version 4.2
December 2009
Summary
Summary

Organise Published Data (page 5-2)
Security (page 5-10)
Aliases (page 5-18)
Questions

What is the best method to organise data in a logical manner?
Why set security on the Published data folders?
What is the benefit of creating Aliases?
Manual Release 1
5-23
Chapter 6:
Backfill Manager
Overview
Introduction
The Backfill Manager is used to add historical values stored in the SCADA Trend
Server to the Historian database in the situation where connection to the SCADA
environment has been lost.
This might be due to the connection only being periodically available or the
Historian Server being only intermittently on-line.

Backfill Manager ...................................................................6-2
Backfill Manager
What is a
Backfill?
If communication is interrupted between the CitectHistorian Server and your

SCADA system, it would typically create gaps in the data being stored to the
Historian. However, this problem can be avoided by using a feature known as
Backfilling.
Backfilling uses the SCADA system's trend logs to fill in any missing values from
your Historian data. As soon as communication is restored after an interruption, the
Historian will automatically retrieve any missing tag values from the SCADA
system's trend data. It will then reconstruct the Historian data accordingly. If
enabled, backfilling will also work for periods where the Historian Data Service is
turned off.
Backfilling is enabled by identifying the trend in the SCADA system that is
associated with a tag you are logging. Referred to as "Binding", this process is set
up on the Logging tab of the Attribute Properties dialog.
By default, the Historian will automatically bind a logged tag to a trend in the
SCADA system with the same name. Under these circumstances, you don't have to
specify where to back fill data from as it happens automatically.
6-2
Version 4.2
December 2009
Backfill Manager (cont.)

However, if any of the trends in the SCADA system have a different name to the
tag they monitor, you'll need to manually bind the tag to its trend.
Alongside it's automated backfilling functionality, CitectHistorian allows you to

manually trigger backfill activity. This is typically useful if you want to add trend
data to Historian that spans the period prior to installation.
Pre-Populate the
Historian
The Backfill technology can also be used to populate the Historian with data
derived from SCADA Trend tags which pre-dates the installation of the Historian
software.
Clearly this would be a one-off task which allows any currently trended data to be
added to the Historian.
Manual Release 1
6-3

Current and
Pending Backfill
Activity
The Backfill Manager is a tool that displays all the current and pending backfill
activity on the CitectHistorian Server. It is primarily a list showing details of the
SCADA trend data scheduled for transfer to the Historian.
Note:
The Backfill Manager will only display a snapshot of the current backfill activity at
the time of opening. The information it displays does not update dynamically.
6-4
Version 4.2
December 2009

Backfills Queued
for:
This displays the name of the Historian server. It indicates that the scheduled
backfill activity will only be implemented for the CitectHistorian Server the
Backfill Manager is running on.
Data Source
This column displays the Data Source from which the backfill data will be
retrieved. If you are in the process of adding a new backfill task, a drop-down list
will be available from this column allowing you to select from the data sources
connected to the CitectHistorian Server.
From
This column shows the time and date that represents the start of the period for data
backfilling.
To
This column shows the time and date representing the end of the period data for the
backfill. If the To column is blank, it means the data source is currently offline. As
soon as the CitectHistorian Server can re-establish communication with the data
source, the To column will display the time of reconnection and the backfill task
will be able to progress.
See Also:
For further information about adding your own backfill tasks, see CitectHistorian
Help Topics Manually triggering backfilling.
Completed To
The Completed To field provides an estimate of how far a backfill task has
progressed by displaying the timestamp for the last value loaded into Historian.
You can roughly assess how close the task is to completion by comparing the time
and date displayed to that in To column.
Status
The Status column uses coloured dots to represent the current status of a scheduled
backfilling task. A green dot indicates that the backfill is currently active; a yellow
dot indicates that it is pending.
Add
Use this button to manually Add a backfill task to the list of those scheduled. If this
button is not active, it means there are currently no tags loaded into the Historian
folder.
Delete
This button will clear a scheduled backfill task that is currently being configured. It
will NOT delete one of the automated backfill tasks, or a manually configured task
that has been implemented with the OK button.
Manual Release 1
6-5
Exercise - Backfill Manager

1
6-6
Add and delete a manual backfill task to the Backfill Manager.

i.
In the CitectHistorian Configuration Manager right click Historian.

Select Backfill from the menu.
ii.
The Backfill Manager will open displaying a snapshot of the current

backfill tasks.
iii.
Click the Add button.

queue.
A new Backfill Task will be added to the
Version 4.2
December 2009
Exercise - Backfill Manager (cont.)

iv.
Click the Datasource for that task.

displaying the available data sources.
A drop down list appears
v.
The From and To dropdowns will display a calendar that allows a

date to be entered.
vi.
Select one of the tasks by clicking the record. Click OK to start the
backfill. The Delete button becomes inactive. This is because
automated backfill tasks, or any manually configured task launched
with the OK button, cannot be deleted.
vii.
Delete any other tasks that were added manually.

button to close the Backfill Manager.
Click the OK
Manual Release 1
6-7
Exercise - Populate the Historian with PreExisting Trend Data

As part of the initial roll-out of a CitectHistorian installation, it is common to
collect all available trend data stored on the CitectSCADA servers and import it
into the Historian.
This exercise will demonstrate how to perform this operation.
Note:
The training computers may or may not be configured to have this data available.
the Instructor will advise whether to proceed with this exercise.
Determine the date-range of available Trend data.

i.
The Instructor will provide the date-range of available data.
ii.
Create a new Backfill task.
iii.
Based on the provided date/time range configure the Backfill task.

be sure to also check the Datasource.
Note:
After selecting the date from the calendar tool, the From and To fields must be
double clicked to be able to modify the time component.
6-8
Version 4.2
December 2009
Exercise - Populate the Historian with PreExisting Trend Data

Here, the screen has been configured for a notional July 1st to
December 31st 2008.
Click the OK button to save the task.
iv.
2
Confirm execution of the Backfill task.

i.
Re-open the Backfill Manager.
ii.
Depending on the amount of data to be imported, this may or may

not be completed.
iii.
Continue closing and opening the Backfill Manager until the status is
marked as completed.
Manual Release 1
6-9
Exercise - Test Automatic Backfill

1
6-10
Identify a historised tag with attached trend tag.

i.
Navigate to the tags folder under the Historian and double click the
tag Aladdin'sCaves.Chris_Temp.
ii.
Select the Logging tab to observe that Chris_Temp has been

automatically linked to the trend tag of the same name.
iii.
Open the CitectSCADA development environment and from the

Project Editor, select the menu System Events. The first entry
shows the automation controlling the Chris_Temp tag which sets the
value to be either 4, 5 or 6 and changed every 4 seconds.
Version 4.2
December 2009
Exercise - Test Automatic Backfill (cont.)

2
Confirm correct operation of the Historian.

i.
Check that samples are being collected by running a query on the

Historian database:
select
*,
dbo.ToDate(SampleDateTime)
NumericSamples order by dd desc
ii.
as
dd
from
Repeat the query a number of times to confirm that the number of

records is increasing, and thus the Historian is capturing data.
Manual Release 1
6-11

3
6-12
Stop and re-start Historian data collection.

i.
Stop the Historian Data service, noting the approximate number of

records in the samples table around the time it was stopped. Note
the time also.
ii.
Open the Backfill Manager - there will be a "pending" backfill task

already created in readiness to backfill the missing samples when the
Historian Data service resumes operation.
iii.
Execute the query from Step 2 on the previous page a few more
times to demonstrate that no samples are currently being collected.
Version 4.2
December 2009

iv.
Leave the service stopped for a few minutes.
v.
Restart the Historian Data service, noting the time as it starts.
Manual Release 1
6-13

vi.
Execute the query again and confirm that samples have been stored
in the table for the period during which the Historian & Data service
was stopped.
Stop the service overnight.

i.
Prior to finishing the training for day 1, stop the Historian Data
Service.
ii.
On commencement of day 2, re-start the Historian Data Service and

note how long the backfill task takes to complete.
Note:
The SCADA Aladdin project must continue running all night for this to fully
succeed. This means that it must be a licensed installation of CitectSCADA. If it is
not, the project will terminate 10 hours after it was commenced (probably around
7:30pm that evening). If the SCADA does terminate, backfill data will only be
available for the period up until it stopped and will only be obtained after the
SCADA is restarted.
6-14
Version 4.2
December 2009
Summary
Summary Backfill Manager

Backfill Manager (page 6-2)
Questions Backfill Manager

Why is Backfill important?
What is the source of Backfill data?
Under what circumstances would a manual Backfill task be created?
When would backfill not run?
Manual Release 1
6-15
End Day One - Summary

Summary
At the end of Day One, you should:

Understand the CitectHistorian Environment
-
SCADA Data sources
SQL Data sources
Be able to Create Projects

-
Create a CitectHistorian instance
Connect data sources
Publish data
Be able to Setup a Historian

-
Historian configuration
Configure tags
Configure Alarms
Be able to publish information

-
Organise data
Access data sources
Set up security access
Create Aliases for data
Be able to configure Backfill Manager
6-16
Manual backfill tasks
Automatic backfill tasks
Version 4.2
December 2009
Chapter 7:
Project Management
Overview
Introduction
CitectHistorian allows you to backup and restore the configuration database for a
CitectHistorian Server. This is useful if you want to store your configuration
settings on a regular basis to ensure that a copy is always kept in a safe place.
Having a stored configuration also ensures that you can restore your system if it has
become damaged. You can also use a backup file to duplicate the configuration of a
CitectHistorian Server onto a new machine.

Backup and Restore Projects .................................................7-2
Active Project ......................................................................7-14
Remove a Project .................................................................7-22
Backup and Restore Projects

Backup
Configuration
Database
CitectHistorian will backup and restore the configuration database for a

CitectHistorian Server. This process is performed through the Configuration
Backup and Restore Utility. This utility is launched from the CitectHistorian
group in the Windows Start Menu.
The backup file is saved with a .CBF extension. It is important to note that Backup
and Restore must be run locally on the CitectHistorian Server.
The .CBF files are simply a re-named .ZIP archive and may be loaded in WinZip or
any similar tool.
7-2
Version 4.2
December 2009
Backup and Restore Projects (cont.)

Recommended
Backup Strategy
Citect is not in a position to accurately gauge the needs of every organisation, but
the following points should serve as a general guide upon which to base your
organisations backup strategy.
CitectSCADA is able to control and monitor the operation of your plant and in
addition store a short-term record of values via the Trend system.
CitectHistorian is intended to be a long-term store for historical data that will
(in all likelihood) be the only location in which that data is stored.
SQL Server 2005 (upon which CitectHistorian is built) contains mechanisms to
assist with the automation of the backup process to either separate disk volumes
or to tape.
The general observation with regard to backups is that the time between
backups should be the length of time for which you are prepared to lose data.
Modern SQL environments permit shadowing of data to restrict the impact of
file corruption, but this technique will not address the catastrophic loss of the
server or the hard disks contained therein.
It would be considered normal to run overnight backups to tape while having
an incremental shadowing task throughout the day.
There is little point in making regular backups when there is no knowledge of
the validity of the contents of the tape to which the data is copied. It is essential
that a trial restore is undertaken at the time of setting up the backup system to
confirm that the data is fully usable. Subsequent (but infrequent) trials should
be performed to confirm valid backups into the future.
Similarly to the previous point, it is equally crucial that successful backup tapes
are stored off-site in a suitably secured facility (there are many companies
world-wide that offer such a service).
These comments specifically relate to backup and protection of the stored data and
do not consider the separate issue of Change Management (and potential roll-back).
Manual Release 1
7-3
Exercise - Backup the Project

1
7-4
Backup the CitectHistorian configuration

i.
Open the Backup and Restore Utility. From the Windows Start
menu, select Programs Citect CitectHistorian Management
Tools Configuration Backup And Restore.
ii.
Select CitectHistorian database from the dropdown list.
iii.
Click the Ellipsis

button to open the Backup File dialog. Give
the backup file a name and click Save to continue.
Version 4.2
December 2009
Exercise - Backup the Project (cont.)

iv.
Click OK to backup your configuration.
v.
Click OK when the backup is complete.
vi.
Click Close to exit the Backup/Restore window.
Manual Release 1
7-5
Exercise - Modify the Database

In order to be sure that the sequence of Backup-and-Restore has actually achieved
something, an intermediate step will be undertaken to remove parts of the current
project. Thus when the project is later restored, the deleted pieces will re-appear.
1
Modify the CitectHistorian Database.

i.
Return to the CitectHistorian Configuration Manager and open
Published Information. Delete the subfolder AladdinsCaves.
ii.
Click Yes to confirm your choice.
7-6
Version 4.2
December 2009
Exercise - Restore the Project

1
Restore the CitectHistorian configuration.

i.
Open the Backup and Restore Utility and select the Restore tab.
ii.
Click the Ellipsis

button to open the Restore File dialog. The file
location will be the same as where the backup was created.
iii.
Select ManageProjects.cbf and click Open.
Manual Release 1
7-7
Exercise - Restore the Project (cont.)
7-8
iv.
Select CitectHistorian from the Database dropdown list box. Click

OK to restore the configuration.
v.
This warning message will appear. Click OK to continue.
vi.
Click the OK button when the Restore is complete.
Version 4.2
December 2009
Exercise - Restore the Project (cont.)

vii.
Open the CitectHistorian Server Manager and check that the

configuration has been restored.
viii.
As it is no longer required, delete the Aladdin folder (and all

contents) beneath the Published Information folder.
Note:
The restore function may modify the passwords for existing users defined in the
system. If it is found that existing users can no longer log in via the Excel client,
the current users must be removed from both the Historian and SQL security
systems and re-created. Information on deleting users from the SQL environment
is provided in Delete the Project (page 7-22).
Manual Release 1
7-9
Exercise - Backup the Historian Database

The previous discussion addressed only the need to Backup and Restore the
configuration database - it did not relate to the actual data collected from the plant.
1
Backup the Historised data.

i.
Open the Historian Data Manager. From the Windows Start menu,
select Programs Citect CitectHistorian Management Tools
Historian Data Manager.
7-10
Version 4.2
December 2009
Exercise - Backup the Historian Database (cont.)

ii.
If the server and database are not connected as shown in the

graphic, create the necessary connections.
iii.
Select the Backup/Restore tab.
iv.
Click the Ellipsis button beside the Backup File field.
Manual Release 1
7-11
7-12
v.
Navigate to a suitable location and give the backup file an

appropriate name (here C:\temp and First_Backup).
vi.
Click OK.
Version 4.2
December 2009

vii.
Note the Backup button is no longer greyed-out. Click it.
viii.
A "bar graph" progress meter will appear on the bottom of the dialog
box. Once done, a message will appear.
ix.
Click OK.
x.
Close the Historian Data Manager.
Manual Release 1
7-13
Active Project
Allows Users to
Switch between
Projects
On a development PC, it quite reasonable to have many projects installed and either
(potentially) operational or under continued development. In either case, only one
project can actually be operating on the PC at any one time. This is referred to as
the Active Project.
The Server icon of the current Active Project is overlayed with a green tick.
When CitectHistorian is installed it sets the default CitectHistorian Server name in

the CitectHistorian Event and Historian services as well as the Windows
Component Service to the local machine computer name, and sets the
CitectHistorian configuration database name to "CitectHistorian".
This means that if a new CitectHistorian Server is added using the default settings,
this server will be the active server project for the local machine. However, should
a CitectHistorian Server be added to the local machine that does not use the default
database name of "CitectHistorian", and this server is to be the Active Server
Project, the CitectHistorian Server Manager provides a context-sensitive menu
item to set the active project.
The Active Project sets the CitectHistorian Server name in the Event and Historian
Services. It is necessary to stop these services before changing the Active Server.
Also if an existing CitectHistorian database is going to be restored under a new
name it is still necessary to link the CitectHistorian Server with a new name using
the Register CitectHistorian Server Wizard.
See Also:
For further information about Active project, see CitectHistorian Help - backing
up and restoring a project Restoring a project configuration.
7-14
Version 4.2
December 2009
Exercise - Active Project

1
Create a new CitectHistorian Server by restoring an existing

configuration under a new name.
i.
Return to the Backup and Restore Utility. Open the Restore tab.
ii.
Select the backup file that you created in the previous exercise.
iii.
Give the Database a new name. Click OK.
Manual Release 1
7-15
Exercise - Active Project (cont.)

iv.
7-16
When the restore is complete click OK and then Close to exit the
Backup and Restore Utility.
Register the new CitectHistorian Server.

i.
Return to the CitectHistorian Configuration Manager.
ii.
Right click Historian Servers and select New Server from the
menu. This will open the Register Historian Server Wizard and
allow you to connect your newly created database to the
CitectHistorian Server.
iii.
Connect to the same CitectHistorian Server Computer as the current

project uses (Training in this manual).
iv.
Click Next.
Version 4.2
December 2009

v.
Use the Windows account.
vi.
At this screen use the dropdown list to select your newly created
database or type in a new name.
vii.
Click Next.
Manual Release 1
7-17
7-18
viii.
The last screen will display your new CitectHistorian Registration

Name. Click Finish.
ix.
The CitectHistorian Configuration Manager will now list your new

CitectHistorian Server.
Version 4.2
December 2009

3
Set the new CitectHistorian Server as the Active Project.

i.
Open the CitectHistorian Status Indicator.
ii.
Stop the Data Service by clicking the red Stop button.
Note:
Notice that the Database is CitectHistorian. As this service is accessing the
CitectHistorian database it is necessary to stop the Data Service before the Active
Project can be changed. The Event Services must also be stopped, but this has not
yet been started, it will be considered in Events (page 9-1).
Manual Release 1
7-19
7-20
iii.
Once the Data Service is stopped (the Start/Continue button will be

painted green), return to the Historian Configuration Manager.
iv.
Right click the newly restored database and select Set as Active
Project.
v.
The CitectHistorian Configuration Manager will now display the green

tick over the Alternate database icon.
Version 4.2
December 2009

vi.
Open the CitectHistorian Status Indicator; click the Refresh button.

The database is now displaying the name of the new database.
vii.
If this database was going to be used it would be necessary to start

the Historian Data and Event Services. However, for now, change
the Active Project back to the CitectSCADAReports database.
viii.
Right click and delete the Alternate Project.
ix.
Restart the Data Service.
Manual Release 1
7-21
Remove a Project
Delete the Project
Should there be a need to delete the entire project and it's data, the following steps
must be taken.
This is NOT an Exercise, do not follow these steps during the course.
Delete all projects in Historian Configuration Manager - the easiest way is to

right click each project and choose Delete from the menu.
Open SQL Server 2005 Server Management Studio

For each of the following databases, right click and select Delete from the
menu.
7-22
CitectHistorian
Historian
ReportServer$CITECTHISTORIANtempDB
Version 4.2
December 2009
Remove a Project (cont.)

In the dialog box, ensure that The selection Close existing connections is
ticked.
Do not delete ReportServer$CITECTHISTORIAN, this should be retained if

the intention is simply to re-start the configuration process.
Manual Release 1
7-23
Remove a Project (cont.)

Delete all users defined in the project from the SQL Security folder.
When an account is created in CitectHistorian a matching account is also created in
the SQL Security folder. Having deleted the CitectHistorian databases and their
associated users already, the SQL users remain. If they are not deleted in SQL and
the same users are re-created in CitectHistorian the accounts will have mis-matched
password hashes and the users will not be able to login, even if the passwords are
the same. Thus the accounts must be manually deleted from the SQL Security subsystem.
7-24
Version 4.2
December 2009
Summary
Summary

Backup and Restore Projects (page 7-2)
Active Project (page 7-14)
Questions

Other than for security, why would Backup and Restore functions be used?
Where must the above functions be run?
What is the benefit of the Active Project?
Manual Release 1
7-25
Chapter 8:
Tasks
Overview
Introduction
Tasks are used to trigger actions, transfer data or email information. A Task may
be triggered manually or set to trigger automatically using Events, which will be
covered in Events (page 9-1).

Why Are Tasks Used? ...........................................................8-2
Task Properties ......................................................................8-3
Data Transfer Tasks ...............................................................8-7
ActiveX Tasks......................................................................8-30
Email Tasks..........................................................................8-34
Organise Tasks into Folders ................................................8-37
Why Are Tasks Used?

Tasks Initiate
Actions
Tasks are used to initiate a defined activity automatically whenever an associated

Event occurs. Tasks replace all the hard to maintain Cicode used for SQL, DDE and
CTAPI connections of the past with simple to use GUIs that require no knowledge
of code to use. This makes the Task simple to view, edit and modify. Like the rest
of the CitectHistorian configuration, Tasks may be backed up and restored with
ease.
Typical Task activities include:
Sending data from a control system to a database
Sending data from the Historian to a database
Sending e-mails
Executing ActiveX script
Executing a DTS package
Sending values to a control system from a database
Tasks are able to provide links between multiple disparate data sources. For
example, using a Task it is possible to transfer real time tag data into a database or
download a complex recipe into the SCADA tags. Tasks also provide simple
access to other utilities for linking with various enterprise resources including
databases, files and even email.
Although used in this course as a means of executing tasks, manual triggering
would be rarely used in a production environment.
8-2
Version 4.2
December 2009
Task Properties
General Tab
Creating a Task involves a process of selecting the Type of activity to be executed,

identifying the triggering Event(s), and then configuring the details of the required
Action. There are several different types of Tasks offered in CitectHistorian.
When a new Task is created the dialog will list these types in the Type field on the
General Tab.
See Also:
For further information about Tasks, see CitectHistorian Help - Working with tasks
Creating a task.
Manual Release 1
8-3
Task Properties (cont.)

Triggering Tab
8-4
The Triggering tab allows Tasks to be configured to run automatically. The

Events are configured separately, however, they are implemented in the
Triggering tab to trigger Tasks. Events will be examined in the chapter Events
(page 9-1).
Version 4.2
December 2009

Action Tab
The Action Tab configures the Task itself. The information in this tab will change
depending on the type of Task that is being configured. This is because each Task
type generates a very different outcome, and therefore requires unique settings and
instructions to fulfill its purpose.
Manual Release 1
8-5

Variables Tab
8-6
The Variables tab features a table where Visual Basic script (VBScript)
expressions or SQL data queries that will be applied to the Task are listed.
Variables are used to modify the activity defined for a Task using customised
VBScript or SQL statements. The Variable Properties dialog is used to compose
the VBScript or SQL statements that will be applied to a Task. This tab varies for
each Task type. Some Task types such as Upload Alarms, Trends and Historian
have predefined variables. Other Task types such as ActiveX and Download Tags
can accept user defined variables.
Version 4.2
December 2009
Data Transfer Tasks

Transfer Data
between Systems
There are several types of activities that can be implemented to transfer data using
Tasks. These include:
Transfers from SCADA data sources to connected databases
Transfers from Historian to connected databases
Sending tag values to a SCADA data source from a database
All of these will be examined in the next few exercises.
Manual Release 1
8-7
Exercise - Upload Alarms Task

1
Configure a Task to upload Alarm data from the CitectSCADA data

source to your SQL Database.
i.
Open the CitectHistorian Configuration Manager and right click
Tasks. Select New Task from the menu.
Note:
If the installation contains a lot of tasks, these may be organised into task folders.
However, this will not be done in these exercises.
ii.
8-8
The Task configuration will open at the General tab. Name the Task
Alarm Upload and select the Upload Alarms type.
Version 4.2
December 2009
Exercise - Upload Alarms Task (cont.)

2
Configure the Actions.

i.
Open the Action tab. Notice that the Source pane has listed only
the SCADA Data Sources and that the columns already contain the
list of Alarm data (properties) on the source SCADA server. A value
for each of these properties in the source Columns list will be
transferred across to the mapped field in the destination database
when the Task is triggered. It is possible to Add and Remove items
from this list by using the buttons below the list, and reorder the list
by clicking the up and down arrows to the right of the list.
Note:
When configuring a Task to upload alarm data, the selected columns must include
the Tag and OnDateTime properties, otherwise the Task will fail.
Manual Release 1
8-9
8-10
ii.
Click the Preview button. This will display the Source Data Preview
window which shows the arrangement of the data in a table, based
on the columns that have been selected. The preview functionality is
useful for checking that the source columns have been configured as
intended. Click OK to return to the Action tab.
iii.
The Destination pane lists the Database Data Sources. Select the
Alarm table from the list.
Version 4.2
December 2009

iv.
Click the Add button to open the Column Selection window.
v.
There are two ways to map the columns correctly. Either select
columns individually in the correct order or select all columns and
then reorder them using the up and down arrows on the Action tab.
vi.
Position the Column Selection dialog box such that the list of source
columns in the New task dialog is visible. In the Column Selection
dialog, select each column name in the order they appear in the
source list and click the right-facing arrow to add to the Selected list.
vii.
When the list is complete, click OK to close the Column Selection

dialog.
Note:
The fields in both columns MUST match exactly as the system will create a 1-to-1
mapping between the two lists in the order they are encountered. The names are
not required to be identical, but the contents and datatypes must match. the up and
down arrows may be used to adjust the order.
Manual Release 1
8-11

3
Configure the Variables.

i.
8-12
Open the Variables tab. SCADA Alarm Upload Tasks have VBScript
applied to them by default. The default limits the request for alarm
data to the last two hours. The variable EndDateTime uses the
VBScript expression "Now()" to set the end of the request period to
the current time. The StartDateTime uses the expression DateAdd()
to set the start of the request period to two hours prior.
Version 4.2
December 2009
ii.
Select the StartDateTime Variable and click Edit.

StartDateTime to 1 hour.
Change the
iii.
Click OK on each of the open dialogs to save the settings of the new
Task.
Execute the new Task.

i.
Return to the CitectHistorian Configuration Manager. Right click the

Task Alarm Upload and select Execute from the menu.
ii.
If the Task is successful this message will be displayed.

The task may take 5 or 10 seconds to execute.
Manual Release 1
Click OK.
8-13

5
View the Alarm data that has been transferred to the SQL
Database.
i.
Open the SQL Server Management Studio.
ii.
Locate the SQL Database. Right click the Alarm table and select
Open Table from the menu.
iii.
If the Task has been successful all alarm data from the last hour will
be visible.
8-14
Version 4.2
December 2009
Exercise - Upload Trends Task

1
Configure two Tasks to upload Trend data from the CitectSCADA

data source to the SQL Database data source.
i.
Create a new Upload Trends Task named Upload Trend Tabular.
ii.
Select the Action tab.
iii.
The Source pane has the SCADA data sources listed the same as the
Upload Alarms Task. Click the Source Tags button. This will open
the Tag Selection window.
iv.
Use the Filter field to display all _Temp tags in the Available Tags
window.
v.
Move all of the tags across into the Selected Tags pane.
vi.
Click OK to return to the Action tab.
Manual Release 1
8-15
Exercise - Upload Trends Task (cont.)

2
Compare the Tabular and Crosstab column styles.

i.
To preview the data in the Tabular style, click the Preview button.
The Tabular style returns each sample value as a separate record.

The data is always distributed across three columns:
Date/Time - contains the date/time stamp for the sample

Tag - the name of the tag
Value - the sample value
The Tabular style is easier to configure and requires no maintenance,
however, the disadvantage of this style is that it is slower and less
efficient to query.
8-16
Version 4.2
December 2009

ii.
Return to the Action tab and change the Column Style to Crosstab
(transpose). Preview the data.
The Crosstab style returns the data one record at a time for each
tag per date/time stamp. Therefore, the columns used include
Date/Time and a separate column for each Tag. The Crosstab style
is the most efficient, easy and fastest to query, however it requires
more maintenance and takes longer to configure.
iii.
Click OK to close the Source Data Preview and change the Column
Style back to Tabular.
Manual Release 1
8-17

3
8-18
Configure the Destination.

i.
Configure the Destination pane to use the table Trend_Tabular and

use the Columns list to map the Destination columns to the correct
Source columns.
ii.
Remove the Locale column from the source list.
Version 4.2
December 2009

4

i.
Open the Variables tab. Note that there is another preconfigured

Variable called SamplePeriod. The default request for trend data is
limited to the last two hours, with a sample period of 0 seconds.
Change the StartDateTime variable to one hour and the
SamplePeriod to 2 seconds.
ii.
Click OK to save the Task and exit the properties dialog.
Note:
With a SamplePeriod of 2 seconds and a randomiser in the SCADA project of
between 5 and 11 seconds, many of the samples stored in the SQL_Database will
have to be estimated.
CitectHistorian uses an estimation method called
"interpolation."
This is discussed extensively in the chapter Historian
Interpolation (page 14-1).
Manual Release 1
8-19

5
8-20
Create another Upload Trends Task.

i.
Create a new Task named Upload Trend Crosstab.
ii.
Select the Action tab and choose Crosstab (transpose) as the

Column style.
iii.
Open the Tag Selection dialog by clicking the Source Tags button
and select all of the _co2 tags.
iv.
Select the table Trend_Crosstab in the Destination pane.
v.
Map the fields to each of the columns in the Source pane.
vi.
Remove the Locale field from the source column.

i.
Open the Variables tab and change the StartDateTime variable to

one hour and the SamplePeriod to 2 seconds.
ii.
Click OK to save the settings and exit the dialog.
Version 4.2
December 2009

7
Transfer the data to the SQL Database.

i.
Right click each of the Tasks and Execute.
ii.
Open the Trend_Tabular table using the SQL Server Management

Studio.
iii.
Compare the information in the Trend_Crosstab table.
Manual Release 1
8-21
Exercise - Upload Historian Tag Data Task

1
Create an Upload Historian Tag Data Task.

i.
8-22
Create a new Task called Historian Tag Upload and select Upload
Historian Tag Data in the Type: field.

i.
Open the Action tab. Select the Tags option in the Historian Folder
field.
ii.
Click the Source Tags button to open the Tag Selection dialog.
Select all of the _Air tags.
iii.
Select the Historian table from the SQL Database. Map the columns
to the corresponding columns on the source side.
Version 4.2
December 2009
Exercise - Upload Historian Tag Data Task

(cont.)
3

i.
Open the Variables tab and change the StartDateTime variable to

one hour and the SamplePeriod to 0 seconds.
ii.
Click OK to save the settings and exit the dialog.
iii.
Execute the Task.
Examine the Result in SQL Manager.

i.
Open the Historian table using SQL Server Management Studio and
view the data.
Manual Release 1
8-23
Exercise - Upload Tag Data (Crosstab) Task

1
Create an Upload Tag Data Task.

i.
Create a new Task called Tag Upload Crosstab and select Upload
Tag Data in the Type: field.

This step will configure the Source side pane to use one tag per
column.
i.
ii.
Click the Add button to open the Add Column dialog and enter
*central into the Filter: field.
In this Task each tag must be configured separately.
Entering a
Column Name is not absolutely necessary but it helps define the

Task. Select Central_Air and enter Air Speed into the Column
Name: field. Then click OK.
8-24
iii.
Repeat the process for the tags Central_co2, Central_Count and

Central_Temp. Ignore the Central_Door tag.
iv.
Configure the Destination pane to use the table Tag_Crosstab.
Version 4.2
December 2009
Exercise - Upload Tag Data (Crosstab) Task

(cont.)
v.
Map the first four columns to the source columns.
vi.
Click OK to save settings and exit the dialog.

Examine the result.
i.
Execute the task.
ii.
View the table in the SQL Server Management Studio.
Manual Release 1
8-25
Exercise - Upload Tag Data (Tabular) Task

1
Create a Tabular Tag Upload Task.

i.
Create a new Task called Tag Upload Tabular and select Upload Tag
Data in the Type: field.

i.
ii.
Open the Action tab and click the Add button in the Source pane.
This time, add the columns to the Source pane using the Constant or
VBScript Expression option.

This option is used to implement a VBScript expression or a constant
in a column associated with the Task, a constant value or any
standard VBScript expression can be included in this field.
This field supports standard VBScript expressions that will provide a
logical outcome, such as Now(), DateTime() and AddDate(). Any
VBScript expression keyed into this field will be passed to the
VBScript engine at the time the Task triggers.
The calculated results are returned to the relevant column and
included in the table of data that is transferred. By default, the
expressions Tag, DateTime and Description are available from the
drop-down list attached to this field.
8-26
Version 4.2
December 2009
Exercise - Upload Tag Data Task (cont.)
iii.
Using the Constant or VBScript option, separately create columns

for the default expressions DateTime and Tag. Remember to assign
suitable column names for each one.
iv.
Create a third column (using the Tag Data option) for TagValue.
Select all tags that start with Chris (use a filter *Chris*).
v.
In the Destination pane select Tag_Tabular in the Table: field. Add

corresponding column mappings for the expressions that were
entered into the Data Source pane.
vi.
Click OK to save the settings and close the dialog.

Examine the result.
i.
Execute the task.
ii.
View the table in the SQL Server Management Studio.
Manual Release 1
8-27
Exercise - Download Tag Data Task

This task will not be saved or executed as there is no source data available to
download. It is presented to the student as an example of how data may be moved
into the Historian system rather than out of it, as was done in the previous
exercises.
1
Create a Tag Download Task.

i.
Create a new Task called Tag Download and select Download Tag
Data in the Type: field.

2
8-28

i.
Open the Action tab and use the dropdown arrow to select
Tag_Download in the Table: field in the Source pane.
ii.
Click the Add button. From the Column Selection window assign all
available fields as columns, except for the field ID.
iii.
Preview the Data Source table. This is simply a representation of the

data currently held in the SQL_Database table.
Version 4.2
December 2009
Exercise - Download Tag Data Task (cont.)

iv.
Set the Where: clause to ID = 1.
v.
Preview the data source table. This time only the first row of data is
returned.
vi.
Change the Where: clause to 2, 3 etc to return the other rows. Do

not configure the Destination pane as this data will not be
downloaded into the SCADA system. Click the Cancel button.
Manual Release 1
8-29
ActiveX Tasks
Customise Tasks
The Tasks that have been configured so far have dealt with the transfer of data
between SCADA and Databases. The remaining types of Tasks are:
Sending e-mails
Executing ActiveX script
Executing DTS packages
ActiveX, DTS Package and Email tasks do not relate directly to the transfer of data
between SCADA and Databases but provide the power and flexibility to tap into
existing corporate resources or customise Tasks.
Note:
The DTS Package Task runs packages that were developed using SQL Server
2000 tools. SQL Server 2005 does not install the DTS package designer although
this package is available through the Microsoft website for backwards
compatibility.
DTS Package Tasks are not covered in this course.
In MS-SQL 2005 and 2008, Microsoft has introduced the replacement: SQL Server
Integration Services (SSIS). SSIS packages are also not addressed in this course.
8-30
Version 4.2
December 2009
Exercise - ActiveX Tasks

1
Set up a Task that uses ActiveX Script to log information into a

text file.
i.
Create a new Task named Date/Time Log.

Script.
The Type: is ActiveX

i.
Open the Action Tab.

continue.
Enter this Active X script.
Click OK to
Note:
This code will use the function CreateObject() to create a file called testfile.txt
and append the current date and time using the function Now().
ii.
Execute the Task manually. Check the C:\ directory for a file named
testfile.txt. It should have one entry showing the date and time that
the Task was executed.
Set up a Task that uses ActiveX Script to log the current value of
the Aer_Tank_Level tag into a text file called water.txt.
i.
Create a new Task named Insert Water Tag Value into File.
The
Type: is ActiveX Script.

ii.
Open the Action Tab. Enter this Active X script.
This script is almost identical to the Date/Time script. The difference

here
is
that
a
CitectHistorian
Variable
called
HistorianVariable("Water") has been added to the line that will be
appended in the file water.txt.
Manual Release 1
8-31
Exercise - ActiveX Tasks (cont.)

4
Configure the Variable.

i.
The next step is to create the CitectHistorian variable.
Open the
Variables tab and Add a new variable. Fill out the property sheet of
the variable using these values:
Name
Water
Data Source
Aladdin
Query Statement
SELECT Value from Tag WHERE Tag =

'Aer_Tank_Level'
See Also:
This example demonstrates how to read Integer values from CitectSCADA. For
information on how to read String Variables from CitectSCADA for use in
ActiveX script refer to CitectHistorian KB Article P1103.
8-32
Version 4.2
December 2009
Exercise - ActiveX Tasks (cont.)

ii.
Click OK to continue. The new variable will look like this.
iii.
Click OK to continue.
iv.
Execute the Task.
Check the c:\ directory for the file named
water.txt.
Manual Release 1
8-33
Email Tasks
Send Email
Tasks
CitectHistorian permits the creation of a task to send a simple email message to any
address on the web.
The email cannot directly contain tag values, although it is a relatively simple task
to create an output file with the ActiveX task which can then be included in the
email as an attachment.
8-34
Version 4.2
December 2009
Exercise - Send Email Task

1
Send an Email using a Send Email Task.
Note:
A set of Gmail email addresses have been created for use in this exercise. They are
[email protected] through to [email protected].
The
instructor will allocate an address for the use of each student. The password for
each account is citectcitect.
i.
Create a new Task called Send Email and select Send Email in the
Type: field.
2

i.
Open the Action tab.

Water.txt file.
ii.
Execute the Task.
Fill out the email form and attach the
Manual Release 1
8-35
Exercise - Send Email Task (cont.)

3
Check the delivery of the email.

i.
Open a Web Browser and navigate to www.gmail.com.
ii.
Log in to Gmail using the account details provided by the Instructor.
iii.
Confirm that the message has been received.
iv.
Open the message to confirm the contents.
v.
Close the message and delete it.
vi.
Log out of Gmail.
vii.
Close the browser.
Note:
If a mail server is not configured for the computer to use, this Task will not do
anything useful.
8-36
Version 4.2
December 2009
Organise Tasks into Folders

Multiple Folders
Tasks may be organised into separate folders to simplify their management.
The use of such folders has no impact on the functionality of the Tasks.
Manual Release 1
8-37
Exercise - Create Task Folders

1
8-38
Create a folder for ActiveX tasks.

i.
Right click the Tasks folder and select New Task folder ...
ii.
Name the new folder ActiveX Tasks.
Version 4.2
December 2009
Exercise - Create Task Folders (cont.)

iii.
Click OK.
iv.
Drag the two ActiveX Tasks into the new folder.
Manual Release 1
8-39
Exercise - Create Task Folders (cont.)

2
Create folders for all Tasks.

i.
Use the following table to create folders and populate them with
Tasks.
Folder Name
Contents
Alarm Tasks
Alarm Upload
Trend Tasks
Upload Trend tabular

Upload Trend Crosstab
Tag Upload Tasks
Tag Upload Crosstab

Tag Upload Tabular
Historian Tasks
Historian Tag Upload
Email Tasks
Send Email
8-40
Version 4.2
December 2009
Summary
Summary

Why Are Tasks Used? (page 8-2)
Task Properties (page 8-3)
Data Transfer Tasks (page 8-7)
ActiveX Tasks (page 8-30)
Email Tasks (page 8-37)
Organise Tasks into Folders (page 8-37)
Questions

Why are Tasks used?
Which tab allows you to set Tasks to run automatically?
Which tab configures the Task itself?
What does the Variables tab do?
What types of Tasks provide the power to tap into existing corporate resources
or to customise activities?
Manual Release 1
8-41
Chapter 9:
Events
Overview
Introduction
CitectHistorian may be configured to initiate actions in the SCADA system. Events

may be executed manually or automatically by using the Event Service.

What is an Event? ..................................................................9-2
The Event Service..................................................................9-6
Recipe Management via Tasks and Events............................9-8
What is an Event?
The Event
Service
The Event Manager runs as a separate service and is managed via the Event Service
tab in the CitectHistorian Status Indicator.
The primary task of the Event Service is to regularly check a list of a available jobs
to determine if they have satisfied their trigger conditions.
Trigger conditions may be time-based (perhaps every minute), data-based (perhaps
when a specific tag attains a pre-determined value) or chained to other events.
9-2
Version 4.2
December 2009
What is an Event? (cont.)

Events Provide a
Trigger
Events signal the occurrence of specified condition changes within your

CitectHistorian system, providing a trigger for automated Tasks. They can be set up
to flag a value change within a connected SCADA system, or whenever a period of
time passes. Events may be based on the progression of a Task, allowing Tasks to
be daisy-chained.
Note:
Events should NOT be used for reaction time critical SCADA control as there are
delays between the conditions becoming true, the Event firing and the Task being
executed.
Event Types
There are five different types of Events in CitectHistorian. These are the three
SCADA types, the Clock and the Task Engine.
CitectSCADA
Event
Triggers an action based on the value of a CitectSCADA Tag
Clock Event
Time based
Task Engine Event
Triggers an action based on the status of a CitectHistorian Task
Manual Release 1
9-3
Exercise - Clock Event

1
9-4
Configure a Clock Event to trigger a Task every 10 seconds.

i.
Open Historian Configuration Manager.
ii.
Right click Events and select New Event from the menu.
iii.
Name the new Event 10 Second Timer. Make the Source Type
Clock and set the Event to occur every 10 seconds. Leave the
Event to be synchronised at midnight. Click OK to save the settings.
Version 4.2
December 2009
Exercise - Clock Event (cont.)

iv.
Double click the Date/Time Log Task to open the Task proerties.
Open the Triggering tab, select the 10 Second Timer Event and click
the right-facing button, thereby enabling it. Click OK to continue.
Manual Release 1
9-5
The Event Service

Detection and
Signalling of
Events
The Event Service is an application that resides on a CitectHistorian Server to

handle the detection and signalling of Events. When running, it monitors the
CitectHistorian system for conditions specified by the currently configured Events,
and flags any time-based Events. This is the nuts and bolts of the whole
CitectHistorian Event System which automates the execution of the Events and
Tasks. Without the Event Service running, the Events and Tasks themselves do not
run and Tasks can only be executed manually.
There are some important features to note regarding the Event Service. These
include:
The Event Service relies on the Historian Service to connect to data sources.
There will be a dialog advising of this
The Event Service needs to stop and restart whenever changes are made to
Events. This includes modifying existing Events, creating new Events or even
deleting old Events
It is not necessary to stop the Event Service when changes are made to Tasks
including adding or removing triggers
The Event Service is really comprised of several distinct phases. The following is a
simplified description of how the system works:
Event Service constantly scans for Events configured since the time it was last
started
When Events occur they are placed on the Event Queue. The Events progress
down the queue in the order they were placed on the queue (first in first out)
When an Event reaches the front of the Event Queue, the CitectHistorian Server
is searched for any Tasks triggered by that Event
The Tasks are placed on the Task Queue. Again, the Tasks progress down the
queue in the order they were placed on the queue (first in first out)
When Tasks reach the front of the Task Queue, the Task is executed
9-6
Version 4.2
December 2009
Exercise - The Event Service

1
Start the Event Service.

i.
Open the CitectHistorian Status Indicator by double clicking the

icon in the System Tray.
Service
ii.
Select the Event Service tab. Start the Event Service by clicking the
Start
button.
Note:
Every time you configure a new Event the Event Service will need to be restarted
for the Event to execute.
iii.
Now that the Event Service is running the 10 Second Timer event
will cause the Date/Time Log Task to run every 10 seconds. Open
the file testfile.txt that was created by the Task in Exercise ActiveX Tasks (page 8-31). Check that the date and time are being
logged every 10 seconds.
Manual Release 1
9-7
Recipe Management via Tasks and Events

Preparing a
SCADA System
to launch a New
Job
CitectHistorian is capable of writing values back to the plant equipment.

Clearly the unannounced modification of individual tag values is a very
unreasonable thing to do ("hey, who turned that pump on?"), however, a
coordinated approach to plant management - via a Recipe system for instance - can
offer major benefits to the overall operation of the facility.
The following exercise will develop a simple representation of Recipe
Management.
Note:
Whenever ANY CitectHistorian system is configured to write back to the
underlying SCADA, extreme care should be taken that suitable practices and
procedures are in place to properly manage the process.
Without suitable care, this exposes the possibility of life-threatening
situations.
Previously, it was demonstrated that a task could be launched manually by right

clicking the task in the task tree and selecting Execute. In order to 'automagically'
execute a task, it must be launched by an Event.
Events are managed by the Event service which regularly polls the list of available
Events detecting which are able to be run. Once an Event runs, it is capable of
launching any Task which has specified the Event as its Triggering Event.
9-8
Version 4.2
December 2009
Exercise - Use an Event to Trigger a Task

This exercise configures Historian to write recipe values to the SCADA system
when a new work order number is selected on the SCADA Flavouring page.
Create a Download Tag Data Task.

i.
Create a new Task called Download Recipe.
ii.
Select the table RecipeSetup as the Source data.
iii.
Click the Add button and select all available column expressions
except ID.
iv.
Configure the Destination pane. Click the Add button and enter *plc
into the Filter: field. Select the appropriate tags (in the same order
as the source list) from the list of available tags then click OK. They
must be added one-by-one to match the column layout of the source
column list.
Manual Release 1
9-9
Exercise - Use an Event to Trigger a Task (cont.)
9-10
v.
Repeat the process to assign tags for each of the remaining columns
in the Source pane with the exception of NamePLC and
WorkOrderPLC.
vi.
Select the Variables tab and click the Add button.
Version 4.2
December 2009

vii.
Configure the Download Recipe Task to select a recipe based on a

CitectHistorian Variable. Fill out the property sheet of the variable
using these values:
Name
MyRecipe
Data Source
Aladdin
Query Statement
SELECT Value from Tag WHERE Tag =

'WorkOrderPLC'
Note:
The variable tag name WorkOrderPLC is enclosed in single quotes.
viii.
The variable tag WorkOrderPLC specifies the name of the soft drink
recipe. Click OK.
ix.
Return to the Action tab and edit the Where: clause so that the
recipe selected will be based on the value of the ID in the
RecipeSetup table.
Manual Release 1
9-11

x.
2
Click the OK button to close the New Task Properties window.

View the source Recipe data in the SQL Database.
i.
Open the Microsoft SQL Server Management Studio.
ii.
Navigate to the RecipeSetup table in the SQL database.
iii.
Execute the query :

SELECT * FROM RecipeSetup
Add more Recipe values (optional).

i.
9-12
Right click the RecipeSetup table and select Open.
Version 4.2
December 2009

ii.
Add a couple of new rows to the table.

Note that the ID number is assigned by the system. Red exclamation
marks indicate unsaved data. To save a row, simply click in the next
blank row.
Create two Events to trigger the Download Recipe Task when the
tag WorkOrderPLC changes.
i.
Return to Historian Configuration Manager and create a new Event

Be sure to tick the Increases
named WorkOrderIncrease.
checkbox.
ii.
Select the When tag field to use the WorkOrderPLC tag.
Manual Release 1
9-13
9-14
iii.
Create a second Event named WorkOrderDecrease. This time select

the Decreases checkbox.
iv.
Return to the Download Recipe Task and open the Triggering tab.
v.
Select the two WorkOrder Events.
vi.
Click OK to close the properties of the Download Recipe Task.
vii.
Restart the Event Service.
Execute the Task.

i.
Open the CitectSCADA runtime window for the Aladdin project, then
open the page Flavouring by clicking the Flavouring Plant image.
ii.
The WorkOrder Number field is protected by the "double

authentication" facility provided by CitectSCADA Version 7.1 called
MultiSignatureForm(). This facility allows additional users to be
defined to counter-sign any specific operation in the plant. In this
situation, an additional user (here called Approver) has been defined
as the counter-signing authority.
Version 4.2
December 2009

iii.
Click on the WorkOrder Number field.
iv.
As this field requires authorisation, a dialog box is displayed showing

all the approvals required (here just one, but up to four may be
demanded).
v.
Click the Verify button to enter the Approver credentials. Type the
password citect.
vi.
Click OK. the Approver user will now be verified.
Manual Release 1
9-15

vii.
Once all counter-signers have entered their passwords, the final step
is to 'approve' the transaction. Click the Approve button (it may still
be cancelled at this point).
viii.
Click the OK button to close the acknowledgement screen. Once this

is done, the data entry dialog box is displayed.
ix.
Remember to choose a value just one higher or lower than the

current value (the current WordOrder number is supplied as a
default). Click OK.
x.
The Recipe will change to match the data linked to the ID in the
RecipeSetup table.
9-16
Version 4.2
December 2009
Exercise - Audit Log of Recipe Management

This exercise will modify the execution of the previous recipe download
functionality to include logging of the recipes to create an audit trail.
Refer to the diagram at the beginning of Exercise - Use an Event to Trigger a Task
(page 9-9).
In this exercise, an additional Task / Event pair will be inserted between the
WorkOrder Event and the Download Recipe Task to write the outgoing recipe to a
data file.
The "Recipe Logged OK" Event is simply a dummy Event to permit chaining as in
such a structure, Events and Tasks must alternate; in addition, the second (dummy)
Event is constructed to be activated by the successful completion of the previous
Task.
Create an Upload Tag Data Task.

i.
Create a new Task called Log Recipe Status.
ii.
On the Action tab, Select the Add button for the source and choose
Constant or VBScript Expression.
iii.
Select DateTime from the dropdown list.
iv.
Click OK.
Manual Release 1
9-17

(cont.)
9-18
v.
Click the Add button again and select all of the PLC tags except the
tags NamePLC and WorkOrderPLC (use *PLC in the Filter field) and
click OK.
vi.
Finally, Add a third source column using Tag as a Constant.
Version 4.2
December 2009

(cont.)
vii.
Use the table RecipeLog as the Destination table. Select the

DateTime, PLCValue and PLCName columns (in that order) in the
RecipeLog table.
viii.
On the Triggering tab, add the

WorkOrderIncrease as selected Events.
ix.
WorkOrderDecrease
and
Click OK.
Manual Release 1
9-19

(cont.)
2
Create a new Event to act on the success of the Log Recipe Status
task.
i.
ii.
9-20
Create a new Event and configure it as follows:
Name
Recipe Logged OK
Source Type
Task Engine
Task Name
Log Recipe Status
State
Succeeded
Click OK.
Version 4.2
December 2009

(cont.)
3
Modify the Download Recipe Task.

i.
Open the Download Recipe Task and select the Triggering tab.
ii.
Remove the two WorkOrder Events from the selected list and add
the Recipe Logged OK Event.
iii.
Click OK.
Test the new configuration.

i.
Stop and restart the Event service.
ii.
Open the Flavourings page on the SCADA project.
iii.
Change the WorkOrder value a few times, pausing for 5 or 10

seconds between each change, confirming that the recipe values
change each time.
Manual Release 1
9-21

(cont.)
iv.
Open Microsoft SQL Sever Management Studio and view the contents
of the RecipeLog table in the SQL Database. Observer that there
are blocks of entries to match each change in the WorkOrder value.
v.
Close Microsoft SQL Sever Management Studio.
vi.
Close Historian Configuration Manager.
9-22
Version 4.2
December 2009
Summary
Summary

What is an Event? (page 9-2)
Event Types (page 9-3)
The Event Service (page 9-6)
Questions
The following questions are used to check your understanding.

What are Events?
How many types of Events are there?
What is the Event Service?
Manual Release 1
9-23
Chapter 10:
The Excel Client
Overview
Introduction
CitectHistorian is supplied with two client applications. The first of these is the
Excel client. Once the data items have been prepared for publication in the
CitectHistorian Configuration Manager they are available for use by the Excel
Client and many other client applications.
This chapter will examine different
methods of extracting and displaying data. We will then use the tools in Excel to
turn that data into meaningful information for business users.

View Data in the Excel Client .............................................10-2
Customise the Excel Client..................................................10-7
Statistical Analysis - Optional Section ..............................10-12
View Data in the Excel Client

Simple
Configuration
10-2
The Excel Client is simple to use. Most of the configuration for the client
applications has been set up in the CitectHistorian Configuration Manager. When
the User has connected to the CitectHistorian Server, the Data Items that the User
has permission to view will be available in the Excel Client, and may then be
manipulated using the powerful tools available in Excel.
Version 4.2
December 2009
Exercise - Excel Client

1
Connect to the CitectHistorian Configuration Manager in order to

view the data that has been prepared in the previous chapters.
The first step is to generate some data to view.
i.
Return to the CitectSCADA Aladdin runtime project and log in as
Engineer with citect as the password.

ii.
Open the Alarm page. The Aladdin project should have been running
for a while now so quite a few alarms should have been generated.
Acknowledge the alarms and more should start appearing. Open the
pages Filtration System and Cave System to generate more alarms.
iii.
The Trends and Historian tags that will be used in these exercises are
logging the values of the Analog tags. The pages Gas Emission,
Wind Speed and Cave Temperature display the values of these
tags. The values can be changed using the sliders.
Manual Release 1
10-3
Exercise - Excel Client (cont.)

2
Open a new spreadsheet and connect to the CitectHistorian data.

i.
Launch the Excel Client and click the New

button to open a new
spreadsheet. When the spreadsheet opens the first button on the
CitectHistorian toolbar will become enabled.
ii.
Click the CitectHistorian Connection

button to open the
Connection dialog. Enter the name of the CitectHistorian Server,
the database and the login credentials of one of the Users who has
been configured in the CitectHistorian Server Security and who is
part of the Guides group.
Note:
Here is the reason for using a CitectHistorian instance when setting up SQL
Server. Notice that only the SQL Servers with a CitectHistorian instance are
displayed in the drop down list. However, the Server Name is displayed without
CitectHistorian in the name. If an SQL Server that does NOT have a
CitectHistorian instance is being used simply type in the name of the SQL Server
rather than choosing it from the list.
iii.
10-4
Click the CitectHistorian Data Selection

selection dialog.
Version 4.2
button to open the data
December 2009

iv.
The Data Selection dialog will display the data items available to the
User who has been selected.
v.
Highlight the Digital Alarms Folder. This will allow the user to select
all items within that folder.
Alternatively the branch may be
expanded to allow individual items to be selected.
vi.
Click the right-facing arrow to move the items into the Selected
Data pane. Click Next to continue.
vii.
Give the Data Presentation the name DigitalAlarms then click
Finish.
viii.
The current Alarm data will be displayed using the default settings.
Notice how the preparation in the CitectHistorian Server has come

into effect. The names of the Alarms Tags are displayed using the
aliases specified in the Aliases (page 5-18).
ix.
Save this file as Digital Alarms Template in a location of your

choosing.
Open a new Spreadsheet.
i.
Connected to the CitectHistorian Server as one of the Users who has

access to the Trend data (someone who is a member of the
Engineers group).
ii.
Select all of the Tank Level items from the Trends folder. The Tank
level trends all end in TL_P. Click Next to continue.
Manual Release 1
10-5

iii.
In the Data Presentation properties dialog, change the Name to

Click Finish to
continue.
TankLevelTrends and the Data Layout to Chart.

iv.
The trend data will appear as an Excel Graph.
10-6
Version 4.2
December 2009
Customise the Excel Client

Modify the
Display Options
The Exercise - View Data in the Excel Client (page 3-26) demonstrated how
quickly it is possible to have CitectSCADA data appear in the Excel Client.
However, the Excel client may be customised to change the look of the data as well
as the type of data to display.
The Data Selection dialog provides more flexibility than simply selecting the data
items. It will also allow a particular time segment to be selected from the
Parameters.
The CitectHistorian Data Properties allows two areas to be configured, the Refresh
type and the Data Layout.
Manual Release 1
10-7
Exercise - Customise the Excel Client

1
10-8
Modify the display options of the selected data. The first part of
this exercise will change the display options for the digital alarms.
i.
Open a new spreadsheet and connect the Excel Client to the

CitectHistorian Server as one of the Users in the Engineers Group.
ii.
Select the Digital Alarms folder and move all the items across to the
Selected Data.
All items in the Selected Data pane will be
highlighted by default. Change the Duration to 30 minutes. Click
Next to continue.
iii.
Change the Name: to DigitalAlarms_30 and change the Refresh

option to Overwrite.
Version 4.2
December 2009
Exercise - Customise the Excel Client (cont.)

iv.
In the Data Layout section click the Headings button.
v.
Scroll down to the end of the category headings and untick the last
four options. Click OK to continue.
vi.
Click the Format button. Then click the Alarm On colour button and
select a different colour from the colour picker.
vii.
Select the Double line from the line style. Make any other changes
to customise the look of the table. Click OK to continue.
viii.
Click Finish to close the Data Presentation window. The table will
appear displaying only the alarms that have occurred in the last 30
minutes and in the customised colour format.
Manual Release 1
10-9

2
10-10
Modify the default settings for displaying trends.

i.
Open a new spreadsheet and connect the Excel Client to the

CitectHistorian Server as one of the Users with access to the
Engineers Published Information.
ii.
The Data Selection parameters for Trends allow the Period to be

changed as well as the End Time and Duration. Select all of the
trends that end in _co2. Change the Duration to 30 minutes.
iii.
A Chart Data Layout only allows the Name of the chart to be

customised. Name the chart CO2Levels.
Version 4.2
December 2009

iv.
The chart will appear using this default format.
v.
However, Excel comes with a range of features that allows charts to

be customised.
vi.
Save
the
spreadsheet
as
C:\InetPub\wwwroot\Historian\Reports\CO2 30 mins.xls.
Manual Release 1
10-11
Statistical Analysis - Optional Section

Turn Data into
Information
10-12
CitectHistorian gathers data that can be used by other business tools. Once this is
achieved it is possible to use that raw data to create information that is useful for
application in business. Excel is a powerful tool that will aid in the statistical
analysis of the data retrieved by CitectHistorian.
Version 4.2
December 2009
Exercise - Statistical Analysis (Optional)

1
Use the tools available in Excel to calculate Alarm Frequency. The

Excel tools will also display the information in a Summary format.
i.
Return to the file saved in Exercise - Excel Client (page 10-3)

called Digital Alarm Template.
ii.
This file has retrieved a list of Alarms over a two hour period and
displays the tag names in Alphabetical order.
iii.
Select Data Subtotals from the main menu. In the Add subtotal
to: box untick SumState and tick Tag. Click OK to continue.
iv.
A new column will appear on the left of the spreadsheet. This

column has counted and subtotalled each alarm. The pane on the
left of the worksheet shows the outline symbols. This enables the
spreadsheet to show and hide the different grouping levels quickly.
In this example there are three levels.
Manual Release 1
10-13
Exercise - Statistical Analysis (cont.)

Level One displays the Grand Count.
Level Two displays the Subtotals.
Level three displays all the raw data.
10-14
Version 4.2
December 2009

2
Once the subtotals have been created this information may be

used to create graphs using the Chart Wizard.
i.
Select Level Two and display the subtotals.
ii.
Highlight all the cells from the blank cell A1 to the last B cell above
the Grand Count.
iii.
Select the Chart Wizard

button from the main toolbar and select
an Exploded pie with a 3-D visual effect. Click Next to continue.
Manual Release 1
10-15
10-16
iv.
The Chart Source Data allows specific cells that contain the labels
and data to be visible in the chart. Click Next to continue.
v.
The Chart Options allow the standard options in the chart type to be
customised. Change the Chart Title to Digital Alarms.
Version 4.2
December 2009

vi.
Select the Data Labels tab and display Value.
vii.
The last step is to select the location for the chart. Select the option
to display the chart as an object in Sheet 2.
Manual Release 1
10-17

viii.
ix.
Click Finish.
Save the file as C:\Inetpub\wwwroot\Historian\Reports\Digital 2

Hours.xls for use in a later exercise.
10-18
Version 4.2
December 2009
Exercise - Perform Calculations (Optional)

1
Use the Excel Client to calculate Alarm Duration.

i.
Return to the file Digital Alarm Template.
ii.
Refresh the Alarm data by clicking the Refresh All CitectHistorian
Data
button on the CitectHistorian Toolbar.
iii.
Select the AckDateTime column.
iv.
Select Insert Columns from the Menu.
v.
Add the heading Duration to the new column.
vi.
Highlight cell D2 and type this formula
=C2-B2
then press the Enter key. The result should look something like this:
1900/01/00 00:00:10
vii.
Make sure cell D2 is still highlighted and select Format Cells

from the menu. This dialog will appear.
viii.
Edit the Type: to display hh.mm.ss only then click OK to continue.

The cell should now display the alarm duration.
Manual Release 1
10-19
Exercise - Perform Calculations (cont.)
ix.
Select the cell D2 and place the pointer over the Fill Button in the
bottom right hand corner of the cell. The pointer will change to the
Fill pointer.
x.
Drag the pointer to the end of the list of alarms.
xi.
Return to the Menu item Data Subtotals... This time select the
Max function and add the subtotal to Duration. Click OK to
continue.
Display this information as a graph using the Chart Wizard.

i.
10-20
Select Level Two and highlight from the Tag heading to the last
subtotal in the Duration column. Do not include the Grand Max.
Version 4.2
December 2009

ii.
Select the Chart Wizard
iii.
This time select a Bar Graph. Click Next to continue.
iv.
In the Source Data screen select the Series tab and remove the
OnDateTime and OffDateTime. Click Next to continue.
button from the toolbar.
Manual Release 1
10-21

v.
In the Chart Options select the Legend tab and untick the Show
Legend option.
vi.
Display as a new object in Sheet2.
vii.
Save
this
file
as
C:\Inetpub\wwwroot\Historian\Reports\MaxDurations.xls for use in

a later exercise.
10-22
Version 4.2
December 2009
Exercise - Analyse Trend Data (Optional)

1
Use the Excel Client to calculate and graph Trend Maximum,

Minimum and Average values over a two hour period.
i.
Open a new Excel Client spreadsheet and connect

CitectHistorian server as any previously defined user.
to
ii.
Select all the _CO2 trends. Click Next to continue.
iii.
Present the data in table view. Click Finish to continue.
iv.
This time the data will be displayed as values in the spreadsheet.
the
Use the analysis tools in Excel to calculate Maximum, Minimum

and Average trend values.
i.
Scroll to the end of the list and under the first column add three new
entries Maximum, Minimum and Average.
ii.
Select the cell to the right of the title Average.
iii.
Click the arrow next to the AutoSum

button. This will display a
list of the most common functions. Select Average from the list.
Manual Release 1
10-23
Exercise - Analyse Trend Data (cont.)
iv.
The default range will appear in the cell.

references are correct then press ENTER.
v.
The value will appear in the selected cell.
vi.
Follow the same procedure for Minimum and Maximum by using the
MIN and MAX functions.
Use the Fill function to calculate values for all the CO2 trends.
i.
10-24
Ensure that the cell
Highlight all three values then place the pointer over the fill button in
the bottom right hand corner of the selected cells. Drag the pointer
across to the right so that the cells under all the columns are
selected. The columns will be filled in sequence.
Version 4.2
December 2009
Exercise - Analyse Trend Data (cont.)

ii.
Copy and paste the Trend Headings into the row above the
calculations. Remove the Cluster Name prefix, AladdinsCaves,
from the headings.
iii.
Use the Chart Wizard to create a bar graph displaying the Maximum,
Minimum and Average values for all of the trends.
iv.
Save
the
file
as
C:\Inetpub\wwwroot\Historian\Reports\CO2TrendData.xls for use in

a later exercise.
Manual Release 1
10-25
Summary
Summary

View Data in the Excel Client (page 10-2)
Customise the Excel Client (page 10-7)
Statistical Analysis (page 10-12)
Questions

Where is the majority of the configuration for the Client applications
performed?
Why customise the Excel client?
Why use Excel to display the data?
10-26
Version 4.2
December 2009
Chapter 11:
Overview
Introduction
The CitectHistorian Web Client is the second of the client applications that are
installed with CitectHistorian. The CitectHistorian Web Client is a web portal to
the plant floor. It allows current data to be viewed at anytime and from anywhere
that an Internet connection can be established. This chapter will demonstrate the
standard features of CitectHistorian Web Client.

Set Up a Trusted Site ...........................................................11-2
Internet Information Services - (IIS) .................................11-10
Connect to the CitectHistorian Server ...............................11-11
The CitectHistorian Web Client Interface .........................11-13
Display Data ......................................................................11-15
Web Client Events .............................................................11-16
Snapshot Data ....................................................................11-22
Time Series ........................................................................11-25
Attributes ...........................................................................11-29
Set Up a Trusted Site

Internet Explorer
In general, it should be possible to run the CitectHistorian Web Client and log in as
a User without any problems. However, depending upon the security arrangements
made by each Network Administrator, it may be necessary to set up the
CitectHistorian Web Servers as Trusted Sites in Internet Explorer.
When the CitectHistorian Web Client is opened, the Home Page is displayed.
11-2
Version 4.2
December 2009
Set Up a Trusted Site (cont.)

How to Set Up
the Web Client
To open the Web Client Help files:

The Help Files will describe the procedures needed to set up a browser to view
Trusted Sites. Open the Web Client Home Page and click this link.
If it is necessary to set up a Trusted Site, click the link. This will open page in the
Help that describes how to set up a Web Server as a Trusted Site.
Manual Release 1
11-3
Exercise - Set Up a Trusted Site

1
Set up the CitectHistorian Web Server as a Trusted Site.

i.
Open Internet Explorer.
ii.
Select Tools Internet Options from the main menu then click the
Security tab.
Hints & Tips

If the menu bar is not visible in Internet Explorer, simply tap the <Alt> key.
iii.
11-4
Select Trusted Sites from the options then click the Sites button.
Version 4.2
December 2009
Exercise - Set Up a Trusted Site (cont.)
iv.
Type in the URL of the CitectHistorian Web Server in the Add this
Web site to the zone field, then untick the Require Server
Verification (https:) for all sites in this zone. Click the Add button.
v.
Click Close.
Configure IIS
i.
ii.
Open the IIS Administrative panel. Start Settings Control Panel

Administrative Tools Internet Information Services.
Expand the tree and right click the Historian web site.
Choose
Properties.
Manual Release 1
11-5

iii.
Within the Virtual Directories tab, set the Application Protection to
Low.
iv.
11-6
Select the Directory Security tab.
Version 4.2
December 2009

v.
Click
vi.
Ensure that the Anonymous Access option remains un-checked.
vii.
Click OK twice.
viii.
Close the IIS Administrative window and the Control Panel.
ix.
the Edit... button in

authentication control section.
the
Anonymous
access
and
Return to the Internet Options screen. With Trusted sites selected

in the upper part of the dialog box, click the Custom Level... button.
Manual Release 1
11-7
11-8
x.
Scroll down to find the ActiveX controls and plug-ins section. Set
the option Initialize and script ActiveX controls not marked as safe
to be Enable.
xi.
Click OK to close the Security Settings dialog box.
Version 4.2
December 2009

3
Configure the Local Intranet settings.

i.
Select the Local Intranet zone.
ii.
Select the Custom level... button.
iii.
Set the Custom Settings to Low.
iv.
Click OK to close the Custom Level dialog box and OK again to close
the Internet Options dialog.
Manual Release 1
11-9
Internet Information Services - (IIS)

Why Do We Use
Internet
Information
Services (IIS)?
Internet Information Services (IIS) is the Windows Web service that makes it easy
for information to be published on the Intranet. The purpose of Internet Information

Services is to take local directory structures and turn them into a URL so that a
remote client can locate the source using a web browser.
IIS is not installed by default but can be added using the Add/Remove Programs
dialog box from the Control Panel.
Many applications produced by Citect use IIS including CitectHistorian,
CitectHistorian Web Client and CitectHistorian Excel Client. Before installing any
of these applications IIS must be installed first.
11-10
Version 4.2
December 2009
Connect to the CitectHistorian Server

CitectHistorian
Web Client
Home Page
When the client connects to the CitectHistorian Web Server the Home Page is
displayed. By default the client will connect to the local CitectHistorian Web
Server. The Address Bar displays the location of the Active Server Page in a
URL format.
http://localhost/Historian/default.asp
A Web Client can connect to a remote Server by changing the location in the
address bar. Internet Information Services provides the references needed to
connect to the correct Server, Website and Page.
When the Server, Website and Page are typed into the Address Bar using the URL
format, the Web Client will connect to the Web Server page.
http://Training/Historian/default.asp
The CitectHistorian Web Client is a client application to the CitectHistorian Server.
Just like the Excel Client, the CitectHistorian Web Client security is set up in the
CitectHistorian Server. After the Home Page has opened, the User must log in to
the CitectHistorian Server.
Manual Release 1
11-11
Exercise - Log In to a CitectHistorian Web

Server
1
Open the CitectHistorian

CitectHistorian Web Server.
Web
Client
and
connect
to
the
i.

CitectHistorian Clients Web Client.
ii.
Click the Log In link on the Home Page toolbar.
iii.
Log in as one of the Users who has been set up in the CitectHistorian
Configuration Manager.
iv.
When the User has logged in the CitectHistorian Web Client toolbar
will display the current User and the Site.
v.
Click the Web Client Link. The Web Client will open and establish a
link to the Web Server. The Folder pane on the page will display the
name of the CitectHistorian Server and all of the data items that the
User has permission to view.
11-12
Version 4.2
December 2009
The CitectHistorian Web Client Interface

Three Areas
The Web Client interface consists of three areas:
Information Tree
The Information Tree displays the name of the CitectHistorian Server. When the
tree is expanded it will display the data that has been made available to the current
User as it has been configured in the CitectHistorian Server.
Manual Release 1
11-13
The CitectHistorian Web Client Interface (cont.)

Summary
Window
The Summary Window displays the items that have been selected for display. The
left pane displays the Data Items as they have been configured in the
CitectHistorian Server. The Right pane displays the configurable parameters for
each item.
Display Area
The Display Area is a visual representation of the data that the User has selected to
view.
11-14
Version 4.2
December 2009
Display Data
Display Current
Plant Floor Data
When the connection to the CitectHistorian Server has been established and a
configured User has logged in, it is then possible to display current plant floor data
in the CitectHistorian Web Client. To view data in the Web Client, simply select
the items from the Information Tree in the left pane, then double click or drag the
item into the Summary Window at the bottom of the page.
The Display Area on the right will use the default display format for whatever
information type is selected for display. When more than one format is selected, for
example Snapshot data and Historical data, the Display Area will split into
multiple sections to accommodate the various data displays.
These are the default display formats for each data type:
Data Type
Default Display Format
Single-value
Tabular
Multi-value
Tabular
Recordset
Tabular
Time-series
Line graph
CitectSCADA Alarm
Gantt chart
Once the data to be displayed is selected, clicking the Refresh Data button will
retrieve data from the Data Sources and display it in the Display Area.
Manual Release 1
11-15
Web Client Events

Gantt Charts
Events allow the display of alarms and other event type logs. Displays include
frequency of occurrences as well as duration of occurrences.
When Alarm items are selected from the Information tree and placed in the
Summary Window a Gantt chart is displayed by default.
Gantt Charts show the duration of each event, and the status of the event using
these colours:
11-16
Red
Event is active and unacknowledged
Green
Event is active and acknowledged
Yellow
Event is inactive but unacknowledged
Version 4.2
December 2009
Web Client Events (cont.)

Pareto Charts
Changing the Event display to a Pareto Chart will show the alarm frequencies.
This chart shows, for instance, that the alarm Main Door Opened has occurred
twelve times within the selected display period.
Manual Release 1
11-17
Exercise - Web Client Events

1
Use the Web Client interface to display alarm data using different
formats.
i.
Open the Web Client and log in as a User who has access to the
Digital Alarms.
ii.
iii.
Select all of the Digital Alarms by double clicking each in turn.

each alarm is selected it will appear in the Summary Window.
As
Select all of the alarms in the Summary Window and change the
Duration parameter to 1 hour.
11-18
iv.
Click the Refresh Data button.
v.
The Alarms will appear in a Gantt chart.
Version 4.2
December 2009
Exercise - Web Client Events (cont.)

vi.
Using the mouse pointer draw a box around some of the alarms.
Draw the box from top left to bottom right.
vii.
The display will zoom in on the area that has been selected.
viii.
Draw the rectangle in reverse, that is, from bottom right to top left,
and the chart will return to its original size.
Manual Release 1
11-19

2
11-20
Change the settings of the graph to display the Digital Alarms in a

Pareto Chart. A Pareto chart displays alarm frequency.
i.
On the toolbar of the display window click the Events dropdown list
and select Pareto.
ii.
The view will change to display the frequency of each alarm within
the specified time frame.
iii.
Click the Settings button on the Display Window toolbar.

open the Display Configuration dialog.
Version 4.2
This will
December 2009

iv.
Click the Advanced button to open the Editing dialog.
v.
Use the properties in the Editing dialog to make changes to the

display of the Pareto Chart.
Note:
The current version of the Web Client does not preserve any changes made to this
view. Upon closure and re-entry the system will return to the default settings.
Manual Release 1
11-21
Snapshot Data
Live Data from
SCADA
Snapshot data is the display of live data directly from the SCADA system. Data
may be updated either by pressing the Refresh Data button or by setting the
parameters of the snapshot to periodically update the data automatically. When the
data is updated, the Web Client executes a query for live data from the SCADA
system and displays the values as a cross-tab list.
Selecting the pull-down list beside the Snapshot button allows the user to select
the display format. The choices offered are:
Line Graph
Cross-tab
Data List
11-22
Version 4.2
December 2009
Exercise - Snapshot Data

1
Display current runtime data in the Web Client in the form of a

Snapshot in a Cross-Tab view.
i.
Log in to the Web Client as a User who has permission to view tag
data.
ii.
Select the Tank Level tags from the viewable data and add them to
the Summary Window.
iii.
Click the Refresh Data button. The Snapshot data will appear in the
Display Area as a Cross Tab table.
Change the view to display the snapshot data in the form of a Line
Graph.
i.
Click the dropdown list beside the Snapshot button and change the
display to a Line graph.
Manual Release 1
11-23
Exercise - Snapshot Data (cont.)

ii.
Go into Settings and change the configuration to Periodically update

snapshot data with an Update period of 5 seconds.
iii.
Click the Advanced button. Using the configuration tools provided,

make changes to the way data is displayed. For instance in the
graphic below, the sample period has been shortened considerably.
11-24
Version 4.2
December 2009
Time Series
Trend Data
Time Series data is a display of Trend Data taken directly from the SCADA
system's historical trend archive. When the Refresh Data button is pressed, the
Web Client executes a query for historical data from the SCADA system and
displays the values, by default, as a Line Chart.
Selecting the dropdown list beside the Time-series button allows the user to select
the display format. Choices offered are:
Line Graph
Histogram
Manual Release 1
11-25
Time Series (cont.)

X-Y Plot
The X-Y Plot is a 2-dimensional plot of data points:
Data List
The Data List is a spreadsheet-style presentation of data.
11-26
Version 4.2
December 2009
Exercise - Time Series

1
Display Trend data in the Web Client.

i.
Clear the items in the Summary Window that were used in the
previous exercise.
ii.
Copy the _CO2 Trends (making sure to use Historised, not live data)
from the Information Tree into the Summary Window and click
Refresh Data. The Trends will appear as a Line Graph showing the
historical data of those items for the last 2 hours.
iii.
Highlight the data items and change the Duration and EndDateTime
parameters.
iv.
Click the Settings button in the Display Area and edit the Line Chart
to display different features, for example, add a Title to the Chart
etc.
v.
Click the Time-series dropdown list and view each type of chart.
Use the Settings button to change the display of each type of chart.
Manual Release 1
11-27
Exercise - Time Series (cont.)

2
Display Historian data in the Web client.

i.
Clear the items from the Summary Window
ii.
Go to the Guides folder and open the Tags folder. The Historian tags
that you configured earlier in Exercise - Create a Published
Information Hierarchy (page 5-4) are located here.
iii.
Add all of the _Temp tags to the Summary Window and click
Refresh Data.
11-28
Version 4.2
December 2009
Attributes
Attribute
Properties
Publishing non-SCADA data is achieved by assigning Attributes to a Published

Information Folder. The Attribute then appears as an Item within the folder.
In this chapter, we will focus on the Attributes Time-series, Recordset and Web
Page.
Manual Release 1
11-29
Attributes (cont.)
Data Stored in
Rows
There are two ways of storing time-series data in a table: in rows or in columns.
The way the data is stored in the table must be known to configure the attribute.
When the data series is in rows, it means the table has at least three fields:
the Date/Time Field
the Data Series Field
the Tag Name Field
Each record contains a single data point sample, with the tag name field used to
identify the data series. The Tag Name: behaves as a WHERE clause.
When the data series is stored in Columns, a record could contain samples for
multiple data series with the samples having the same date/time stamp for each
record. In this case, only the date/time field and data series field need to be selected.
The difference between storing data series in rows versus columns is that when they
are stored in rows, data series can be added easily by adding more rows whereas
adding data series to a table using column storage means the definition of the table
must be changed. On the other hand, storing data series in columns is more
efficient, in terms of both disk space usage and query performance. Basically the
names of the trend data-series that are stored in any given table are known, the table
should be designed to store its data-series in columns, i.e. one column per dataseries.
11-30
Version 4.2
December 2009
Exercise - Database Recordset Attributes

CitectHistorian supports user defined recordset attributes that use data from a
database source. The recordset is defined by a query command text that is
supported by the Data Source, such as an SQL statement against a database.
1
Use the data in the Trend_Tabular table that was created in

Exercise - Upload Trends Task (page 8-15) to display data as a
Recordset.
i.
ii.
Right click on the Guides folder to create a new Attribute.
iii.
Call the attribute Cave Temps from Database and select Recordset
as the format.
iv.
button to the right of the Expression

Use the Expression Builder
field and define the expression as follows:
SELECT * FROM Trend_Tabular WHERE TrendName =

'AladdinsCaves.Central_Temp' AND TrendValue <> 'na'
Hints & Tips

There are also various query building tools available, such as MS Access, SQL
Query Analyser, and Visual InterDev from which an SQL statement may be copied.
v.
2
Assign Everyone permission to the attribute.

View the new Recordset item in the Web Client
i.
Launch the Web Client and after logging in, select the Guides folder
and the Cave Temps from Database item.
ii.
Refresh the view.
View the new Recordset item in the Excel Client.
Manual Release 1
11-31
Exercise - Web Page Attributes

It is possible to display a variety of documents in the Web Client client by defining
them as Web Page Attributes. Basically, any file type which the IE browser can
resolve may be displayed or run from the Web Client. For example: .pdf, .xls, .avi,
.bmp and .htm files. You simply define a URL to the document you wish to view.
1
Display documents in the Web Client.

i.
Create a new Published Information folder named Documents.
ii.
Add a new Attribute to this folder and select the Web Page format.
iii.
Name the attribute Digital Alarms 2 Hours.
iv.
In the Expression field enter the path to the Digital 2 Hours.xls file
(created in Exercise - Statistical Analysis (Optional) (page 1013)) as a URL e.g.
http://Training/Historian/Reports/Digital 2 Hours.xls
v.
Open the Permissions tab and assign permission to Everyone. Click

OK to continue.
vi.
Return to the CitectHistorian Web Client. Right click the server name
and select Refresh from the menu.
vii.
Double click the new attribute Digital Alarms 2 Hours then click
Refresh.
viii.
11-32
When this dialog appears select Open.
Version 4.2
December 2009
Exercise - Web Page Attributes (cont.)
ix.
Select Enable Macros if the prompt is displayed.
x.
The document will appear in the Web Client window.
xi.
Create Attributes to display the documents MaxDurations.xls and

CO2TrendData.xls created during the earlier optional exercises.
Create an Attribute to display an Adobe Acrobat file in the Web
Client.
i.
Create a new Web Page attribute in the Documents folder. Name

the attribute Report PDF.
ii.
There is already an example acrobat file called PDF_Report in the

Reports folder in the Web Client. Add this file location as a URL in
the Expression: field, i.e.
http://Training/Historian/Reports/PDF_Report.pdf
iii.
Assign Permissions and view the PDF file in the Web Client.
Note:
Adobe Acrobat Reader must be installed on the computer to be able to view this
document.
Manual Release 1
11-33
Summary
Summary

Set Up a Trusted Site (page 11-2)
Connect to the CitectHistorian Server (page 11-11)
The CitectHistorian Web Client Interface (page 11-13)
Display Data (page 11-15)
Web Client Events (page 11-16)
Snapshot Data (page 11-22)
Time Series (page 11-25)
Questions

What is the CitectHistorian Web Server?
Time Series data is?
Describe the process of allowing access to the Historian website for client PCs.
What is Snapshot data?
What is the difference between row-based and column-based attribute data?
What is the purpose of a user-defined recordset?
What types of document can be displayed in the Web Client?
11-34
Version 4.2
December 2009
End Day Two - Summary

Summary - Day 2
At the end of Day Two, you should:

Be able to Manage Projects:
-
Backup and Restore a CitectHistorian instance
Backup the Historian data
Configure an Active Project
Be able to Create Tasks:

-
Create Data transfer tasks
use ActiveX tasks
Be able to Create Events

-
Run the event service
Define and execute events
Be able to configure Excel Client

-
View Data
Customise the Client
Be able to configure Web Client

-
Configure access
Display data
Use client events
Manual Release 1
11-35

CitectHistorian V4.2 R1 Vol1

Uploaded by

Copyright:

Available Formats

CitectHistorian V4.2 R1 Vol1

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CitectHistorian V4.2 R1 Vol1

Uploaded by

Copyright:

Available Formats

What is the CitectHistorian Web Server?

What is the CitectHistorian Web Server?

What is Snapshot data?

What is Snapshot data?

Manual Release 1

Schneider Electric (Australia) Pty Ltd

December 2009 Edition for Version 4.2

INTRODUCTION TO CITECTHISTORIAN ................................................ 1-1

Overview .................................................................................................................... 1-1

DATA SOURCES ...................................................................................... 2-1

Overview .................................................................................................................... 2-1

CITECTHISTORIAN AT A GLANCE ......................................................... 3-1

Overview .................................................................................................................... 3-1

HISTORIAN ............................................................................................. 4-1

Overview .................................................................................................................... 4-1

PUBLISH INFORMATION ......................................................................... 5-1

Overview .................................................................................................................... 5-1

BACKFILL MANAGER ............................................................................ 6-1

Overview .................................................................................................................... 6-1

PROJECT MANAGEMENT ....................................................................... 7-1

Overview .................................................................................................................... 7-1

TASKS ..................................................................................................... 8-1

Overview .................................................................................................................... 8-1

Overview .................................................................................................................... 9-1

THE EXCEL CLIENT ............................................................................. 10-1

Overview .................................................................................................................. 10-1

CITECTHISTORIAN WEB CLIENT ........................................................ 11-1

Overview .................................................................................................................. 11-1

INTRODUCTION TO CITECTHISTORIAN .............................................. 12-1

Overview .................................................................................................................. 12-1

INTEGRITY CHECKER .......................................................................... 13-1

Overview .................................................................................................................. 13-1

HISTORIAN INTERPOLATION ............................................................... 14-1

Overview .................................................................................................................. 14-1

PROCESS ANALYST .............................................................................. 15-1

Overview .................................................................................................................. 15-1

HISTORIAN REPORTS DEPLOYMENT MANAGER ................................ 16-1

Overview .................................................................................................................. 16-1

SAMPLE REPORTS ................................................................................ 17-1

Overview .................................................................................................................. 17-1

ENERGY REPORTS ............................................................................... 18-1

Overview .................................................................................................................. 18-1

CASE STUDY ......................................................................................... 19-1

Overview .................................................................................................................. 19-1

COURSE SUMMARY .............................................................................. 20-1

Overview .................................................................................................................. 20-1

MODIFY EXISTING REPORTS ................................................................ A-1

Overview ................................................................................................................... A-1

CITECTHISTORIAN IN A DOMAIN ......................................................... B-1

Overview ................................................................................................................... B-1

SQL SERVER 2005 REPORTING SERVICES .......................................... C-1

Overview ................................................................................................................... C-1

SCHEDULE REPORTS............................................................................. D-1

Overview ................................................................................................................... D-1

CITECTHISTORIAN INSTALLATION ...................................................... E-1

CitectHistorian is a plant-wide reporting tool that allows traditionally disparate data

This Chapter Covers These Topics:

Before You Begin

Please write the name of your Instructor here

This training manual is a supplement to the authorised training. In order to make