Historian Getting Started

Historian Getting Started

Proficy

TM

Historian

G E T T I N G S T A R T E D

V e r s i o n 3 . 1

M a r . 2 0 0 6

All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical means, including photocopying and recording, without permission in writing from GE Fanuc Automation.

Disclaimer of Warranties and Liability

The information contained in this manual is believed to be accurate and reliable. However, GE Fanuc Automation assumes no responsibilities for any errors, omissions or inaccuracies whatsoever. Without limiting the foregoing, GE

Fanuc Automation disclaims any and all warranties, expressed or implied, including the warranty of merchantability and fitness for a particular purpose, with respect to the information contained in this manual and the equipment or software described herein. The entire risk as to the quality and performance of such information, equipment and software, is upon the buyer or user. GE Fanuc Automation shall not be liable for any damages, including special or consequential damages, arising out of the user of such information, equipment and software, even if GE Fanuc

Automation has been advised in advance of the possibility of such damages. The user of the information contained in the manual and the software described herein is subject to the GE Fanuc Automation standard license agreement, which must be executed by the buyer or user before the use of such information, equipment or software.

Notice

GE Fanuc Automation reserves the right to make improvements to the products described in this publication at any time and without notice.

2006 GE Fanuc Automation. All rights reserved. Microsoft is a registered trademark of Microsoft Corporation. Any other trademarks herein are used solely for purposes of identifying compatibility with the products of GE Fanuc

Automation.

CIMPLICITY is a registered trademark of GE Fanuc Automation.

Portions of this software are copyrighted by DataDirect Technologies, 1991-2006

We want to hear from you. If you have comments, questions, or suggestions about our documentation, send them to the following email address: [email protected]

Getting Started with Historian

Table Of Contents

Reference Documents

What's New in Historian 3.1

File Collector Alarm and Event Support

Export and Import Alarms from the Excel Add-In

Held Point Included in Queries

OPC Subqualities

StepValue Tag Property

CIMPLICITY Collector Redundancy

Disable Auto-Refresh of Alerts

OLEDB Conversion functions

Overview of Historian

System Components

Historian Alarms and Events

Historian Data Collectors

Historian File Collector

Historian Server

Historian Administrator

Excel Add-In

Historian SDK

Historian Migration Tools

Understanding the System Architecture iFIX Implementation Guidelines

Historian Alarm and Event Archiving

Historian Web Administrators vs. Non-Web Administrators

9

9

10

10

7

8

8

8

11

12

12

4

5

7

7

3

3

3

4

1

1

3

3

3

3

iii

Proficy Historian Getting Started

Setting up the Historian Environment

Task Overview

Hardware Requirements

Software Requirements

Compatibility

Supported Regional Settings

Time and Date Formatting

Supported Data Types

The Hardware Key

Installing the Hardware Key

Disabling Guest Accounts

Optimizing Virtual Memory

Using a Remote SQL Server

Installing Internet Information Server (IIS)

Installing Internet Information Services

Installing Historian Software

Installing the Historian Server

Log Files Created After You Start Historian for the First Time

Installing the Historian Web Administrator

Connecting to the Historian Web Administrator

Installing Historian Non-Web Administrators

Starting the Historian Non-Web Administrator

Installing Historian Data Collectors

Steps to Install Data Collectors on the Same Computer as the Server

Steps to Install Data Collectors on a Different Computer

Installing the Historian Excel Add-In

Installing Historian SDK

iv

31

31

32

32

29

29

30

30

25

27

27

28

28

21

22

22

23

23

24

25

14

14

15

18

18

19

20

Table Of Contents

Uninstalling Historian and Historian System Components

Uninstalling Historian

Upgrading from a Previous Release

Uninstalling the old Historian Product

Installing the new Historian Product

Upgrading the Historian SDK

Interoperability of Historian Versions

Implementing Historian Security

Protecting Your Process

Creating and Implementing a Security Strategy

Historian Security Groups

Historian Group Rights

Security Setup Example

Setting up Historian Security Groups

Setting Local Groups in Windows NT

Setting Local Groups in Windows 2000 or Windows XP Pro

Avoiding Unauthorized Access When Using Historian Security

Working with Domain Security

Creating Security Groups in Windows NT Domain Controller

Creating Security Groups in Windows 2000 Domain Controller

Using a Windows 2000 Domain Controller with a Windows NT Historian

Server

Establishing Your Security Rights

54

55

Identifying the Security Checking Process

Implementing Tag Level Security

Retrieving Data from Historian

Sampling Modes

56

57

59

59

39

45

47

36

36

37

38

33

33

33

34

34

34

35

48

48

51

52

52

53

v

Proficy Historian Getting Started

Calculation Modes

Filtered Data Queries

Overview of Filtered Data Query Parameters

Example: Filtered Queries in the Excel Add-In

Using Historian with iFIX

Creating Historian Charts using Mixed Pens

Using Historian with iFIX

Using iFIX drivers with Historian

Collecting iFIX Alarm and Event Data

Viewing Historian Values and Time Stamps in an iFIX Chart

Importing the Historian Toolbar into iFIX

Using the Toolbar Buttons

Formatting OPC Tags Containing Special Characters

Filtering Tags Using THISNODE with Expression Builder

The iFIX Data Collector

Historian and iFIX Chart Objects

Browsing iFIX Tags On Networked iFIX/FIX32 Nodes

Using the iFIX Expression Editor to search tags

Searching for Calculation or Server-to-Server tags in the iFIX Expression

Editor 79

Using the iFIX Integration Toolkit

Uninstalling Historian if iFIX v2.6 is installed

Using v7.x Drivers with Historian

79

80

80

Using Autocreate

Using the Latched Data feature

Running iFIX 7.x Drivers as OPC Servers

Running iFIX 7.x Drivers as a service with Automatic Startup

80

81

81

81

74

74

75

75

76

76

77

77

78

78

79

63

65

66

68

72

72

72

vi

Table Of Contents

Troubleshooting iFIX and Historian 85

Running iFIX as a service with Workspace listed in the SCU Task List 85 iFIX Workspace delay when remote session is lost

Starting iFIX when a remote Historian session is unavailable

Accessing Mission Control when a remote Historian session is lost

Using the iFIX V2.6 chart with Historian domain security enabled

86

86

86

86

Accessing tags in the iFIX chart after setting OPC Collector to "Made After

Restart" 86

Collecting data in an iFIX chart with Time Assigned By Source

Synchronizing the time on iFIX SCADA Servers and View Clients

Startup Procedure Overview

87

87

88

Index 91

vii

Getting Started with Historian

Before you begin installing Historian, please take some time to review the Getting Started with

Historian manual.

This manual includes information about the following:

An Overview of Historian

Setting up the Historian Environment

Installing Historian

Implementing Historian Security

Retrieving Data from Historian

Using Historian with iFIX

This manual provides descriptive material and specific operating procedures for performing all common tasks.

Reference Documents

For related information about Historian, refer to the following documents:

Using the Historian Administrator

Historian Data Collectors

Using the Historian Excel Add-In

1

Proficy Historian Getting Started

Historian Alarms and Events

Migrating Advanced and Classic Historian Data

Using the Historian OLE DB Provider

Historian Software Development Kit (SDK) Online Help System

2

Getting Started with Historian

What's New in Historian 3.1

File Collector Alarm and Event Support

The File Collector now supports importing alarm and event data. See the File Collector documentation for more information.

Export and Import Alarms from the Excel Add-In

The Excel Add-In now supports importing and exporting alarm and event data. See the

Historian Alarms and Events documentation for more information.

Held Point Included in Queries

When using archive or collector compression, Historian will now report the most recent held point when querying for data.

OPC Subqualities

Historian 3.1 stores sub-qualities for Good, Bad, and Uncertain data qualities in order to comply with the OPC 2.0 specification.

StepValue Tag Property

The StepValue property has been added as a retrieval option on the tag level. This property indicates that values collected on the tag change sharply (such as a digital signal changing from

0 to 1) and should not be interpolated when retrieved from the archive.

CIMPLICITY Collector Redundancy

Collector redundancy support in Historian 3.1 has been extended to include the CIMPLICITY collector.

3

Proficy Historian Getting Started

Disable Auto-Refresh of Alerts

The Historian NonWeb Administrator now has the ability to disable auto-refresh of alert messages on the main screen.

OLEDB Conversion functions

Conversion functions have been added to the OLEDB query syntax to convert results from the variant data type. See the OLEDB manual for more information.

4

Overview of Historian

Proficy Historian is a high performance data archiving system designed to efficiently collect, store, and retrieve time-based information at extremely high speed efficiently. The system architecture consists of the following:

Historian Server – The Historian server is the central point for managing all of the client and collector interfaces, storing and (optionally) compressing data and retrieving data. All tag data (numbers, strings, BLOBs) are stored in a proprietary format in the archive database.

The Archive Database consists of several files, each of which represents a specific time period of historical data.

If licensed for the “Alarm and Event” option then the server also manages the storage and retrieval of OPC alarms and events in either a SQL Server or MSDE database.

Collectors – The Historian includes several types of data collectors for collecting data from a wide variety of applications including: iFIX v2.6+, FIX v6.5+, CIMPLICITY HMI v5.5+,

CIMPLICITY Machine Edition, OPC 1.0 or 2.0, OPC Alarms & Events, Files (csv or xml), and OSI PI.

The Calculation collector is designed to perform math and analysis on Historian data and store the results on the server. The Server-to-Server collector boasts the same calculation capabilities as the Calculation collector, but it stores the results on a remote server.

Most collectors are capable of performing first-order “dead band” compression as well as a

“browse & add” configuration and store & forward buffering.

Clients – All client applications retrieve archived data through the Historian API. The

Historian API is a client/server programming interface that maintains connectivity to the

Historian Server and provides functions for data storage and retrieval in a distributed network environment.

5

Proficy Historian Getting Started

Typical Historian System

The Historian Archive indexes all information by Tagname, a unique identifier for a specific measurement attribute. For iFIX users, an Historian Tagname normally represents a

Node.Tag.Field (NTF). Searching by Tagname and Time Range is a common and convenient way to retrieve data from Historian. If you use this technique to retrieve data from the

Archiver, you do not need to know which archive file on the Historian Server contains the data.

You can also retrieve data using a filter tag.

Historian is capable of storing many different data types, such as Floating Point, Integer,

String, and BLOB (undetermined binary data type), such as an Excel spreadsheet, a PDF file,

6

Implementing Historian Security

or a Word file. The source of the data defines the ability of Historian to collect specific data types.

System Components

A Typical Historian System contains several components:

One or more Historian Data Collectors with various collection interfaces

One or more Historian Servers

One or more Historian Web Administrators

One or more Historian Non-Web Administrators

Historian OLE DB provider

One or more Excel Add-In packages, installed on any client node

Programs using Software Development Kit (SDK)

All clients communicate with the Server through the Historian API. The subsections that follow list the functions performed by each component.

Historian Alarms and Events

Historian Alarms and Events provides tools to collect, archive, and retrieve alarm and event data in Historian.

Refer to the Historian Alarms and Events manual for more information

Historian Data Collectors

Data Collectors are the interface between a data source and the data archiver. They:

7

Proficy Historian Getting Started

Collect data using a specific acquisition interface, such as iFIX EDA, OPC

Alarms and Events, CIMPLICITY HMI Point Management API, Machine

Edition View, OSI PI, or OPC 1.0 or 2.0.

Perform first level data compression (deadband/update by exception).

Buffer data (store and forward) whenever a server connection is lost.

Refer to the Historian Data Collectors manual for more information.

Historian File Collector

File Collectors import .CSV or .XML files into Historian. The files can contain data, tagnames or other configuration information, and messages that you can import with a File Collector.

Refer to the Historian Data Collectors manual for more information.

Historian Server

An Historian Server performs the following tasks:

Manages all system configuration information.

Manages system security, audit trails, and messaging.

Services write and read requests from distributed clients.

Performs final data compression.

Manages archive files.

Historian Administrator

An Historian Administrator provides a graphical user interface for performing Historian maintenance functions including:

8

Implementing Historian Security

Tag configuration.

