Home

Introduction to Historian Server System

1. Point Type When to Use It Digital Use the Digital point type for points whose value can only be one of several discrete states such as ON OFF or Red Green Yellow Int16 Use the Int16 point type for points whose values are integers between 0 and 32767 15 bit unsigned integers Int32 Use the Int32 point type for points whose values are integers between 2147450880 and 2147483647 32 bit signed integers Float16 Use the Float16 point type for floating point values scaled The accuracy is one part in 32767 Float32 Use the Float32 point type for single precision floating point values not scaled IEEE floating points Float64 Use the Float64 point type for double precision floating point values not scaled IEEE floating points String Use the String point type for strings of up to 976 characters Blob Blob stands for Binary Large Object Use the Blob point type to store any type of binary data up to 976 bytes Timestamp Use the Timestamp point type for any time date in the range 1 jan 1970 to 1 Jan 2038 Universal Time UTC 5 2 4 Data Source PointSource Attribute The PointSource attribute specifies which interface is the data source for this point Set the PointSource attribute to match the point source character for the interface see What s a Point Source on page 41 The default point source is L which stands for Lab Depending on your installation the default point source is either L or Lab
2. Archive File Size MB Start Time EndTime Lifetime E DA Pkdatpiarch 002 localhost Empty 128 Current Time Current Time E DA Pkdatipiarch 003 localhost Empty 128 Current Time Current Time DA Plkdatpiarch 004 localhost Prams z os 14 Od 00 30 49 30 E DA Plkdatpiarsh 005 pefalhost Has Data 128 000 0 p localhost Archive Gap 08 Nov 04 13 33 16 08 Nov 04 13 33 46 i E D APidat piarchy001 localhost Has Data 128 23 Jan 04 123626 08 Noy O04 13331 h 30d 00 56 m i To fix an archive gap right click on the line displaying the archive gap Select Create New from the resulting pop up menu The Create New Archive dialog box appears The dialog box is already filled in for you with the right start and end times to fill the archive gap Click OK The Archive Manager plug in creates and registers the new archive and an archive gap no longer appears in the archive list Automating Archive File Creation With Factory Talk Historian 2 0 or later you can set up archive files automatically as needed This is very convenient but you need to keep a close eye on available disk space for the archives To automate archive file creation follow these steps l Make sure you have a fixed size Primary Archive automatic archive generation won t work if you have a dynamic Primary Archive The automatically generated archives will be the same size as the Primary Archive Make sure you have a valid shifta
3. The piadmin user always has read write access to all resources regardless of access settings By default the pidemo user has read only access to all objects For more information about these two accounts see What are the piadmin and pidemo User Accounts on page 49 What are the piadmin and pidemo User Accounts By default each Historian Server has two accounts Q The Administrator account called piadmin is the super user account It has permission to do anything on the Factory Talk Historian System regardless of security settings This means that you need to restrict access to the piadmin account to a very small group of trusted managers You cannot delete the piadmin account Q Demonstration account the pidemo user is the demonstration account The pidemo user has permission to look at all the data but is not allowed to make any changes Chapter 9 Managing Historian Security 9 2 5 For example the pidemo user cannot edit a point You can delete the pidemo account if you wish The default password is blank for both the piadmin and the pidemo accounts Since the piadmin account can do just about anything on the Historian Server you should choose a good password for the piadmin account and change it periodically You cannot delete the piadmin account Setting up Groups to Manage Resource Access When a user is not the owner of a particular Historian resource such as a point or database PI checks to see if the
4. Point Configuration The complete list of attributes characterizing a point Point Database The information store that contains the list of all points and their complete point configuration The list includes both typical points that have their data stored in the archive and COM connector points that have their data stored on foreign data sources The point database is hosted by the Base Subsystem Point Identifier PointID The unique number used to identify a point This is primarily meant for internal use within the Historian Server but it is often needed in API SDK programming and troubleshooting scenarios Point identifiers are assigned sequentially as points are created and they are not reused if points are deleted The base attribute PointID stores a point s assigned number after creation Point Security Access control for a point which consists of specifying an owner and a group and the respective read write permissions Each point has one security specification for controlling access to its attribute configuration and a second separate security specification for controlling access to its archive data The base attribute PtAccess holds the security specification for configuration and the base attribute DataAccess holds the security specification for archive data Glossary of Terms PointType The base attribute that specifies the data type for the values that a point stores The possible point types include the f
5. Archive Subsystem The core Historian Server component that is responsible for writing data to reading data from and otherwise managing the complete data archive The Archive Subsystem is very tightly coupled with the Snapshot Subsystem which is actually responsible for performing compression on the incoming data Argument Command Line User input specified after the name of a program to control or modify the behavior of that program in some fashion A command line argument must typically be separated from the program name and other command line arguments by at least one space Depending on the program command line arguments must typically be prefixed by a hyphen or a slash Several of the diagnostic utility programs that are distributed with the Historian Server like piartool and pidiag will require the use of one or more command line arguments Attribute Point A characteristic or parameter of a point that directs an interface and the Historian Server in the collection and processing of data values for that point Page 74 Glossary of Terms Attribute Set A named collection of attributes One or more attribute sets are used to define point classes to establish the complete list of attributes that can specified when creating or modifying a point of that class Base Point Class The common set of point attributes that all other point classes include The Base class includes both system and user assign
6. File Tools Help ping strider gi AH Pi You can select more than one server at a time Interface Configuration Utility ICU The Interface Configuration Utility ICU is a tool that makes it easy to configure and manage your Historian interfaces Install the ICU on each of your Interface Nodes How to Install the ICU 1 On the Products menu point to Interfaces and click on Historian Interface Configuration Utility 2 On the right side of the page under Docs and Downloads left click on Install Kits At this point you might need to log into the Web site if you haven t already 3 Click the Download button for the Historian Interface Configuration Utility ICU install kit 4 After downloading the install kit double click the Setup executable to install the ICU How to Run the ICU The ICU is a point and click tool for configuring interfaces You can only run it directly on the Interface Node where the interface is installed To run the ICU go to the Interface Node and on the Windows Start menu point to Programs point to FactoryTalk Historian System and then click Historian Interface Configuration Utility The first time you run the ICU on an Interface Node you need to register each interface Also make sure that the interface supports the ICU utility See Configuring Interfaces on page 43 Page 6 3 1 Getting and Using the Tools You Need 3 1 3 Using Other Historian Tools In addition to SM
7. From the above picture you can tell the following E E The destination of the files for the backup operation is e PNbackup The number of Archives to be backed up is 1 That is only the primary archive will be backed up The scheduled task will run the e PNadmYpibackuptask bat command file The pibackuptask bat in turn launches the e PNadmlYpibackup bat command file The backup task will be run under the System account 7 5 Checking the Message Logs There are several places to look for messages related to backup l 2 You can search the PI Message Log for messages related to backup with the following command pi adm pigetmsg st t et pn pibacku The above command will search for backup related messages from midnight until current time Chapter 7 Managing Backups 3 The output of the pibackup bat script is written to a log file The destination of this log file is the same as the destination of the backup and the name of the log file is of the form pibackup dd mmm yy hh mm ss txt 4 The NTBackup log file VSS Backups only If there was a problem creating a VSS shadow copy during a backup the reason for the failure will be logged at the beginning of the NTBackup log file 5 If the Run As user for the PI Server Backup scheduled task is the same as your account then you will be able to view the NTBackup log from the Tools I Report menu of NTBackup Launch NTBackup from a DOS command pr
8. INTEGRATED PRODUCTION amp PERFORMANGE SUITE LISTEN THINK SOLVE INTRODUCTION TO HISTORIAN SYSTEM MANAGEMENT PUBLICATION HSEPISM GR021A EN E March 2009 Supersedes Publication HSEPISM GR020A EN E Rockwell Allen Bradley Rockwell Software Automation Contact Rockwell Automation Customer Support Telephone 1 440 646 3434 Online Support http support rockwellautomation com Copyright Notice O 2008 Rockwell Automation Technologies Inc All rights reserved Printed in USA 2007 OSISoft Inc All rights reserved This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation Technologies Inc Any reproduction and or distribution without prior written consent from Rockwell Automation Technologies Inc is strictly prohibited Please refer to the license agreement for details Trademark Notices Factory Talk Rockwell Automation Rockwell Software the Rockwell Software logo are registered trademarks of Rockwell Automation Inc The following logos and products are trademarks of Rockwell Automation Inc Factory Talk Historian Site Edition SE Factory Talk Services Platform and Factory Talk Live Data The following logos and products are trademarks of OSIsoft Inc PI System Other Trademarks ActiveX Microsoft Visual Basic Windows 98 Windows NT Windows 2000 and Windows XP are either registered trademarks or trademarks of Microsoft Corporation in the United States and
9. Tools Utilities Three Point Database attributes affect compression CompDev CompMin and CompMax These are known as the compression specifications Processes Scripts Variables Arguments Switches Options Parameters Attributes Values Properties Methods Events Functions Procedures and Key Commands On the Tools menu click Advanced Options Press CTRL ALT DELETE to reboot Interface components Click Tools gt Tag Search to open the Tag Search Menus Menu Items tool Icons Buttons Tabs Click the Advanced Search tab Monospace Consolas monospace is used for To list current Snapshot information every 5 seconds type Code examples use the piartool ss command For example Consolas Commands to be typed on the l piartool ss Counters for 7 Aug 05 14 35 56 Point Count 10033 font command line optionally with arguments or switches System input or output such as Snapshot Events 1228011 excerpts from log files and other Out of Order Snapshot Events 139 data displayed in ASCII text Snapshot Event Reads 392 Events Sent to Queue 771952 Bold consolas is used in the Primary Capacity Remaining 2540349 context of a paragraph Light Blue Links to URL Web sites http www rockwellautomation com support Underlined Page iv Preface Using this Guide Related Documentation Rockwell Automation provides a full range of documentation to help yo
10. present this parameter defines the path and file name pretit to be used for new archives Or Cancel Apply 2h 10 Click OK If there is not enough disk space to create the new archives Historian overwrites data in the old archives You can find more information about automatic archive file creation in the Historian Server System Management Guide Chapter7 MANAGING BACKUPS It s important to back up the Historian Server daily so that you don t lose data and configuration information On a Historian Server that is already correctly configured to back itself up automatically all you need to do is check your backups periodically and check that you have enough disk space available for upcoming scheduled backups Q About Historian Server Backups Q Choosing a Backup Strategy LY Checking Whether Backups are Scheduled Q Setting up Automatic Backups 7 1 About Historian Server Backups All backups of Historian that are done while the FactoryTalk Historian System is running are managed by the Historian Backup Subsystem PNNbin pibackup exe Typically the backups are launched via the PAadm pibackup bat backup script However if Historian is installed on Windows 2003 Server you can backup Historian with any third party backup application that supports Volume Shadow Copy Services VSS This chapter only discusses backups with the backup script Note If you don t have buffering turned on for all interfaces you might los
11. 1 systems For more information see About the Historian ServerHistorian Server on page 11 Q Clients Operators engineers managers and other plant personnel use a variety of client applications to connect to the Historian Server to view plant data For more information see About Client Applications on page 16 About Historian Interface Nodes Rockwell Automation provides specialized interface programs interfaces for each data source These interfaces typically run on a dedicated system called an Interface Node which connects both to the data sources and to the Historian Server For historical reasons Interface Nodes are also sometimes referred to as API Nodes or Data Source Nodes Interface Nodes can run multiple interfaces to multiple Historian Servers The Interface Node might be a machine that is a part of the foreign data system or a stand alone dedicated interface machine or even a Historian Server itself Historian to Historian Q Data Flow on the Interface Nodes Q About Buffering Data Flow on the Interface Nodes The Historian Server stores data in the form of events Each event has a value and a timestamp that tells you what time the value was collected The interfaces collect data from the data sources and typically use exception reporting meaning that they pass significant events on to the Historian Server and discard the rest If the buffering service Managing Buffering on page 63 is configured on the interface no
12. Archive Manager plug in Q About Archives Finding the Archive Files Making Sure PI Doesn t Overwrite Your Archives Creating an Archive Registering an Archive Unregistering an Archive Moving an Archive Fixing Archive Gaps Ooovoovovovo vo Automating Archive File Creation 6 1 About Archives The FactoryTalk Historian System stores your data in archives Typically archives are files of a fixed size that can hold Historian data Fixed archives allocate the full amount of space upfront meaning that an empty archive and a full archive take the same amount of disk space The archive receiving current data is called the Primary Archive When the Primary Archive becomes full an Archive Shift occurs and the next available archive becomes the new Primary Archive Note Historian actually performs the archive shift before the Primary Archive is completely full so that older data can be added later if necessary Introduction to Historian Server System Management Page 25 Chapter 6 Managing Archives Primary Archive piarch 003 When piarch 003 fills this archive will become the Empty Archive piarch 004 Primary Archive Filled Archive piarch 002 Filled Archive piarch 001 For an archive file to be eligible to be the new Primary Archive it must be registered Registering an Archive on page 28 writeable shiftable and large enough to handle the current size of the Point Database
13. Data 128 23rJan Dd 12 36 26 E DA Pk datpiarcsh 002 localhost Empty 128 Current Time pendalpinehogg Current Time Ci a 5 The Create New Archive dialog box appears Name the new archive file and choose the Clone the primary archive fixed size radio button 6 If you want to choose a different size for the archive you need to understand the issues in archive sizing Read the chapter on managing archives in the Historian Server System Management Guide 7 Click the OK button The Archive Manager plug in creates and registers the archive Registering an Archive In order for the Historian Server to recognize a file as an archive file you must register it By registering an archive file you tell the Historian Server that the file exists and that is an archive file The Historian Server cannot access data in unregistered archives nor can the Historian client applications Page 28 6 6 Unregistering an Archive The SMT Archive Manager plug in provides an easy interface for registering archives To register an archive follow these steps I Run SMT and select the Historian Server on which you want to view the archives How to Run SMT on page 5 2 Click to expand the Operation item in the System Management Plug ins pane System Management Plug Ins Analysis Framework Points Se U peration ArchiviiM anager Message Log Viewer T Module Database Editor Network Manager Statistics Server Process
14. Historian Server consists of several modules including a set of core subsystems To check whether the Historian Server is running you simply check that the core subsystems are running Core Subsystem What It Does Archive subsystem The Historian Archive subsystem stores and serves the data after it comes out of the Snapshot subsystem Backup subsystem The Historian Backup subsystem controls the backup of the Historian Server Base subsystem The Base subsystem maintains the point configuration data This subsystem also hosts the Module Database Page 12 4 2 About the Historian Server Core Subsystem What lt Does PI License Manager The PI License Manager maintains licensing information for the Historian Server and all connected applications Message subsystem The Message subsystem records status and error messages for the Historian Server in a log file PI Network Manager The PI Network Manager provides the connection between all the subsystems in the Server This subsystem also manages network connections between the FactoryTalk Historian System and client applications Shutdown subsystem Determines when the Historian Server was stopped and writes shutdown events to points configured to receive these events runs only at startup and then stops on non Clustered Historian Servers Snapshot subsystem The Snapshot subsystem stores the most recent event f
15. Nodes get the data from your data sources and send it to the Historian Server Users get data from the Historian Server and display it with client tools for example ProcessBook DataLink or RtWebParts ss LL Data Source Interface Node Data Source Thin Clients Overview of FactoryTalk Historian System Data Flow Q Data Sources Your data sources are the instruments that generate your data They can be almost anything and they can connect to the Interface Nodes in a variety of different ways Historian s Performance Equations ACE and Totalizer are also all data sources See Managing Data Source Equipment on page 71 for more information about Data Sources Q Interface Nodes Interface Nodes run Historian interfaces Historian interfaces get the data from the data sources and send it to the Historian Server Each different data source needs a Historian interface that can interpret it OSIsoft has over 300 different interfaces For more information see About Historian Interface NodesHistorian Interface on page 10 and Managing Interfaces on page 41 Q Historian Server The Historian Server stores the Historian data and acts as a data server for Microsoft Windows based client applications You can also use the Historian Server to interact with data that is not stored in Historian external Introduction to Historian Server System Management Page 9 Chapter 4 Introduction to the Factory Talk Historian System 4
16. Service Configuration hen Startup Type Service name piperfmon basic amp Auto Display name Pl piperfmon basict Manual Disabled Installed service Dependencies bufsery Alerter ALG 4 Apodam aspnet state 13 Click the Start the Interface arrow button at the top of the ICU This starts the interface Page 62 Chapter 11 MANAGING BUFFERING If you are not currently using the buffering service on your Interface Nodes refer to Configuring Interfaces for Buffering on page 45 Once it s running buffering typically takes care of itself Q About Buffering Q Checking whether the Buffering Service Is Running Q Testing the Buffering Service Q Ifthe Buffering Service Isn t Working Q Starting the Buffering Service 11 1 About Buffering Rockwell Automation provides a buffering service that can save your data if the Interface Node loses its connection to the Historian Server When an Interface Node is running the buffering service bufserv data flows from the data source through the interface to the buffering service and from there to the Snapshot Subsystem on the Historian Server TEL Data Source Interface PI Saray Node Data Flow with Buffering If the Historian Server is not available e g for an upgrade on the Server then bufserv stores the data in a file buffer on the Interface Node When the Historian Server becomes available again bufserv sends all the stored data from the
17. Subsystem with a timestamp that is older than the current Snapshot value The Historian Server sends out of order events directly to the Event Queue for archiving without compression testing What is Compression Testing The Archive Subsystem uses compression testing to determine what events need to be saved in the Archive The point of compression testing is to store just enough data to accurately reproduce the original signal Page 14 4 2 About the Historian Server 4 2 8 For example in the following illustration all the events fall on the same straight line In simple case like this you don t actually need to store all the points on the line If you store just two points you can exactly recreate the point value for any other time eng units The same principle applies to compressing real world data The Historian Server uses a sophisticated compression algorithm to determine which events it needs to keep in order to provide an accurate data history The CompDev CompMin and CompMax attributes allow you to control the granularity of the compression algorithm Q The CompMin and CompMax attributes give you some control over how often the Historian Server should save a new value for a particular point Q CompDev and CompDevPercent allow you to decide how much a point s value needs to change in order for Historian to save it For details on setting compression testing attributes see Compression Specification
18. basic version of the interface is included with the Historian Server Pipeschd bat The script file containing the startup configuration for the Performance Equation Scheduler PIPOINT Table A synonym for Point Database In piconfig the table that provides access to the Point Database Pishutev The executable or process name that implements the Shutdown Subsystem Pisnapss The executable or process name that implements the Snapshot Subsystem Pisqlss The executable or process name that implements the SQL Subsystem Page 86 Glossary of Terms Piupdmgr The executable or process name that implements Update Manager Point A variable whose value is measurable and typically dynamic Examples include transmitter readings status indicators manual inputs control limits etc Each point must be assigned a unique tag on the Historian Server and measurements of the point captured over time are effectively stored as an array of timestamped values in the data archive Point Class A collection of one or more attribute sets Examples of point classes include Base Classic Alarm and Totalizer All point classes include all the attributes from the Base class which has a core set of attributes needed by various processes in the FactoryTalk Historian System Other point classes add attributes needed to provide functionality for certain processes The base attribute PtClassName specifies the point class for every point
19. can view the item and they are also allowed to edit it No access Users cannot view or edit the item What are PI Access Categories PI grants access to certain resources databases point data and point attributes based on user access category There are three categories of user access in PI owner group and world For each Historian resource you can configure the permissions for each user category PI grants resource access based on whether a user is the Owner of the item being accessed a member of its Group or neither Each resource has one Owner and one associated Group Page 48 9 2 Managing Users and Groups 9 2 4 everyone else Resource owner PI Resource hh _ C Resource group Category Description Owner Each resource has one and only one owner The owner is always a single user not a group Owner access is usually read write but it doesn t have to be Group Each resource has one and only one associated group Group access is often read only but it doesn t have to be Since each resource has only one associated group you sometimes need to create additional groups to give access to all the users who need it Setting up Groups to Manage Resource Access on page 50 World The World category is where you set the permissions for users that are not the owner and not in the associated group By default world access is none but it doesn t have to be
20. create shared memory buffers you re probably trying to run the buffering service under an account that does not have administrative privileges Follow the instructions in Starting the Buffering Service on page 68 11 5 Starting the Buffering Service These instructions assume that you are starting the buffering service on an Interface Node that is configured for buffering Managing Buffering on page 63 and that the following items are installed on the Interface Node E E E E The interface software for the interface s you want to buffer Historian Interface Configuration Utility ICU Historian API this is installed with the interface software Historian SDK this is installed with the ICU To start the buffering service on an Interface Node follow these steps l From the Windows Start menu on the Interface Node point to Programs point to FactoryTalk Historian System and then click PI Interface Configuration Utility The ICU appears Select an interface from the Interface pull down menu If the interface you want does not appear in the Interface pull down menu then you need to register that interface with the ICU Configuring Interfaces on page 43 Page 68 11 5 Starting the Buffering Service Zu Pl Interface Configuration Utility Interface Tools Help Interlace Ee pipeschd gt localhost BethPing localhost be vralsinsspectruml gt tri Vralsinsspectrumd gt trnit 3 On the Tools m
21. following three attributes to configure the exception reporting specifications Specification Attribute How and When to Use it Exception Deviation ExcDev Use this attribute to specify how much a point value must change before the interface reports the new value to Historian Use ExcDev to specify the exception deviation in the point s engineering units As a general rule you should set the exception slightly smaller than the precision of the instrument system ExcDevPercent You can use ExcDevPercent instead of ExcDev ExcDevPercent sets the exception deviation as a percentage of the Span attribute but be careful If your Span attribute is not set correctly your exception reporting will be wrong too A typical exception deviation value is about 1 of Span Exception Minimum ExcMin Use ExcMin to limit how often in seconds the interface reports a new event to Historian For example if you set ExcMin to five then the interface discards any values collected within five seconds of the last reported value ExcMin is typically set to zero Exception Maximum ExcMax Set ExcMax to the maximum length of time in seconds you want the interface to go without reporting a new event Page 20 5 2 About Point Attributes 5 2 8 Specification Attribute How and When to Use it to Historian After this time the interface will report the new event to Histori
22. for a point Certain characters are not allowed like V and The term Tag and Point are often used interchangeably Tag Configurator An SDK based Add In to Excel that facilitates creating editing and viewing points from a spreadsheet This is the ideal application for bulk point operations Timeout Table The information store that contains all the configuration parameters for the Historian Server When tuning the performance of the Historian Server several of these Timeout Table parameters will typically need to be adjusted Timestamp A date and time almost always associated with a data value through an Event The Historian Server stores timestamps internally in UTC Universal Coordinated Time Timestamp Point Type The point type used to store values that are timestamps The possible range of timestamps that can be stored is 1 Jan 1970 through 1 Jan 2038 Totalizer Subsystem The component of the Historian Server that can be used to continuously calculate a variety of quantities like totals averages minimum and maximum values and standard deviations Trust A record stored on the Historian Server that automatically grants access for a program connecting to the Historian Server without requiring an explicit Historian user login A trust consists of one or more Connection Credentials criteria and the name of an existing Historian user to be used for access All trusts are stored in the Trust Table w
23. pibasess PiService localhost I DAHL pimeget 19584 pimeget PiService local MAP Aer ar ow PIService l 8 For each APIBE row in the table look under the PeerName column to find the hostname for the Interface Node associated with that particular buffering service The IP address 1s also listed under the PeerAddress column localhost 32 DAPI APIBE i InterfaceNodel 19 localhost 46 DAPI ARIE t InterfaceNodez 198 localhost 59 DAR APIBE gt nterfaceNode3 192 160 localhost 82 DAPL APRE gt IntetaceNoded 12180 loralhostele DAPL piafsemer ese EN tt pialarm i ehg 9 Interface Nodes that do not have an APIBE application associated with them are not running the buffering service 10 Start the buffering service on all Interface Nodes where it is not running Starting the Buffering Service on page 68 Note If you are looking for a particular Interface Node among many click the PeerName heading to sort the table by host name 11 3 Testing the Buffering Service The only way to actually test whether the buffering service is working is to interrupt the connection between the Historian Server and the Interface Node for a period of time and then after restoring the connection check to see whether you have data Chapter 11 Managing Buffering 11 3 1 11 3 2 When should I test the buffering service The best time to check the buffering service is when you re shutting down the Historian Server a
24. setting of one work shift for example 8 hours To learn more about how Historian calculates compression see the Historian Server Reference Guide Note For Digital Blob or String points only the compression maximum and minimum times are important Historian ignores the compression deviation specification for them Point Value Range Zero Span and Typical Value The Zero Span and Typical Value attributes specify the range of values for a point Zero Indicates a point s lowest possible value Zero does not have to be the same as the instrument zero but that is usually a logical choice This attribute is required for all numeric data type points and is critically important for float16 points Span The difference between the top of the range and the bottom of the range This attribute is required for all numeric data type points Typical Value Documents an example of a reasonable value for this point For a numeric tag it must be greater than or equal to the zero and less than or equal to the zero plus the span Configuring Shutdown Events Shutdown The Shutdown attribute has two possible values 1 On and 0 Off If the Historian Server shuts down Historian writes a shutdown event to all points that have the shutdown flag set to 1 On Set Shutdown to Off for points on interfaces that are buffered See Managing Buffering on page 63 The buffering service restores the data for these
25. tags as soon as it connects to the Historian Server again Point Security PtOwner PtGroup PtAccess DataOwner DataGroup DataAccess Each point has different configurable access privileges for its data and its point configuration To control who has access to what you assign an owner and a group for each point s data and attributes respectively Then you set owner group and world privileges Read What are PI Access Categories on page 48 to learn how this works Historian point security is divided into two separate pieces Data Access and Point Access Page 22 5 3 Creating New Points Data Access Specifies who has access to a point s data values Snapshot and Archive data Point Access Specifies who has access to the point s attributes Zero Span Descriptor and so on You can have different owners and different group access for a point s attributes than for the point s data So for example one user might be allowed to edit the data for a point but not be allowed to edit the attributes of that point Note If users don t have permission to view a point s attributes they won t be able to see that point s data either in most cases This is because client applications need access to the point attributes in order to get the data To edit the owner group and permissions for a point select the point in SMT s Point Builder and click the Security tab General Classic Archive Other
26. with the SMT SQC Alarms plug in that provides equivalent functionality SQL Subsystem The component of the Historian Server that prepares and executes Structured Query Language statements directed against it from mainly ODBC and SDK applications The existence of the SQL Subsystem allows clients to access Historian Server information stores like the Data Archive and Point Database using the same SQL syntax used to interact with relational databases State Set A synonym for Digital State Set or DigitalSet Statement Handle An object allocated by the SQL Subsystem to enable servicing of a SQL request or Statement Glossary of Terms Status The classification of an Event depending on the nature of its value If the event has a valid value considering the type of point then the event is considered to have a Good status If the event has a SYSTEM digital state as a value then the event is considered to have a Bad status Steam Functions A set of built in functions available within a Performance Equation that calculate the thermodynamic properties of steam Step The base attribute that specifies how to interpolate between successive archive events If Step 1s non zero the value is assumed to change in a stepwise or staircase fashion String Point Type The point type used for storing strings sequences of alphanumeric characters up to 976 characters in length Subnet A networking term that refers to a range of nume
27. 1 8 1 2 What s an Interface ID Number rrrnnnnnnnrnrvnnnnnnnnevnvnnnnrvnnnnnnnnsennrnnnnnsennrnnnsnsennnnn 42 MSN vr 42 02 Coniguning WOT ACCS susino a aa aaa a aai 43 8 3 Starting and Stopping Interfaces xxnennnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnr 44 8 4 Monitoring Interface Performance nnxrrnnnnvennnnnuvnnnnnuvennnnnvennnnnvennnnnevnnnnnvennnnnvennnnnvevnnnnner 44 8 4 1 Checking IORates and Performance POintS rrrrrrrrnnnnnnnnnrrrrvrrnnrrnnnnrrrsrernnnnnnnnn 44 842 ENN NE 44 8 5 Configuring Interfaces for Buffering rxxrnrnnnnnnnnnnnnnnnnnnnnnnnnnvennnnnnnnnnnnennnnnnnnnnnnnnennnnnnnn 45 8 6 Where to Go for More Information on Interfaces xrrrnnnnnnvvnnnnnnnnnennnnnnnnnennnnnnnvennnnnnnr 45 Chapter 9 Managing Historian Security rrernnnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnvennnnnnnnnnnnnnennnnnnnnnnnnr 47 gT DU PSN orice siecle eecie cree ice E AE tien EER E ESEESE 47 9 2 Managing Users and GroupsS sannnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnnnnnnnnnvennnnnnnnnne 47 9 2 1 About Users and Groups cccccccseeeeeccceeeeceseeseeceeeeeeeeeseeceeeeessseaeeeeeeeessaaeeeeeeees 48 9 2 2 What are Access Permissions rrrrrnnnrrnnnnnnerrnnnnrrnnnnrennnnnnennnnnnrennnnnsennnnnnennnnnsene 48 9 2 3 What are PI Access Categories rrrrrnnnrnrnrrrvrrrnnnnnnnrvrnnrrnnnnnnsrnnnnrrnnnnnnnsrennnrnnnnnn 48 9 2 4 What are the piadmin and
28. 12 bit A D converter can never be more precise than 1 part in 4096 Q The ExcMax attribute sets a limit on how long the interface can go without reporting a value to PI After the ExcMax time period the interface sends the next new value to Historian regardless of whether the new value is different from the last reported value Q The ExcMin attribute sets a limit on how frequently the interface can report values For example if you want the interface to wait a full ten minutes before reporting a new value to the Historian Server then you would set the ExcMin attribute to ten minutes For details on setting exception reporting attributes see Exception Specifications on page 20 Some interfaces do not support exception reporting See the documentation for your interface to determine whether it supports this capability 4 2 About the Historian Server The Historian Server is the heart of your FactoryTalk Historian System It gets the data and routes it in real time throughout the FactoryTalk Historian System and your entire information infrastructure making it possible for everyone to work from a common set of real data Operators engineers managers and other plant personnel can connect to the Historian Server and view manufacturing data from Historian Data Storage or from external data storage systems Q What s in the PI Directory Chapter 4 Introduction to the Factory Talk Historian System U File System Dos and Don ts Q Che
29. 43 Start and stop the interface directly on the Interface Node 1 From the Windows Start menu on the Interface Node open the Control Panel and then open Administrative Tools 2 Inthe Administrative Tools folder double click on Services 3 In the Services window find the interface that you want to start or stop In the Windows Services panel Historian interface services are listed with the PI prefix For example the buffering service is listed as PI Buffer Server 4 Right click on the interface service select either Start or Stop from the resulting pop up menu 8 4 Monitoring Interface Performance There are two main ways to check how your interfaces are working Q Checking IORates and Performance Points Q Checking Log Files 8 4 1 Checking IORates and Performance Points Create a FactoryTalk Historian ProcessBook display that shows the IOrates and performance points for each interface Some interfaces do not have performance points so for these interfaces you rely on IORates points alone Type of Point What it Does lORates point Monitors the flow of data from an interface Every 10 minutes each IOrates point registers the 10 minute average data transfer rate to PI in events second Performance Reads the value in seconds that it takes the interface to complete one round Point of data collection for a set of points You can create one performance point for each scan class of each interface You c
30. Class of Point PtClass Attribute rrrrrrnnnnrrnrrrrrrrrnnnnnnnrrrrrrnnnnnnnsrenvrrnnnnnnnnssennnnnnnn 18 5 2 3 Data Type of Point PointType Attribute rrrrrrrrrrnnrrorrnnrrrrnnnrrrvnnnnrrnrnnrrernnnnrnnnnn 19 5 2 4 Data Source PointSource Attribute rrrrrrrrrrnnnnnrnrrrrrnnnnnnrnrvrrnrrnnnnnnnrrrnnnrnnnnnnnee 19 5 2 5 Interface ID Number Location1 Attribute rrrrnnrrrrrrrnnnrrrrrnnnnrrrrrrnnnnrrernrnnnenrennnnn 20 5 2 6 Setting Scan Class Location4 Attribute rrrrrrrrrnnnrrrrrrrrrnnnnnrrrrrrrrrrnnnnnnnnrrnrnnnnnn 20 5 2 7 Exception Specifications cccccccecccccccceccceeesseeecceeeeeeeeeseeeeeeeessseesseeeeeeeessaaageeeeess 20 528 Compression Specifications uavvvveavravdes ende a a a T a 21 5 2 9 Point Value Range Zero Span and Typical Value rrrrrrnnnrrrrnrnnnnrrernnnnrnvennnnnn 22 5 2 10 Configuring Shutdown Events Shutdown evnnnnnnnnnvvvvnnnnnnnnnrrrvvnvrnnnnnrrrrrrnnrnnnnn 22 5 2 11 Point Security PtOwner PtGroup PtAccess DataOwner DataGroup BE EL SJ A E E E E 22 5 3 Creating NEA PONS Lese 23 54 Finding Malfunctioning Points uuasseessmesddnvnndreddebmed dnae 23 5 5 DECOMMISSIONING Points a AE A EEEE 24 50 Deleng PONIS seisoa a A 24 Chapter 6 Managing Archives uuuuuasanuismeummmseumumjimvumvmvuvesunihunnvidsne 25 ol POT TNS eee 25 6 2 Finding the Archive FIGS vag sanert ee auemetsaddmnaemeninnesudsdeanendendse 26 6 3 Making Sure Historian Doesn t Overwrite
31. Database Security Editor Q About Databases Q Managing Databases with SMT About Databases The Historian Server includes several databases that store PI configuration information and process data The two main databases are the Point Database also called the Point Configuration and the Data Archive usually called simply the Archive Database security is similar to point security in that you can set Owner Group and World permissions for most PI databases Users need read access to be able to read information within a database Users need to have write access in the database to be able to create an item For example write access to the point database allows you to create a point You can configure security for the following PI Databases by setting Owner Group and World permissions see What are PI Access Categories on page 48 Database What it Stores PI Batch Database PIBatch Database for PI Batch objects PI Digital State Table PIDS Contains the digital state sets PI Heading Sets Database Stores the heading sets for the Module Database PlHeadingSets Module Database PIModules Stores and maintains all the data objects associated with the Module Database including PIModules PlHeadingSets and PlHeadings Historian Point Database PIPOINT Contains the list of points that are either recorded in the Data Archive or mapped to points in foreign data systems PI Transfer Record Database Stores the tran
32. If no eligible archives are available for an Archive Shift Historian uses the oldest available filled archive as the new Primary Archive overwriting the data in the old archive For example in the preceding illustration after the shift from piarch 003 to piarch 004 no empty registered archives are left If no new archives are created then piarch 001 becomes the next Primary Archive It takes Historian a few minutes to complete an Archive Shift During that time you are not allowed to add edit or delete points Historian stores incoming data in the Event Queue until the shift is complete and then writes the queued events into the new Primary Archive Note Archives that can grow in size to accept variable amounts of data are called dynamic archives Dynamic archives are not discussed in this document See the Historian Server System Management Guide for details 6 2 Finding the Archive Files By default the archives are placed in the PNdat directory but you can put them anywhere you like The Archive Manager lists the location of each registered archive file 1 Run SMT and select the Historian Server on which you want to view the archives How to Run SMT on page 5 2 Click to expand the Operation item in the System Management Plug ins pane Page 26 6 3 Making Sure Historian Doesn t Overwrite Your Archives System Management Plug Ins Analysis Framework Points Message Log Viewer Module Database Edito
33. Manager Timeout Table Editor FI Version Intertaces Data FT curity 3 From the list of Operation plug ins double click on Archive Manager The Archive Manager plug in appears in the Active Plug in pane It lists all the archives registered on the selected server Unregistered archive files do not appear in the list 4 Click the Register an Archive icon to register the archive t Pl System Management Tools Active Plug In Archive Manager File Tools Help Pl Servers y localhost ping strider trinity OP dat piarch 006 localhost Primary 128 08 Nov 04 13 33 46 Cure DSP datpiarch 00E localhost Has Data 128 08 Nov 04 13 33 16 O8 No E DAPKdatplarch 001 localhost Has Data 128 aan 04 12 36 26 08 E DP dat piarch O02 localhost A 128 D APIkdatipiarch 003 localhost Current Time Current Time en 5 A file browsing window appears Double click on the archive file you want to register The Archive Manager plug in registers the file and it appears in the list of registered archive files 6 6 Unregistering an Archive If you want to move or reprocess an archive file you need to unregister it make your changes and then re register it You cannot unregister the primary archive The SMT Archive Manager plug in provides an easy interface for unregistering archives To register an archive follow these steps Chapter 6 Managing Archives I Run SMT a
34. ORMANCE As System Manager you should check regularly on how Historian is performing By creating Historian performance points called PIPerfmon points and trending them in a ProcessBook display you can see how a system is doing at a glance Q About FactoryTalk Historian System Performance Monitoring Which Performance Counters to Monitor Building Performance Monitor Points Trending Performance Points Performance Monitoring Kit Historian 2 0 and Later 0D OODD Configuring the PIPerfmon Interface Note Historian performance points PIPerfmon points are different from interface performance points which are discussed in Monitoring Intertace Performance on page 44 10 1 About FactoryTalk Historian System Performance Monitoring One important way to monitor your Factory Talk Historian System s performance is to record key performance counters Performance counters can provide important insights into a number of performance management problems including memory disk and process management problems Historian gets performance counter data through the Historian Performance Monitor interface PIPerfmon PIPerfmon reads the Historian point database to determine which performance counters to monitor It then scans for the performance counter and sends exception reports to the Historian system There are two versions of the PIPerfmon interface full and basic The Historian Server comes with the basic version which is just like th
35. Security System Data Access Point Access Data owner piadmin Point owner piadmin v Data group piuser v Paint group piadmin v Permissions Permissions Owner Owner Reads tite Reads tite Group Group Read Only v Read Only v World World None Mone v 5 3 Creating New Points As a Factory Talk Historian System Manager you might need to create a new Historian Point The easiest way to create a new tag is to copy an existing tag that 1s very similar to the tag you want to create then you can just edit the Tag attribute and any other attributes that you want to change SMT s Point Builder provides an easy interface for editing and creating Historian points If you re very familiar with Excel you will probably find the Excel plug in TagConfigurator a better tool to use If you want to create more than one point at the same time use TagConfigurator 5 4 Finding Malfunctioning Points At least once a month you should use SMT s Historian Stale and Bad Tags plug in to search for stale and or bad points This plug in identifies points that have not received data for a long time or that have current values representing error conditions such as I O timeout Pt Created bad input or in many cases Shutdown Also check any flat lined or stuck points Chapter 5 Managing Historian Points When you find points that are no longer useful points that represent dat
36. T and the ICU Rockwell Automation provides many other tools that are useful to System Managers The most current tools are always available by downloading the latest version of Factory Talk Historian from Rockwell s technical support website Here are a few that are good to know about E E E TagConfigurator An Excel plug in that allows you to create new tags and modify the attributes of existing tags from a spreadsheet Module Database Builder An Excel plug in that allows you to view and modify items from the Module Database in an Excel spreadsheet Historian SQC Alarm Manager Used to manage the Real Time SQC Alarms on Historian Servers 3 1 4 Using the Windows Command Interpreter As a FactoryTalk Historian System Manager you sometimes need to use one of PI s command line utilities To do this you need to open a Windows command prompt window l 2 On the Windows Start menu click Run The Windows Run dialog box appears In the Open text field type cmd Click OK A Windows command prompt window appears Use the cd command to change to the directory that contains the PI utility For example to change to the P adm directory on the D drive you would type cd D D PI adm Chapter4 INTRODUCTION TO THE FACTORYTALK HISTORIAN SYSTEM The Factory Talk Historian System collects stores and manages data from your plant or process You connect your data sources to one or more Historian Interface Nodes The Interface
37. Use L or Lab for points that are not associated with any interface to specify lab input points Chapter 5 Managing Historian Points 5 2 5 5 2 6 5 2 7 Interface ID Number Location1 Attribute The Location1 attribute is only for interface points meaning points that get their data from a Historian interface as opposed to some other source Most interfaces use the Location1 attribute to specify the interface ID number described in What s an Interface ID Number on page 42 Setting Scan Class Location4 Attribute The Location4 attribute is only for interface points meaning points that get their data from a Historian interface as opposed to some other source Each Historian interface has one or more scan classes for scheduling data collection See What s a Scan Class on page 42 You set the Location4 attribute for a point to specify which of the interface s scan classes you want to use Note Most interfaces require you to use the Location4 attribute to set the scan class however there are exceptions particularly among older interfaces Also some interfaces get data on command rather than scanning Always check the documentation for the interface Exception Specifications Exception reporting specifications determine which events the interface sends to Historian and which it discards To learn more about exception reporting refer to What is Exception Reporting on page 10 Each point can set the
38. Your Archives rnrnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnn 27 64 Cr atino elas do ve 27 6 5 Registering an FANG INIVG sssini ai E A AEREE 28 66 Unregistering an ATCNIVE sssusa 29 or M ving NAN assia ee 30 69 FIXING Archive Gaps ce E N EE a 31 6 9 Automating Archive File Creation annnnxxnnnnnnnnnnnnnnnnnnnnnnnnnnnnnvennnnnnnnnnnnnnennnnnnnnnnnnennnnnnnn 32 Chapter 7 Managing Backups muuerasmmmmememmnilnsinnmmnssemelikdrmvesnoenmvevnosdssvann 35 Page x Table of Contents 7 1 About Historian Server Backups vauuavsmmassimseinnnammmnn evnet 35 7 2 CHOOSING a Backup Staleqvmamarv4vv4v4p1vp varselet 35 73 Checking Your Backup Files aanasnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn nnmnnn 36 7 4 Checking Whether Backups are Scheduled ssssunnrrnnnnnnnnnnvevevnnnnnnnnnnvevnnnnnnnnnnneevnnnnnn 36 7 5 Checking the Message LOGS usunnnnnnnunnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn nnna 37 7 6 Setting up Automatic Backups sssannnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn mnnn 38 7 7 Site Specific Backup TaSkS nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn mnnn 39 Chapter 8 Managing Interfaces nnnnxnnnnnnnnnnnnnnnevnnnnnnnnnnnnnevnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnevnnnnnnnnn 41 8 1 About Historian INtENHates Luuusaquunagnmsmesbuearameaaeamedndenn 41 8 11 Whats a Point NE uuciiinscariinranaiiini a aii aiai 4
39. a from obsolete equipment for example you should decommission them see Decommissioning Points on page 24 5 5 Decommissioning Points Typically to decommission a point you set the Scan attribute to 0 off 1 Open SMT and select the Historian Server for that point see How to Run SMT on page 5 2 Inthe System Management plug ins list under Points choose Point Builder 3 Search for the point 4 Click the Archive tab 5 Under Scan click Off Some interfaces don t use the scan bit to turn off points If you want to decommission a point for such an interface change the point source attribute for that point to a value that you use only for decommissioned points 5 6 Deleting Points When you delete a point you lose all data for that point so you break any client displays that use the point Further once you delete a point you can t get it back If you are unsure about the purpose of a point s existence or about the need for any historical data associated with it it s safer to decommission the point see Decommissioning Points on page 24 rather than deleting it Page 24 Chapter6 MANAGING ARCHIVES You need to pay close attention to the Historian archives because this is where Historian stores your data About Archives on page 25 As the data accumulates you need new archives to hold it Otherwise Historian overwrites data in existing archives You can do all or most of your archive management with the SMT
40. a time so while you re in the Historian Servers pane click to deselect all other Historian Servers Now there should be only one checkmark in the Historian Servers pane 4 Click to expand the Operation item in the System Management Plug ins pane System Management Plug Ins Analysis Framework Points Se U peration Archia anager Message Log Viewer Module Database Editor Network Manager Statistics Server Process Manager Timeout Table Editor Pl Version Interface Data FT curity 5 From the list of Operation plug ins double click on Network Manager Statistics The Network Manager Statistics plug in appears in the Active Plug in pane 6 Click on the Name column header to sort the list alphabetically by service or application name Page 64 11 3 Testing the Buffering Service ia 9 f E Server ID PIPath Name PID Reg ppType local D FI FIN eth inel PlServic bee N ET ke SEEM st pg PS ens nimeget 7 Now look in the Name column for the buffer service which in this display is called APIBE You should see one APIBE connection for every Interface Node that is running the buffering service Server ID PlPath Mame PIC Reg ppName Reg ppT ype localhost 32 localhost 46 F localhost 59 localhost 82 localhost 0 ua localhost 3 DAPI pialarmi 180 pislarm Server pp localhost 4 DAPL piarchss 224 piarchss PlService localhost 35 DAPFI pibasess 2240
41. ace data for monitoring sheet products Factory Talk Historian DataLink Allows PI to access and deliver data to and from spreadsheet programs and create easy to read reports PI Control Monitor Oversees plant control systems ensuring accuracy and keeps a historical system record PI BatchView Displays PI Batch data on Windows desktop computers PI Manual Logger Used to organize and manually enter data from handheld loggers computer terminals scanners and other input devices into the FactoryTalk Historian System PI AlarmView Summarizes PI Alarm server information and displays those data ina hierarchical tree structure to any number of clients on or off site Factory Talk Historian ActiveView Seamlessly renders existing FactoryTalk Historian ProcessBook displays for the Web RtWebParts Web parts that work with RtBaseline Services to display Historian and other data in various ways Page 16 Chapter5 MANAGING HISTORIAN POINTS This section gives you a brief introduction to Historian points and point attributes and then covers the basic point related tasks that a System Manager needs to know how to do Q About Points About Point Attributes Creating New Points Finding Malfunctioning Points Decommissioning Points Doovo vo Deleting Points This material is an introduction to Historian points For comprehensive documentation on Historian points see the Histo
42. an Server Because the buffering service works to help prevent data loss but is disabled by default enabling and configuring buffering is a critical task for an administrator Bufserv The executable or process name that performs the Buffering Service Calculated Point A synonym for PE Point Calculated Tag A synonym for PE Point Classic Point Class The common set of attributes required by most standard OSIsoft interfaces such as Location and Location4 Clock Scheduling A method of triggering program execution to occur based on a fixed time or clock schedule such as that defined by a scan class Clock scheduling is one method available for triggering PE or ACE calculations Another method is Event Scheduling Page 76 Glossary of Terms COM Connector A COM object designed to allow the Historian Server to access data from foreign data sources and make it available to any Historian client application in a seamless fashion Some currently available COM Connectors include those for data historians from AspenTech and Honeywell as well as one for any data source with an OLEDB provider In order to function all COM Connectors require the services provided by the Redirector COM Connectors are only available on Windows platforms COM Connector Point A point belonging to a special point class that has at least three attributes defining how to reference a particular value on a foreign data source One of the attributes i
43. an archive file that is available for use Registering an archive can be performed with several different programs including piartool and SMT Satellite node Any remote computer on a network running Historian software other than the Historian Server software Examples of the software the computer might be running include interfaces PINet or PlonPINet Scan The base attribute that specifies whether or not the interface or scanning program should collect new data for the associated point If Scan is disabled set to 0 then new data will not be collected Scan Class A specification that provides an interface with the schedule for performing data collection for its associated points The scan class specification consists of a period and an optional offset The period determines the recurring interval when data collection should occur and the offset determines when data collection should first Glossary of Terms start A scan class can also optionally contain a code to force the interface to use UTC time for scheduling A point can only be in one scan class and assignment to a scan class is typically configured through the classic attribute Location4 SDK A COM based Software Development Kit that provides rich access to objects and data stored on the Historian Server The SDK is used for other Historian applications like ProcessBook 3 x and DataLink 3 x and also for custom user applications The SDK is only available for Windows
44. an easily create both IORates points and performance points for an interface using the ICU Configuring Interfaces on page 43 8 4 2 Checking Log Files The Factory Talk Historian System logs interface and buffering errors in the pipc log and or the pigetmsg log on the interface machine You can use SMT s Message Log Viewer tool to see these messages Some interfaces also produce an interface output file that might contain information about how the interface is performing Page 44 8 5 Configuring Interfaces for Buffering Most interfaces also write a performance summary every 8 hours to pipc log For each scan class the summary shows the duration of the most recent scan the percent of scans missed and the percent of scans skipped Historian counts a scan as missed if it was started after its scheduled start time due to a previous scan taking too long Historian counts a scan as skipped if it did not have an opportunity to run at all Note that a previous scan can be from any of the defined scan classes Performance points are an important tool for tuning scan classes because if a scan takes too long it can cause the next scan to be skipped resulting in data loss You can tune scan classes by changing the scan frequency the scan offset and the number of tags in the scan list For more information on configuring scan classes and scan lists see the user manual for your interface 8 5 Configuring Interfaces for Buffering If yo
45. an firewall is explained in the FactoryTalk Historian System Management Guide 9 2 Managing Users and Groups This section explains how to manage user accounts and how to set up groups to manage access permissions to Historian resources It contains the following sections Introduction to Historian Server System Management Page 47 Chapter 9 Managing Historian Security 9 2 1 9 2 2 9 2 3 Q About Users and Groups Q Setting up Groups to Manage Resource Access Q Adding Editing and Deleting Users and Groups About Users and Groups The Historian Server has its own user account security Each user account is protected by a password Users can also belong to one or more groups Historian groups are collections of users who need the same level of access to a particular Historian resource such as point data or attributes As System Manager you can configure which users and groups have access to which Historian resources point data and attributes for example and how much access they have To configure this access you set permissions for a particular resource s owner and group What are Access Permissions PI Permissions like Windows permissions determine whether a particular user is allowed to view and or edit an item in PI PI provides the three standard levels of access permissions Access Description Read only access Users can view the item but they cannot change it Read write access Users
46. an without applying the exception deviation test To learn more about exception reporting see the Historian Server Reference Guide Note For Digital Blob or String points only the exception maximum and minimum times are important Historian ignores the exception deviation specification for them Compression Specifications Historian uses the compression specifications to filter the data passed from the Snapshot to the Archive The goal is to store just enough data to accurately reproduce the original signal By filtering out data that you don t need you get more efficient Archive storage and the Archive can serve the data to the clients more efficiently Where exception reporting uses a simple dead band method for filtering data Historian s compression testing uses a more complex method that follows the slope of the data the swinging door compression algorithm Historian s compression testing algorithm is explained in detail in the Historian Server Reference Guide The compression specifications include a flag that allows you to turn compression on or off We recommend you turn compression on for all real time points in the system You usually turn compression off for points with manually entered data production targets control limits and so on For each point you can set four attributes to configure the compression specifications Specification Attribute What it Does Compression Flag Compres
47. and delete users and groups to change user passwords and to add and remove users from groups Chapter 9 Managing Historian Security Run the System Management Tools How to Run SMT on page 5 Select the Server on which you want to manage the accounts How to Select a Server in SMT on page 6 Click to expand the Security item in the System Management Plug ins pane From the list of Security plug ins double click on User and Group Editor The User and Group Editor plug in appears in the Active Plug in pane The Users tab lists all the users who have accounts on the selected server Similarly the Groups tab lists all the groups registered on the selected server To work with users to add or delete users or to change a password select the Users tab To work with groups to add or delete a group or to add users to or delete users from a group select the Groups tab Different icons appear in the toolbar depending on whether you select the Users or Groups tab Some icons are enabled only when you click on an item in the list P PI System Management Tools File Tools Help lig xea BAE 2 localhost ning Users Groups strider ay Efipiadmin localhost PI Administration piadrnin W pidemo localhost PI Demo piuser 9 3 Managing Historian Trusts As System Manager you need to update the Historian trusts anytime any trusted machine changes host name or IP address Use SMT s Historian Tru
48. and later PI Snapshot Subsystem Events in Overflow Total of events in the overflow queue files Queues Available in Historian Server v 3 4 and later PI Snapshot Subsystem Events in Primary Number of events in the primary queue file Queue Available in Historian Server v 3 4 and later PI Snapshot Subsystem Number of Overflow Number of overflow queue files 0 if only the Queues primary queue is active Available in Historian Server v 3 4 and later Note This table lists only a very small subset of the Historian performance counters The Historian Server System Management Guide provides a comprehensive list of all available Historian performance counters 10 3 Building Performance Monitor Points The FactoryTalk Historian System Management Tools The FactoryTalk Historian System Management Tools SMT on page 5 includes a plug in for building PIPerfmon tags called the Performance Monitor Tag Builder To build a performance monitor point follow these Steps 1 Run the System Management Tools How to Run SMT on page 5 2 Select the Server on which you want to create the performance point How to Select a Server in SMT on page 6 3 In the list of Points plug ins double click on Performance Monitor Tag Builder The Performance Monitor Tag Builder appears in the Active Plug in pane 4 Under the Tag Settings tab choose an existing PIPerfmon interface from the pull down menu If no interfaces appea
49. ant information store of the Historian Server that contains the historical data record of all events for all points The Data Archive is commonly referred to as simply the Archive Data Source Node A synonym for Interface Node Data Type The kind of value that will be used Both points and point attributes have a data type Some of the possible types include several kinds of numbers digital string and Blob Page 78 Glossary of Terms Descriptor The base point attribute that can be used to provide a textual description of a point The Descriptor is a common attribute to display in various client applications and user reports Deviation Blanket In compression the conceptual parallelogram with a width that extends from the previous archive event to the current event and a height equal to twice the compression deviation DigitalSet The base attribute required for all digital points to indicate the appropriate digital set containing the list of possible digital state values for the point Digital Point Type A point type typically used when values can only be one of several discrete states such as ON OFF or Red Green Yellow This point type is the nearest equivalent to the PI 2 x Digital type Digital State Set A named collection of digital states For example a digital state set called ValveStates may contain the two possible discrete states of a valve OPEN and CLOSED Digital State Table A table that c
50. apter 9 MANAGING HISTORIAN SECURITY PI has two main mechanisms for security log in accounts users and groups and trusts E E E E About PI Security Managing Users and Group Managing Historian TrustsHistorian Trust Managing PI Database Security 9 1 About PI Security The two most commonly used methods of PI Security are user identification security login accounts with access permissions and trusts trusted computers that are granted access without having to log in E User Identification Security The Historian Server has its own user identification and password security Users typically access client applications server connections and other Historian resources by typing in a valid user name and password For some resources such as point data and attributes you can set access permissions based on user name and group association User identification security is explained in Managing Users and Group on page 47 PI databases rely on user identification security Managing PI Database Security Trusts In some situations you don t want to require a username and password to establish a PI connection A typical example of this is a Historian interface application requesting a connection to a Historian Server PI provides trust security for this type of situation Trusts are explained in Managing Historian TrustsHistorian Trust Note PI also provides a firewall mechanism that is not covered in this guide The Histori
51. ass can also optionally contain a code that requires that the interface use UTC time f hh mm ss hhimmiss U period offset UTC time Scan Class Description Example Component Period The period specifies the interval 01 00 00 between calculations The first two Get data every hour digits are the hours the second two the minutes and the third two the seconds Offset The offset specifies a start time for the 01 00 00 13 00 00 calculation The offset is optional PI Get data every hour starting at counts the offset from midnight of the 1PM current day As with the period the first two digits are the hours the second two the minutes and the third two the seconds Page 42 8 2 Configuring Interfaces Scan Class Component Description Example UTC Time The UTC time specifies that the scheduling sync with Universal Coordinate Time UTC The UTC time is optional To use it add a comma followed by a capital U to the end of the scan class 01 00 00 13 00 00 U Get data every hour starting at 1PM UTC time Note If a scan class has a frequency of more than an hour make it a UTC scan class Otherwise your scheduling might be thrown off the next time there s a switch change to or from daylight savings time UTC scan classes don t have this problem because they force the scan class scheduling to sync with UTC rather than local time 8 2 Configuring In
52. ating point type typically chosen for single precision floating point values This type is not scaled Float64 Point Type The only floating point type capable of storing double precision floating point values This type is not scaled Home Node A computer running the Historian Server software or the network location IP address or hostname of such a computer Glossary of Terms I Point Type Interface manuals sometimes refer to the I point type This is synonymous with either Int16 Point Type or Int32 Point Type Initializing Archive The process of writing all the primary records one for each existing point to an archive file and cleaning and preparing overflow records in order to receive data Int16 Point Type The integer point type typically chosen for values that are 15 bit unsigned integers 0 to 32767 This type is the nearest equivalent to the PI 2 x Integer type Int32 Point Type The only integer type capable of representing 32 bit signed integers Because the lowest 32K values of the 32 bit range are reserved for digital states the effective useful range of possible integer values is 2147450880 to 2147483647 Interface Configuration Utility ICU A Windows GUI application installed on an Interface Node for the purpose of easing the burden of managing interfaces and their configuration files Interface Node computer running one or more Historian interfaces or the network location IP address or host
53. ble target archive available This gives you a backup in case the file creation fails for some reason This target archive can be dynamic or fixed Run SMT How to Run SMT on page 5 Select the Server on which you want to automate archive file creation How to Select a Server in SMT on page 6 From the list of Operation plug ins double click on Timeout Table Editor The Timeout Table Editor appears in the Active Plug in pane Click the Archive tab and select any item in the list Click the New Timeout Setting button Page 32 6 9 Automating Archive File Creation E General Archive Base Net Manager Snapshot Update Manager localhost Plarchez ThreadLCount localhost Archive BackupLeadT ime an z a640i localhost Archive CacheHecordFool ds Point Count 2048 10465 OD localhost NET 65535 128 1344 mwe Ma itelachePerPoint AB 1 eife Merit yal 1 10 eto A dialog box appears 8 In the top field which is the Name field type in Archive_AutoArchiveFileRoot 9 Inthe Value field type in the path to the directory where you want Historian to create the archives along with the archive file prefix For example if you type D PI arc piarch then PI creates new archive files in the D P arc and names them piarch 001 piarch 002 and so on fi localhost Archive Auto rchvefileHoot kd Value D APkarctpiarcH Range Mir Default Max Automatic archive file creation om shifte If A
54. buffer in chronological order back to the Introduction to Historian Server System Management Page 63 Chapter 11 Managing Buffering Historian Server At this point if you look at the data in ProcessBook you see a continuous flow of data with no gaps As System Manager you should make sure that the buffering service is running on each Interface Node The main exception to this rule is for PINet Nodes which perform their own buffering Also a few interfaces such as batch file and event file work better without the buffering service If you re not sure whether a particular interface is compatible with the buffering service check the documentation for that interface You need only one buffering service running on each Interface Node to buffer all the interfaces for a particular Server however you can only buffer data to one Server at a time from each Interface Node You can set the maximum size of the file buffer up to 2GB in the ICU Configuring Interfaces on page 43 11 2 Checking whether the Buffering Service Is Running To check whether buffering is running on an Interface Node look for the APIBE process for that particular Interface Node in the Network Manager Statistics SMT plug in 1 Run the System Management Tools How to Run SMT on page 5 2 Select the Server that is connected to the Interface Nodes you want to check How to Select a Server in SMT on page 6 3 It s easier to check one Historian Server at
55. button and browse to the location of the PIPerfmon executable By default Historian installs the PIPerfmon executable in the PIPC directory under Interfaces PIPerfmon_basic Type in a descriptive name for the interface such as Performance Monitor Interface or PIPerfmon Type in a Point Source What s a Point Source on page 41 The default point source for PIPerfmon is the pound sign Type in an Interface ID number What s an Interface ID Number on page 42 Select the Host Factory Talk Historian System This can be the Historian Server itself Click OK A dialog appears saying that the interface is ready to be configured Click OK If you re using the Performance Monitor Kit from DevNet add the following scan classes for the interface What s a Scan Class on page 42 00 00 05 00 01 00 Click Apply Under the Service Tab type in a user name and password for a Windows account with Administrative privileges on the Historian Server then click the Create button This installs the interface Chapter 10 Monitoring Factory Talk Historian System Performance u Pl Interface Configuration Utility piperfmon basic1 Interface Tools Help Dlx mj me Interface Performance Monitor Interface gt localhost Type piperimon Pl Performance Monitor Description piperfmon basic ese version 1 1 0 1 UNIINT version 3 5 5 General Unin piperfmon Service IORates Status Tags Pert Pointe Pert Cou
56. ce Monitor Kit This kit gives you a point configuration spreadsheet that allows you to create your performance points in a matter of seconds and it also gives you a great Performance Monitoring display for ProcessBook You can get this kit from OSIsoft s Developers Network http devnet osisoft com Note The Developer s Network is a useful source of tools and information for Factory Talk Historian System Managers but the downloads are not actively supported by OSlsoft If you have trouble getting installing or running the Performance Monitor Kit you cannot get help from Technical Support Also this kit might not work with future releases of PI 10 6 Configuring the PIPerfmon Interface The executable for the basic version of the PIPerfmon interface is included in your Historian Server installation To configure PIPerfmon on your Historian Server follow these steps 1 Run the ICU How to Run the ICU on page 6 2 On the ICU menu select New The Configure a New Interface dialog appears Page 60 10 6 Configuring the PIPerfmon Interface ot 11 eu Configure a New Interface Use the Browse button to select PI Interface service file exe to configure The additional parameters shown may also be selected Browse to interface executable required Interface name as displayed in the ICU optional Point Source Interface IDF Host FI System mv HE HE Cancel Click the Browse
57. cessful event addition to the archive Historian Archive Subsystem Cache Flush Operations sec Rate at which points are flushed from the archive cache to disk Historian Archive Subsystem Cache Record Count Archive cache records in memory Historian Archive Subsystem Events Read sec Rate of archive events read Historian Archive Subsystem Time to Archive Shift Number of seconds until the archive is projected to shift This time is not calculated if the archive is less than 20 full PI Base Subsystem Module Count Total number of modules in the Module Database PI Base Subsystem Point Count Total number of defined points This number includes the Connector Point Count PI Snapshot Subsystem GetSnapshots sec Rate of events read from the Snapshot PI Snapshot Subsystem OutOfOrderSnapshots sec Out of order events sent to the Snapshot PI Snapshot Subsystem Queued Events sec Events sent to Event Queue PI Snapshot Subsystem Snapshots sec Events sent to the Snapshot Historian Archive Subsystem Primary Archive Used Percent of used records in Primary Archive file Available in Historian Server v 3 4 and later Page 58 10 3 Building Performance Monitor Points Historian Performance Counter Tag Name Description Historian Archive Subsysteml Total Unflushed Total number of unflushed events Available in Events Historian Server v 3 4
58. ch represent valid data and much more Point attributes are fully documented in the Historian Server Reference Guide This section gives you a brief overview of a few key attributes Q Point Name Tag Attribute Q Class of Point PtClass Attribute Data Type of Point PointType Attribute Data Source PointSource Attribute Interface ID Number Location Attribute Setting Scan Class Location4 Attribute Exception Specifications Compression Specifications Point Value Range Zero Span and Typical Value Oooovoovoovoovo vo Configuring Shutdown Events Shutdown Q Point Security PtOwner PtGroup PtAccess DataOwner DataGroup DataAccess There are more than 50 different point attributes that you can specify for each point The exact list of attributes that configures a point depends on the class of the point see Class of Point PtClass Attribute on page 18 Point Name Tag Attribute The Tag attribute specifies the name of the point Many Historian users use the terms tag and point interchangeably which is fine Technically though the tag is actually just the name of the point Follow these rules for naming Historian points Q The name must be unique on the Historian Server Q The first character must be alphanumeric the underscore _ or the percent sign L No control characters are allowed such as linefeeds or tabs Q The following characters are not allowed ve eset ye Class of Point PtClass Attribute The attributes t
59. cking whether the Historian Server is RunningHistorian Server Q Data Flow in the Historian ServerHistorian Server 4 2 1 What s in the PI Directory By default the Historian Server installs its files in a folder called PI on the disk with the most available space but you can choose a different location for PI during installation Within the PI directory the Historian Server installs the subdirectories listed in the table below Directory Contents adm Contains administrative tools bin Contains subsystem or PI service executables dat Contains databases such as points and digital states This is also the default directory for archives log Contains log files setup Contains files for install and uninstall 4 2 2 File System Dos and Don ts The two most important tips on the file system are Q Disable virus scanning on the archive folder Virus scanning may corrupt archive files The problem with virus scanning is that because the data is random it might have a bit pattern that matches a known virus signature The virus scanning software then locks and quarantines the primary archive Q Don t use the Windows File System Compression feature on the Historian Server When you use compressed files you slow down Historian s access to archive files The compression might save disk space but it requires more CPU resources 4 2 3 Checking whether the Historian Server is Running The
60. ctions v No stale connections are accumulating v There are no network errors SMT Network Manager Statistics Data v The I O rate tag trends look good Check I O rate tags Sources v There are no error messages in the see Monitoring Interface pipc log file Performance on page 44 Points v There are no stale or bad tags SMT Stale and Bad Tags Tags see Finding Malfunctioning Points on page 23 Technical v There are no new bulletins Technical Support Web Site Support Site v There are no software upgrades or http www rockwellautomation com s patch releases you should install upport Page 4 Chapter3 FACTORYTALK HISTORIAN SYSTEM DMINISTRATION TOOLS 3 1 Getting and Using the Tools You Need 3 1 1 Rockwell Automation provides two tools that make it much easier to manage a Factory Talk Historian System If you haven t already installed these two tools do it now Q The FactoryTalk Historian System Management Tools SMT on page 5 Q The Historian Interface Configuration Utility ICU Historian Interface on page 6 Make a habit of checking the Rockwell Support Web Site http www rockwellautomation com support regularly for updates to these tools Rockwell Automation also provides some other helpful tools that you might want to look at if you have the time Q Using Other Historian ToolsHistorian Tools on page 7 System Management Tools SMT The System Management Tools SMT is set of easy
61. de then the events go through the buffering service If the Interface Node cannot connect to the Historian Server the buffering service holds the data until the Server connection is restored What is Exception Reporting The point of exception reporting is for the interface to send you the data you are interested in rather than taxing the network connection by sending a lot of data that is not meaningful Exception reporting uses a simple dead band algorithm to determine whether to send events to the Historian Server For each point you can set exception reporting specifications that create the dead band The interface ignores values that fall inside the dead band Page 10 4 2 About the Historian Server ExcDev temperature ExcDev This value falls outsisde the deadband so the interface reports it to PI along with the previous value time In the preceding illustration values A D and C are reported to the Historian Server Value A is the last reported value values B and C fall within the exception dead band but value D falls outside the deadband so the interface reports value D and the previous value in this case value C The interface uses the point s ExcDev ExcMin and ExcMax attributes to decide whether to report the new value to Historian Q The ExcDev or ExcDevPercent attributes determine how much a point s value needs to change before the interface sends it to the Server For example a
62. e data during backups See Checking whether the Buffering Service Is Running on page 64 PINet buffers data for interfaces running on PINet nodes 7 2 Choosing a Backup Strategy The easiest backup strategy is to set up Historian to automatically run the backup scripts every day as described in Setting up Automatic Backups on page 38 and in more detail in the Historian Server System Management Guide You can also run the scripts manually The backup script initiates backups via NTBackup NTBackup exe on platforms that support VSS and or with the piartool backup command on platforms that do not support VSS It is highly recommended that you run Historian on a platform that supports VSS because VSS backups cause minimal disruption to the operation of Historian Introduction to Historian Server System Management Page 35 Chapter 7 Managing Backups 7 3 Checking Your Backup Files It s important to check your backup files each day Q Check the backup log daily Checking the Message Logs on page 37 Make sure that the last backup completed successfully Q Periodically test your backups by simulating a disaster recovery Q Check to make sure that the backup files are where they re supposed to be and that the file size looks right These files should be about the same size each time if the backup file is suddenly substantially smaller then the backup might not have successfully completed Q Make sure that you are not
63. e full version except that it LJ Must run on the machine with the Historian Server Q Is limited to 512 points LJ Allows one instance of the interface Introduction to Historian Server System Management Page 57 Chapter 10 Monitoring FactoryTalk Historian System Performance Q Will collect data for local performance counters only To use PIPerfmon to monitor performance you build a point for each performance counter you re interested in Which Performance Counters to Monitor on page 58 and then create a ProcessBook display that contains those points Trending Performance Points on page 59 You can then open the ProcessBook display and check system performance at a glance Note You can also view the statistics for the Historian performance counters in Microsoft s Performance Monitor utility System Monitor in Windows 2000 10 2 Which Performance Counters to Monitor The most confusing thing about performance counters for new System Managers is figuring out which ones to monitor The following list contains the basic set of performance counters that Rockwell Automation recommends you monitor This list includes some counters that are available only on Historian 2 0 and later If you are running an earlier version of Historian and don t want to upgrade just use the other counters in the list Historian Performance Counter Tag Name Description Historian Archive Subsystem Archived Events sec Rate of suc
64. e should typically be empty Event Scheduling A method of triggering program execution when some specific condition occurs such as the arrival of a new Snapshot event for a particular point Event scheduling is one method available for triggering PE or ACE calculations Another method is Clock Scheduling ExcDev The base attribute that specifies exception deviation in engineering units ExcDev specifies the deadband or how much a new value must differ from the previous value sent to the Snapshot Subsystem on the Historian Server in order to determine whether the new value is significant and should also be sent ExcDevPercent The base attribute that specifies exception deviation as a percentage of Span another base attribute The relationship is defined by the following equation ExcDev ExcDevPercent 100 Span If both ExcDev and ExcDevPercent are specified when creating or editing a point ExcDevPercent takes precedence Exception Reporting The process normally executed by an interface program or external system of sending events to the Snapshot Subsystem on the Historian Server only when there has been a significant change in the monitored value Significance is determined with a simple deadband algorithm Exception Specification The three base attributes that control the exception reporting process for a particular point ExcDev ExcMax and ExcMin Although they are technically not included in the specification ExcDevP
65. ed attributes Base Subsystem The core Historian Server component that is responsible for hosting several configuration stores such as the Point database the User and Group database and the Trust table The Base Subsystem also hosts the hierarchical Module Database Batch A batch represents a span of time on a unit Batch Alias An additional name usually the common name for a unit attribute A batch alias allows batch users and applications to reference the more natural common name of a unit attribute instead of its more obscure instrument name which may only be readily understood by the instrument or process engineer Batch Database BDB A logical collection of batch objects hosted by the Module Database and the Archive Subsystem All access to the Batch Database is provided exclusively by the SDK The Batch Database is independent of the older batch information store maintained by the Batch Subsystem Batch Generator PIBaGen An SDK based interface that writes batch information into the Batch Database The interface detects batch activity by monitoring specific points on the Historian Server for events that trigger the beginning and ending of a batch Batch Subsystem BSS A Historian Server process that is responsible for configuring monitoring and recording batch activity in the data archive The main interface to the Batch Subsystem is provided by piconfig Read only access to the batches recorded by the Batch Sub
66. ed for nearly all of the commands to function properly Pibasess The executable or process name that implements the Base Subsystem Pibatch The executable or process name that implements the Batch Subsystem Piconfig An interactive command line utility program that provides access to nearly all the configuration and data stores maintained by the Historian Server Several client applications have come along to provide a graphical interface to these various tables Glossary of Terms and databases but certain tasks can still only be performed with this command line utility To achieve some degree of automation a series of piconfig commands can be saved to a text file which can then be passed as input to piconfig Pigetmsg A command line utility program that allows the viewing of Historian Server messages stored by the Message Subsystem Messages can be retrieved based on characteristics like timestamp a search string or the program name that generated the message Pilistupd A command line utility program that displays information about the registered consumers and producers maintained by Update Manager Consumer info includes the number of outstanding events in its buffer Pinetmgr The executable or process name that implements Network Manager Ping An interface that monitors the network availability of computers by directing an ICMP ping request agai them and then storing the response times in Historian points A
67. enu point to API Buffering The Buffering dialog box appears 4 Under the Settings tab make sure the Enable buffering checkbox is checked Zu API Buffering Service Settings gt Maximum file size 100000 Use Default Sendrate Use Default ils memory buffer sz Lise Default Ise Default mor n fault r 5 Change the maximum file size if necessary The maximum is 2GB dii 6 Under the Service tab type in the name and password for a Windows account that has administrative privileges on this computer Zu API Buffering Service Setting Start Stop Device name Bufserv Display name FI Buffer Server a_i Stopped Windows account login Dependencies tcpip Create Remove Lue VICES a 7 Click OK 8 From the Windows Start menu open the Control Panel and then open Administrative Tools 9 Inthe Administrative Tools folder double click on Services Chapter 11 Managing Buffering 10 In the Services window right click on PI Buffer Server and select Start from the resulting pop up menu The buffering service should start now If it doesn t see If the Buffering Service Isn t Working on page 66 Fig Local gt fy PI ACE 1 1 suneduler PI Advanc manual Local System 4 PI ACE 2 0 Scheduler PI Advanc Manual Local System PI Buffer Server Automatic OST BFryer fs PIPC Log Server BEE ar
68. er Checklist Lu uememmmeisnsssasemeaeinmettntassaddvinekanedansdassedd kunedanad ae 3 Chapter 3 FactoryTalk Historian System Administration TOOIS rrvnnnnnnvennnnnnnnernnnnnnvennnnnnnnnern 5 Chapter 4 Introduction to the FactoryTalk Historian System nnxrrrnnnnnnnvnnnnnnnvennnnnnnnvennnnnnnnnenr 9 Chapter 5 Managing Historian POintS n xxxxnennnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnr 17 Chapter 6 Managing Archives nnnnnnxnnennnnnnnnnnnnnnennnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnnnnnnr 25 Chapter 7 Managing Backups aannnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnvennnnnnnnnnr 35 Chapter 8 Managing Interfaces nn nxxxnnnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnennnnnnnnnnnnnennnnnnnnnnnnnvennnnnnnnnnn 41 Chapter 9 Managing Historian Security rrrrrnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnr 47 Chapter 10 Monitoring FactoryTalk Historian System Performance annnnxvnnnnnnnnnnnnnnnnnnnnn 57 Chapter 11 Managing Buffering ssiccccnnesuicissicccncicsesaincvnssematansves naaa a 63 Chapter 12 Managing Data Source Equipment ssssruunvrvnnnnnnnnnnnnvevnnnnnnnnnnnnnnennnnnnnnnnnernvnnnnnnnnnnr 71 Chapter T3 Gs sinnon iow senha ceased steams ae cae asenicawuncnnnsuivenanicwwscwnens 73 Introduction to Historian Server System Management Page vii TABLE OF CONTENTS Preface Using th
69. ercent and Span affect ExcDev Page 80 Glossary of Terms ExcMax The base attribute that specifies exception maximum time in seconds ExcMax is the maximum time difference from the last sent event before the next event will be sent ExcMax thus effectively limits the length of time that events can be discarded because their values did not exceed exception deviation ExcMin The base attribute that specifies exception minimum time in seconds ExcMin is the minimum time difference from the last sent event before the next event is eligible to be sent Thus the send rate of events for the associated point can be at most one event every ExcMin seconds Firewall A table hosted by Network Manager that provides the first level of security access to a Historian Server Access can either be allowed or disallowed based on the IP address or hostname of a client computer Fixed Archive A type of archive file that allocates all of its disk space at creation time Thus both an empty and full archive occupy the same amount of disk space Unless shifting has explicitly been disabled non empty fixed archives will participate in archive shifts Another archive type is a Dynamic Archive Float16 Point Type The only floating point type that is scaled The accuracy is one part in 32767 and the range is defined by the Zero and Span base attributes This type is the nearest equivalent to the PI 2 x Real type Float32 Point Type The flo
70. erformance Points rrrnnnnvrnnnnnvennnnnvernnnnnvnnnnnvevnnnnvernnnnnvennnnnvevnnnnvernnnnnvevnnnuennnn 59 10 5 Performance Monitoring Kit Historian 2 0 and Later rnnnnennnnnonnnnnnnnnnnnnnnnnnnnnennnnn 60 10 6 Configuring the PIPerfmon Interface n xxxnnnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnneennr 60 Chapter 11 Managing Buffering sn xxxnennnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnn 63 Tel PDO BITEN 63 11 2 Checking whether the Buffering Service IS Running rrnnnnnnnnnnvnnnnnnnnnnnnnnennnnnnnnnnnnennr 64 11 3 TESTING The Butl ring Servic Eisis a Eaa 65 11 3 1 When should I test the buffering service rrrrrrrnnnnnrvnrnnrnrrvrrnnnnrrrnrrnnnnrrnnnnnnenn 66 11 3 2 How do I test the buffering Service rrrrrrrnnnrnrrvrrnnnnnrrnrnnnnnrennrnnnrrrnrnnnnnnennnnnnsnee 66 11 4 If the Buffering Service Isn t Working nnxnnennnnnnnnnnnnnvennnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnenenn 66 11 4 1 How to Check the Login Information for Buffering rrrrrrrrrrnrrrnnnnnrnnrvrrrnnnnnnnnre 66 11 4 2 How to Check the pipc log File rrrrrrrrrrrrnrrrnnnnnnnrrrnnrrrnnnnnnnrrennnrnnnnnnsrennnnnnnnnsnnnee 68 11 5 Starting the Buffering ServiCe xxnrnnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnvennn 68 Chapter 12 Managing Data Source Equipment ssssruunvrvnnnnnnnnnnnnrvvnnnnnnnnnnnenevnnnnnnnnnnneve
71. es all communication between the Historian Server subsystems Network Manager also manages all connections from client applications and their communication with the Historian Server Node A computer on a network or the network location IP address or hostname of such a computer ODBC The driver software that exposes a Historian Server as an ODBC compliant data source and thus provides the Historian Server with the ability to communicate with any ODBC compliant client application that needs to access the process data stored on the Historian Server Offline Archive Utility The same program that runs the Archive Subsystem but just in a different mode The offline archive utility is used for a variety of archive maintenance tasks such as merging multiple archives files into a single archive file or reprocessing an archive file to recover it from a corrupt or failed state Glossary of Terms Offset An optional field used when defining a scan class that specifies the first time at which a scan should occur If no offset is specified the first scan occurs immediately after the specified interval After the initial scan subsequent scans continue to occur after every specified interval Out of Order Event An incoming event whose timestamp is prior to the timestamp of the event currently residing in the Snapshot table for a particular point All such events bypass compression and are written directly to the Event Queue Owner T
72. fer Record Database 57 Troubleshooting Buffering 68 Trusts About 49 About 54 Type attribute 20 21 Typical Value attribute 24 Unregistering archives 32 User and Group Editor 53 User Database 57 User Identification Security 49 Users Managing 49 UTC Time 45 Web site Developers Network 75 support 75 Windows command prompt window 7 World access 51 Zero attribute 24
73. g attribute When you change the point insert a digital event into the data to indicate when the transition from the old to the new instrument took place Page 72 Chapter 13 GLOSSARY Annotation Arbitrary information e g text comment other binary data that can be associated with any archive value Annotations are accessed exclusively with the Historian SDK and are stored in an archive file s corresponding annotation file lt archive_filename gt ANN The maximum size of an annotation is equal to the page size in the Event Queue which is 1 MB by default with a maximum of 8 MB API A C based Application Programming Interface library of functions that enable programs to access Historian Servers locally or remotely across a network FactoryTalk Historian ProcessBook 2 x and earlier FactoryTalk Historian DataLink 2 x and earlier a majority of interfaces and many custom programs depend on this library API Node A synonym for Interface Node Archive The historical record of time series data maintained by the Historian Server The term is often overloaded sometimes it s used to refer to the entire logical data record itself sometimes it s used to refer to a specific archive file and sometimes it s used to refer to the subsystem responsible for actively hosting the historical data record Archive Event Any Event that is stored in the Archive Archive File A binary file that contains a section of t
74. hat you need to configure for a particular point depend on what the point is for Historian provides several different classes of points each of which provides a slightly different set of attributes to work with You can also build your own point classes Points that represent data from a Historian interface are always in the Classic point class The list of available Historian point classes is as follows Classic The Classic point class includes attributes used by interfaces Page 18 5 2 About Point Attributes Base The Base class is a common set of attributes that all point classes include The Base class includes both system assigned and user assigned attributes This is the minimum set of attributes that a Historian point needs in order to function Alarm The Alarm class is used for alarm points See the Historian Server Applications Guide for more information on Alarm points Totalizer The Totalizer class is for a type of point that represents a running total of data There are many different kinds of Totalizer points For more information on Totalizer points see the Historian Server Applications Guide and the SMT help topic for the Totalizer Editor SQC_Alarm The SQC_Alarm class is for SQC_Alarm points See the Historian Server Applications Guide for more information on SQC_Alarm points 5 2 3 Data Type of Point PointType Attribute Use the Type attribute to specify the data type of the point values
75. he data archive covering some finite time range These files defined by start and end times should be contiguous and non overlapping Two types of archive files may be created Dynamic and Fixed Introduction to Historian Server System Management Page 73 Glossary of Terms Archive Gap non zero period of time between the end time of one archive file and the start time of the chronologically next archive file Archive gaps are not desirable because archive events with a timestamp during the gap cannot be stored on disk in an archive file and will be discarded To avoid archive gaps archive files should always be created such that the end time of one archive equals the start time of the chronologically next archive Archive Queue less commonly used synonym for Event Queue Archive Shift The process of clearing the oldest writeable and shiftable archive file and making it the new primary archive An archive shift typically happens automatically when the previous primary archive becomes full but it sometimes must be performed manually for maintenance and troubleshooting purposes Archive Shift Flag A flag that controls whether or not a particular archive file can participate in archive shifts If the flag is disabled set to 0 then that specific archive file will not participate in archive shifts Unlike a fixed archive once a dynamic archive receives any data the shift flag is automatically and permanently disabled
76. he individual user that has permission to view and edit a resource on the Historian Server Each resource can have only one owner Two examples of resources include a point s data attribute name DataOwner and a point s configuration attribute name PtOwner PE Point A Historian point whose value is calculated by the Performance Equation PE Scheduler based on the point s configured performance equation specified in the ExDesc base attribute Perfmon PIPerfmon The Windows only Performance Monitor interface which reads Windows Performance Counters and stores the values in Historian points The basic version of the interface can only monitor a limited number of Windows Performance Counters from the local computer Performance Equation PE An expression that allows a user to implement an arbitrary and potentially sophisticated calculation without formal programming A performance equation has an intuitive syntax and may consist of standard mathematical and logical operators as well as a wide variety of built in functions The result of a performance equation can be archived for a PE point just like data for any other point Performance equations are also available programmatically via the SDK for archive calculations and other data filtering operations Performance Equation Scheduler PIPESCHD The hybrid interface and subsystem on the Historian Server responsible for evaluating performance equations for all points that specif
77. hich is hosted by the Base Subsystem Trust lookup is always performed when an application first connects to the Historian Server Glossary of Terms Unit In batch processing the name of the equipment set on which batch activity takes place The definition of a unit is not limited to a single piece of equipment For example a unit could be a single reactor or a group of reactors and related equipment Universal Data Server UDS An obsolete name for the Historian Server Update Manager The core component of the Historian Server that buffers data events and notifications of configuration changes for programs that have requested this service For example ProcessBook will request updates of Snapshot events for a point on a trend so that the trace will remain current all such events will pass through Update Manager Zero Attribute The base point attribute that indicates the lowest possible value for a point Zero is only enforced for values for float16 points Page 94 TECHNICAL SUPPORT AND RESOURCES Rockwell provides dedicated technical support internationally 24 hours a day 7 days a week You can read complete information about technical support options and access all of the following resources at the Rockwell Automation Support Web site http www rockwellautomation com support Help Desk and Telephone Support Telephone support is available 24 hours a day 7 days a week Q North America 1 440 646 3434 Q O
78. ibutes 22 ExcMax 10 ExcMin 10 File system Server 12 Filtering data Exception reporting 10 Firewall 49 Fixed archives 27 Fixing archive gaps 33 Page 98 Float 16 point type See Float32 point type 21 Float64 point type 21 Frequency Data collection 22 Gaps Archives 33 Generating archives automatically 34 Group access 51 Groups Managing 49 Setting up 52 Heading Sets Database 57 Health Check 3 Historian Overview 9 Historian APS 19 Historian Backups See Backups Historian databases See Databases Historian Points See Points Historian Security See Security Historian Server See Server Historian trusts See Trusts ICU 6 About 6 Configuring interfaces with 45 Starting Buffering 70 ID number Interface 44 Information On interfaces 47 Instruments See Data Sources Int16 point type 21 Int32 point type 21 Interface Configuration Utility See ICU Interface ID number 44 Interface Nodes About 10 43 Buffering 65 Data flow 10 Multiple interfaces 10 Interfaces Configuring 45 Configuring for Buffering 47 downloading documentation for v Getting more information 47 Log files 46 Monitoring performance 46 PIPerfmon 62 Point source 43 Registering 45 Starting and stopping 46 IORates points 46 Load Sharing Interface Nodes 10 Location1 attribute 44 Location4 Attribute 22 log directory 12 Log files Interfaces 46 Log Files pigetmsg 46 pipc l
79. is Guide aaiottercaccair enacted hiss cow emewan deve moe deren seeded ew samsueutevapiuetaubwsuedenseewstuabeedarseaacousnnd iii ADIOS NTS anio xiii Chapter 1 Introduction to FactoryTalk Historian System Management nnnnnnnnnnnnnnnnnnvennnnnn 1 Li AO NSG BIK ee 1 Chapter 2 System Manager Checklist nnnnnnnnnennnnnnnnnnnnnvennnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnevennnnnnnnnnnnr 3 2 1 System Manager CHECKIISE wnccviisiccviccicencncecsesscccetancccndecsasiucteccsasicnxeetmnnycestetinainstecenusckneceemeuees 3 Chapter 3 FactoryTalk Historian System Administration Tools cccssssessesseeseeseeeseees 5 3 1 Getting and Using the Tools You Needi rrrnnnnnnvennnnnnnnnennnnnnnennnnnnnnnennnnnnnnnennnnnnnnennnnnnnnnnn 5 3 1 1 System Management Tools SMT rrrrnnnnnnnnnrnnnnnnvvnrnnnnnnennrnnnnrnnrnnnnnnrnnrnnnnnsennnnnnn 5 3 1 2 Interface Configuration Utility ICU rrrrrrrnrrrnnnnnrnnvvrnnnnnnnnnnvvrnvrnnnnnnnnssrnnnnnnnnnnnee 6 EG Unge MSG AM TOR reser 7 3 1 4 Using the Windows Command Interpreter rrrrrrrrrrnrrnnnnnorrrnvrrnnnnnnnnrvnnnrrnnnnnnnnee 7 Chapter 4 Introduction to the FactoryTalk Historian System nnrernnnnnnnvnnnnnnnvennnnnnnnnennnnnnnnnenn 9 4 1 About Historian Interface Nodes nnnrrnnnnnnnvevnnnnnnvennnnnnnnnennnnnnnnnnnnnnnnnnennnnnnnennnnnnnnnvennnnnnnr 10 4 2 About the Historian Server uvrvqvqeeqveassaasmsssmamsndesmvmnnisdin 11 4 2 1 What s in the PI Directory rrr
80. longing to a particular interface When you configure an interface you specify a point source for that interface All the points that belong to that interface must use that point source code as the value for the PointSource attribute The Historian Server comes pre configured with applications that use some of the otherwise available point source characters When you re choosing a character to use as the point source for an interface avoid using the following characters Character Reserved For 9 RampSoak Simulator Introduction to Historian Server System Management Page 41 Chapter 8 Managing Interfaces 8 1 2 8 1 3 Character Reserved For C Performance Equations scheduler G Alarm L default point source character R Random Interface Simulator T Totalizer program Q Alarm What s an Interface ID Number The Interface ID number is a number that associates a point with a particular copy of an interface Set the Interface ID number to any positive integer Points that use the interface then typically use the ID number as the value of the Location1 attribute Refer to the interface documentation though to be sure What s a Scan Class A scan class is a code that Historian interfaces use to schedule data collection Scan classes consist of a period which tells PI how often to collect the data and optionally an offset which tells PI when to start collecting data A scan cl
81. m password d re profiles listed below sre Profile a Service bled 5 Click on the General tab and click the Start button under Service status Tou can erate k Startup type Biasso Service status Stopped Tou can specify the start parameters that apply when you start the service from here 6 Click OK Note Make sure the interface that you are buffering is running under this same Windows account The buffering program shares memory between bufserv and the interface If they are not running under the same account then they can not share memory and buffering will not work Chapter 11 Managing Buffering 11 4 2 How to Check the pipc log File Historian writes messages about the interfaces in the pipc log file If you re having trouble with the buffering service it s a good idea to check the log file l From the Windows Start menu on the Interface Node point to Programs point to FactoryTalk Historian System and then click PI Interface Configuration Utility The ICU appears On the Tools pull down menu click Log Files The Log File dialog box appears tu Log Files PIPC Loa Files Service amp Settings Date Last Modified Size KB 10 31 2004 20416 AM 7 30 2004 2 34 38 PM pipcOOOO log 272004 1207 39PM 01 23 2004 123547 PM 262 In the Log Files dialog box double click on the pipc log entry The pipc log file appears If you see the error message Unable to
82. me followed by the option v for example piarchss exe v View Computer Platform Information To view platform specifications e In Windows right click on My Computer and choose Properties For more detailed information select Start gt Run and enter msinfo32 exe Page 96 INDEX OF TOPICS ann files 33 Access categories 50 Access permissions 50 Access privileges Points 24 Adding new data sources 73 adm directory 12 Administrator account 51 Alarm Manager SQC 7 Alarm point class 21 Annotation files 33 API Nodes 10 APS 19 Archive Gaps 33 Archive Manager 29 31 archive queuing 16 Archive shift 27 Archives About 27 Annotation files 33 Archive Manager 29 31 Archive shift 27 Creating 29 Creating automatically 34 Fixing Gaps 33 Moving 32 Preventing overwrites 29 Primary 27 Registering 30 Unregistering 32 Attribute PtClass 20 Tag 20 Attributes Compression specification 23 Exception reporting 22 Location1 44 Location4 22 Point source 43 Points 19 PointSource 21 PointType 20 21 Shutdown 24 Span 24 Typical value 24 Zero 24 Auto Point Sync 19 Automating archive creation 34 Backups Monitoring 38 Bad points Finding 25 Base point class 21 Batch Database 57 bin directory 12 Blob point type 21 Buffering About 65 Account 68 Checking if running 66 Configuring interfaces for 47 How to fix 68 How to test 68 pipc log 70 Starting service 70 Tes
83. n t working properly If the Buffering Service Isn t Working on page 66 Note Why unplug the Historian Server and not the Interface Node Because many Interface Nodes get their data from the network If you unplug such an Interface Node from the data source then the interface gets no data and you can t test data buffering 11 4 If the Buffering Service Isn t Working 11 4 1 If the buffering service is not working correctly first check the login information for the buffering service then check the pipc log file How to Check the Login Information for Buffering Be sure that bufserv service is set to run under a local Windows Administrator account on the Interface Node not under System Account or any other unprivileged account To check this follow these steps Page 66 11 4 If the Buffering Service Isn t Working 1 From the Windows Start menu open the Control Panel and then open Administrative Tools 2 Inthe Administrative Tools folder double click on Services 3 Inthe Services window right click on PI Buffer Server and select Properties from the resulting pop up menu 4 Click the Log On tab and enter the account information for a Windows account that has administrative privileges on this Interface Node Do not use the System account Pl Butfer Server Properties Local Computer General Log On Recovery Dependencies Log on ag Local System account Password Confir
84. n page 29 move it to the new location and then register it again Registering an Archive on page 28 When you move the archive file be sure to move the associated annotation file as well The annotation file has the same name as the archive file except that it ends in ann For example if the archive is named piarch 003 then the associated annotation file would be called piarch 003 ann Page 30 6 8 Fixing Archive Gaps 6 8 Fixing Archive Gaps Historian archive files meet chronologically end to end accounting for all of history with no gaps and no overlaps If a gap does occur it s important to identify and fix it as soon as possible To check for and fix archive gaps follow these steps I Run SMT and select the Historian Server on which you want to view the archives How to Run SMT on page 5 2 Click to expand the Operation item in the System Management Plug ins pane System Management Plug Ins Analysis Framework Points Message Log Viewer Module Database Editor Network Manager Statistics Server Process Manager Timeout T able Editor Pl Version Interface Data FT curity 3 From the list of Operation plug ins double click on Archive Manager The Archive Manager plug in appears in the Active Plug in pane It lists all the archives registered on the selected server Any archive gaps are clearly labeled and highlighted in red Chapter 6 Managing Archives 6 9
85. name of such a computer Interface A software program that collects data from some type of data source and sends the data to a Historian Server Some interfaces also have the ability to read data from a Historian Server and write back to the data source Interface Status Utility ISU A standalone program for determining whether or not an interface is sending fresh data to the Historian Server Ipisql Utility An interactive command line program that executes SQL statements directed at the Historian Server The utility depends on the API to communicate to the Historian Server Page 82 Glossary of Terms Mapped Point A synonym for COM Connector Point Message Subsystem The Historian Server component that records informational and error messages from various Historian Server subsystems in a series of log files The Message Subsystem can also serve these messages to various client applications Module Database MDB hierarchical information store hosted by the Base Subsystem that consists of one or more Modules Each Module contains collections of Properties Aliases and other Modules Module Database Builder An SDK based Excel Add In that allows the creation modification or viewing of elements of the Module Database in a spreadsheet The Module Database Builder is the ideal user interface when performing bulk operations on the Module Database Network Manager The core Historian Server component that handl
86. nd select the Historian Server on which you want to view the archives How to Run SMT on page 5 2 Click to expand the Operation item in the System Management Plug ins pane System Management Plug Ins Analysis Framework Points Se Operation Archia anager Message Log Viewer 4 Module Database Editor Network Manager Statistics Server Process Manager Timeout T able Editor Pl Version Interface Data r F p 3 From the list of Operation plug ins double click on Archive Manager The Archive Manager plug in appears in the Active Plug in pane It lists all the archives registered on the selected server Unregistered archive files do not appear in the list 4 To unregister an archive file click the Unregister selected archive icon to unregister the archive The archive disappears from the list p PI System Management Tools Active Plug In Archive Manager File Tools Help Servers bra E Fay E 2 E w localhost Ex ping start Time strider FE DA Pdatpiarch 005 localhost Primary 128 08 Nov 04 13 33 46 Cure trinity S DSP datpiareh 006 localhost HasData 128 Hov O4 13 ab 08 O SPI datypiarch 001 localhost HasData 128 SJar O4 12 36 26 Ca E DA PK datpiarch 002 local u 128 Current Time Ev VPlydatkpiarct i Curent Time pem FEE m m 1 em LT a 6 7 Moving an Archive If you want to move an archive file you unregister it Unregistering an Archive o
87. nd the Security item in the System Management Plug ins pane From the list of Security plug ins double click on Trust Editor The Trust Editor plug in appears in the Active Plug in pane To view the settings for an existing trust right click on that trust in the list and select Properties from the resulting pop up menu The Trust Properties dialog box appears localhost Proxy_12 Proper DE Trust Mame Pl Server Mame localhost IP Information Hostname IP Address i Neth ask HEIE EE Windows Account Domain Account Application Information Application Name FI User piadmin cae Each trust has a name and three basic areas of information IP information Windows account information and application information In addition each trust has an associated Historian user Chapter 9 Managing Historian Security You do not need to fill in all the areas in the Properties form The more details you fill in the more restrictive the trust becomes For example if you create a trust for a particular hostname then any request from that hostname gets access based on that trust However if in addition to the hostname you add an application name then that trust lets through only the specified application from that hostname 9 4 Managing PI Database Security 9 4 1 PI stores its configuration information and process data in databases You can configure access to the databases with SMT s
88. nrrnnnnnnnnrnnnnnrevnrnnnnnnrnnvnnnnnnrnnnnnnnrnnnnnnnnnsnnnnnnnsnsnnnnnnn 12 4 2 2 File System Dos and Don ts rrrrrrnnnnnvvnrnnnnrvnvrnnnnnrennrnnnnnrennnnnnnsennnnnnensennnnnnnsennnnnn 12 4 2 3 Checking whether the Historian Server iS RUNNING cccccceecsseseeeeeeeeseeaeeeeees 12 4 2 4 Data Flow in the Historian S rvel cccccccccsssccccecessseceeeeeeceeeeeeeeceeeeseeeeeeeeeenees 14 4 2 5 What is the Snapshot nss rnnrnnrnnnnnnnnnnnrvnnnnnnnnnnnnnnnnnnnnnnnnnrnnnnnnnnnnnnsnnnnnnnnnnnnnsee 14 4 2 6 What are Out of Order Events rrrrrrnannnnernrnnnnnnvnnrnnnnnnvnnrnnnnnsennnnnnnnsnnnnnnnnrennnnnn 14 4 2 7 What is Compression Testing rrrrnnnnrrnrrrnrrrnnnnnnvrnnrrrnnnnnnnsrrnnnrrnnnnnnnsrnnnnnnnnsnnnee 14 4 2 8 What is the Event Queue rrrnnnnnnnnnnnnnnanvnnnnnnnnnnnnnvnnnnnnnnnnnnnarennnvnnnnnnnnsnnnnnnnnnnnnsee 15 4 3 About Client APPICAlUONS isaac vertices ddiewenicatiyapincceincanisiennatenisidd enaseseaeuendeasakeucenaneuntseniaknacdesses 16 Chapter 5 Managing Historian POintS n xxxxnrnnnnnnnnnnnnnvennnnnnnnnnnnnennnnnnnnnnnnnennnnnnnnnnnnnennnnnnnnnnnnr 17 Introduction to Historian Server System Management Page ix Table of Contents 5S1 ABU POMS 4vuvrv4vvevev4vd d4e4vvevsve a E 17 52 PADOUU OMI ANDUTES csc cease eect ee eee eee eee 17 5 2 1 Point Name Tag FAMOUS ci csrslaccongatinesvonccasancennlasseotetaracaunianmonsinatacsanrenandinenannniess 18 5 2 2
89. nyway For example if you stop your Historian Server for software upgrades or other maintenance be sure to check for data loss after you restart Also if your network connection goes down so that the Historian Server loses its connection to the Interface Node anyway that s a great time to check that your data was saved by the buffering service If you decide to interrupt the connection between an Interface Node and the Historian Server for a buffering test choose a time when your Historian users will be least inconvenienced by missing data and access to the Historian Server Do this test once or twice a year How do I test the buffering service To test the buffering service unplug the Historian Server from the network 1 Choose a time when your Historian users will be least inconvenienced by missing data and access to the Historian Server 2 Send a memo or email warning users in advance of the test and telling them how long the Server will be off the network 3 Unplug the network connections from the back of your Historian Server for a few minutes 4 Plug the connections back into the Historian Server Notify your users that the Historian Server is back on the network 6 Open ProcessBook and look to see if you have continuous data it might take several minutes for Historian to fully restore the data If you do have continuous data then your buffering is working correctly If you have gaps in your data then the buffering is
90. og 46 Message logs pipc log 70 Module Database 57 Module Database Builder 7 Monitoring Backups 38 Moving archives 32 Naming points Tag attribute 20 No access 50 Nodes Interface 10 Obsolete points 26 Offset 44 OSIsoft Universal Interface 43 out of order event 15 Owner access 51 Performance Interfaces 46 Performance counters Which to use 60 Performance points About 59 Index of Topics Creating 61 Interfaces 46 PI 3 4 and later 62 PIPerfmon interface 62 Trending 61 Period 44 Permissions Access 50 Owner group world 50 piadmin account 51 piarchss Archived Events sec 60 piarchss Cache Record Count 60 piarchss Events Read sec 60 piarchss Primary Archive Used 60 piarchss Time to Archive Shift 60 piarchss Total Unflushed Events 61 pibasess_Module Count 60 pibasess_Point Count 60 PIBatch 57 pidemo account 52 PIDS 57 pigetmsg 46 PIHeadingSets 57 PIModules 57 pipc log 46 70 PIPerfmon interface 62 Point source 63 PIPOINT 57 pisnapss_Events in Overflow Queues 61 pisnapss_Events in Primary Queue 61 pisnapss_GetSnapshots sec 60 pisnapss_Number of Overflow Queues 61 pisnapss_OutOfOrderSnapshots sec 60 pisnapss_Queued Events sec 60 pisnapss_Snapshots sec 60 PITransferRecords 57 PIUSER 57 Point Access Privileges 25 Point classes 20 Point Database 56 57 Point Security Configuration 24 Point Source PIPerfmon 63 P
91. oint sources 43 Point types See Points About See Points Attributes 19 Creating 25 Decommissioning 26 Deleting 26 Finding Malfunctioning 25 points vs tags 20 PointSource attribute 21 PointType attribute 20 21 Primary archive 27 Privileges Points 24 PtClass attribute 20 Queue Event 16 Read only access 50 Read Write access 50 Registering archives 30 Registering interfaces 45 Removing equipment 74 Retiring points 26 Run command 7 Scan class PIPerfmon interface 63 Scan Class Location4 attribute 22 Scan classes About 44 Security About 49 Owner group world 50 Page 100 Point configuration 24 Server About 11 Compression 15 Compression testing 15 Data flow 14 File system See Snapshot 15 Setting up groups 52 Shutdown attribute 24 SMT about v About 5 Archive Manager 29 31 Database Security Editor 57 Installing 5 Running 5 User and Group Editor 53 Snapshot 15 Span attribute 24 SQC Alarm Manager 7 SQC_Alarm point class 21 Stale points Finding 25 Starting buffering 70 Starting interfaces 46 Stopping interfaces 46 String point type 21 Support Web site 75 System Management Tools v See SMT Tag attribute 20 TagConfigurator 7 Tags See Points tags vs points 20 Technical support Web site 75 Testing Buffering 68 Time UTC 45 Timestamp point type 21 Tools for System Managers 5 Totalizer point class 21 Training Where to find 75 Trans
92. ollowing int 16 int32 float16 float32 float64 digital string Blob and timestamp Point Type can be edited after point creation but not all type transitions are allowed PointSource The base attribute that identifies the interface or other scanning software responsible for providing data for the associated point Posting Sending events packaged into messages that contain either 128 or 256 events depending on the server platform from the Snapshot Subsystem to the Archive Subsystem Posting is typically no longer performed with the introduction of the memory mapped Event Queue in later versions of the Historian Server Postprocessing Processing by the Totalizer on the values stored in the Snapshot table that enables accurate counting and summary calculations The results of these operations are then stored in other points Primary Archive The archive file with an end time of current time All events recorded with a timestamp after the start time of the primary archive are stored in this archive file Thus the primary archive typically contains the most recent data for all points At most one primary archive may be registered at any given time Product In batch processing the description of a specific material or class of materials This term is used in batch applications that use equipment to produce a variety of different materials R Point Type Interface manuals sometimes refer to the R point type This is synonym
93. omatic archive creation then you need to make sure you don t run out of disk space on that machine 6 4 Creating an Archive The SMT Archive Manager plug in provides an easy interface for creating editing and monitoring your Historian archives To create a new Historian archive follow these steps 1 Run SMT and select the Historian Server on which you want to view the archives How to Run SMT on page 5 Chapter 6 Managing Archives 6 5 2 Click to expand the Operation item in the System Management Plug ins pane System Management Plug Ins Analysis Framework Points Message Log Viewer T Module Database Editor Network Manager Statistics Server Process Manager Timeout T able Editor Pl Version Interface Data a F a f 3 From the list of Operation plug ins double click on Archive Manager The Archive Manager plug in appears in the Active Plug in pane It lists all the archives registered on the selected server The Primary Archive is first on the list 4 To create a new archive click the Create a New Archive icon p PI System Management Tools Active Plug In Archive Manager File Tools Help Pl Servers sa ETELE nn fue ric sever staus Size MBJ Star Time strider D APA dat vplarch 005 localhost Primary 28 O08 Moy 04 13 33 46 Currer krinity D APi dat piarch O06 localhost Has Data 128 05 Nov 04 13 33 16 08 N l E D Pl dat piarch 001 localhost Has
94. ompt and choose to run in advanced mode Backup Utility Untitled Job Edit View Tools Help Welcome Backup Restore and Manage Media Schedule Jobs ES Click to select the check box for any drive folder or file that you want to back up el E Desktop Mame Comment Gf My Computer EI My Computer Ga Le 34 Floppy IA O dat fresh 34 amp s Local Disk C O Home Developm H O se Local Disk E o My Beets H O DVDACD Ryw Drive D oO applou evt S Clientele 7 3 on Mars T pel System State findhrsthle tx amp OG datfresh 3 4 U M GardnerCabinNov amp Gy Home Development Main Site files Home Developm a OG My Documents O TAP ServerD acs pdt fH 164 My Network Places O Questions For Jam LI E Show Desktop sct O temp tst Backup destination Backup options i Normal backup Full log Some Start Backup file types excluded Backup media or file name e PlMest backup PI Backu Browse For Help press Fl 7 6 Setting up Automatic Backups An automated backup task can be installed with the PAadm pibackup bat backup script You must install the automated task because the installation of the Historian Server does not install a backup task The syntax for using the pibackup bat file is as follows PIbackup bat lt path gt number of archives archive cutoff date install where lt gt indicates a required parameter and indicates an optional
95. ontains the complete definition of all defined digital state sets This table is hosted by the Base Subsystem Distributed Data Collection Gathering data from multiple sources and from more than one computer on a network The FactoryTalk Historian System is designed to work extremely well in an environment with distributed data collection Dynamic Archive A type of archive file that does not pre allocate its disk space at creation time but instead grows as needed A dynamic archive can be configured to grow up to a maximum size and support a maximum number of points but a non empty dynamic archive cannot participate in archive shifts Another archive type is a Fixed Archive Glossary of Terms Event The fundamental unit of information used in the Historian Server Each event consists of two main components a value and a timestamp The value can be one of several different data types e g string digital int32 float64 The timestamp is always represented as UTC seconds and can contain a sub second component Event Queue A buffer consisting of one or more memory mapped files that stores events that have passed or bypassed compression and are destined for archive storage The Snapshot Subsystem writes events into the Event Queue and the Archive Subsystem reads events out of the Event Queue While events are still in the Event Queue they are not visible by any client applications Under normal operating conditions the Event Queu
96. or each point It applies compression sends data to the Event Queue and serves Snapshot events to the client applications SQL Subsystem The SQL Subsystem processes SQL statements including those submitted by the PI ODBC Driver Update subsystem The Update subsystem sends notifications of changes in values or point attributes to any interface or client application that is signed up for notification To check whether the core subsystems are running you can use the Server Process Manager plug in in the Factory Talk Historian System Management Tools SMT 1 Open the FactoryTalk Historian System Management Tools and select the Server you want to check see The FactoryTalk Historian System Management Tools SMT on page 5 2 Inthe System Management plug ins list under Operation choose Server Process Manager The list of processes appears 3 If the core subsystems except Shutdown on non Clustered Historian Servers are running then the Historian Server is running The Shutdown subsystem runs only when the Historian Server is starting up so Shutdown is listed as Stopped El g localhost FI Totalizer Subsy stern Running pr Ol Alarm Subsys formance Egua a a In addition to the core subsystems the Server Process Manager lists the status of optional subsystems such as Batch and Performance Equation Scheduler These optional subsystems do not need to be running in order for the Historian Server
97. or other countries Adobe Acrobat and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and or other countries All other trademarks are the property of their respective holders and are hereby acknowledged Warranty This product is warranted in accordance with the product license The product s performance may be affected by system configuration the application being performed operator control maintenance and other related factors Rockwell Automation is not responsible for these intervening factors The instructions in this document do not cover all the details or variations in the equipment procedure or process described nor do they provide directions for meeting every possible contingency during installation operation or maintenance This product s implementation may vary among users This document is current as of the time of release of the product however the accompanying software may have changed since the release Rockwell Automation Inc reserves the right to change any information contained in this document or the software at anytime without prior notice It is your responsibility to obtain the most current information available from Rockwell when installing or using this product Modified Thursday November 13 2008 8 02 pm PREFACE USING THIS GUIDE About this Guide This guide provides a starting place for new FactoryTalk Historian System Managers on Windo
98. orm compression Besides performing compression and writing events to the Event Queue the Snapshot Subsystem responds to client requests for Snapshot events and forwards Snapshot events for requested points to Update Manager Page 90 Glossary of Terms SNMP Interface An interface included that collects performance data from any device that supports the Simple Network Management Protocol and then stores the values in Historian points Examples of devices include computers printers and routers basic version of the interface is included with the Historian Server for Windows SNMP Point Builder An SMT plug in useful for creating and editing points for the SNMP Interface Span The base point attribute that specifies the range or the difference between the maximum and minimum values for a point Span is required for all numeric points and is linked to compression and exception specifications through CompDevPercent and ExcDevPercent respectively Span is only enforced for values for float 16 points SQC The SDK based Add In to ProcessBook that enables users to create and view variety of Statistical Quality Control charts on their ProcessBook displays SQC chart limits can be Historian points manually entered constants or values from ODBC datasets defined within ProcessBook SQC Alarm Manager A stand alone client application used for managing Real Time SQC Alarms on a Historian Server This application has been replaced
99. ous with the Float16 Point Type or Float32 Point Type or Float64 Point Type Ramp Soak A standard interface program included with the Historian Server that generates signals that might have come from a batch process This interface is useful for testing and validating a Historian Server without affecting actual process data Page 88 Glossary of Terms Random Simulator A standard interface program included with the Historian Server that is capable of generating a sinusoidal wave and several kinds of pseudo random data This interface is useful for testing and validating a Historian Server without affecting actual process data Real time SQC The component of the Historian Server that provides continual evaluation of Statistical Quality Control pattern tests and the management of alarms generated from these tests Use of this component will assist in monitoring how well a process stays within its control limits Recalculator The component of the Historian Server that adjusts the values of PE points automatically whenever the values of points used in their expressions are added edited or deleted by any application Redirector The component of the Historian Server that functions as the intermediary between server subsystems and all COM connectors The redirector is an out of process COM server that is only available on Windows platforms Registering an archive Informing the Archive Subsystem of the name and location of
100. parameter The command line parameters must be specified in the above order If the install flag is not specified a backup will be performed immediately The more restrictive of number of archives and archive cutoff date takes precedence Regardless of number of archives and archive cutoff date archives that do not contain data will not be backed up Page 38 7 7 Site Specific Backup Tasks Parameter Example Description lt path gt E PI backup Path must be the complete drive letter and path toa directory with sufficient space for the entire backup number of archives 2 The number of archives to backup For example 2 will backup the primary archive and archive 1 archive cutoff date 10d The cutoff date is specified in PI time format For example 10d restricts the backup to archives archives that contain data between 10 days prior to current time and current time The more restrictive of number of archives and archive cutoff date takes precedence install Installs a scheduled task to run pibackup bat daily at 2 00 am If the install flag is not specified then a non VSS backup is performed immediately 7 7 Site Specific Backup Tasks If the pisitebackup bat file exists then the pibackup bat backup script calls it before exiting If you have any tasks you want pibackup bat to execute each day after the backup then add these tasks to a file called pisitebackup bat in
101. pidemo User Accounts rrrrrnnnnnnvvvrnnnnnvenvnnnnnnrennnnnn 49 9 2 5 Setting up Groups to Manage Resource ACCESS rrrrrrrrnrnnnnnnrrrrvrnrrnnnnrrrrrrrnnnnnnnnn 50 9 2 6 Simple Case Example for Managing Groups rrrrrnevrrrnnnnnnnnvrnnvrrnnnnnnnsrennnnnnnnnn 51 9 2 7 Example for Managing Multiple Groups rrrrrvnnnnnnnnrnvrvnnnrnnnnnnrrrrennrnnnnrrrsrernnnnnnnnn 51 9 2 8 Adding Editing and Deleting Users And Groups rrrnnnnnrvnnnnnnnnvvnrnnnnnnennrnnnnrennnnnn 51 95 Managing Hislorian TrUSIS am ic Se ec ewan eee 52 TN eee ee ee eee eae ene eae eee 52 O32 Managing Trusts WITT Mva 53 9 4 Managing PI Database Security ssnnnxxnvnernnnnnnnnnnnnvnnnnnnnnnnnnennnnnnnnnnnnnnennnnnnnnnnnnnneennnnnnnn 54 9 4 1 About Databases rrrrrnrrrvvnnnnrrrvrrnnnnnrvvrrnnnnrrnnrnnnnnsennnnnnnnsennnnnnsennnnnnsnsennnnnnsssennnnnn 54 9 4 2 Managing Databases with SMT rrrrnnnnnnnnnrvnnnnnnnnrvnnnnnnnrnnnnnnnnsennrnnnnnsennnnnnsnsennnnn 55 Table of Contents Chapter 10 Monitoring FactoryTalk Historian System Performance annnnxnnnnnnnnnnnnnnnnnnnnnn 57 10 1 About FactoryTalk Historian System Performance Monitoring annxxrnnnnnvennnnnnvennn 57 10 2 Which Performance Counters to Monitor rnnnrvvvvnvnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnnnnennnnnnnn 58 10 3 Building Performance Monitor POIntS rrvannvernnnnnvennnnnvennnnnnernnnnvennnnnvevnnnnnennnnnnvevnnnnuennn 59 10 4 Trending P
102. platforms but it can access a Historian Server running on any supporting operating system The distribution kit for the SDK also includes the API Shutdown Event An Event whose value consists of the Shutdown digital state from the SYSTEM digital set and whose timestamp is intended to mark when the Historian Server or an interface or some other application or device is not available Shutdown Subsystem The component of the Historian Server that writes a shutdown event for all points that match a particular tag mask and attribute selection By default any tag with its base attribute Shutdown set to I will receive a shutdown event After the Shutdown Subsystem writes all the shutdown events for the appropriate points it will stop running Snapshot Event An overloaded term that can refer to either any Event sent to the Snapshot Subsystem or the event currently residing in the Snapshot table for a particular point The event stored in the Snapshot table for each point has the most recent timestamp of all events received so far for that point when a new event arrives with a more recent timestamp the previous event is passed through the compression filter Snapshot Subsystem The core component of the Historian Server that receives all the new data events for all points regardless of the sending application The most recent of these events for each point is maintained in the Snapshot table along with additional information necessary to perf
103. r Network Manager Statistics Server Process Manager Timeout Table Editor Pl Version Interface Data F curity h 3 From the list of Operation plug ins double click on Archive Manager The Archive Manager plug in appears in the Active Plug in pane The Archive File column lists all the archives registered on the selected server and displays the full path for each The Primary Archive is first on the list Note Don t use anti virus software to scan the directories containing Historian Server database and archive files on systems collecting production data 6 3 Making Sure Historian Doesn t Overwrite Your Archives If you don t have an empty writable shiftable archive available when the archive shift occurs Historian overwrites the oldest available full archive unless your Server is set up to create archives automatically If your Factory Talk Historian System does not create new archives automatically you can set it up to do that if you like Automating Archive File Creation on page 32 Here s what you need to do 1 Find out where the Historian archive files are located Finding the Archive Files on page 26 2 If you don t want Historian to create new archives automatically then you need to figure out how often your archives fill and you need to create new archives Creating an Archive on page 27 as needed so that Historian doesn t run out of space and start overwriting data 3 If you do use aut
104. rian Server Reference Guide 5 1 About Points Points sometimes also called tags are the basic building blocks of a Historian system because they are how you track the events that comprise your data history When the System Manager or Rockwell Field Services engineer installs a Historian Server he creates a Historian Point for every source of data that the FactoryTalk Historian System needs to track Each point has more than 50 attributes About Point Attributes on page 17 that define exactly how the data should be collected for that point These attributes determine how frequently the point gets new values the data type of the point values whether integer or string for example who is allowed to view and or edit the point and so on The Base Subsystem stores points and their attributes in the Point Database Note Some Historian interfaces are compatible with Auto Point Sync APS which tracks changes in foreign data systems and automatically updates the Historian Points Configuration to reflect those changes 5 2 About Point Attributes Point attributes are where you configure how and when Historian should collect data from a particular data source Point attributes specify the data source location how often Historian Introduction to Historian Server System Management Page 17 Chapter 5 Managing Historian Points 5 2 1 5 2 2 should get new values from the data source which values Historian can ignore and whi
105. rical IP addresses Subsystem A functionally distinct software component or module that executes in its own process space The Historian Server has several core subsystems such as Network Manager Update Manager Base Snapshot and Archive Swinging Door Compression A data compression algorithm used by the Snapshot Subsystem that guarantees all of the original samples were within a specified value the compression deviation of a straight line drawn between any two events selected for archiving In other words this compression algorithm allows for the reconstruction of the original signal as a series of straight lines and the maximum error between the reconstructed and original signals is guaranteed to be no more than the compression deviation System Digital State Set The default digital state set that contains a few hundred digital states that may apply to any tag States may be added to this set but states in the offset range 193 320 are reserved for use by the FactoryTalk Historian System and should not be modified Page 92 Glossary of Terms System Management Tools SMT A set of easy to use programs for performing a wide variety of common administrative tasks in a Factory Talk Historian System It is available by downloading the latest version of Factory Talk Historian from Rockwell s technical support website http www rockwellautomation com support Tag The base attribute that is the unique alphanumeric name
106. rs in the list make sure PIPerfmon is installed and running on the Historian Server Configuring the PIPerfmon Interface on page 60 5 Click the Build Tag tab and select the performance monitor points you want to create from the list of available counters 6 Click the Create Tags button The plug in creates the performance monitor tags for you 10 4 Trending Performance Points If you put your PI Performance Monitor points on a ProcessBook display you can check your FactoryTalk Historian System performance at a glance You might also include interface performance points Monitoring Interface Performance on page 44 and representative points from each of the batch alarm performance equation and ACE component Chapter 10 Monitoring FactoryTalk Historian System Performance The following illustration shows the ProcessBook display for the Performance Monitoring Kit from the OSI Developer s Network Performance Monitoring Kit PI 3 4 and Later on page Error Bookmark not defined This is a good example of a ProcessBook display for performance monitoring NTK fa pa INE S Ai hb SARREN De el SEE SR En Se EN Sa Va i an yc linda Sansa HE MR cs ET E NAD SSS ESS Soe AN DN ae gt Ree TE NINE SEES 10 5 Performance Monitoring Kit Historian 2 0 and Later If you re running Historian 2 0 or later then you can download and use the Historian Server Performan
107. running out of space on the disk where Historian creates the backups 7 4 Checking Whether Backups are Scheduled Open the Scheduled Task control panel f amp Scheduled Tasks Sime File Edit View Favorites Tools Advanced Help y gt 3 Va Search KE Folders gt x 2 Fr Address Scheduled Tasks E Mame Schedule Next Run Time Last Run Time Status Last Result Creator 2 add Scheduled Task At 2 00 AM every day 2 00 00 4M 2 00 05 AM 0x0 matzen The name of the backup task that is installed with the pibackup bat file is called PI Server Backup If backups have been running successfully the Last Run Time should not be blank The next run time should be about one day apart from the Last Run Time Details of the scheduled task can be viewed by double clicking on the task Page 36 7 5 Checking the Message Logs PI Server Backup Task Schedule Settings Security EA CAWINDOWSSTaskst PI Server Backup job _L Backup file destination Number of Archives to backup Start In Comments i 7 su The backup script being run The user login account Run only if logged on Enabled scheduled task runs at specified time
108. s Glossary of Terms Compressing The base point attribute that controls whether or not compression is performed for a particular point If Compressing 1s disabled set to 0 then all events will bypass compression Compression The process of selecting which Snapshot events will be sent to the Archive for storage Applying compression is one of the main responsibilities of the Snapshot Subsystem and the specific algorithm used is known as Swinging Door Compression Compression Specification The three base attributes that control the compression process for a particular point CompDev CompMax CompMin Although they are technically not included in the specification CompDevPercent and Span affect CompDev and Compressing determines whether the specification is needed at all Connection Credentials The set of identifying information about a client application seeking connection to the Historian Server This information can include the client computer s IP address or hostname the client application s name or the Windows Domain name and Windows user name under which the client application is running API applications are restricted in the credentials that they can specify The Historian Server uses connection credentials to determine if there is a matching Trust D Point Type Interface manuals sometimes refer to the D point type This is synonymous with Digital Point Type Data Archive The fundamental and most import
109. s the name of the COM Connector needed to communicate with the foreign data source These points are only available on Windows platforms CompDev The base attribute that specifies the compression deviation in engineering units This represents the maximum error when historical data values need to be interpolated and at the very least should typically be set to the error of the underlying instrument CompDevPercent The base attribute that specifies compression deviation as a percentage of Span another base attribute The relationship is defined by the following equation CompDev CompDevPercent 100 Span If both CompDev and CompDevPercent are specified when creating or editing a point CompDevPercent takes precedence CompMax The base attribute that specifies the compression maximum time in seconds CompMax is the maximum time difference from the previous archive event before the next event will be sent to the archive Because the Historian Server itself never generates events a lower bound on the archiving rate for the associated point cannot be determined from CompMax alone CompMin The base attribute that specifies the compression minimum time in seconds CompMin is the minimum time difference from the previous archive event before the next event is eligible to be archived Because the Historian Server itself never generates events the archiving rate for the associated point will be at most one event every CompMin second
110. s and data Everyone else in your company needs to see all the points but they are not allowed to edit them In this case you create a Historian group called developers and you make all the developers members of this group You configure every point s data and attributes to belong to the developers group this does not effect the point owner and you set the group permissions for all the points to read write You set the World permissions for each group to read only Now all the members of the developers group have read write access to the Data and Attributes for all the points and everyone else has read only access to all the points Example for Managing Multiple Groups Now consider the example in which you have three groups in your company developers managers and operators Operators need read only access to the data for the Sinusoid point Developers and managers need read write access to the data for the Sinusoid point You set World permissions to read only so that the operators can see the point But since you can associate only one group with the Sinusoid point data you need to create a combination group which you might call devMan All the users in the developers group and all the users in the managers group belong to the devMan group You associate the Sinusoid data with the devMan group giving all these users read write access to that data Adding Editing and Deleting Users and Groups Use the SMT User and Group Editor to add
111. s is a new Interface Node you also need to install the ICU How to Install the ICU on page 6 and set up the trusts Managing Historian TrustsHistorian Trust on page 52 Q Install the interface according to the instructions in the interface documentation Q Register and configure the interface with the ICU Configuring Interfaces on page 43 Q Start the buffering service if it isn t already running on this Interface Node Starting the Buffering Service on page 68 Q Build a new point s to get the data from the equipment into Historian Creating New Points on page 23 Introduction to Historian Server System Management Page 71 Chapter 12 Managing Data Source Equipment 12 3 Removing Obsolete Equipment When equipment goes offline you need to decommission any points associated with that equipment Decommissioning Points on page 24 If you do not decommission obsolete points the Factory Talk Historian System continues to try to get values for them which is bad for system performance and can sometimes even lead to data loss for other points 12 4 Replacing Equipment If you replace an instrument with a different one that measures the same process value it s usually best to continue using the same Historian point Edit the point as required so that it will collect the new data If the instrument is significantly different you might need to adjust the compression and exception attributes among others Don t change the Ta
112. s on page AR What is the Event Queue The Historian Event Queue serves as a memory buffer between the Snapshot and Archive Subsystems The Snapshot Subsystem adds data to this queue while the Archive Subsystem removes data from the queue Snapshot EventQueue Archive o Doo coc ccccdens Normally the Event Queue passes events through to the Archive as quickly as they arrive but in some circumstances the Archive Subsystem might be too busy or an archive file might be unavailable When this happens the Event Queue holds the data filling until the Archive is again available This is called Archive Queuing EventQueue Archive X Snapshot The most common causes of Archive Queuing are Chapter 4 Introduction to the Factory Talk Historian System Q The archives are unavailable because Archive Shift or archive backups are occurring Q The Archive Subsystem is busy because incoming events are out of order 4 3 About Client Applications The Historian Server works with a wide range of client applications from ProcessBook and DataLink to RtWebParts Some of the client software packages available from Rockwell Automation are listed in the table below Software Description Factory Talk Historian ProcessBook An easy to use graphics package that allows users to create dynamic interactive graphical displays featuring real time Historian data PI ProfileView Creates a comprehensive display of surf
113. sfer records for plant materials PITransferRecords Historian User Database PIUSER Database where Historian users are defined For comprehensive information on databases refer to the Historian Server Reference Guide Page 54 9 4 Managing PI Database Security 9 4 2 Managing Databases with SMT The SMT Database Security Editor plug in provides a simple interface for managing user and group access to PI databases To use the Database Security Editor 1 Run the System Management Tools How to Run SMT on page 5 2 Select the Server on which you want to manage the database security How to Select a Server in SMT on page 6 Click to expand the Security item in the System Management Plug ins pane 4 From the list of Security plug ins double click on Database Security Editor The Database Security Editor plug in appears in the Active Plug in pane listing all the PI databases for which you can configure the access permissions What are Access Permissions on page 48 5 Select the database for which you want to configure access The Database Properties dialog box appears amp PIPOINT Properties T able PIPOINT PI Server localhost Owner v Group pladrnir Owner Access Read write Group Access Read S World Access Read res 6 Select your access configuration from the pull down menus and click OK Chapter 10 MONITORING FACTORY TALK HISTORIAN SYSTEM PERF
114. sing Turns compression on or off set to 1 to turn compression on or 0 to turn compression off Compression deviation CompDev or As a rule of thumb set CompDev to the precision of the instrument Set it a little loose to err on the side of collecting rather than losing data After collecting data for a while go back and check the data for your most important tags and adjust CompDev if necessary Use CompDev to specify the compression deviation in the point s engineering units minimum time CompDevPercent Use CompDevPercent to specify the compression deviation as a percent of the point s Span attribute Compression CompMin Sets a minimum limit on the time between events in the Archive Set the CompMin attribute to zero for any point coming from an interface that does exception reporting You typically use CompMin to prevent an extremely noisy point from using a large amount of archive space Chapter 5 Managing Historian Points 5 2 9 9 2 10 5 2 11 Specification Attribute What it Does Compression CompMax CompMax sets a maximum limit on the time between maximum events in the Archive If the time since the last recorded event is greater than or equal to CompMax then Historian automatically stores the next value in the Archive regardless of the CompDev setting You typically set CompMax to the same value for all points in the system It s common practice to choose a CompMax
115. st Editor to view and manage your Historian trusts OG About Trusts Q Managing Trusts with SMT 9 3 1 About Trusts PI uses trusts to allow access to resources without requiring that someone enter a user name and password PI typically uses trusts to grant access to interfaces At a bare minimum every Historian Server has the following four trusts Q The Historian Server itself by host name Q The Historian Server itself by IP address Q The Historian Server itself by the special name localhost Page 52 9 3 Managing Historian Trusts 9 3 2 Q The special IP address 127 0 0 1 In addition you set up a trust for each Interface Node that connects to the Historian Server For each Interface Node configure the following three trusts Q The Interface Node by IP address and netmask Q The Interface Node by fully qualified host name for example apollo rockwell com Q The Interface Node by the short host name for example apollo The preceding interface trust configuration 1s the most general configuration If you want tighter security read the section on PI security in the FactoryTalk Historian System Management Guide Managing Trusts with SMT Use the SMT Trust Editor to view existing trusts and to add edit or delete trusts l 2 Run the System Management Tools How to Run SMT on page 5 Select the Server on which you want to manage the trusts How to Select a Server in SMT on page 6 Click to expa
116. system is typically provided by the API but it is possible to map Batch Subsystem units to the Batch Database so that their batches can also be accessed by the SDK The batch information store maintained by the Batch Subsystem is independent of the newer Batch Database Glossary of Terms BatchView A Windows client application that allows the viewing of batch data from the Batch Database and the Batch Subsystem BatchView consists of three different components an SDK based ProcessBook Add In an API based Excel Add in and a stand alone SDK based application for quick batch searching Blob Point Type The acronym for Binary large object and the point type typically chosen for an arbitrary unstructured array of bytes Interpretation of the bytes can only be performed by the retrieving application Because the record size in archive files is currently fixed in size at 1024 bytes the value of a single event for a Blob point can contain binary data of up to only 976 bytes in length If larger binary objects must be written then either the binary data must be split into multiple events for the Blob point or the data must be stored as an annotation Buffering Service An API process that typically runs on an Interface Node for the purpose of storing interface data during periods when network communication to the Historian Server is unavailable When network communication is restored the buffering service relays the stored data to the Histori
117. t How to check it Historian v Core systems and interfaces are SMT Server Process Manager Server running see Checking whether the Historian Subsystems Server is RunningHistorian Server on page 12 Archives v All archives are loaded SMT Archive Manager v There are no gaps between archives see Managing Archives on page 25 v There is an empty archive available for Update Manager the next shift v There is enough disk space for the new archives for automatically created archives v The Archive data for a reference tag looks normal Backups v FactoryTalk Historian System backups Check the files and disk have been run see Managing Backups on page 35 v There is enough disk space for future backups v The backup files are copied to the backup media or device Introduction to Historian Server System Management Page 3 Chapter 2 System Manager Checklist Area Check to see that How to check it Event Queue v The Archive data flow is normal v The Snapshot data flow is normal v The Event Queue flow is normal v There is enough disk space available for the Event Queue s v There are no unexpected out of order events Historian Performance Monitor points see Monitoring Factory Talk Historian System Performance on page 57 Message Log v There are no errors or unusual events in the message logs SMT Message Log viewer Connections v No unusual connection losses reconne
118. t on page 3 FactoryTalk Historian System Administration Tools on page 5 Introduction to the FactoryTalk Historian System on page 9 Managing Historian PointsHistorian Points on page 17 Managing Archives on page 25 Managing Backups on page 35 Managing Interfaces on page 41 Managing Historian Security on page Error Bookmark not defined Monitoring FactoryTalk Historian System Performance on page 57 Managing Buffering on page 63 Where to Go to Get More Help on page Error Bookmark not defined Introduction to Historian Server System Management Page 1 Chapter 2 SYSTEM MANAGER CHECKLIST 2 1 System Manager Checklist This section provides a quick reference table for checks that you need to perform regularly to make sure that your FactoryTalk Historian System is working properly This is sometimes called a Daily Health Check because we recommend you perform each of these checks each day The checklist is organized into functional areas with a list of things to check in each area This table does not provide detailed instructions for checking each item To learn more about how to check a particular item go to the section listed in the column on the right You perform most of the checks using the FactoryTalk Historian System Management Tools SMT To learn how to get these tools see FactoryTalk Historian System Administration Tools on page 5 FactoryTalk Historian System Health Checklist Area Check to see tha
119. ted Automatic Local System arted Automatic Local System arted Automatic Local System Sa P1 piping_basicl fs Plug and Play Ms Portable Media Seri Manual Local Systern Sy Print Spooler arted Automatic Local System 84 Protected Storage All Tasks Farted Automatic Local System Sos RSYP Manual Local System fy Remote Access Gut Refresh Manual Local System i 4 Remote Access Con Properties arted Manual Local System fy Remote Desktop He Manual Local System fy Remote Procedure Help arted Automatic Local System emote Procedure Man kai Page 70 Chapter 12 MANAGING DATA SOURCE EQUIPMENT Changes to your plant or process equipment sometimes mean you need to make changes to Historian LY About Data Sources Q Adding New Equipment Q Replacing Equipment E Removing Obsolete Equipment 12 1 About Data Sources Your data sources can be almost anything including Distributed Control Systems DCSs Programmable Logic Controllers PLCs lab systems Supervisory Control and Data Acquisition systems SCADA process models and other business information systems 12 2 Adding New Equipment When new equipment comes online you need to configure Historian to recognize it and set up points to collect the data Q Connect the equipment to an Interface Node and install the appropriate interface software You can download interface documentation from the Technical Support Web Site http techsupport osisoft com If thi
120. terfaces If you have access to the Interface Nodes for your FactoryTalk Historian System then the Interface Configuration Utility ICU is the best way to manage your Historian interfaces You need to do an initial configuration in the ICU for each interface This is called registering the interface with the ICU I On the ICU menu select New The Configure a New Interface dialog appears eu Configure a New Interface Use the Browse button to select FI Interface service file exe to configure The additional parameters shown may also be selected Browse to Interface executable required Interface name as displayed in the ICU optional Point Source Interface IDF Host PI System Cancel 2 Click the Browse button and browse to the location of the interface executable By default Historian installs your interface executables in the Program Files PIPC Interfaces directory 3 Type in a descriptive name for the interface The ICU uses this name in its displays so choose a name that you can remember Type Type Selec ot in a Point Source in an Interface ID number t the Host FactoryTalk Historian System Click OK Chapter 8 Managing Interfaces 8 3 Starting and Stopping Interfaces The first time you start a Historian Interface you need to start it from the Windows Services control panel After that you can start and stop the Interface from the ICU Configuring Interfaces on page
121. the PNadm directory Typically Factory Talk Historian System Managers use the pisitebackup bat file to move the backup directory to tape Factory Talk Historian System Managers may also use the script to back up specific files that are not included in the Historian Server backup Chapters MANAGING INTERFACES Once you install and configure an interface on a Historian Interface Node you can typically then leave it to run indefinitely without any intervention If you perform software upgrades or security patches or if the network infrastructure changes you might need to know how to perform a few basic tasks Q About Historian InterfacesHistorian Interface Configuring Interfaces Starting and Stopping Interfaces Monitoring Interface Performance Configuring Interfaces for Buffering Doo ODD Where to Go for More Information on Interfaces 8 1 About Historian Interfaces 8 1 1 Historian interfaces are the software applications that take the data from your data source and send them to the Historian Server There are hundreds of Historian interfaces and they each have their own specific documentation However because most interfaces are based on the OSIsoft Universal Interface Unilnt they share a common set of features The three basic variables that define an interface are interface ID scan class and point source What s a Point Source The PointSource attribute is a single character that identifies a Historian point as be
122. ting 67 Index of Topics When to test 68 bufserv 65 chdir command 7 Checking Backups 38 Checking interface log files 46 Checklist for System Managers 3 Class attribute 20 Classic point class 20 cmd 7 Command Line 7 CompDev 15 CompDev attribute 23 CompDevPercent 15 CompDevPercent attribute 23 CompMax 15 CompMax attribute 24 CompMin 15 CompMin attribute 23 Compressing attribute 23 Compression deviation 23 Compression Flag 23 Compression specifications Attributes 23 Compression testing 15 Compression Testing 15 Computer platform Information 102 Configuring interfaces In the ICU 45 Configuring Interfaces For buffering 47 Creating archives 29 Creating performance points 61 Creating points 25 Daily Health Check 3 dat directory 12 Data How often to get new values 22 Data Access privileges 25 Data Archive 56 Data flow Interface Nodes 10 Overview 9 Server 14 Data Source Nodes 10 Data sources 73 Adding new 73 Removing equipment 74 Database Security Editor 57 Databases About 56 Decommissioning points 26 Deleting points 26 Demonstration account 52 Developers Network 75 DevNet 75 Digital point type See Digital State Table 57 Directories Server 12 Documentation conventions 1V for interfaces v On interfaces 47 Equipment Adding new 73 Removing 74 Event Queue 16 ExcDev 10 ExcDev attribute 22 ExcDevPercent attribute 22 Exception reporting 10 Attr
123. to be running Chapter 4 Introduction to the Factory Talk Historian System 4 2 4 4 2 5 4 2 6 4 2 7 Data Flow in the Historian Server When the Historian Server gets a new event from an interface or manual input program it sends the event to the Snapshot Subsystem The Snapshot Subsystem holds a single value for each Historian point in memory When a new value comes in the Historian Server sends the old value to the Archive Subsystem The Archive Subsystem performs compression testing on the value and either discards it or sends it on to the Event Queue depending on the result of the test What is the Snapshot The Snapshot Subsystem gets the new data from the Interface Node and holds the most recent value for each point This most recent value is called the Snapshot for that point Sinusoid Snapshot O 98 12878 When a new event comes in it becomes the Snapshot for that point The Historian Server evaluates the previous Snapshot according to the compression specifications and either sends the new value to the Event Queue or discards it Sinusoid Snapshot To Compression Testing O 97 06629 8 12878 From Interface Node These values in the Snapshot Subsystem are called Snapshot events or sometimes just Snapshots The collection of all the Snapshot values for all the points is the Snapshot database What are Out of Order Events An out of order event is an event that enters the Snapshot
124. to use plug ins that provide all the basic tools you need to manage a Windows based FactoryTalk Historian System You access this set of tools through a single host application called the SMT Host The SMT Host is more commonly called the System Management Tools or simply SMT How to Install SMT 1 On the Products menu point to System Management and click on PI SMT 3 2 On the right side of the page under Docs and Downloads left click on Install Kits At this point you might need to log into the Web site if you haven t already 3 Click the Download button for the System Management Tools install kit 4 After downloading the install kit double click the Setup executable to install SMT How to Run SMT To run SMT on the Windows Start menu point to Programs point to FactoryTalk Historian System and then click FactoryTalk Historian System Management Tools Introduction to Historian Server System Management Page 5 Chapter 3 FactoryTalk Historian System Administration Tools How to Select a Server in SMT SMT includes a Historian Servers pane which lists all the available Servers Most tasks are easier in SMT if you select a single Historian Server on which you want to perform that task To select a Historian Server in SMT 1 Open the SMT Console How to Run SMT on page 5 2 From the Historian Servers pane click the box next to the Historian Server that you want to work with KPI System Management Tools
125. u are starting the buffering service on an Interface Node for the first time you also need to re configure the interfaces so that they work correctly with buffering 1 Configure the interfaces on this node so that they re dependent on the buffering service 2 Set the shutdown attribute to off for points on these interfaces 3 Restart the interfaces so that they can send their data through the buffering service Note When installing an interface for the first time it is a good idea to disable buffering until you are sure the interface is correctly collecting data and storing it in the archive Bufserv stands in for the archive when it is not available and may mask errors your interface would see when running unbuffered 8 6 Where to Go for More Information on Interfaces There are many different sources of information on Historian interfaces Q Each interface has its own documentation If you re not sure how to configure a particular interface check the documentation for that specific interface Q Many interfaces are based on the Universal Interface UniInt Q The Historian Server System Management Guide contains a chapter on managing interfaces Q The Technical Support Web Site also provides a product page dedicated to Historian interfaces and a FactoryTalk Historian System Manger Resources page You can get information on new releases as well as information on the Interface Configuration Utility and other tools Ch
126. u understand and use the Historian Server Historian Server Interfaces and PI Client Tools Each Interface has its own manual and each Client application has its own online help and or user guide Using Historian Server Tools The Historian Server provides two sets of powerful tools that allow system administrators and users to perform system administration tasks and data queries Q The Historian Server includes many command line tools such as pidiag and piartool The Historian Server Documentation Set provides extensive instruction for performing Historian Server administrative tasks using command line tools Q The Historian System Management Tools SMT is an easy to use application that hosts a variety of different plug ins which provide all the basic tools you need to manage a FactoryTalk Historian System You access this set of tools through a single host application This host application is sometimes referred to as the SMT Host but it is more commonly called System Management Tools or SMT You can download updates and patches to FactoryTalk Historian from http www rockwellautomation com support In addition to extensive online help that explains how to use all of the features in the SMT the SMT includes the Introduction to FactoryTalk Historian System Management user guide QUICK TABLE OF CONTENTS Chapter 1 Introduction to FactoryTalk Historian System Management nnnnnnnnnnnnnnnnnnnnnnnnnern 1 Chapter 2 System Manag
127. user is a member of the group that is associated with that resource If so then the user gets whatever access level the group has You can associate only one group with a particular Historian resource This means that if you want to configure access for more than one group you typically need to create a new group that includes all the users for whom you want to configure access For example the following figure illustrates an organization with three groups Developers Managers and Operators One user is a member of both the Developers and the Managers group Group Group Group Developers Managers Operators Suppose that all the users in the Developers and Managers groups need read write access to a particular resource such as the attributes for the Sinusoid point Because a resource can have only one associated group you need to create a group that contains all the developers and all the managers and then associate that resource with the new group Page 50 9 2 Managing Users and Groups 9 2 6 9 2 7 9 2 8 28 A p 88 086 Group Group Group Developers Managers Operators a8 88 8 Group DevMan Typically you create different Historian groups for groups in your organization that need different point access Simple Case Example for Managing Groups Consider the simple example in which you have a single group in your company developers that needs the ability to see and edit point attribute
128. utside of North America http www rockwellautomation com locations Knowledgebase The KnowledgeBase provides a searchable library of documentation and technical data as well as a special collection of resources for system managers http www rockwellautomation com knowledgebase Before You Call or Write for Help When you contact Rockwell Automation Technical Support please provide e Product name version and or build numbers e Computer platform CPU type operating system and version number e The time that the difficulty started e The message log s at that time Find Version and Build Numbers To find version and build numbers for each FactoryTalk Historian System subsystem which vary depending on installed upgrades updates or patches use either of the following methods e If you have Factory Talk Historian System Management Tools SMT installed select Start gt Programs gt FactoryTalk Historian System gt FactoryTalk Historian System Management Tools In SMT select the server name then under System Management Plug Ins open Operation gt PI Version The PI Version tree lists all versions Introduction to Historian Server System Management Page 95 Technical Support and Resources e If you do not have SMT installed open a command prompt change to the piiadm directory and enter piversion v To see individual version numbers for each subsystem change to the pi bin directory and type the subsystem na
129. vnnnnnnnnnnr 71 12 Abu Data SES arsen 71 122 Adding New ENN ssn eee eee ease eee ene 71 12 3 Removing Obsolete Equipment secsiiiccccsscariecesssenenseversetenwsecevtnmutansncrvtdentenetewesesteivedsoneenees 72 12 4 Replacing EAUPMEN ssis aeaa aai 72 CAPET GIOS Say VA 73 Technical Support and ReSOuUrCeS sssnnnuunsnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn nnmnnn nnmnnn 95 Help Desk and Telephone Support cccccecccsseeseeceeeeeeceeeeeeceeeesseeeaeeeeeeeeesseeeaeeeeeeeeeseaas 95 Mer 95 BVOC OTTO EE EE 97 Page xii TABLES AND FIGURES Tables FactoryTalk Historian System Health Checklist rrrnnrrnrrrnnnrnovrrrnnnnnvrrnrnnnnnvennrnnnnennvnnnnnnennnnnnn 3 Overview of FactoryTalk Historian System Data Flow rrrrrnrnnnnnnnnnrrnnvnnnrnnnnnnrrernnrnnnnnrrserennnn 9 Figures Dala FIOW WIth gt GL 0 EE ME 63 Introduction to Historian Server System Management Page xiii Chapter 1 INTRODUCTION TO FACTORY TALK HISTORIAN SYSTEM MANAGEMENT 1 1 About this Book This guide provides a starting place for new Factory Talk Historian System Managers on Windows based Factory Talk Historian Systems It introduces the Factory Talk Historian System Historian Server and Interface Nodes and gives you the Factory Talk Historian System Management basics including system backups archive management and security This guide contains the following topics Q DODDO DODDO System Manager Checklis
130. ws based Factory Talk Historian Systems This guide Q Introduces the Factory Talk Historian System Historian Server and Interface Nodes Q Explains system components architecture data flow utilities and tools Q Provides instruction for managing points archives backups interfaces security and trusts and performance Q Includes a glossary and resource guide Introduction to Historian Server System Management Page iii Preface Using this Guide Conventions Used in this Guide This guide uses the following formatting and typographic conventions Title Case Historian Client Tools Use the client tool FactoryTalk Historian FactoryTalk Historian System ProcessBook to verify that all data has been Elements recovered Historian Server Subsystems All incoming data is queued in the Event Queue by the Snapshot Subsystem Italic text Files Directories Paths The backup script is located in the P ladm directory Emphasis Archive files can be either fixed or dynamic The New Terms archive receiving current data is called the Primary Fields Archive See Section 4 2 Create a New Primary Archive References to a chapter or section Bold Italic text References to a publication See the Historian Server Reference Guide Bold text System and Application The Archive Subsystem piarchss manages data components archives Piarchss must be restarted for changes to m Subsystems take effect
131. y its point source default C Page 84 Glossary of Terms Performance Point An overloaded term that can mean either a point associated with the Perfmon interface or a special point used to monitor interface performance on a per scan class basis In the case of monitoring interface performance the point tracks how long in seconds the interface took to collect data for all tags in that scan class for each scan Historian Server The set of several software subsystems packaged together that constitute a single logical server application capable of storing time series data from distributed data sources and serving this same data to client applications in real time FactoryTalk Historian System The complete collection of software applications running on one or more computers that function to collect store retrieve analyze view or manage process data Examples of these software applications include interfaces the Historian Server and client applications Piarchss The executable or process name that implements both the Archive Subsystem and the Offline Archive Utility Piarcreate A command line utility program for creating both fixed and dynamic archive files After creation the archive files must be registered with the Archive Subsystem in order to be made available for use Piartool A command line utility program that provides a number of diagnostic and management functions The Historian Server must be start

Introduction to Historian Server System

Contents

Download Pdf Manuals

Related Search

Related Contents