Maintaining and backing up archive files.

Data collector configuration.

Security configuration.

Controlling data collectors.

Searching and analyzing system alerts and messages.

Refer to the Using the Historian Administrator manual for more information.

Excel Add-In

The Historian Excel Add-In is a very useful tool for presenting and analyzing data stored in archive files. Using this tool, you can design custom reports of selected data, automatically process the information, and analyze the results. You can also use it for performing tag maintenance functions in Historian, such as adding tags, importing or exporting tags, or editing tag parameters.

Refer to the Using the Historian Excel Add-In manual for more information.

Historian SDK

The Software Development Kit (SDK) is designed for writing Visual Basic (VB) or Visual

Basic for Applications (VBA) Scripts. Using the SDK, you can develop your own scripts to perform selected repetitive or complex tasks or to make your own custom user interface. To use the SDK, create a VB/VBA project with the SDK as a project reference.

Refer to the SDK Help system for more information.

9

Proficy Historian Getting Started

Historian Migration Tools

Historian provides migration tools to allow you to migrate your existing Classic and Advanced

Historian configurations and data and your iFIX Alarm and Event data into the Historian environment. Previous Historian configurations established tags, collection groups, collection rates, and deadbands for tags collected into each Historian. These tags and collection rates are transferred into Historian by the migration tools.

Refer to the Migrating Advanced and Classic Historian Data manual for more information.

Understanding the System Architecture

You have wide flexibility in configuring your Historian application. Since Historian can support a fully distributed architecture, you can spread the data collection, server, administration, and client data retrieval functions across many different nodes in a network, or you can install all components on a single computer.

Since the Historian API is the basic building block for connectivity, all Historian functions, including data collection, administration, and data retrieval, use the Historian API.

You can connect the Historian API to a local Historian Server in the same manner as to a remote Historian Server by simply providing the name of the server. This name must be the

Computer Name or IP Address of the target Historian Server, and the server must have TCP/IP connectivity. If you use the Computer Name of the server rather than the IP Address, the IP

Address must be available to the client through DNS, a WINS server, or through the local host table.

It is recommended that you install the Historian Server on a central dedicated server, as shown in the Typical Historian System figure. Next, install data collectors on each data source, and point them back to the central Historian Server by specifying the appropriate server Computer

Name. Install a separate data collector for each type of collection interface used in your system.

Observe the following constraints when you install collectors:

iFIX Collector, File Collector, Simulation Collector, Calculation Collector, or Server-

to-Server Collector – install only one collector of each type per computer.

10

Implementing Historian Security

OPC Collectors – install only on a computer where the OPC Server is running locally. You can install multiple collectors on a single computer, however, by installing a collector for each OPC Server.

Mixed Collectors – you can install various types of collectors on a single computer, subject to the preceding constraints.

iFIX Implementation Guidelines

With an iFIX implementation, install data collectors on each SCADA Server that contains the

Node.Tag.Fields (NTFs) you want to collect. You can minimize system load in this way because you are not relying on FIX networking to pull remote data into the node where the collector is running.

In a distributed environment, remote data collectors automatically buffer collected data in the event of loss of a network connection between the collector and the Historian Server. When the network connection is re-established, the data collectors automatically re-establish data flow and forward all buffered data to the server.

The store and forward feature does not apply when you use iFIX networking for data collection. Since iFIX network connections are located ahead of the data collector in the data flow path, the store and forward feature does not protect against loss of data when an iFIX network connection is interrupted, as illustrated in the following figure.

Ineffective Use of Store and Forward in an iFIX Network

11

Proficy Historian Getting Started

Effective Use of Store and Forward in an iFIX Network

Historian Alarm and Event Archiving

Historian's Alarm and Event (A&E) archiving offers the ability to collect A&E data from any

OPC-compliant A&E server and store it in an integrated relational database (MSDE), or to an existing Microsoft SQL server. Historian Alarm and Event data is associated with the related process data from its source to allow for quick analysis.

For more information, refer to Historian Alarms and Events.

Historian Web Administrators vs. Non-Web Administrators

Historian Web Administrators can run on any client(s) on the Internet (or intranet). They connect to the Historian system through the Administration web site, which you can install with the Historian Server. To support administration through an Historian Web Administrator, you must first install and run the Microsoft Internet Information Server (IIS). Once IIS is installed, any remote client with Internet Explorer 5.5 or greater can use the Administration web site. If you installed client tools on your IIS computer, you can use the Administration web site from the server.

NOTE: Installation of IIS on Windows 2000 or above is recommended. For Historian

Servers installed on Windows NT systems, the use of Historian Non-Web Administrators is recommended.

12

Implementing Historian Security

You can install the Historian Non-Web Administrator on any computer(s) connected to the

Historian Server through the API. With Historian Non-Web Administrators, you do not need to install IIS.

13

Proficy Historian Getting Started

Setting up the Historian Environment

Before you start setting up your Historian environment, identify the computers that will function as your clients, data collectors, administration workstations, and archiver. The following sections outline the setup procedures in detail.

Task Overview

When you are ready to set up your Historian environment, use the following procedure:

1. Set up each computer.

Use the section Hardware Requirements as a guide, and refer to the user manual that accompanies each computer for detailed setup information.

2. Install Windows NT, 2000, XP Pro, or 2003 Server on each computer as needed.

Use a login account with administrator rights so that you can install Historian later.

Use the section Software Requirements as a guide, and refer to the user manual that accompanies each software product for more detailed setup information.

3. Set up the network adapters and network software required for each computer.

4. Install the Hardware Key on your Historian Server node only.

Refer to the section Installing the Hardware Key for instructions on attaching the key to your computer.

5. Disable the Guest account in Windows security if you want to limit authentication to known Windows users only.

14

Implementing Historian Security

Hardware Requirements

For Historian Servers, the minimum hardware requirements are:

A Pentium 4-based 2.0 GHz or better computer with 1 GB RAM.

A CD-ROM drive.

100 MBit TCP/IP-compatible network interface adapter for network communication and certain I/O drivers.

A screen resolution of at least 1024 X 768.

80 GB free hard drive space, for the data archives, message files, buffer files, and log files used by the system.

For Data Collector nodes, the recommended minimum hardware requirements are:

A Pentium 4-based 2.0 GHz or better computer with 512 MB RAM.

40 GB of free hard drive space to store buffered data.

A CD-ROM drive.

TCP/IP-compatible network interface adapter for network communication and certain I/O drivers.

For the Microsoft Cluster service, the minimum hardware requirements are:

A Pentium 4-based 2.0Ghz or better computer with 1GB of RAM

80 GB of local free hard drive space

40 GB shared SCSI hard drive (RAID preferred)

15

5000

10,000

20,000

50,000

100,000

150,000

200,000

Proficy Historian Getting Started

Two 100Mbit TCP/IP-compatible network interface adapters for network communication and certain I/O drivers (one for public network, another for private network).

NOTE: The configuration of each server added to the cluster must be identical to the other servers in the cluster.

You determine the size of an Historian Server as a function of the number of tags from which data is collected, the rate of alarm and event collection, and how often you intend to collect the data and how much data you want to keep online. The number of tags is an indicator of the number of concurrent users likely to access the system. The primary factor is server memory requirements; CPU load is a secondary factor. If the number of concurrent users is significantly different from the suggested guidelines, adjust server memory size accordingly.

Use the following parameters to determine the size of the Historian Server.

Tags Users CPU

200

200

200

10

30

50

100 1000

1000

2000

2000

RAM

(MB)

1000

1000

1000

Recommended

Archive Size

100MB

500MB

500MB

500MB

500MB

1GB

1GB

Single

Single

Dual

Dual

Quad

Quad

Quad

16

Implementing Historian Security

Tags Users RAM

(MB)

3000

Recommended

Archive Size

1GB

CPU

250,000 200 Quad

For iFIX systems, count each Node.Tag.Field (NTF) as a separate tag when you determine the size of the system. For example, FIX.FIC101.F_CV and FIX.FIC101.B_CUALM (current alarm) both count as tags, even though they are derived from the same iFIX tag.

Use the following parameters to determine the size of the Historian Alarm and Event archiver.

Alarm & Event Rate

1 / minute

RAM

1GB

CPU

Single

1 / second

10 / second

2GB

2GB

Single

Single

100 / second 4GB Double

You must have disk storage capacity in the multi-GB range for the many data archive files

(typically 500 MB each) and alarms you will generate, especially if you want to keep old data online.

NOTE: As more applications run simultaneously on a server, performance decreases.

Whenever possible, run additional applications on separate computers.

17

Proficy Historian Getting Started

Software Requirements

The minimum Historian software requirements are:

Windows NT v4.0 with Service Pack 6 or later installed, Windows 2000

Professional with Service Pack 2 or later, Windows XP Pro, or Windows Server

2003.

Internet Explorer v6.0 or greater

For systems with Historian Web Administrators, Microsoft IIS (Internet

Information Server). IIS is not required for Historian Non-Web Administrators.

Windows 2000 or higher is required for the Alarm and Event archiver.

Network interface software for network communication. The TCP/IP network protocol is required.

SQL Server 2000 SP2 or greater required for "Use Existing SQL Server" option in alarm and event archiving configuration.

The Historian Excel Add-In requires installation of Office 2000, Office XP, or

Office 2003.

The Historian Web Administrator requires the Java Runtime Environment version

1.4.2_02 or later.

Compatibility

Several GE Fanuc products work with Proficy Historian. The following is a general set of required versions to work with Historian 3.1.

18

Implementing Historian Security

Product

Proficy Portal

CIMPLICITY

Machine Edition

View iFIX

ROC Driver

Required Version

2.1 with current service packs.

To work with CIMPLICITY Alarm and Event Data, the

CIMPLICITY A&E Server must be of version 6.1 SP4, 6.1 with current service pack and Hotfixes, or later. On

Windows 2000 SP3 and Windows 2003 SP1, 6.1 SP5 or later is required.

To work with Machine Edition data, the Machine Edition software must be version 5.0 with current service packs or later.

To work iFIX alarm and event data, you must have iFIX version 3.1 with current service packs or 3.5 with current services packs and the iFIX OPC AE Server for your version. The iFIX OPC AE Server for your version is available through GlobalCare.

NOTE: You will need a valid GlobalCare account to download the iFIX OPC AE Server.

Version 6.31 is required for use with Historian.

Supported Regional Settings

Historian supports the following regional settings available in the Windows Control Panel:

Decimal symbol - one character

19

Proficy Historian Getting Started

Digit grouping symbol

List separator - one character

Time style

Time separator

Short date style

Date separator

Time and Date Formatting

Avoid changing the time style or short date style in regional settings to values that are outside of the standard styles provided. Changing these values to non-standard styles may result in improperly formatted times and dates.

Historian supports the following short date formats, some of which may not be available in certain language versions of Windows:

• dd/mm/yy

• dd/yy/mm mm/dd/yy mm/yy/dd yy/dd/mm yy/mm/dd

20

Implementing Historian Security

Supported Data Types

The following table lists the supported Historian data types and their sizes:

Size

Double

Integer

Fixed

String

Variable

String

Binary

Object

Data

Type

Single

Float

Double

Float

Single

Integer

4 bytes

8 bytes

2 bytes

4 bytes

Configured by user.

No fixed size.

No fixed size.

Historian does not support the use of the Binary Object data type with the Data Collectors. Refer to the SDK online Help for more information on working with BLOB data types.

21

Proficy Historian Getting Started

Data

Type

Scaled

Size

2 bytes

The Hardware Key

You are required to use a hardware key to run Historian Server. The hardware key:

Enables software options available to your installation, as requested by you.

Can be electronically reprogrammed using an upgrade utility, as requested by you. Consequently, you are no longer required to exchange hardware keys for version updates or option changes.

Protects against illegal duplication of Historian software.

Additionally, two hardware keys are offered: one that supports parallel port configurations, and one that supports USB port configurations.

Historian runs in demo mode (one user, 100 tags) if the key is not installed.

NOTE: File the packing slip that came with the hardware key in a safe place. The codes on this slip are necessary to quickly duplicate the key in case it is damaged or misplaced.

Installing the Hardware Key

To install the hardware key:

1. Power off the computer and all peripheral devices prior to installing the hardware key; it is sensitive to static electricity.

2. Remove any connections to your computer's parallel port.

22

Implementing Historian Security

3. Secure the hardware key in the parallel port and tighten the screws.

IMPORTANT: Do not remove the hardware key from your node while Historian

Server is running. If you do remove the key while running, the server will shut down when the next key check is performed, which occurs every two hours. When no key is attached, Historian defaults to demo mode. When you exceed the demo mode defaults of one user connection and 100 tags, the Historian Data Archiver stops; this is intended licensing behavior.

4. If you had any equipment connected to your parallel port, connect it to the back of the hardware key. If you are using a USB port for the hardware key, you cannot plug any other equipment into the port. Use another port for any additional equipment connections you may need.

The number of tags and clients that you are licensed to use appears in the System Statistics screen of the Historian Administrator. If the Licensed Tags field displays 100 tags and the

Licensed Users field displays 1 client, ensure that you have correctly installed your hardware key.

Disabling Guest Accounts

Whether or not you use Historian security, make sure that you disable Guest accounts on your computer. It is recommended that you disable Guest accounts so that Historian operates in the most secure environment, limiting the users to known Windows users.

Optimizing Virtual Memory

Through the use of paging files, Windows allocates space on your hard drive for use as if it were actually memory. This space is known as virtual memory. Be sure to optimize the virtual memory on the Historian archiver computer. The following list describes how to optimize virtual memory in Windows to achieve maximum performance from Historian.

To optimize the virtual memory paging file for Historian in Windows:

1. Double-click the System icon in the Windows Control Panel.

23

Proficy Historian Getting Started

2. Click on the Performance tab in the Windows NT System Properties dialog box.

In the Windows 2000 or Windows XP Pro System Properties dialog box, click on the Advanced tab, then click on the Performance Options button.

3. Click the Change button in the Virtual Memory group box.

4. Enter a value equal to three times your physical memory in the Initial Size field.

5. Enter the same number (from step 4) in the Maximum Size field.

6. Click the Set button.

7. Click OK to save the changes and exit the dialog box.

NOTE: If the paging file is set to grow dynamically, your system may experience severe performance problems during run time. To ensure optimal performance, be sure that the

Initial Size and Maximum Size of the paging file are the same so that the paging file does not grow dynamically. For more information on creation and sizing of Windows paging files, refer to the Microsoft Windows Help.

Using a Remote SQL Server

If you have chosen to connect Historian to a remote SQL Server, you must ensure the following conditions are met:

The Historian Alarm Archiver service must be run on a user account that has privileges to log into the SQL Server using Windows Authentication

The Default Backup Path, found on the Archive screen, must be a shared directory that is accessible to both the Historian Data Archiver and the remote

SQL Server. It is recommended that this shared directory be placed on the same computer as the Historian Data Archiver service.

24

Implementing Historian Security

Installing Internet Information Server

(IIS)

For an Historian Web Administrator client to communicate with the Server, you must install

Microsoft Internet Information Server (IIS) on the Server. This section describes procedures for installing IIS on Windows 2000.

IMPORTANT: You must install IIS before installing Historian.

Installing Internet Information Services

To install IIS on Windows 2000 Professional, 2000 Server, or XP:

1. Open the Control Panel.

2. Click Add/Remove Programs.

3. Click Add/Remove Windows Components.

4. Select Internet Information Services (IIS).

5. Click the Details button. The Details dialog box appears.

6. Select the Internet Information Services Snap-In and World Wide Web Server options.

7. Click OK.

8. Click Next to proceed to the Configuring Components phase.

25

Proficy Historian Getting Started

9. When prompted, insert the Windows 2000 CD or browse to a directory that contains the WIN 2000 setup files.

10. Click Finish to complete the installation.

If you need additional assistance in installing IIS, refer to www.microsoft.com.

To install IIS on Windows 2003 Professional or 2003 Server:

1. Open the Control Panel.

2. Click Add/Remove Programs.

3. Click Add/Remove Windows Components.

4. In the Components list box, click Application Server, then click Details.

5. In the Subcomponents of Application Server list, click Internet Information

Services.

6. Click OK.

If you need additional assistance in installing IIS, refer to www.microsoft.com.

26

Implementing Historian Security

Installing Historian Software

Historian provides a single install program on a CD with options that install each system component. Before running the installation program, define the desired system architecture and determine which components you want to install on each node.

NOTE: To install a data collector, you must first install the source software. If you have added new source software since installing Historian, you must re-run the Historian install. Keep currently installed components checked when reinstalling Historian. Some components may be restarted when installing new data collectors.

If you are installing all system components on a single computer, run the install program on that computer only. If you plan to use multiple computers as server, data collector, administrator, and other clients, run the install program on each computer to install the specific components needed for that computer.

If you are installing system components on a machine with any previous Historian components installed, the Install program automatically detects the already installed components and displays those items as checked in the components screen. Select the new components in addition to the already installed components, and continue through the upgrade.

Installing the Historian Server

If you plan to use Historian Web Administrators with your system, you must first install

Microsoft IIS. Refer to Installing Internet Information Services on WIN2000 PRO and

WIN2000 SRV for the recommended installation procedure. If you do not plan to use Historian

Web Administrators, you do not need to install IIS.

To install the Historian Server:

1. At the computer you select as the server, insert the Historian CD and run the

Historian Install program. The Historian Install Wizard appears.

27

Proficy Historian Getting Started

2. Select Historian Server and click Next.

NOTE: If you intend to run all components on a single computer, select all components and click Next.

Log Files Created After You Start Historian for the First Time

When you start collection, the Historian Server creates an archive. It places archive files in the

Archives folder specified during installation. By default, this is c:\Program Files\GE

Fanuc\Proficy Historian\Archives. All files with the .IHA extension are Archive data files.

The file with the .IHC extension contains configuration information.

The archiver and collectors place log files in the Logfiles folder. By default, this is c:\Program

Files\GE Fanuc\Proficy Historian\Logfiles. The Archiver produces two log files, a

DATAARCHIVER-XX.LOG file and a DATAARCHIVER.SHW file. Each collector also produces two log files. For example, the Simulation Collector produces these files:

SimulationCollector-01.log and SimulationCollector.shw.

You can view log files using Notepad or any other text editor. The .LOG file shows events, warnings, and errors produced by the Archiver during operation; the .SHW file shows current configuration information that applies to the Historian Server.

Installing the Historian Web Administrator

Installing the Historian Web Administrator allows users from any computer with Microsoft

Internet Explorer v5.5 or higher installed to access the Web Administrator.

To install the Historian Web Administrator:

1. At the Windows 2000 (Professional or Server), XP Pro, or 2003 Server computer you select as the server, insert the Historian CD and run the Historian Install program. The Historian Install Wizard appears.

2. Select the Administrative Web Site (requires IIS 4.0 or greater) option in addition to any previously installed components. The Historian Server and Historian

Client options are automatically selected.

28

Implementing Historian Security

NOTES:

You must have IIS installed before attempting to install the Historian Web

Administrator. Refer to the Installing Internet Information Server (IIS) section for more information. If you are using Windows NT, it is recommended that you install the Historian Non-Web Administrators. Refer to Installing Historian Non-

Web Administrators for more information.

If you are re-running the Historian install, do not unselect previously installed components, as they will be removed from the Historian installation.

3. Proceed through the installation screens.

Connecting to the Historian Web Administrator

To connect to the Historian Web Administrator, follow these steps:

1. Open your browser and for the URL, type in http://SERVERNAME/Historian, where SERVERNAME is the computer name running IIS.

2. When the login dialog appears, enter a valid username, password, and domain, if any, for the Historian Server, and click OK. The Historian Administrator Main screen appears.

Installing Historian Non-Web Administrators

You can install an Historian Non-Web Administrator on any node that connects to the Server through an Historian API.

To install an Historian Non-Web Administrator:

1. Insert the Historian CD and run the Historian Install program.

2. When the Install Wizard appears, select the Historian Administrator option in addition to any previously installed Historian components and then click Next.

29

Proficy Historian Getting Started

The program installs the Historian Non-Web Administrator and any other components associated with it, including the API. If you prefer, you can install the Historian Administrator at the same time you install other options, by selecting all desired options at once.

Starting the Historian Non-Web Administrator

To start the Historian Non-Web Administrator:

1. From the Start button in the bottom toolbar, select Program Files and then

Proficy Historian 3.1.

2. Select Historian Administrator to open the application.

As an alternative, you can create a shortcut and start Historian from a desktop icon.

3. Optionally, click on the Main link. The login dialog box appears.

4. Optionally, select the server from the drop-down menu, enter your username,

password, and domain, if any, and then click OK.

The Historian System Statistics screen appears. You can now proceed with all

Historian Administrator functions.

NOTE: If you leave the UserName, Password, and Domain fields blank and click

OK, then the login information of the currently logged in Windows user is used.

Installing Historian Data Collectors

All collectors, except the iFIX, FIX32, CIMPLICITY HMI, and Machine Edition* View collectors, can run as Windows services. If so configured, they will also continue to run after you log out, and can be configured to start when you start your computer. The iFIX or FIX32

Collector, on the other hand, starts when iFIX or FIX starts, and runs after logout if iFIX or

30

Implementing Historian Security

FIX is so configured. The CIMPLICITY HMI Data Collector and Machine Edition View collectors start when their associated CIMPLICITY HMI projects are started.

The CIMPLICITY HMI Data Collector must be installed on the same workstation that your

CIMPLICITY HMI Project runs on.

You only can install one Server-to-Server Collector and one Calculation Collector per computer.

NOTE: Historian data collectors must be installed after the source software has been installed. For example, the iFIX SCADA software must be installed before the iFIX collector. Wherever possible, data collectors should be installed on the same machine as the data source, to take maximum advantage of collector buffering.

Steps to Install Data Collectors on the Same Computer as the

Server

To install Historian Data Collector software on the same computer as the

Server:

1. Insert the Historian CD and run the Historian Install program.

2. Select the appropriate type of Data Collector in addition to any previously installed Historian components and click Next.

Steps to Install Data Collectors on a Different Computer

To install Data Collector software on a different computer:

1. Run the Historian install program on that computer.

2. Select the appropriate type of Data Collector in addition to any previously installed Historian components and click Next.

3. When prompted, enter the correct Historian Server Computer Name (or IP

Address) to ensure connectivity at startup.

31

Proficy Historian Getting Started

NOTE: The collector will not appear in the Historian Administrator until after the collector has been started.

Installing the Historian Excel Add-In

You can install the Excel Add-In on any client or server on which the API has been installed.

To install the Excel Add-In:

1. Verify that Microsoft Excel is installed on your computer.

2. Run the Historian install program on that computer.

3. When the Install Wizard appears, select the Historian Excel Add-In option in addition to any previously installed Historian components and click Next.

4. When prompted, enter the correct Historian Server Computer Name (or IP

Address) to ensure connectivity at startup.

If you prefer, you can install the Excel Add-In at the same time you install a data collector or server. The Add-In must be enabled in Excel before you can use it. To enable the Excel Add-

In, refer to Installing the Excel Add-In with Historian in the Using the Historian Excel Add-In manual.

Installing Historian SDK

If you need to create customized programming for the Historian Server, use the Historian

Software Development Kit (SDK) with Visual Basic or any application that provides a VBA programming interface, such as iFIX, Microsoft Excel or Word. The Install Wizard places the

Historian Software Development Kit (SDK) in the System32 directory and automatically registers it. To use the SDK, set up a project reference with the Historian Software

Development Kit.

32

Implementing Historian Security

Uninstalling Historian and Historian System Components

Uninstalling Historian

To remove all Historian System information from your computer:

1. Double-click the Add/Remove Programs icon in the Control Panel. The

Add/Remove Programs dialog box opens.

2. Select Proficy Historian 3.1, and click the Remove button. a. To uninstall Historian and save the current Historian configuration and data, select Do Not Delete Archives and click Next. b. To uninstall Historian and delete the current Historian configuration and data, select Delete Archives and click Next. c. To abort the uninstall, select Cancel Uninstall and click Next.

3. The uninstall proceeds and all Historian components are removed.

For information on uninstalling OPC Data Collectors, refer to the Modifying and Uninstalling

OPC Collectors section of the Historian Data Collectors manual.

Upgrading from a Previous Release

Before upgrading Historian, it is recommends that you follow these steps:

Backup all archive data files (*.iha), configuration files (*.ihc) and backup files.

By default, you can find these files in the c:\Program Files\GE Fanuc\Proficy

Historian\Archives folder.

33

Proficy Historian Getting Started

Optionally, use the Excel Add-In to export your tag configuration for all tags. It is recommended that you export tags associated with each collector on a separate worksheet.

Uninstalling the old Historian Product

You can uninstall the old Historian product before installing the new Historian, but you do not have to. If you choose to uninstall, make sure that you remove all Historian SIMs before uninstalling the old Historian product.

If you uninstall the old Historian product, you do not need to remove any Historian archives, unless you want to. When you use the Windows Add Remove Programs wizard to uninstall

Historian, a message box appears asking if you want to remove the archives. If upgrading, select the Do Not Delete Archives and Continue option and click Next to continue with the uninstall.

Installing the new Historian Product

If you chose to uninstall Historian first, make sure you restart your computer before installing the new Historian. For the steps on how to install Historian, refer to the section at beginning of this chapter, Installing Historian Software.

NOTE: If you have uninstalled a previous version of Proficy Historian and did not remove the archives, ensure you direct the new Historian to the previous install folder (for example, c:\Program Files\iHistorian) so that the Historian install program will find the existing archives and configuration file.

Upgrading the Historian SDK

If you want to run an SDK program that you created with an older version of Historian on a newer version, you must first rebuild the program on a computer with an older version installed. You cannot run an SDK application built on an Historian node on a node running an older version of the software.

34

Implementing Historian Security

Interoperability of Historian Versions

Interoperability guidelines for Historian versions include:

Historian Collectors below v3.1 can write to Historian v3.1 Archivers.

Historian Clients below v3.1 can retrieve data from Historian v3.1 Archivers.

Historian v3.1 Clients can retrieve data from Historian Archiver below v3.1.

Historian v3.1 Collectors cannot write to Historian Archivers below v3.1.

An SDK program built on an Historian v3.1 node does not run on an Historian below v3.1.

An SDK program that you created in Historian below v3.1 must be rebuilt on the

Historian v3.1 computer if you want to run it on the v3.1 computer.

In general, it is recommended that you use consistent versions of client and server applications. If you do use different client and server versions of the Historian, it is recommended to regularly back up all archives and tag configurations.

NOTE: To determine the version of the server, client, and SDK, click on the

About link in the Historian Administrator.

35

Proficy Historian Getting Started

Implementing Historian Security

Historian is a high performance data archiving system designed to collect, store, and retrieve time-based information efficiently. By default, access to these Historian archives, tags, and data files is available to any valid operating system user account. In this default environment, all users are allowed to read, write, change, and delete archives, tags, or data files in the

Historian Administrator, SDK, Migration Tools, and Excel Add-In. However, you may find that you want to make these functions and data available only to authorized personnel. You can do this by creating and defining Historian Security Groups in your Windows Security.

Historian includes an Electronic Signature and Electronic Records security feature. This option provides installations concerned with the FDA's 21 CFR Part 11 regulation – or any site interested in added security or tracking – the ability to require a signature and password every time a change in data or configuration is requested. For more information on the Electronic

Signature and Electronic Records feature, refer to the Using Historian in a Regulated

Environment section of the Using the Historian Administrator manual.

Whether or not you use Historian security, make sure that you disable Guest accounts on your computer to limit access to valid Windows user accounts.

Protecting Your Process

If you want to restrict access to Historian archives, files, and tags, or protect your data files from unauthorized changes, you can enable Historian security. Using security is optional and is disabled by default. By enabling security, you can restrict access to the following:

Modifying data using the Excel Add-In

Updating security for individual tags or groups of tags

Creating, modifying, and removing tags

36

Implementing Historian Security

Tag protection (adding, modifying, removing, an so on) can be applied at a global level to all tags or at the individual tag level. Refer to Implementing Tag Level

Security for more information.

Reading data in the iFIX Chart object, Excel Add-In, and Migration Utilities

Writing data

Starting and stopping collectors

Creating and deleting collectors

Creating, modifying, and deleting archives

Historian uses the operating system security groups to create a security structure. You enable security for a particular set of functions by adding specific Historian Security Groups to your groups. You can also add security groups to your domain controller. Refer to Security Tab section in the Historian Administrator Manual for information on selecting local or domain security groups.

By defining one or all of the groups, you begin to set up a security structure. Refer to the

Historian Security Groups section for more information on the Historian Security Groups available.

Creating and Implementing a Security Strategy

When you begin to implement security, you should first define a clear strategy. Consider the following when beginning to set up your security strategy:

If you disabled the Guest account, a user must provide a valid username and password even if no groups are created.

Protection is only provided for the functional areas for which you have built the associated Historian Security Groups.

37

Proficy Historian Getting Started

If you only choose to define some of the security groups, all users still have all access to any uncreated groups. All users are still assumed to be a member of a group unless that group has been created, with the exception of iH Audited

Writers group. You must add the iH Audited Writers group to the Windows security groups so that a user can become a member of this group.

For example, if you elect to define the iH Security Admins group and iH Archive

Admins group, both the members associated with those defined groups and all other valid users still have access to such functions as creating and modifying tags until you create the iH Tag Admins security group.

If you decide to implement any of the Historian Security groups, you should first add and define the iH Security Admins group.

WARNING: If you do not create and define the iH Security Admins group, all valid users are assumed to be members of this group. This membership overrides any other security group that you set.

For more information on the Historian Security Groups available and their security functions, refer to the Historian Security Groups section and the Historian Security Groups table.

Historian Security Groups

The following are the available Historian Security groups:

iH Security Admins – Historian power security users. Security Administrators have rights to all Historian functions. This group also has the ability to change tag level security, archive security, and modify the Electronic Records and Signatures option. This is the only

Historian security group that overrides tag level security.

iH Collector Admins – Allowed to start and stop collectors, browse collectors, configure collectors, and add new collectors.

iH Tag Admins – Allowed to create, modify, and remove tags. Tag level security can override rights given to other Historian security groups. Tag Admins can also browse collectors.

38

Implementing Historian Security

iH Tag Admins are not responsible for setting Tag Level Security. This task can only be performed by an iH Security Admins. For more information on setting

Tag Level Security, refer to the Implementing Tag Level Security section.

iH Archive Admins – Allowed to create, modify, remove, backup, and restore archives.

iH UnAudited Writers – Allowed to write data without creating any messages.

iH Audited Writers – Allowed to write data and to produce a message each time a data value is added or changed.

Tag, archive, and collector changes log messages regardless of whether the user is a member of the iH Audited Writers Group.

iH Readers – Allowed to read data and system statistics. Also allowed access to Historian

Administrator.

Historian Group Rights

Use the security table that follows to identify which types of user groups you need to create and define in your security system.

Function

Create Tags:

Excel Add-In

SDK

Historian Administrators

File Collector

Remove Tags:

iH

Security

Admins

X

iH Un

Audited

Writers

X

iH

Audited

Writers iH

Readers

39

Proficy Historian Getting Started

Function

Historian Administrators

SDK

File Collector

Modify Tags:

Historian Administrators

Excel Add-In

SDK

File Collector

Modify Archive Security:

Historian Administrators

SDK

Backup Archive:

Historian Administrators

SDK

Restore Backup:

Historian Administrators

SDK

Create Archive:

X

X

X

X

X

iH

Security

Admins iH Un

Audited

Writers iH

Audited

Writers iH

Readers

40

Implementing Historian Security

Function

SDK

Historian Administrators

Start/Stop Collector:

SDK

Mission Control (iFIX)

Historian Administrators

Browse Collector:

Historian Administrators

Read Data:

Chart Object

Excel Add-In

SDK

Write Data (UnAudited):

Excel Add-In

SDK

Write Data (Audited):

Excel Add-In

SDK

X

X

X

X

X

iH

Security

Admins iH Un

Audited

Writers

X

iH

Audited

Writers

X

iH

Readers

X

41

Proficy Historian Getting Started

Function iH

Security

Admins

X

iH Un

Audited

Writers

X

iH

Audited

Writers

X

iH

Readers

Modify Data:

Excel Add-In

SDK

Update Security for Tag:

Excel Add-In

SDK

Historian Administrators

Migrate

Migration Tools

X

X

Function

Create Tags:

Excel Add-In

SDK

Historian Administrators

File Collector

iH

Archive

Admins iH Tag

Admins

X

iH

Collector

Admins

42

Implementing Historian Security

Function

Remove Tags:

Historian Administrators

SDK

File Collector

Modify Tags:

Historian Administrators

Excel Add-In

SDK

File Collector

Modify Archive Security:

Historian Administrators

SDK

iH

Archive

Admins iH Tag

Admins

X

iH

Collector

Admins

X

X Backup Archive:

Historian Administrators

SDK

X Restore Backup:

Historian Administrators

SDK

43

Proficy Historian Getting Started

Function

Create Archive:

SDK

Historian Administrators

Start/Stop Collector:

SDK

Mission Control (iFIX)

Historian Administrators

X

Browse Collector:

Historian Administrators

Read Data:

Chart Object

Excel Add-In

SDK

Write Data (UnAudited):

Excel Add-In

SDK

Write Data (Audited):

Excel Add-In

iH

Archive

Admins iH Tag

Admins iH

Collector

Admins

X

X

44

Implementing Historian Security

Function

SDK

Modify Data:

Excel Add-In

SDK

Update Security for Tag:

Excel Add-In

SDK

Historian Administrators

iH

Archive

Admins iH Tag

Admins iH

Collector

Admins

Migrate

Migration Tools

Security Setup Example

The following example takes you through the process of establishing your security needs and defining and setting up the levels of security.

Example

This example demonstrates how to implement security with Historian, starting with the default open security system.

1. Establish your user needs.

45

Proficy Historian Getting Started

For this example, assume the following user needs in a plant of 14 users:

User Needs Added to Security

Group

iH Security Admins USER1

USER2

USER3

USER5

USER6

USER8

Power user. Needs total access to security.

Read/Write Data (no messages).

Create, modify, and delete tags.

Backup, restore, and create archives.

• iH UnAudited

Writers iH Tag Admins iH Archive Admins

USER4

USER7

Read/Write Data (no messages).

Create, modify, and delete tags.

Start/Stop Collectors.

Backup, restore, and create archives.

• iH UnAudited

Writers

• iH Tag Admins

• iH Collector

Admins

• iH Archive Admins

• iH Readers USER9-

14

Read Data.

2. Add and define the iH Security Admins Group.

Once you determine that you want to establish a security structure, you must create and define the iH Security Admins group. This group of users is typically the "power users" of the Historian. Security Administrator rights allow them to manage configuration and give them free rein to the entire system. For this example, only USER1 would be added to the iH Security Admins group.

46

Implementing Historian Security

3. Establish and create any other Historian Security Groups as needed.

NOTE: Any user with Windows administrative permissions can add or remove

Windows groups and users. As such, an administrator on a Windows computer, can add himself to any Historian security group.

You should then set up the functional security groups as needed. For this example, Write, Tag, Archive, and Collector security is required, so the groups associated with those functions should be added and defined. There is no need for

Audited Writers and all valid users can read data, so neither the iH Audited

Writers Group nor the iH Readers Group need to be added.

4. Define any individual Tag Level security.

In addition to defining iH Tag Admins that have the power to create, modify, and remove tags, you can also define individual tag level security to restrict access to sensitive tags. You can grant read, write, or administrative privileges per tag. For more information on setting Tag Level security, refer to the Implementing Tag

Level Security section.

Setting up Historian Security Groups

This section describes how to add the Historian Security Groups to your local and domain

Windows NT, 2000, and XP security systems.

You can choose whether Historian uses LOCAL or DOMAIN security by selecting an option on the Security Tab of the Archive Maintenance screen in the Historian Administrator. If you select the local security option, the groups are defined as local groups on the Historian Server.

If you select the Domain security option, the groups are defined as global groups in the primary domain controller of the Historian Server. With domain security, Historian locates the Primary

Domain Controller (PDC), if available, or a Backup Domain Controller (BDC) in order to establish groups. If the PDC and all BDCs are unavailable, the system locks all users out until rights can be established with a valid PDC or BDC.

NOTE: If you change this setting, you must stop and re-start the Historian Server for this change to take effect.

47

Proficy Historian Getting Started

Setting Local Groups in Windows NT

To create a new local group on a Windows NT machine:

1. Open the User Manager Console from the Administrator Tools folder in the Start

Menu.

2. In the User Manager Console, select the user accounts you want to add to the new group.

3. Select New Local Group from the User menu.

4. Enter the appropriate Historian Security Group name in Group Name field. For a list of available Historian Security Groups and their functions, refer to the

Historian Security Groups section.

IMPORTANT: You must enter the Historian Security Group name exactly as it appears. The security groups are case sensitive.

5. Optionally, enter a description of the new group in the Description field.

6. Click Add to add members to the local group.

7. Complete the fields in the Add Users and Groups dialog box.

Setting Local Groups in Windows 2000 or Windows XP Pro

To create a new local group on a Windows 2000, 2003, or Windows XP Pro machine:

1. Open the Control Panel.

2. Double-click the Administrative Tools icon.

3. Double-click the Computer Management icon. The Computer Management console opens.

48

Implementing Historian Security

4. Select Groups from the Local Users and Groups folder in the system tree.

5. From the Action menu, select New Group. The New Group dialog box appears.

6. Enter the Historian Security Group name in the Group Name field. For a list of available Historian Security Groups and their functions, refer to the Historian

Security Groups section.

IMPORTANT: You must enter the Historian Security Group name exactly as it appears. The security groups are case sensitive.

7. Optionally, enter a description of the Historian Security Group in the Description field.

8. Click the Create button.

9. Click the Close button.

Adding Users to a Windows 2000, 2003 or Windows XP Pro Security Group

Before adding users to your group, you must first add your users to the Windows system. For more information on adding users, refer to the Users Overview section of the Windows 2000 or

XP Pro online Help.

To add a user to a group:

1. Open the Control Panel.

2. Double-click the Administrative Tools icon.

3. Double-click the Computer Management icon.

4. Select Groups from the Local Users and Groups folder in the system tree.

5. Select the group to which you want to add users.

49

Proficy Historian Getting Started

6. From the Action menu, select Properties. The Users Properties dialog box appears.

7. Click the Add button.

8. Select the users or groups to add from the listed users or enter the names of the users or groups you want to add in the bottom field.

9. Click the Add button.

TIP: To validate the user or group names that you are adding, click the Check

Names button.

10. When you have added all users to the group, click OK.

Adding a Local User in Windows XP Pro

To add a local user:

1. Verify object types is Users or Groups.

2. Verify the From This Location setting is your local machine. (Click Locations to specify the local machine, if required.)

3. Click the Advanced button.

4. Click Find Now.

5. Select the users or groups to add from the listed users or enter the names of the users or groups you want to add in the bottom field.

6. Click the OK button in the Advanced dialog

7. Click the OK button in the Select Users dialog.

8. Click the OK button in the group properties dialog.

50

Implementing Historian Security

To Add a Domain User in Windows XP Pro

1. Verify object types is Users or Groups.

2. Verify the From This Location setting is your windows domain. a. Click Locations to specify the domain, if required. b. Select Entire Directory or the specific domain underneath Entire

Directory. c. Click OK

3. Click the Advanced button.

4. Click Find Now.

5. Select the users or groups to add from the listed users or enter the names of the users or groups you want to add in the bottom field.

6. Click the OK button in the Advanced dialog.

7. Click the OK button in the Select Users dialog.

8. Click the OK button in the group properties dialog.

Avoiding Unauthorized Access When Using Historian Security

To ensure a secure environment when using Historian security, do not create any local user accounts unless Historian is set up on a stand alone machine. Also, disable the Windows Guest account.

51

Proficy Historian Getting Started

Working with Domain Security

When you configure Historian to use Domain security groups and security groups exist, it attempts to locate either the Primary Domain Controller (PDC) or one of the Backup Domain

Controllers (BDC) in order to find Historian Security Group information. If the Historian

Server machine is not a member of a domain, or if a Primary or Backup Domain Controller cannot be located when the Historian Data Archiver service starts, access to Historian is denied to all users.

In this case, it is necessary to make the Historian Server a member of a domain and to make sure a Domain Controller is available before starting or restarting the Historian Data Archiver service. For convenience, the data archiver show (.SHW) file lists all PDCs and BDCs available at the time of archiver startup. Use this list to verify that the Historian Server has visibility into the appropriate domain.

After the list of Domain Controllers has been established, the Historian Server will use that list to query for Security Group Membership on an as needed basis. If at any time a request for

Group Membership information is made and the Primary Domain Controller is not available,

Historian selects the first Backup Domain Controller and attempts the same request. If a

Backup Domain Controller successfully responds to the request, the process of querying for

Group Membership can stop. Otherwise, Historian will attempt to query Group Membership information from the next available Backup Domain Controller. If no Backup Domain

Controller successfully responds, access to the system is denied.

Changing security group configuration from Local to Domain or vice versa requires that the

Historian Data Archiver service be restarted for the change to take effect.

Creating Security Groups in Windows NT Domain Controller

To create a new Global security group in a Windows NT Domain:

1. Open the User Manager for Domains window from the Administrative Tools menu. The User Manager for Domains window appears.

2. In the User Manager for Domains window, do one of the following:

52

Implementing Historian Security

Select the user accounts you want as the initial members of the new group.

Select any group to ensure no user accounts are initially selected.

3. In the User menu, click New Global Group. The New Global Group dialog box appears.

4. Enter the Historian Security Group name in the Group Name field.

5. In the Description field, enter a description.

6. To add members for the new group, select one or more user accounts in Not

Members and then click Add.

7. To remove members from the new group, select one or more user accounts in

Members and then click Remove.

Creating Security Groups in Windows 2000 Domain Controller

To create a new security group in a Windows 2000 Domain:

1. Double-click the Administrative Tools Icon in the Control Panel. The

Administrative Tools dialog box opens.

2. Double-click the Active Directory Users and Computer icon. The Active

Directory dialog box opens.

3. In the Active Directory Tree display, select Users.

4. Right-click on Users to display the right-click menu.

5. Select New and click Group from the right-click menu. The New Object - Group dialog box appears.

53

Proficy Historian Getting Started

6. In the Group name field, enter the name of the new Historian group exactly as you have defined it. Leave the other default options unchanged.

7. Click OK to create the new group.

Using a Windows 2000 Domain Controller with a Windows NT

Historian Server

When you use domain security with a Windows NT Historian Server and the domain controller is a Windows 2000 controller, you must configure the Historian DataArchiver service to log on as a valid domain account and you must add the user right to Act as a Part of the Operating

System to its list of rights.

To do this:

To set up logon of Historian data archiver service

1. In Control Panel, double-click the Services icon. The Services dialog box opens.

2. Double-click Historian Data Archiver. A Service dialog box appears.

3. In the Log On As panel, click This Account and select a domain user account.

4. Click OK.

54

Implementing Historian Security

To add the act as part of operating system right to the domain account

1. In Administrative Tools (common), open the User Manager Console.

2. In the Policies menu, select User Rights. The User Rights Policy dialog box opens.

3. Select the Show Advanced User Rights option. A drop-down arrow appears in the

Rights field of the dialog box.

4. In the drop-down list, select the Act as a Part of the Operating System option.

5. Click Add. The Add Users and Groups dialog box appears.

6. Select your domain username and click Add. Then click OK.

7. In Services, restart Historian DataArchiver.

You should now be able to log on to Historian Administrator using Domain

Security.

If you attempt to log on the Historian Data Archiver as a Local System Account, you may be denied access because the System Account in Windows NT is not privileged to access the

Windows 2000 Domain Administrator. A valid domain user account, however, is privileged to access the Windows 2000 Domain Administrator if it is has also been granted the Act as a Part of the Operating System right.

Establishing Your Security Rights

Your security identity is established upon connecting to the server. This occurs through the following steps:

1. Specifying a username and password of an account.

55

Proficy Historian Getting Started

Upon connection, the system checks to see if you have a valid NT account. If you have supplied a username and password (through the Excel Add-In for example), security checks that user. If username and password are not supplied and you are on a Windows 2000 or NT 4.0 machine or higher, security checks the currently logged in user.

NOTE: If you do not pass a domain name the account will be checked locally in the same way a mapped drive attempt happens. You have to specify a username and password that exists on the server.

2. Determining group membership of that account.

Once the account is validated, the server determines group membership. For more information on the process and hierarchy of the groups, refer to the Identifying the Security Checking Process section.

3. Caching membership profile.

Once the group and tag membership are determined, it is cached for the connection and not looked up again. If users are added to or deleted from a group, the cache is not updated.

NOTE: The cache information is per connection, and not per IP address. In other words, it is cached per application and not per system.

Identifying the Security Checking Process

The following figure details the security checking process.

56

Implementing Historian Security

Security Checking Process

Implementing Tag Level Security

In addition to defining iH Tag Admins that have the power to create, modify, and remove tags, you can also define individual tag level security to protect sensitive tags.

This tag level security can be set in the Historian Administrator. You do not need to use the

Historian Security Groups for this security setting. You may use one of the Windows predefined groups (power users, for example) or create your own separate group specifically for

57

Proficy Historian Getting Started

this function. For more information on creating and adding groups, refer to the Setting up

Historian Security Groups section.

NOTE: Only users defined as iH Security Admins have rights to set individual tag level security, browse and query all tags in the Historian Administrator.

To set Tag Level Security for an individual tag:

1. Open the Historian Administrator.

2. Click on the Tags link. The Tag Maintenance screen appears.

3. Select a tag (or group of tags) from the Tag Name section of the Tag Maintenance screen.

4. Click on the Advanced Tab to display the advanced tag options.

5. In the Read Group, Write Group, or Administer Group field, select the security group that you wish to assign to the tag from the drop-down list.

The drop-down list automatically lists all security groups that are defined in your

Windows security environment.

For example, if an iH Security Admins user selects a tag and chooses power users from the

Read Group drop-down list, in addition to members of the iH Security Admins group, only a member of the power users group will be able to read data for that tag. Even a member of the iH Readers group will not be able to access data for that tag, unless they are also defined as a member of the power users group.

58

Retrieving Data from Historian

After data collection, the Historian Server compresses and stores the information in the

Archive Database. Any client application can retrieve archived data through the Historian API.

The Historian API is a client/server programming interface that maintains connectivity to the

Historian Server and provides functions for data storage and retrieval in a distributed network environment.

You can retrieve data from Historian using one of the following:

• iFIX

CIMPLICITY

Excel Add-In

Custom SDK Applications

OLE DB

Sampling and calculation modes are used on retrieval of data that has already been collected to the archive. These modes do not effect data collection. Some sampling modes are suited to compressed data and should be used when collector compression or archive compression is used.

Sampling Modes

Sampling modes are used to specify how the data will be retrieved from Historian. Several modes are available, such as CurrentValue, Interpolated, Calculated and RawByTime.

Sampling modes are specified in the client you use to retrieve data from Historian.

Descriptions and common usages of the sampling modes in Historian are as follows:

59

Proficy Historian Getting Started

Sampling Mode

CurrentValue

RawByTime

RawByNumber

Interpolated

Results

Retrieves the most recent data sample value received by the archiver, of any data quality. This does not necessarily produce the most recent raw data sample, as archive compression may not have stored the most recent raw sample.

The sample has a time stamp, a value, and a quality. The time stamp returned is not typically the current time; it is the time stamp as sent by the collector. If you have a slow poll rate or if collector compression is enabled, the time stamp may be much earlier than the current time.

Returns all raw samples of all qualities with a time stamp greater than a specified start time, and less than or equal to a specified end time. The RawByTime sampling mode will not return a sample equal to the start time.

Returns a specified number of samples of all qualities with a time stamp greater than or equal to the start time. The

RawByNumber sampling mode will return a sample with a time stamp equal to the start time if one exists

You must also specify a direction and number of samples when using this sampling mode.

When archive or collector compression is used, a minimal number of actual data samples are stored in the archive.

When this data is retrieved, interpolation can be performed to create an evenly spaced list of most likely real-world values

(since the actual values have been removed from the archive through the compression algorithm).

60

Sampling Mode

Startup Procedure Overview

Results

The Interpolated sampling mode is also useful for data samples that haven't undergone archive compression. For example, you may want to plot data along an interval that doesn't match the collected raw samples. Using the

Interpolated sampling mode would give you the most likely real-world values for the specified period.

Typically, you use the interpolated sampling mode when data is not collected on a set time schedule, or if you want to see the results returned in an interval that is slower than the collection rate. For example, these instances show when you can use interpolated mode to make evenly spaced values:

A tag is collected as "unsolicited." In this case, we really do not know what the time interval is between collected values.

The deadband and/or archive compression for a tag results in non-evenly spaced collection intervals.

A tag is collected once per 8-hour shift, but you want to see it displayed in 1 hour intervals with a linear slope between points.

61

Proficy Historian Getting Started

Sampling Mode

Lab

Trend

Calculated

Results

The Lab sampling mode only returns the collected values, without any interpolation of the value. The collected value is repeated for each interval until there is a change in the raw data sample's value.

Lab sampling is most often used to create a step chart rather than a smooth curve.

Use Lab sampling instead of interpolated if you only want true collected values returned. The Lab sampling mode is generally not useful on highly compressed data. Use interpolated sampling instead.

The Trend sampling mode was designed to produce maximum performance when retrieving data for plotting, particularly over long time periods.

The trend sampling mode returns the maximum and minimum value collected during each interval. When plotted, this makes it possible to display an accurate representation of the data that won’t miss any extremums, by only retrieving a minimum of points.

For example, a trend of 1 year of data with a 1 day interval will return 730 values consisting of the 365 minimums and

365 maximums for each day of the year.

Returns samples based on a selected Calculation mode. Refer to Calculation Modes for more information.

62

Startup Procedure Overview

Calculation Modes

Calculation modes are used when the sampling mode is set to Calculated. The data type of all calculated values will be DoubleFloat except for MinimumTime and MaximumTime, which will be a Date.

The calculation modes in Historian are:

Calculation Mode

Count

Results

Displays the number of raw samples in the specified interval. This only indicates the count and does not display the actual values or qualities of the samples.

The Count calculation mode is useful for analyzing the distribution of raw data samples. If you have a higher number of raw samples than expected, you may decide to implement collector or archive compression. If samples are missing then you may want to slow your collection rates

Minimum

MinimumTime

Displays the minimum value in a specified interval with good data quality. This value may be raw or interpolated.

NOTE: The Minimum and MinimumTime calculation modes actually retrieve two additional samples per interval; one is interpolated at the interval start time and the other is interpolated at the interval end time. These samples are used in calculations just like any raw or interpolated value.

Displays the time stamp of the minimum value in a specified interval.

63

Proficy Historian Getting Started

Calculation Mode

Maximum

MaximumTime

RawAverage

Average

Total

Results

See the note in Minimum for additional information.

Displays the maximum value in a specified interval.

NOTE: The Maximum and MaxmimumTime calculation modes actually retrieve two additional samples per interval; one is interpolated at the interval start time and the other is interpolated at the interval end time. These samples are used in calculations just like any raw or interpolated value.

Displays the time stamp of the maximum value in a specified interval.

See the note in Maximum for additional information.

Displays the arithmetic average of the raw values in a specified interval with good data quality. This is useful only when a sufficient number of raw data values are collected.

Similar to RawAverage, but performs a special logic for time weighting and for computing the value at the start of the interval. This is useful for computing an average on compressed data.

Retrieves the time-weighted total of raw and interpolated values for each calculation interval. The collected value must be a rate per 24 hours. This calculation mode

64

Startup Procedure Overview

Calculation Mode

RawTotal

StandardDeviation

Results

determines a count from the collected rate.

Displays the arithmetic sum of raw values in a specified interval.

Displays the time-weighted standard deviation of raw values for a specified interval.

RawStandardDeviation Displays the arithmetic standard deviation of raw values for a specified interval.

TimeGood Displays the amount of time (in milliseconds) during an interval when the data is of good quality and matches filter conditions if the filter tag is used.

Filtered Data Queries

Filtered data queries enhance Historian by adding filter tags and additional filtering criteria to standard queries. Unfiltered data queries in Historian allow you to specify a start and end time for the query, then return all data samples within that interval. A filtered data query, however, will allow you to specify a condition to filter the results by, as well as calculation modes to perform on the returned data. Filtered data queries are performed on the Historian server.

For example, a filtered data query is useful when trying to retrieve all data for a specific Batch

ID, Lot Number, or Product Code and for filtering data where certain limits were exceeded, such as all data where a temperature exceeded a certain value. Rather than filtering a full day's worth of process data in the client application, you can filter data in the Historian archiver, and

65

Proficy Historian Getting Started

only return the matching results to the client application. The result is a smaller, more relevant data set.

You can use filter criteria with raw, interpolated, and calculated sampling modes. You cannot use it with current value sampling. The logic of selecting intervals is always interpolated, even when the data retrieval is raw or calculated. The value that triggers a transition from false to true can be a raw value or interpolated value.

For Historian, you can use filtered data queries when retrieving data from the following applications:

Excel Add-In

OLE DB Provider

SDK programs

You can also use filtered data queries with other applications, such as the Proficy Real Time

Information Portal event chart. You cannot use a filtered data query in an iFIX chart.

Overview of Filtered Data Query Parameters

Use of filter parameters with a data query is optional. The following table describes each of the filtering parameters you can use.

TIP: To enable filtering, specify a Filter Tag. All other parameters are ignored if the

Filter Tag is not set.

Parameter

Filter Tag

Description

The single tag name used when applying the filter criteria. Entering a tag for this parameter indicates that you want to perform a filtered data query. The other filter fields are disregarded unless you specify a filter tag.

66

Startup Procedure Overview

Parameter

Filter Mode

Filter

Comparison

Mode

Description

The type of time filter:

ExactTime – Retrieves data for the exact times that the filter condition is True (only True).

BeforeTime – Retrieves data from the time of the last False filter condition up until the time of the True condition (False until True).

AfterTime – Retrieves data from the time of the True filter condition up until the time of next False condition (True until

False).

BeforeAndAfterTime – Retrieves data from the time of the last False filter condition up until the time of next False condition (While True).

The Filter Mode defines how time periods before and after transitions in the filter condition should be handled.

For example, AfterTime indicates that the filter condition should be

True starting at the timestamp of the archive value that triggered the

True condition and leading up to the timestamp of the archive value that triggered the False condition.

The type of comparison to be made on the filter comparison value:

Equal – Filter condition is True when the Filter Tag is equal to the comparison value.

EqualFirst – Filter condition is True when the Filter Tag is equal to the first comparison value.

EqualLast – Filter condition is True when the Filter Tag is equal to the last comparison value.

NotEqual – Filter condition is True when the Filter Tag is

NOT equal to the comparison value.

67

Proficy Historian Getting Started

Parameter Description

LessThan – Filter condition is True when the Filter Tag is less than the comparison value.

GreaterThan – Filter condition is True when the Filter Tag is greater than the comparison value.

LessThanEqual – Filter condition is True when the Filter

Tag is less than or equal to the comparison value.

GreaterThanEqual – Filter condition is True when the

Filter Tag is greater than or equal to the comparison value.

Alarm Condition – Specifies an alarm condition to filter data by. For example, Level.

Alarm SubCondition – Specifies an alarm sub-condition to filter data by. For example, HIHI.

The Filter Comparison Mode defines how archive values for the

Filter Tag should be compared to the Filter Value to establish the state of the filter condition. If a Filter Tag and Filter Comparison

Value are supplied, time periods are filtered from the results where the filter condition is False.

Filter

Comparison

Value

The value to compare the filter tag with when applying the appropriate filter to the data record set query (to determine the appropriate filter times).

Example: Filtered Queries in the Excel Add-In

The following example shows how a filtered data query will return specific data from the

Historian archive.

This example makes use of two tags, batchid and ramp. The batchid tag is updated before a new batch is produced with the new batch's ID. The ramp tag contains raw data sent by a

68

Startup Procedure Overview

device in the process. In this example, we'd like Historian to return data samples at ten second intervals for the ramp tag during the period that the batchid tag is set to B1.

A standard query in Historian for the ramp tag's values between 08:00 and 08:01, at ten second intervals, would look like this:

Time Stamp

07/30/2003 08:00:10

Value

16

Data Quality

Good

07/30/2003 08:00:20

07/30/2003 08:00:30

07/30/2003 08:00:40

07/30/2003 08:00:50

22

34

46

50

Good

Good

Good

Good

07/30/2003 08:01:00 55 Good

If we did a query against the batchid tag for the same time interval, we would receive the following results:

Time Stamp

07/30/2003 08:00:00

Value

B0

Data Quality

Good

07/30/2003 08:00:20 B1 Good

69

Proficy Historian Getting Started

Time Stamp

07/30/2003 08:00:45

Value

B2

Data Quality

Good

To filter data queries in the Excel Add-in:

In order to find the values of the ramp tag for the B1 batch, you would enter the following values into the Historian Filtered Data Query dialog box:

1. In the Tag Name(s) field, enter the tag you want to receive results from - the ramp tag in this example.

2. Select a start and end time for your query.

3. In the Filter Tag field, enter the tag you want to enable filtering with - batchid in this example..

4. In the Filter Comparison field, select your comparison condition.

5. In the Include Data Where Value Is field, enter your filter condition value.

6. In the Include Times field, select your filter mode.

7. In the Sampling Type field, select your sampling mode.

8. In the Calculation field, select your calculation mode.

9. Select your Sampling Interval.

10. In the Output Display field, select which tag values you wish to display.

70

Startup Procedure Overview

The output of the above would look similar to this:

Time Stamp

07/30/2003 08:00:20

07/30/2003 08:00:30

Value

22

34

Data Quality

Good

Good

07/30/2003 08:00:40 46 Good

Note that although we specified a start time of 08:00 and an end time of 08:01, Historian has only returned data samples that are relevant to the batch B1.

71

Proficy Historian Getting Started

Using Historian with iFIX

Creating Historian Charts using Mixed Pens

Historian allows you to put both OPC data source and FIX Tag type pens into your iFIX charts;

Classic Historian only allows you to use Fix Tag pens. Note that if you create a mixed pen chart in iFIX Historian Mode and attempt to open the chart in Classic Historian mode, you may not be able to view either pen.

Using Historian with iFIX

You can enhance the power of the Historian by pairing it with iFIX. The benefits of using

Historian with iFIX clients include:

• iFIX Chart features:

Sub-second support

Auto Update

Time Zone Support

Daylight Savings Time (DST) Support

Filter and Sort by description, and directly access OPC tags in the

Expression Editor

Support for Historian interpolated data retrieval.

Ability to access multiple Historian Servers (even within the same chart).

72

Startup Procedure Overview

The ability to easily script against the SDK in VBA. This allows you to retrieve record sets in Historian for processing and display, and to build time-aware graphics that can display animations from any selected time.

Writing status information directly into iFIX tags, so the health of the iFIX

Collector can be monitored in real time within iFIX.

Easy migration of iFIX Classic Historian Configuration and Data.

Easy migration of iFIX Alarm and Event Data.

Collection of iFIX Alarm and Event Data.

NOTE: You can plot any collected data, not just iFIX Collector data.

Please be aware of the following when using Historian with iFIX:

You must install iFIX before installing Historian if you want to install the iFIX

Collector. If you attempt to install Historian on a machine without iFIX installed and select the iFIX Collector under the Select Components, a message appears stating that iFIX is required on this node to install the iFIX Collector.

You must install the iFIX Alarm & Event server before installing the iFIX AE

Collector from the Historian installation and setup program.

You must manually import the Historian Toolbar into the iFIX WorkSpace after you have installed Historian. Refer to Importing the Historian Toolbar into iFIX for more information.

In working with iFIX, be aware that the Historian user owns the archive process and that Historian security is independent of iFIX security.

If you attempt to use the iFIX Chart Group Wizard to add Simulation or OPC tags, you will receive an error. The Chart Group Wizard only supports iFIX

Historian tags that use the iFIX historical tag naming convention.

73

Proficy Historian Getting Started

Historian does not support the installation of collectors or servers on Terminal

Server machines running in application server mode.

Using iFIX drivers with Historian

If you are running iFIX in your Historian environment, you can use any iFIX driver (version

6.X or 7.X). Historian uses data from the iFIX process database, therefore once the driver brings the data into the Process Database (PDB), it is available to Historian via EDA and the iFIX Collector.

If you are using a FIX32 node, you can also use any iFIX driver. To get FIX32 data into

Historian, use the FIX32 collector.

Collecting iFIX Alarm and Event Data

Historian supports Alarm and Event collection from an iFIX server.

To configure the iFIX AE collector to start automatically when iFIX starts add the iFIX AE collector to the list of startup tasks in the System Configuration Utility (SCU).

To add the collector to the SCU list, open the Task Configuration dialog box in iFIX, enter

ihIFIXAECollector.EXE in the Filename field and runasdos in the Command Line field, and click the Add button.

NOTES:

After starting the iFIX AE collector you will need to use the Historian administration tool to link it to its associated iFIX data collector.

If ItemIDs are not being collected, and you see an entry in your log file that says

"Alarm Item IDs Will Not Be Collected. 'CV' Vendor Attribute Not Found", you must increase the Delay Collection at Startup (sec) value in the collector's configuration.

For more information, refer to the following topic:

74

Startup Procedure Overview

OPC Alarm and Event Collector.

Viewing Historian Values and Time Stamps in an iFIX

Chart

When viewing an iFIX chart, set the interval time to a fine granularity to ensure that you will see Historian values and Time Stamps when you zoom in on the chart.

Importing the Historian Toolbar into iFIX

You must import the Historian toolbar into the iFIX WorkSpace after you have successfully installed Historian.

To import the toolbar:

1. Start iFIX v2.6 or higher.

2. Open the iFIX WorkSpace.

3. Select Toolbars from the WorkSpace menu. The Toolbars dialog box appears.

4. Select WorkSpace from the Owners list.

5. Click the Customize button. The Customize Toolbars dialog box appears.

6. Click the Import button. The Import Toolbars dialog box appears.

7. Select Historian from the Toolbars list.

8. Click the Import button to import the Historian Toolbar.

9. Click the Close button. The Customize Toolbars dialog box closes and the

Historian Toolbar appears in the iFIX WorkSpace.

75

Proficy Historian Getting Started

NOTE: The Configure Historian Servers toolbar in the WorkSpace specifies the location of historical data retrieval for the WorkSpace, not the location of the historical data storage. You can view/retrieve data stored on these listed servers while you select a pen for a chart display. The Configure Historian Servers dialog also determines where HDA programs and historical ODBC retrieve data from, which is always the default server.

Using the Toolbar Buttons

Use the Change Historian button (left-most button on the toolbar) to switch to Historian mode to browse tags and retrieve data from your Historian Server.

Formatting OPC Tags Containing Special Characters

After selecting an OPC tag in the Expression Builder, you must add single quotes to the pen list in order to handle special characters.

For example:

Hist.node1.Data Point.Int2

`Hist.node1.'Data Point.Int2'

If a single quote (`) or a backslash (\) is a literal part of the addressing string syntax (e.g.

HIST.NODE1.'MIXER'LINE.INT2), it must be preceded by a backslash (\) in order for the character to be passed to the server as part of the address

(HIST.NODE1.\'MIXER\'LINE.INT2).

76

Startup Procedure Overview

Filtering Tags Using THISNODE with Expression Builder

If you configure an iFIX node to use Local Node Alias and then use for example MIXER as the node name, you can use a filter such as M* to return a list of all tags that start with M including

THISNODE. If you use T* as a filter, no tags will be returned, because THISNODE is an alias, not a real node name.

The iFIX Data Collector

Several components of Historian, such as the iFIX Data Collector, work with iFIX. The iFIX

Data Collector uses the Easy Data Access (EDA) protocol to retrieve data from a running iFIX system.

The iFIX Install program automatically provides an iFIX node name to the iFIX Data

Collector. The default name is iFIXnodename_iFIX. If you browse tags, the Data Collector retrieves every tag with a node name that matches the one you are browsing. Refer to the

Historian Data Collector manual for more information on Data Collector tag configuration.

NOTE: You can install only one iFIX Data Collector per computer.

The preferred way to start an iFIX Collector is to add the collector to the iFIX System

Configuration Utility (SCU) list. The collector then starts automatically whenever you start iFIX.

To add the collector to the SCU list, open the Task Configuration dialog box in iFIX, enter

"ihFixCollector.exe" in the Filename field and "runasdos" in the Command Line field, and click the Add button.

IMPORTANT: Stop the iFIX or FIX32 collector before attempting to modify selected iFIX or FIX database blocks and fields you want to be made available in a browse. You can access the blocks and fields from the Configuration tab of the Collector Maintenance screen.

77

Proficy Historian Getting Started

Historian and iFIX Chart Objects

The iFIX chart object plots the last recorded value for pens using Historian tags if the data for those tags comes in from a data collector and the collector loses its connection to the data archiver.

Suppose you configure an iFIX chart object to auto-update the historical data. If the data collector loses its connection to the data archiver, the iFIX chart object flatlines at the last recorded value. When the connection between the collector and archiver is reestablished, the chart then shows the correct data for the period in which the collector was not available.

Optionally, you can use a heartbeat to determine when the iFIX Data Collector stops sending data and restart the collector. For more information, refer to the Example: Restarting the iFIX/FIX32 Collector Using a Heartbeat section in chapter 6 of the Historian Data Collectors guide.

Browsing iFIX Tags On Networked iFIX/FIX32 Nodes

It is recommended that you install an iFIX Collector on each node you want to collect data from. You can choose, however, to use the iFIX networking structure to bring tags into your iFIX Collector from multiple iFIX nodes or systems.

To select multiple nodes to browse from modify the Nodes to Browse field in the

Configuration Tab of the Collector Maintenance screen. This field displays the mask used to select tags when performing a browse of the collector node. The default is the iFIX SCADA or

VIEW (iClient) node name that you installed the collector on. If you want to browse for tags on other iFIX/FIX32 nodes via FIX networking, you can enter the other node name(s) here, separated by commas with no spaces. You must have the iFIX system configured for networking.

For more information, refer to the iFIX Electronic Books on FIX networking.

78

Startup Procedure Overview

Using the iFIX Expression Editor to search tags

Since iFIX tags have a NODE.TAG.FIELD format, you must enter separate node and tag filters when you use the Expression Editor to search for tags. This is important when you search for non-iFIX tags, such as those generated by a Simulation Collector. For example, if the simulation tags have the format T20.Simulation 00001, T20.Simulation00002, etc., which is different from the iFIX format, use a node filter of * and a tag filter of t2* to return all

Simulation tags. An iFIX tag with the name T2.Ramp.F_CV would not be returned in that example because the Tag Name (Ramp) does not contain T2. T2 is the node name.

Searching for Calculation or Server-to-Server tags in the iFIX

Expression Editor

You cannot use the Calculation or Server-to-Server Collectors as a search filter in the iFIX

Expression Builder. The Calculation or Server-to-Server Collectors do not appear in the

Collector Type drop-down list in the iFIX Expression Builder as an option for filtering.

Using the iFIX Integration Toolkit

If you are using the iFIX Integration Toolkit (HDA) with Historian, you must ensure that the

HTRDATA directory path location listed in the SCU contains a folder for each node name and a single file with a valid Classic Historian Archive name (for example, "00090300.H24"). If this structure is not in place, all "HdaEnumNodes" calls will fail to return the list of remote nodes. The file does not need to be created by HTC and does not need to contain any historical data. You can create the files using Notepad by saving an empty file as "00090300.H24" including the quotation marks to <Drive:\htrdata\><Remotenodename> where the path matches the HTR data path in the SCU.

GE Fanuc Automation recommends that all new custom historical data applications be built using the Historian SDK.

79

Proficy Historian Getting Started

Uninstalling Historian if iFIX v2.6 is installed

If iFIX v2.6 is installed, when you uninstall Historian, you should select No if prompted to remove the shared file named SPR32X30.OCX, the Farpoint Spreadsheet v3.0 (a third-party

ActiveX control).

If the install removes the SPR32X30.OCX file, the iFIX WorkSpace reports a VBA compile error the next time you open the iFIX WorkSpace.

If you receive the compile error when you open the iFIX WorkSpace, run the following command from the iFIX base path: regsvr32 SPR32X30.OCX

This command re-registers the Farpoint Spreadsheet.

Using v7.x Drivers with Historian

Consult the following topics for using the iFIX v7.x drivers with Historian

Using Autocreate

Using the Latched Data feature

Running iFIX 7.x Drivers as OPC Servers

Running iFIX 7.x Drivers as a service with Automatic Startup

Using Autocreate

iFIX 7.X drivers have an AutoCreate feature that automatically generates datablocks if an iFIX

Database or an OPC Collector requests them. If you have enabled AutoCreate in an Intellution

7.X driver that you are using with Historian, any datablock deleted from a group will be recreated by the next collector request. To stop the recreation, disable AutoCreate for the driver. You cannot specify only iFIX AutoCreate.

80

Startup Procedure Overview

Using the Latched Data feature

iFIX 7.X drivers running as OPC Servers have a latched data feature. If you select this feature,

the driver continues to display the last known good value, even when a connection to the process hardware is broken. The Historian OPC Collector considers the latched values as bad data and does not collect the values.

Running iFIX 7.x Drivers as OPC Servers

Current versions of iFIX 7.X drivers can run as OPC Servers. If you are running 7.X drivers as

OPC Servers, you must either run the 7.X driver on a computer with iFIX installed or install the new hardware key.

Running iFIX 7.x Drivers as a service with Automatic Startup

The following procedure details the steps needed to set up your iFIX 7.X driver to run as a service with automatic startup. The procedure describes a specific ABR driver setup which requires RSLinx; however, you can also use the steps to configure your other 7.X drivers by substituting the driver name and other specific driver information. If your driver requires a third party software, such as RSLinx, ensure that it is configured properly as a service before moving on to step 2.

To set a collector to run as a service with the ABR driver:

1. Install and configure Rockwell Software's RSLinx.

2. Install an ABR OPC Server.

3. Create an ABR Configuration, save it, and configure it for auto start.

4. Install and configure your OPC Collector: a. Install an OPC collector. The Historian install prompts you for a Prog ID and a name. b. Enter Intellution.ABROPC.

81

Proficy Historian Getting Started

c. Choose not to restart your system.

5. Configure DCOM defaults for Windows 2000 or Windows NT:

NOTE: You should only need to configure DCOM on your Windows computer once.

a. Select Run from the Start menu and enter DCOMCNFG. The Distributed

COM Configuration Properties dialog box appears. b. Select the Default Security tab. c. Click the Edit Default button in the Default Access Permissions section. d. Click the Add button to add System and Interactive Groups (if not present). e. Click OK to return to the Distributed COM Configuration Properties dialog box. f. Click the Edit the Default button in the Default Launch Permissions section. g. Click the Add button to add System and Interactive Groups (if not present). h. Click OK to return to the Distributed COM Configuration Properties dialog box. i. Click Edit the Default button in the Default Configuration Permissions section. j. Click the Add button to add System and Interactive Groups (if not present). k. Click Apply and OK to close the DCOM configuration utility.

82

Startup Procedure Overview

6. Register Intellution OPC Server to run as a service: a. Ensure that the Power Tool and all clients are shut down. b. At the run prompt, enter the following:

ABRdrv REGSERVICE

Note that this text is case sensitive. c. Verify that the ABR OPC Server appears in the Services dialog box. If it doesn't, you may have entered it incorrectly. Ensure that all client applications to the driver, including the Power Tool, are closed and the

Services Dialog is closed. If all client applications are closed, try entering the string again.

7. Start the Server manually through the Services Dialog in the Control Panel.

8. Start the Collector manually through the Control Panel.

9. Log into the Historian Administrator and add all of the tags from the collector.

10. Open the Run prompt from the Start Menu.

11. Enter Regedt32 in the Open field and set the following dependencies:

Set the Dependency of the iHOPCCollector on the OPCServer: a. Locate the iHOPCCollector folder. This folder is typically located in the

\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\iH

OPCCollector path. b. Add a value to the iHOPCCollector registry key:

I. Select Add a Value from the Edit menu.

83

Proficy Historian Getting Started

II.

III.

IV.

Enter the following exactly in the Value field:

DependOnService

Select REG_MULTI_SZ as the data type.

Click OK. A dialog box appears prompting you to enter the value.

V.

VI.

Enter ABRdrv.

Click OK. c. Set Dependency of OPC server on its 3rd party API:

NOTE: This dependency only applies to the ABR and other drivers which require a 3rd party API. For all other 7.X drivers, only set the iHOPCCollector dependency.

I. Locate the ABRdrv folder. This folder is typically located in the

\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Ser vices\ABRdrv path.

II. Add RSLinx to DependOnService:REG_MULTI_SZ value.

Open Services in the Control Panel. 12.

13. Select and set the ABRdrv and iHOPCCollector Startup to automatic.

14. Configure RSLINX to run as a Service: a. Select Options from the View menu. b. c.

Select the Service Tab.

Select the Run as a Service check box.

84

Startup Procedure Overview

15. Restart your computer.

16. Verify that all services started, and that data is being collected.

Troubleshooting iFIX and Historian

Consult the following topics for troubleshooting iFIX and Historian.

Running iFIX as a service with Workspace listed in the SCU Task List

• iFIX Workspace delay when remote session is lost

Starting iFIX when a remote Historian session is unavailable

Accessing Mission Control when a remote Historian session is lost

Using the iFIX V2.6 chart with Historian domain security enabled

Accessing tags in the iFIX chart after setting OPC Collector to "Made After

Restart"

Collecting data in an iFIX chart with Time Assigned By Source

Running iFIX as a service with Workspace listed in the SCU Task

List

If you have configured iFIX to run as a service, you should not have WORKSPACE.EXE listed as a configured task in the Task Configuration dialog box of the SCU. If

WORKSPACE.EXE is listed as a configured task, it may lead to unpredictable results. For example, if you are also running Historian, no servers will appear in the Server Name field of the Configure the Historian Server dialog box and you will not be able to browse Historian tags in the iFIX Expression Editor.

To rectify this, remove WORKSPACE.EXE from the list of configured tasks in the SCU.

85

Proficy Historian Getting Started

iFIX Workspace delay when remote session is lost

If the connection between iFIX and a remote Historian session is lost, you may experience a 90 second delay in the iFIX Workspace Configuration environment, chart, or Expression Builder when accessing a pen associated with that Historian session.

In the Run Time Environment, all pens in a chart disappear for 90 seconds when the session to a remote Historian session is lost, even if they are associated with a local Historian server.

Starting iFIX when a remote Historian session is unavailable

If you are using Historian with iFIX, the iFIX Workspace attempts to connect to the Historian

Server when it starts up. If a remote Historian server is unavailable, it may take one minute or longer for iFIX Workspace to display for each unavailable server.

Accessing Mission Control when a remote Historian session is lost

If a remote Historian session is lost while you are accessing the HTC tab of Mission Control in the iFIX Workspace, the HTC tab may blank out for a minute or longer.

Using the iFIX V2.6 chart with Historian domain security enabled

If you have enabled Historian Domain Security in the Historian Administrator, you will need to download the latest iFIX v2.6 SIM to use the iFIX Chart. For more information on iFIX SIMs, refer to http://globalcare.gefanucautomation.com/downloads/sims/ or contact your local sales representative.

Accessing tags in the iFIX chart after setting OPC Collector to

"Made After Restart"

If you add tags in the Historian Administrator to a Server from an OPC Collector that has

Configuration Changes set to Made After Collector Restart, you will be able to see those tags in the iFIX Expression Builder. You can add them to a chart, for example, but they have no collected data until you manually stop and restart the OPC Collector.

86

Startup Procedure Overview

Collecting data in an iFIX chart with Time Assigned By Source

If you are retrieving data in an iFIX Chart from an Historian Server, have set the Time

Assigned by field to Source, and have collectors running behind the Server time, the chart will display a flatline up to the current time of the local machine.

Synchronizing the time on iFIX SCADA Servers and View Clients

To ensure that acknowledgements are not lost or attributed to the wrong alarm, synchronize the clocks on SCADA servers and iFIX View Client machines. If the clocks are not synchronized, alarms generated on the SCADA nodes and acknowledged on the iFIX View Client nodes could have significantly different timestamps. You can synchronize the clocks using the NET

TIME command. Refer to the Windows Help system for more information.

87

Proficy Historian Getting Started

Startup Procedure Overview

To install and start up Historian in the shortest possible time:

1. Define your system architecture.

Decide what collectors to install on which nodes, what computers to designate as the Historian Server and the Historian Administrators, whether or not they will be web-based, and how much memory and disk space you can assign to buffers and archives. Record the computer names of each node.

2. Ensure that iFIX and other data sources are installed.

3. Set up your Historian environment. (Refer to Chapter 2.)

4. If you plan to use web-based Administrators on a Windows 2000, XP Pro, or

2003 Server system, install Microsoft Internet Information Server (IIS), and install Internet Explorer 5.5 or later on web based clients. (Refer to Chapter 3.)

5. At the server node, power off the computer, plug the Hardware Key into the parallel port or USB port, and restart. (Refer to Chapter 2.)

IMPORTANT: For USB keys, skip step 5, and proceed to install the Historian product software. After installing the Historian, software then you can plug in the key.

6. At the server node, insert the Historian CD and select Historian Install. Respond to prompts, selecting Historian Server for installation. If you want other items installed on the Server, select them at the same time as the Historian Server.

NOTE: If you forget to add a component and re-run the install do not unselect previously installed components as they will be uninstalled.

7. Install collectors where needed.

88

Startup Procedure Overview

iFIX – Select the Historian iFIX Collector to collect data and/or the iFIX

AE Collector to collect alarms and events. When prompted, type in the name of the Historian server as the destination for archived data.

FIX32 – Select the Historian FIX32 Collector to collect data. When prompted, type in the name of the Historian server as the destination for archived data.

CIMPLICITY HMI – Select the CIMPLICITY HMI collector to collect data. To collect alarms & events, select the OPC AE Collector and when prompted select the CIMPLICITY OPC AE server

(CIMPLICITY.HMI.AESvr.1). When prompted, type in the name of the

Historian server as the destination for archived data.

OPC Alarms & Events – To collect data from an OPC AE server select the OPC AE collector and when prompted select the name of the OPC

AE server.

OPC Data – To collect data from an OPC v1.0/2.0 server select the

OPC Data collector and when prompted select the OPC data collector from the list provided.

Calculation – To install a calculation collector select it from the list of options and when prompted type in the name of the Historian server as the destination for the calculated values

Server-to-Server – Select the Server-to-Server collector to collect data from one Historian server (“Source”) and store it on another

(“Destination”). When prompted, type in the name of both the source and destination Historians.

OSI PI – Select the OSI PI collector to collect data from an OSI PI node and store it in the Historian. Select the OSI PI Distributor to collect data from the Historian server and store it on an OSI PI node. When prompted, type in the name of the OSI PI and Historian servers

8. Restart your computer if prompted to.

89

Proficy Historian Getting Started

If your collector services are not configured for automatic start up, manually start them.

9. At the web-based Administration client(s), run the Internet browser and enter the

URL for your server. When the Historian Administrator's main screen appears, you are ready to set up archives, collectors, and tags in the Archive Maintenance,

Collector Maintenance, and Tag Maintenance screens. Refer to the Using the

Historian Administrator manual for details.

Or, at non-web-based Administration clients, start the Administrator from the

Historian Startup Group. When the Historian Administrator's main screen appears, you are ready to set up archives, collectors, and tags in the Archive

Maintenance, Collector Maintenance, and Tag Maintenance screens. Refer to the

Using the Historian Administrator manual for details.

NOTE: Collectors will not appear in the Historian Administrator until they are started.

90

Index

A

Administrator, functions performed .........8

C calculation modes all63

Average ............................................63

Count................................................63

Maximum .........................................63

MaximumTime..................................63

Minimum ..........................................63

MinimumTime ..................................63

RawAverage......................................63

RawStandardDeviation ......................63

RawTotal ..........................................63

StandardDeviation .............................63

TimeGood .........................................63

Total .................................................63 calculation modes..................................63

D data collectors, overview .........................7 domain security backup domain controller ..................52 changing from local to domain...........52 working with..................................... 52 domain security .................................... 52

E primary domain controller ................. 52 querying group membership .............. 52 environment, setting up......................... 14

Excel add-in described ............................................ 9 installing........................................... 32

Excel add-in ......................................... 32

F

File Collector, described ......................... 8 formatting, time and date ...................... 20

H

Historian administrator, starting (nonweb) ................................................. 30

Historian software data collectors................................... 30 install Wizard.................................... 27 installing........................................... 27 installing server................................. 27 installing toolkits............................... 32 non-web-based administrators ........... 29

91

Proficy Historian Getting Started

Historian software................................. 29

I

IIS installing on Window 2000................ 25 required for ....................................... 25

IIS ........................................................ 25 installing data collectors ................................... 30

Excel add-in...................................... 32

Historian server................................. 27 software development kit................... 32 installing............................................... 32 installing Historian hardware requirements ...................... 15 memory requirements........................ 18 regional settings ................................ 19 setting up environment ...................... 14 software requirements ....................... 18 time and date formatting.................... 20 installing Historian................................ 20 internet information server (IIS), installing overview........................................... 25

Windows 2000 server........................ 25

Windows 2000 workstation ............... 25 internet information server (IIS), installing........................................... 25 interoperability ..................................... 35

K key hardware........................................... 22 installation procedure........................ 22 installing hardware key ..................... 22 key ....................................................... 22

M migration tools, described ..................... 10

O overview administrator ...................................... 8 data collectors..................................... 7

Excel add-in ....................................... 9

File Collector...................................... 8

Historian security.............................. 36 server ................................................. 8 system architecture ........................... 10 system components............................. 7 overview ................................................ 7

R requirements disk storage capacity......................... 15 hardware........................................... 15 processor speed................................. 15

RAM ................................................ 15 server specifications.......................... 15

92

software ............................................18 requirements .........................................18 retrieving data, description ....................59

S sampling modes

Calculated .........................................59

CurrentValue.....................................59

Interpolated .......................................59

Lab ...................................................59

RawByNumber..................................59

RawByTime ......................................59

Trend ................................................59 sampling modes ....................................59 security checking process ...............................56 creating a strategy..............................37 establishing your rights......................55 overview ...........................................36 protecting your process......................36 security groups ..................................38 setup example....................................45 tag level security ...............................57 security .................................................57 security groups adding users ......................................48 archive administrators........................38 audited writers...................................38

Index

collector administrators ..................... 38 creating domain security groups ........ 52 readers.............................................. 38 rights ................................................ 39 security administrators ...................... 38 setting local groups in ....................... 48 setting local groups in NT ................. 48 setting local groups in Windows

2000.............................................. 48 setting up groups............................... 47 tag administrators.............................. 38 unaudited writers............................... 38 security groups ..................................... 38 server functions performed ............................ 8 installing........................................... 27 server ................................................... 27 setting up Historian ............................... 14 software development kit, described........ 9 starting non-web Administrator ............. 30 startup procedure overview ................... 88 system architecture overview ................ 10

U upgrading ............................................. 33

W working with the iFIX Data Collector.... 77

93

94

Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement