Owner's manual

ManualsBrandsRockwell Automation ManualsEquipment1756-HIST2G FactoryTalk Historian ME 2.2

Summary of content (330 pages)

PAGE 1
PAGE 2
Contact Rockwell Customer Support Telephone — 1.440.646.3434 Online Support — http://www.rockwellautomation.com/support/ Copyright Notice © 2011 Rockwell Automation Technologies, Inc. All rights reserved. Printed in USA. 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.
PAGE 3
Contents 1 • Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Benefits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Distributed FactoryTalk Historian Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 4
FACTORYTALK HISTORIAN ME USER GUIDE Installing FactoryTalk View SE Patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FactoryTalk Historian ME EDS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging In to FactoryTalk Historian ME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging Out of FactoryTalk Historian ME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 29 29 32 3 • Viewing Module Information . . . . . . .
PAGE 5
CONTENTS Using the Add Points Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Discovering Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reviewing Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Tag Browser to Create Points .
PAGE 6
FACTORYTALK HISTORIAN ME USER GUIDE Connecting to a New FactoryTalk Historian SE or PI Server . . . . . . . . . . . . . . Failing to Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Tag Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Monitoring Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shutting Down the Data Transfer Service . . . . . . . .
PAGE 7
CONTENTS Backing Up and Restoring Module Configuration Files . . . . . . . . . . . . . . . . . . . . . . Displaying Backup Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Downloading Files to a Client Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uploading a Backup File to the Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring the Module from a Backup File . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 8
FACTORYTALK HISTORIAN ME USER GUIDE Web Diagnostics Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Hardware Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CPU, RAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NAND. . . .
PAGE 9
CONTENTS Initiating Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using FactoryTalk Historian DataLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining the Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Excel as an Add-In: Example Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . 229 230 230 231 C • FactoryTalk Directory Integration . . . . . . . . . .
PAGE 10
FACTORYTALK HISTORIAN ME USER GUIDE Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ControlLogix Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logix Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CompactFlash Firmware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Performance . . .
PAGE 11
1 Overview The FactoryTalk® Historian Machine Edition (ME) Module is a fully embedded historian in a ControlLogix® module that can be inserted into a Rockwell ControlLogix chassis to utilize backplane communications and collect data from multiple controllers. It collects data at very high speeds, runs calculations and statistics on the data inside its storage archive, utilizing exception and compression filtering to significantly reduce the data archive space.
PAGE 12
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE To provide an overview of your FactoryTalk Historian ME, this chapter provides the following sections: “Features” “Benefits” “Distributed FactoryTalk Historian Architecture” “FactoryTalk and ControlLogix Integration” “Hardware Specifications” “Where to Start” “Additional Information” “FactoryTalk Licensing” “Technical Support” “Consulting Services” “Training Programs” Features Key advantages of FactoryTalk Historian ME
PAGE 13
1 • OVERVIEW Reliable and robust hardened, embedded appliance with a low total cost of ownership. Only a client computer is needed to install and configure your FactoryTalk Historian ME. FactoryTalk Historian ME records data safely and accurately with solid-state data capture. It has no moving parts and requires no operating system or computer maintenance. It is not subject to downtime due to network outage or the need to perform maintenance on any subsequent firmware updates.
PAGE 14
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Reduces validation by including OEM delivery and testing. Enhances performance by: Monitoring or calculatings effective equipment usage and performance. Detecting degradation of performance and initiating alerts or requests for operations and maintenance actions. Providing real-time, time-stamped operational and production data.
PAGE 15
1 • OVERVIEW Provides an engine of unmatched performance and scalability, tightly integrated with the FactoryTalk Services Platform to provide data accuracy and availability across the Rockwell Automation® Integrated Architecture. Introduces a historian appliance that offers scalable connectivity to Rockwell Automation controllers.
PAGE 16
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE FactoryTalk and ControlLogix Integration FactoryTalk Historian ME works with the FactoryTalk product suite and Rockwell ControlLogix devices. The ControlLogix hardware and software provide easy and secure access to resources (data, status, and configuration) within the ControlLogix devices. FactoryTalk Services Platform and FactoryTalk Product Suite You must install the FactoryTalk Services Platform V2.10.
PAGE 17
1 • OVERVIEW FactoryTalk Network Directory Server to FactoryTalk Services Platform version 2.10.02. For additional information on upgrading a previous version of the FactoryTalk Network Directory Server, see the Rockwell Automation Knowledgebase at http://www.rockwellautomation.com/resources/support.html. The FactoryTalk Services PlatformV2.10.02 CPR 9 SR2 includes services and applications listed in the following table. FactoryTalk Services Platform V2.10.
PAGE 18
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE FactoryTalk Services Platform V2.10.02 CPR 9 SP2 FactoryTalk Live Data Allows FactoryTalk services-enabled products to discover, connect, and share real-time data in a secure, scalable manner. V2.10.02.24 FactoryTalk Web Services Provides the ability for thin clients to connect to Web-based Rockwell Automation software products through a Web browser. Before installing FactoryTalk Web Services, install Microsoft Internet Information Services (IIS).
PAGE 19
1 • OVERVIEW FactoryTalk Product Suite FactoryTalk VantagePoint Allows you to view process data from FactoryTalk and FactoryTalk Historian ME in VantagePoint Excel® reports, dashboards, VantagePoint EMI and portals. Integrates the FactoryTalk Historian ME data into the VantagePoint model, allowing you to correlate the V3.1 and above data with various other data sources. FactoryTalk Historian DataLink V3.1 and above FactoryTalk Historian ProcessBook V3.0 and above FactoryTalk Historian Batch View V3.
PAGE 20
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE ControlLogix System Communications A ControlLogix system consists of anything from your FactoryTalk Historian ME and a stand-alone controller in a single chassis to more complex configurations that include Ethernet/IP communication modules. The ControlLogix system in a chassis uses connections to establish communication links between devices such as a Logix5000 controller-to-local communication modules such as an EN2T or ENBT module.
PAGE 21
1 • OVERVIEW Where to Start This User’s Guide should be used as a companion to the online help in the FactoryTalk Historian ME web interface. It is not necessary to read it from front to back in sequential order. The following table provides a quick reference for tasks you may want to perform. If You Want To Go to This Chapter Read about factors that may influence “Design Considerations and Limitations” the design of your FactoryTalk Historian ME environment.
PAGE 22
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE If You Want To Go to This Chapter “Collecting Data” Stop or start Data Collection. View the status of Data Collection. Configure disk or log thresholds. Work with Compression or Exception Filtering Configure Data Transfer. Stop or start Data Transfer. Transfer data to a FactoryTalk Historian SE. View a model Data Transfer scenario. “Data Transfer Sample Scenario” View current or archive data.
PAGE 23
1 • OVERVIEW If You Want To Learn about software, hardware, or system requirements. Work with the Client Tools CD. Use your module for the first time. Log In to your module. Log Out of your module. Use the Rule Editor. Create rule files. Create tag attribute files. Use the Add-on Profile (AOP). Start or stop your module without using the web interface controls. Restore module default settings without using the web interface controls.
PAGE 24
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The quick start guide is also provided as a printed manual. FactoryTalk Historian ME Installation Instructions (1756-IN106A-EN-P) explains how to install FactoryTalk Historian ME. It also includes environmental testing and certification information. The installation information is provided as a printed manual. FactoryTalk Historian ME Online Help - describes FactoryTalk Historian ME web interface in detail. Access the help files by clicking the About...
PAGE 25
1 • OVERVIEW Technical Support Please visit Rockwell Automation Customer Support Center at http:// support.rockwellautomation.com/ for access to user forums, sample code, software and firmware updates, product manuals, and other downloads. Knowledgebase The Customer Support Center offers an extensive online knowledgebase that includes frequently asked questions (FAQs) and the latest patches. Please visit http:// www.rockwellautomation.com/resources/support.
PAGE 26
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE FactoryTalk Historian ME has two product numbers. The 1G or 2G in the part number indicates how much data storage is associated with the module. Product Catalog Number Description 1756-HIST1G FactoryTalk Historian ME 1GB module 1756-HIST2G FactoryTalk Historian ME 2GB module Exact wording of any messages that appeared on your screen. Descriptions of: What happened and what you were doing when the problem occurred.
PAGE 27
2 Getting Started Before installing FactoryTalk Historian Machine Edition (ME), determine your platform requirements and configuration environment. The information in this chapter offers some guidelines as you begin planning.
PAGE 28
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The greater the demand, the more powerful a system must be to support this demand. For large or complex applications, use computers with faster CPUs and more RAM. In addition to this, there should always be sufficient disk space to provide virtual memory that is at least twice the size of the physical RAM.
PAGE 29
2 • GETTING STARTED IE Internet Options The location of your Internet options settings vary according to which operating system you are using. However, in general, you should: Disable any popup blockers to view online help. Select the Local Intranet icon (generally located under Security settings), and click [Sites] to use the default setting, Automatically detect internet network. Use the default Security level for this zone.
PAGE 30
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE IE 8 Compatibility Mode Internet Option If you are using Internet Explorer 8 in compatibility mode, you must enable the security setting for Include local directory path when uploading files to a server. FactoryTalk Historian SE Patch FactoryTalk Historian ME can be integrated with FactoryTalk Historian SE 2.1 after you have installed the FactoryTalk Historian SE patch.
PAGE 31
2 • GETTING STARTED This installs the Add-On Profile (AOP) for your module. Getting Started Videos These videos provide instruction in how to install, configure and use the various FactoryTalk Historian ME components. You must have Adobe Flash Player installed on your system in order to view these videos. RSLogix 5000 Clock Update Tool This tool is located in the \Redist folder on the Client Tools CD. RSLinx Classic This tool is located in the \Redist folder on the Client Tools CD.
PAGE 32
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE ControlLogix Chassis Requirements The ControlLogix chassis is part of a modular system that you can create with FactoryTalk Historian ME, an Ethernet/IP communication module(s), and controller module(s). Chassis are available with 4, 7, 10, 13, and 17 slots. You can place the FactoryTalk Historian ME module into any slot. Slot 0 is the first slot and is always the left-most slot in the rack (the first slot to the right of the power supply.
PAGE 33
2 • GETTING STARTED All clients (including web clients) are logged out and disconnected. Log files are packaged and downloaded from the Download Logs page of the Web Diagnostics interface. See “Download Logs” for more information about web diagnostics. You collect the following information for the upgrade process: The catalog number of FactoryTalk Historian ME (1756-HIST1G or 1756HIST2G, depending on the size of the CompactFlash drive.) The network configuration information.
PAGE 34
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Setting up Your ControlLogix Environment Perform the following steps to set up your ControlLogix environment before installing FactoryTalk Historian ME: 1. Set up the ControlLogix chassis. 2. Insert the ControlLogix controller(s) into the chassis. 3. Power on the system. 4. Configure the ControlLogix device(s). See your ControlLogix Chassis and ControlLogix Controller documentation for more detailed information.
PAGE 35
2 • GETTING STARTED Installing FactoryTalk Historian ME Client Tools After you have selected the platform that best suits your needs and have installed FactoryTalk Historian ME into the chassis, you will then determine the configuration environment for the FactoryTalk Historian ME client tools. The client tools can be found on the CD that was shipped with FactoryTalk Historian ME.
PAGE 36
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE In addition to the tools and patches, the FactoryTalk Historian ME release notes and user documentation are available on the CD. Installing FactoryTalk Services Platform This option installs FactoryTalk Services Platform CPR 9 SR2. The FactoryTalk Services Platform is an underlying architecture and set of common services that Rockwell Automation products build upon. It must be installed on the computer that hosts the FactoryTalk Directory server.
PAGE 37
2 • GETTING STARTED common address book, which finds and provides access to plant-floor resources, such as data tags and graphic displays. Only Network Directory is supported. FactoryTalk Security can be used to secure your FactoryTalk network after installing FactoryTalk Services Platform. It is important to select the Custom option to install the FactoryTalk Services Platform Web Services component.
PAGE 38
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Directory. Select the Network radio button; FactoryTalk Historian ME supports a Network Directory, not Local Directory. Select the FactoryTalk Network Directory See the FactoryTalk Help at Programs > Rockwell Software > FactoryTalk Tools > FactoryTalk Help for information about using the FactoryTalk Administration Console.
PAGE 39
2 • GETTING STARTED Installing FactoryTalk View SE Patch FactoryTalk Historian ME can be integrated with FactoryTalk View SE V5.0 and above. FactoryTalk View SE provides a trend object for FactoryTalk Historian ME users to see visual representations of data. To enable trending of Factory Talk Historian ME points in FactoryTalk View SE, both the FactoryTalk View SE patch and the FactoryTalk Historian Management add-on patch must be applied to your FactoryTalk Historian ME system.
PAGE 40
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 2. Enter the IP address of FactoryTalk Historian ME in the Address field. The IP address scrolls across the LED display on the front panel of FactoryTalk Historian ME. Note that the default network configuration type is DHCP. If a DHCP server is not available, then an IP address will not be displayed. You will either need to configure a DHCP server or use the AOP to set the IP address.
PAGE 41
2 • GETTING STARTED 3. Click [Go] to the right of the Address field, or click [Enter]. This opens the login page. Home appears in the top main navigation bar of the web interface Change the blank default piadmin user password immediately Login appears in the left-side navigation bar of the web interface 4. Enter the default user name piadmin and leave the password field blank. The first time you log in, the default user name is piadmin and the password is blank (no password).
PAGE 42
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Logging Out of FactoryTalk Historian ME To log out of the FactoryTalk Historian ME web interface, click Logout (in the upper right corner of the web interface) before closing your web browser. If you close your browser without logging out, a cookie will retain the session for twenty minutes, and another user may access FactoryTalk Historian ME without logging into the module.
PAGE 43
3 Viewing Module Information The following sections provide information that will assist you in monitoring performance and diagnosing common issues. “System Status” “Status” “Module Identity” “System Utilization” “System Statistics” System Status The System Status information displays when you log in to FactoryTalk Historian ME. It is located on the bottom, left-hand corner of every page and provides the following system status information. It refreshes automatically every 30 seconds.
PAGE 44
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE System status features include: CPU usage - percentage of the module’s CPU that is being used.. The CPU usage percent listed under the System Status section on the left-hand side may display a different percent than what is listed under CPU and Processes in the main window because the CPU usage listed under System Status is updated periodically while the CPU usage listed in the main window is static. It does not change once the page is loaded.
PAGE 45
3 • VIEWING MODULE INFORMATION Module Information This section displays the module name, the current firmware version, current time for the module, and the total time the module has been running. Controller FactoryTalk Historian ME Module in slot 2 in slot 1 System Status This section displays the current status of the Point Server, Data Collection Service, and the Data Transfer Service. Point Server - FactoryTalk Historian ME server that manages the archives and provides access to historical data.
PAGE 46
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Data Transfer Service - FactoryTalk Historian ME Data Transfer subsystem. The status may be Running, Stopped, or Error. System Utilization This section displays the current CPU usage, memory information and storage information along with a graphical representation of this information. The red portion indicates a critical stage for each component. Point Statistics This section displays the total points in the module and how many are actively receiving data.
PAGE 47
3 • VIEWING MODULE INFORMATION Module Identity Under Home on the main navigation, click Module Identity in the left-hand navigation to display the module identity information. Module Information This section displays the same information found on the Status page, as well as the slot number where the module resides and its serial number. For information on changing these settings, see “Working with System Settings” in the “Administering the Module” chapter.
PAGE 48
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Network Settings This section displays the current network settings for FactoryTalk Historian ME. For information on changing these settings, see “Working with System Settings”. This section displays: MAC Address - unique Media Access Control (MAC) address of the module. This number cannot be changed. IP Address - Internet Protocol (IP) address of the module.
PAGE 49
3 • VIEWING MODULE INFORMATION This section displays: Security Mode - FactoryTalk (FT) Security mode or FactoryTalk Historian ME Native mode. Browser Protocol - HTTP or secure HTTP (HTTPs). Client Connections This section displays the current number of clients connected to FactoryTalk Historian ME. Up to 5 clients may be connected simultaneously.
PAGE 50
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE System Utilization Under Home on the main navigation, click System Utilization in the left navigation bar to display the System Utilization information.
PAGE 51
3 • VIEWING MODULE INFORMATION CPU and Processes - displays the current percent of the CPU in use and the processes currently running. The CPU usage percent listed in the System Status section may display a different percent than the percentage listed in the CPU and Processes section in the main window. This is because the CPU usage listed in the System Status section is updated periodically while the CPU Usage information displayed in the main window is static.
PAGE 52
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE the Auto Refresh value to 0 or not entering a value in the box disables the Auto Refresh feature. When using the auto refresh feature, follow these guidelines: 42 Try to limit the amount of time auto refresh is being used. It is not recommended to keep a page running in auto refresh mode when you are not using it. Display the minimum amount of data necessary. This will reduce the amount of memory being used.
PAGE 53
3 • VIEWING MODULE INFORMATION Network Manager Statistics The Network Manager view retrieves a snapshot of the current Network Manager connection statistics. If a row does not contain a value for a particular column, then there is no information available for that column heading for that particular connection.
PAGE 54
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The Network Manager table contains the following fields: Field 44 Description ID Connection ID. This is the primary key. Path Root directory on the server. This directory is the same for all connections. Name Connection name. ID Process ID number. Reg App Name Registered application name. Reg App Type Registered application type. Protocol Version Protocol version of connecting application. Peer Name Host name of connecting machine.
PAGE 55
3 • VIEWING MODULE INFORMATION Field Description SDK Count Number of SDKs. Server ID Identification number for the server. NetMgr Version Network manager version number. OS Sys Name Operating system name. OS Node Name Operating system node name. OS Release Operating system release number. OS Version Operating system version number. Machine System name. User User name. OS User Operating system user name. Trust Name of the trust connection.
PAGE 56
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Snapshot and Archive Statistics The Snapshot and Archive view allows a user to monitor the current FactoryTalk Historian ME snapshot and archive statistics. The Snapshot and Archive table contains the following fields: Field 46 Description Type Snapshot or archive file type. Counter Performance counter. Value Current snapshot and/or archive value. Change Value change between updates.
PAGE 57
3 • VIEWING MODULE INFORMATION Archive File Statistics FactoryTalk Historian ME stores your data in archives, which are files that hold FactoryTalk Historian ME data. Archive files are fixed which means that they are always the same size, regardless of how much data they contain. 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.
PAGE 58
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE files stored on FactoryTalk Historian ME are displayed by default when you select the Archive Files option. The Archive Files table contains the following fields: Field 48 Description Archive File File archive name, which includes the full path. Status Archive status displays one of the following: Primary - the archive file that is currently receiving data. Has Data - indicates the archive file contains data and is full.
PAGE 59
3 • VIEWING MODULE INFORMATION Field Description Annotations The size in bytes of the annotation file associated with the archive file. Annotation File Size The size in megabytes of the annotation file associated with the archive file. Shift Prediction The target archive or the predicted shift time. Primary Offset The number that indicates the number of primary archive records in use. Overflow Offset The number that indicates the number of overflow records in use.
PAGE 60
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 50
PAGE 61
4 Viewing Data This chapter contains the following sections: “Viewing Current Data” “Viewing Archive Data” “Viewing Trends” “Changing the Views” Viewing Current Data To view data that is currently being collected by FactoryTalk Historian ME, click on View Data, and then click Current Data in the left-side navigation.
PAGE 62
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Defining Search Criteria Search criteria entered the Current Data, Archive Data, and Trends pages persists across all three pages. To generate a Current Data, Archive Data, or Trends view, define your search criteria and enter it in the fields at the top of the page, then click [Search]. This information tells FactoryTalk Historian ME what data you are interested in viewing. Note that for all fields, the asterisk (“*”) is a wildcard value.
PAGE 63
4 • VIEWING DATA 4. Select a scan rate from the drop-down menu. The scan rate is the rate (in seconds) at which the data is collected. 5. Select On, Off, or “*” from the Archiving drop-down menu to display points with a specific archive bit setting. On - returns points where the archive is set to On. Off - returns points where the archive is set to Off. Asterisk (“*”) - returns points that meet either condition (On or Off) and meet the other search conditions. 6.
PAGE 64
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Exporting Data Exporting data will export all points that have been returned after you’ve executed a search. The export process creates a CSV (comma-separated values) document that can be opened by Microsoft Excel. If you have selected a few rows to be displayed and click [Export], all row data will be exported. If you want to export a subset of rows, enter more specific search criteria. To export data: 1. Click [Export]. 2.
PAGE 65
4 • VIEWING DATA Search criteria entered in the Current Data, Archive Data, and Trends pages persists across all three pages. In the search fields, enter the search criteria, and then click [Search]. See “Defining Search Criteria” for information.
PAGE 66
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 1. Highlight the point by positioning the blue highlight bar over the selected point. You can only view archive data for one highlighted section at a time. 2. Enter a start time and end time. See the section “Start and End Times” for more details about setting the start and end times. 3. Click [View] to display archived data for the specified time range.
PAGE 67
4 • VIEWING DATA Search criteria entered in the Current Data, Archive Data, and Trends pages persists across all three pages. In the search fields, enter the search criteria, and then click [Search]. See “Defining Search Criteria” for information. Displaying the Trend Chart The trend chart displays trends for selected points using colored variants to distinguish between the different points.
PAGE 68
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE AUTO REFRESH Click the green arrow to generate a trend chart for selected points in the table. Timestamps on the Y axis change as time passes and the chart refreshes. Click the red box to stop Auto Refresh. Auto Refresh must be disabled before you use the Zoom, Show Points, or Show Vertical Bar features. See the section “Start and End Times” for more details about setting the start and end times.
PAGE 69
4 • VIEWING DATA SHOW POINTS Check the Show Points checkbox to display discrete data points in the trend chart. Each point will be represented in the chart as a bubble. You must disable Auto Refresh (by clicking the red square) before you can enable the Show Points feature. If you want to draw a trend chart that consists of high speed points, avoid checking the Show Points checkbox due to the large number of points that will be displayed.
PAGE 70
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE SMALL WINDOW The small window next to the Trend Chart displays the chart in the total time period set by the time parameters. ZOOM To zoom in on a specific time span for a set of data, click and drag the mouse to draw a box and release the mouse. The highlighted area will display in the trend chart allowing you to view data in a specific time span more closely. You must disable Auto Refresh (by clicking the red square) to zoom.
PAGE 71
4 • VIEWING DATA RESET Click [Reset] to restore the small window next to the trend chart to its default view. To remove a point from the chart, clear the checkbox next to its name in the list below the trend chart. Changing the Views The Current Data, Archive Data, and Trends view can be changed by filtering data, sorting columns, refreshing, and (for Current Data) auto refreshing. Filtering Search Results Data To filter search results, select either the All Rows or Selected Rows radio button.
PAGE 72
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Choosing the Selected Rows radio button will continue to return the selected rows for each search until [Reset] is clicked. This will return the search parameter fields to their default values and clear all row selections that were made in previous searches. Sorting Columns You can sort any table column in the current, archive, or trends table. Simply click the up-down arrow in the column heading.
PAGE 73
4 • VIEWING DATA Refreshing a View To refresh a view, click [Search] again. Auto Refreshing a View To set the table to auto refresh, enter a refresh interval (in sections) in the Auto Refresh box below the table. Setting the Auto Refresh value to 0 or not entering a value in the box disables the Auto Refresh feature. When using the auto refresh feature, note the following: Try to limit the amount of time auto refresh is being used.
PAGE 74
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Syntax Definition 06-dec-08 15:00:00 3:00:00 p.m. on December 6, 2008 mon+14.5h 2:30:00 p.m. last Monday t sat-1m 00:00:00 (midnight) on the current date (today) 11:59:00 p.m.
PAGE 75
5 Managing Points This chapter contains the following sections: “Using the Add Points Wizard” “Using the Tag Browser to Create Points” “Manually Creating and Editing Points” “Defining Point Attributes” “Configuring Scan Types” “Configuring Trigger Input and Output Points” “Working with Scan Classes” Using the Add Points Wizard To start the wizard, click Manage Points in the top navigation bar, then click the Add Points Wizard in the left navigation bar.
PAGE 76
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Discovering Tags In Step 1: Discover Tags, set the search parameters for discovery of tags. Parameters include the rule file, tag file, scan rate, and controller. Click the arrow icon to view the rule file or the tag attribute file Check a box to select controller tags to browse 1. Select a Rule file (optional). ADDefault.xml is the default. You may select None. A rule file is an XML file that determines which points will be discovered by the wizard.
PAGE 77
5 • MANAGING POINTS Edit the default rule file and change the Item.Count LTE parameter value to a number greater than 2000. Create a custom rule file with an Item.Count LTE parameter value that is greater than 2000. If you select None and do not apply rules, clicking [Show Tags] will generate a list of all points from Logix controllers. 2. Select a Tag file. The Tag (also called tag attribute) file is an XML file that determines the properties (attributes) of the points to be created.
PAGE 78
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE When selecting a scan rate, it is important to be aware that points that have an invalid scan rate configured will not be created. The valid scan rates are as follows: Advised and Polled - equal to or greater than 0.5 seconds. High Speed - equal to or greater than 0.01 seconds and equal to or less than 0.5 seconds. Any point that was not created is listed in the Review Results page with the reason it was not created.
PAGE 79
5 • MANAGING POINTS Creating Points In Step 2: Create Points, the Add Points Wizard returns search results based on the criteria set in Step 1: Discover Tags. To search the results, enter search criteria: Name - the name of the tag in the controller. The default is “*”, which displays all tags. Slot - slot location of the controller in the chassis. Tags from the controller selected in the Start Search In field in Step 1: Discover Tags will display by default.
PAGE 80
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE You can also use the following features to tune your selections before you create points. 70 All/None - toggle the All/None checkbox to select or clear all points. If you select None, the checkboxes are cleared and you must select points individually to create them. [Change Scan Rate] - allows you to alter the scan rate set in Step 1: Discover Tags.
PAGE 81
5 • MANAGING POINTS Alter the original scan rate Change the number of points Select the points you want to create by selecting the checkboxes for each point and then clicking [Create]. After all points are created, FactoryTalk Historian ME will display a list of points that were not created in the Points Not Created table if there are any errors. Click [Restart Wizard] to begin the point creation process again. Your browser will prompt you to verify that you want to recreate points using the wizard.
PAGE 82
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Data Collection Status - indicates whether Data Collection is running or stopped. To stop Data Collection, click [Stop Data Collection]. The button immediately changes to [Start Data Collection]. Make sure that Data Collection is fully stopped before starting it again. This may take a few minutes. For optimal performance, stopping and re-starting Data Collection is recommended after tags are created.
PAGE 83
5 • MANAGING POINTS Using the Tag Browser to Create Points The Add Individual Points page provides a consolidated tree view in which you can browse and view controller tags and then select one or more tags for point creation. Click Manage Points in the top navigation bar, then click the Add Individual Points in the left navigation bar to access the page. You can create a maximum of 2500 data points per FactoryTalk Historian ME.
PAGE 84
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Scan Rate - use the drop-down list to set the scan rate. The scan rate is the rate (in seconds) at which the data will be collected. This scan rate setting supercedes the scan rate specified in the tag attribute file. The Add Individual Points page consists of three panes: Folders, Contents, and Selected Tags. Folders Pane The Folders pane displays a list of ControlLogix project files.
PAGE 85
5 • MANAGING POINTS Creating Points To create points in the tag browser: 1. Select the folder that contains tags of interest. The Contents pane displays the tag name and type from the selected folder. The Contents pane is automatically populated Select the folder 2. Check the box in the Select column to select tags in the Contents pane. You can use the All/None checkbox or the Tag Filter to filter the tags. All/None - toggle the All/None checkbox to select or clear all tags.
PAGE 86
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Tune your tag selection with the Tag Filter or the All/ None checkbox Click [Add Tag(s) to List] to move tags to the table below and create points 4. To create points, click [Create]. List of selected tags Click [Create] 5. A confirmation dialog box will prompt you with the question, “Are you sure you want to create these points?” Click [Yes] to proceed. If Data Collection is already running, points will start to collect data.
PAGE 87
5 • MANAGING POINTS A result page will display. The first section provides you with the number of points created, number of points not created and the total number of points in the module. The second section provides Data Collection status. The Points Not Created table provides a list of points not created and the error message that explain the reason why the point was not created. Duplicate tag names are not allowed.
PAGE 88
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Manually Creating and Editing Points To manually create new points or edit point attributes, click Manage Points in the top navigation bar, and then click Edit Points in the left navigation bar. Point attributes tell FactoryTalk Historian ME how and when the server should collect data from a particular data source.
PAGE 89
5 • MANAGING POINTS You can also use the Edit Points page to rename points. 1. Enter search criteria in the available fields and click [Search]. 2. In the search results field, highlight the point you want to rename. 3. At the bottom of the table, click [Rename]. The Point Property page opens. 4. Enter the new point name and click [Save]. Click [Reset] to reset the values. If the Data Transfer service is in Auto Transfer mode, the new points will be created with the new tag names.
PAGE 90
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Defining Point Attributes The Point Property page allows you to specify settings for each point. It contains four sections: General, Exception Filtering, Compression Filtering, and Snapshot Value. Click [Reset] to clear the sheet and enter new values. GENERAL POINT PROPERTIES The General section contains the following fields: 80 Name - provides a label for the point.
PAGE 91
5 • MANAGING POINTS The name must be unique. The first character must be alphanumeric or the percent sign (%). No control characters (such as linefeeds or tabs) are allowed. The following characters are not allowed: * ' ? ; { } [ ] | \ ` ` " ( ) Descriptor - defines 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.
PAGE 92
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Type - specifies the data type of the point values. Changing a point’s data type causes the Archive subsystem to close the current archive record and start a new one with the new type information in the header. For points collected automatically, use the point type that most closely matches the point type in the source system. Selections include: Int16 - used for points whose values are 16-bit integers.
PAGE 93
5 • MANAGING POINTS The default selections available through the FactoryTalk Historian ME web interface include: SYSTEM BatchAct Phases Modes RABoolean You can use the FactoryTalk Historian SE System Management Tools to create additional digital sets. For more information, please refer to the FactoryTalk Historian SE Introduction to Historian System Management guide. Scan Type - determines the scan type for the point.
PAGE 94
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Trigger Input - triggered input tags are used to collect a data point after a particular triggering event has occurred. For trigger input tags, See “Trigger Point Configuration Examples” for a Trigger Input tag configuration sample. Output - triggered output tags are used to output (write-back) a data point to a controller after a particular triggering event has occurred. See “Trigger Point Configuration Examples” for an Output tag configuration sample.
PAGE 95
5 • MANAGING POINTS Span Value - value for the difference between the top of the range and the bottom of the range. It is required for all numeric data type points. Zero Value - indicates the lowest value possible. A zero is required for all numeric data type points. EXCEPTION FILTERING POINT PROPERTIES The FactoryTalk Historian ME exception-reporting specification determines when to send data to the Snapshot subsystem.
PAGE 96
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Field Compression Min Description Value that indicates events are archived if the elapsed time since the previous event is greater than or equal to the minimum time, and the event value has changed by more than the deviation. The value is expressed as dd hh mm ss. Typically, the Compression Min should be 0. Compression Max Value that indicates events are archived if the elapsed time is greater than the maximum time. The value is expressed as dd hh mm ss.
PAGE 97
5 • MANAGING POINTS SNAPSHOT VALUE POINT PROPERTIES The Snapshot Value section contains the following fields: Value - the current value of the tag, which is based on the tag type. Timestamp - time and date stamp for the current value of the tag. Configuring Scan Types The Data Collection service collects points based on scan type and scan rate. You must ensure scan types and scan rates are correctly configured for the Data Collection service.
PAGE 98
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Controller From External Data Source Trigger Input points Controller To External Data Source (Write back) Output points FactoryTalk Historian ME Archive Input Points An input point is a polled, advised, or high speed or triggered point when the data flow is from a controller to the FactoryTalk Historian ME snapshot and archive. For Trigger Input points, a separate trigger point must be configured.
PAGE 99
5 • MANAGING POINTS point source. The point type of the trigger point does not have to be same point type as the Output point. The Output point is associated with the trigger point by setting the Source Tag attribute of the Output point equal to the tag name of the trigger point. Any scan tag referenced in the Extended Description or Scan Tag fields must not be high speed or have a scan rate of faster than 1 second.
PAGE 100
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Treats conditions other than Any as Any. The EVENT keyword: Requires a trigger condition for it to function properly. Allows a space, comma, or semicolon to separate trigger definitions. Keyword Trigger Condition Description Example TRIG The condition is always Any. EVENT Any EVENT Nonzero Trigger on any non-zero value.
PAGE 101
5 • MANAGING POINTS SOURCE TAG The Source Tag field is used to designate a trigger tag. Enter a trigger tag name for the triggered Trigger Input or Output point. Trigger Point Configuration Examples This section contains a set of configuration examples for Trigger Input points and Output points.
PAGE 102
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Triggered Input Point with EVENT Keyword and Increment Condition OUTPUT POINTS 92 Triggered Output Point
PAGE 103
5 • MANAGING POINTS Triggered Output Point with TRIG Keyword Trigger Output Point with EVENT Keyword and Anychange Condition 93
PAGE 104
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Working with Scan Classes A scan class is a code that FactoryTalk Historian ME interfaces use to schedule Data Collection. Scan classes consist of a period of time in seconds, which tells FactoryTalk Historian ME how often to collect the data. You must have administrator privileges to create, edit, or remove scan classes.
PAGE 105
5 • MANAGING POINTS Scan class names cannot be edited in this release 95
PAGE 106
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE After creating, editing, or removing a scan class, a dialog displays indicating that Data Collection and Data Transfer must be restarted. When you have finished modifying the scan classes, click [Restart]. Creating a Scan Class To create a new scan class: 1. Click [New]. The name of the new scan class is entered in the Scan Point field. FactoryTalk Historian ME does not support editing the scan class name. 2. Enter a time value, in seconds, in the Time field.
PAGE 107
6 Collecting Data This chapter contains the following sections: “Collecting Data Overview” “Starting and Stopping Data Collection” “Viewing Data Collection Status” “Storing Data” “Exception Filtering” “Compression Filtering” Collecting Data Overview To view Data Collection information, click Configure Historian in the main navigation bar, and then click Data Collection in the left navigation bar.
PAGE 108
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Total Archive Files - the number of 10-MB archive files residing in the archive. On the 1G FactoryTalk Historian ME, approximately 40 10-MB archive files are pre-allocated as data containers. On the 2G FactoryTalk Historian ME, approximately 130 10-MB archive files are pre-allocated as data containers. Total Archive Files Used - the number of archive files currently being used to store data in the Archive subsystem.
PAGE 109
6 • COLLECTING DATA Viewing Data Collection Status The Status section shows whether Data Collection is running or stopped. The Data Collection service is optimized to collect as many points as possible based on scan rates. Running - indicates that the Data Collection interface is currently collecting and archiving data. Stopped - indicates that the Data Collection interface is currently stopped. Data is not being collected.
PAGE 110
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE These Data Collection controls are also available to the controllers (through the master controller in the chassis) using all controller programming languages, such as Ladder logic. Storing Data To view FactoryTalk Historian ME data storage information, click Configure Historian in the top navigation bar, and then click Data Storage in the left navigation bar. The Data Storage service monitors the NAND flash-based storage used in the module.
PAGE 111
6 • COLLECTING DATA Archive Statistics The Archive Statistics section displays information about file system usage. Total Archive - total amount of disk space allocated for the data archive. Total Archive Used - total amount of disk space currently in use for archived data on the archive partition. Total Archive Free - total disk space available on the archive partition. This space is not currently in use.
PAGE 112
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Log Threshold Configuration The Log Threshold Configuration section allows you to specify a warning level for log files. The range is 95-99%, and the default is 95%. When the log storage reaches its configured threshold, FactoryTalk Historian ME deletes older log files and logs a message in the System Log page: “ has been removed because the /mnt/log partition is full.
PAGE 113
6 • COLLECTING DATA Warning - a capacity percentage between 25 and 100 at which FactoryTalk Historian ME will issue a warning. The default is 50%. Critical - a capacity percentage between 25 and 100 at which FactoryTalk Historian ME will issue a critical message. The default is 75%. You can set FactoryTalk Historian ME to stop Data Collection when it reaches this point.
PAGE 114
A is the last reported value. TEMPERATURE FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE ExcMax ExcDev ExcDev TIME D falls outside the The value DD deadband so the Data Collection service reports it and the previous value to FactoryTalk Historian ME. In the preceding illustration, values A, D, and C are reported to the FactoryTalk Historian ME server. Value A is the last reported value, and values B and C fall within the exception deadband.
PAGE 115
6 • COLLECTING DATA Field ExcMax Description Sets a limit on how long the Data Collection service can go without reporting a value to the FactoryTalk Historian ME server. After the ExcMax time period, the Data Collection service sends the next new value to the FactoryTalk Historian ME server, regardless of whether the new value is different from the last reported value.
PAGE 116
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Parameter NewEvent Description The value/status/timestamp of event to test for exception. Exception reporting works by comparing the new event to the old event as follows: If the time between the new event timestamp and old event timestamp is greater than or equal to the ExcMax, the new event is sent to the Snapshot. For digital points, if the new value differs from the old value, the new event is sent to the Snapshot regardless of excmin time.
PAGE 117
6 • COLLECTING DATA EXCEPTION MINIMUM The Exception Minimum (ExcMin) attribute is a deadband after the previous value. This is used to suppress noise. It is specified in seconds. A new data value that is received before the end of the ExcMin interval will be discarded. EXCEPTION MAXIMUM The Exception Maximum (ExcMax) attribute puts a limit on the length of time that values can be discarded due to exception testing. For example, it is possible for the incoming data to be a single value for many days.
PAGE 118
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE This simple example illustrates how FactoryTalk Historian ME applies data compression. In practice, the curves are more complex than straight lines, and the compression specifications for each tag must be tuned properly to achieve a balance between storage efficiency and accuracy. The same principle applies to compressing real-world data.
PAGE 119
6 • COLLECTING DATA Compression Maximum time (CompMax) Eng Unit Value TIME The compression specifications work in a similar way to the exception specifications. Just like exception reporting, compression is a filter. The difference is that the exception specifications determine which events should be sent to FactoryTalk Historian ME, whereas the compression specifications determine which of the events sent to FactoryTalk Historian ME should go into the archive.
PAGE 120
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE change at all uses very little archive space. A compression maximum time of one work shift (for example, 8 hours) is often a good choice. Use the CompMin to prevent an extremely noisy point from using a large amount of archive space. This parameter should be set to zero for any point coming from Data Collection that does exception reporting. In this case, the exception minimum time should be used to control particularly noisy points.
PAGE 121
7 Transferring Data This chapter contains the following sections: “Transferring Data Overview” “Configuring Data Transfer” “Selecting Points to Transfer” Transferring Data Overview The Data Transfer service works with the Data Storage and Data Collection services to transfer historical data to a FactoryTalk Historian Site Edition (SE) or PI server (available from OSIsoft). The Data Transfer service can only transfer data to one FactoryTalk Historian SE or PI server at a time.
PAGE 122
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Connecting to a New FactoryTalk Historian SE or PI Server If the connection information in the Configuration service indicates a new FactoryTalk Historian SE or PI server, the Data Transfer service needs to build a new Point ID mapping table. The Data Transfer service uses the tag information in the Data Storage service to build the new Point ID mapping table.
PAGE 123
7 • TRANSFERRING DATA Shutting Down the Data Transfer Service When Data Transfer receives a shut down signal from the FactoryTalk Historian ME system, it records it in the system log and changes its status on the Data Transfer page to Stopped. Configuring Data Transfer To configure the Data Transfer service, click Configure Historian in the top navigation bar, and then click Data Transfer in the left navigation bar.
PAGE 124
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Establishing a FactoryTalk Historian SE or PI Server Connection To establish a connection to the FactoryTalk Historian SE or PI server: 1. Enter the FactoryTalk Historian SE or PI server host name or IP address in the Host Server field. This must be a host name or IP address for a single server. FactoryTalk Historian SE server collectives are not supported. 2. Click [Test Connection] to confirm that the FactoryTalk Historian SE or PI server can be accessed.
PAGE 125
7 • TRANSFERRING DATA FactoryTalk Historian SE 115
PAGE 126
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE PI Server 3. Click [Save]. Each field in the FactoryTalk Historian SE /PI Server Parameters section is automatically populated with information from the FactoryTalk Historian SE or PI server once the server connection has been established. Settings determined by the FactoryTalk Historian SE or PI server are: 116 Current Time - the FactoryTalk Historian SE or PI server time. It is read-only.
PAGE 127
7 • TRANSFERRING DATA FTHSE Licensed Points (FactoryTalk Historian SE) - the number of points that have been assigned to the FTMS point source on the FactoryTalk Historian SE. It is based on the currently active license for FactoryTalk Historian SE and is an indication of the number of FactoryTalk Historian ME points that can be transferred to the FactoryTalk Historian SE. Total Licensed Points (PI server) - the number of points that have been assigned to the PI server.
PAGE 128
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Status displays the current Data Transfer status (Running or Stopped). If necessary, click [Start] or [Stopped] to start or stop Data Transfer. Enable Auto Transfer Auto Transfer is disabled by default. If you change to AutoTransfer mode and then click the Enable Auto Transfer checkbox, this provides immediate Data Transfer. Clicking [Save] is not required.
PAGE 129
7 • TRANSFERRING DATA Archive File Time Span for ME-to-SE or PI Server Data Transfer When setting up the FactoryTalk Historian SE or PI server, you must ensure that the archive file time frame covers the archive time frame of FactoryTalk Historian ME. For example, if FactoryTalk Historian ME has been collecting data for the 07/01/ 2009 to 07/05/2009 time period, the FactoryTalk Historian SE or PI server archive time period must also cover the 07/01/2009 to 07/05/2009 time period.
PAGE 130
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The Data Transfer Points page allows you to search for points in the FactoryTalk Historian ME database and assign them for transfer to the selected FactoryTalk Historian SE or PI server. To populate the Data Transfer Points table, enter the search criteria in the data fields and click [Search].
PAGE 131
7 • TRANSFERRING DATA Adding Points to Transfer The table lists all points that fit the search criteria. If the point has been created in the FactoryTalk Historian SE or PI server, this is indicated in the table. All checked points are tagged for transfer to the FactoryTalk Historian SE or PI server. The table lists the following information: Selected - adds the point to Data Transfer. Points that have already been added are checked also. Name - name of the data point in FactoryTalk Historian ME.
PAGE 132
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 122
PAGE 133
8 Administering the Module This chapter contains the following sections: “Setting User Security” “Managing Users” “Managing Groups” “Managing Time” “Working with System Settings” “Uploading Files to the Module” “Backing Up and Restoring Module Configuration Files” “Using the System Log” “Repairing Archives” “Restoring Defaults” “Shutting Down” “Restarting the Module” “Rebooting the Module” Setting User Security You can configure your module for either Fac
PAGE 134
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE If you plan to use the auditing features of FactoryTalk Historian ME while using FactoryTalk Security, you need to create user IDs in User Management that exactly match user IDs in FactoryTalk Security. This will allow you to track changes through a specific user and not a user group. Membership in the piadmin group does not automatically give special privileges. However, the piadmin user account does have unlimited access and cannot be deleted.
PAGE 135
8 • ADMINISTERING THE MODULE piadmin Restore Defaults piuser FTHAdministrators FTHEngineers FTHOperators FTHSupervisors All access View only All access All access View only View only Upload Management All access View only All access All access View only View only Time Management All access View only View only All access View only All access Native Security If you have administrator privileges, you can create, modify (including password reset), or delete users when the FactoryTalk Histori
PAGE 136
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Creating Users To create a new user. 1. On the User Management page, click [New]. 2. Enter a user name. User names must be made up of English alphabet characters and the numeric characters 0-9. 3. Enter a description (optional). 4. Enter a password for the user (optional, but recommended). Passwords cannot be 16 characters long. 5. Confirm the password. 6. Select the group(s) you want this user to belong to (optional). 7. Click [Save].
PAGE 137
8 • ADMINISTERING THE MODULE Managing Groups FactoryTalk Historian ME groups can only be viewed, not changed. To view groups, click Configure Historian in the top navigation bar, and then click Group Management in the left navigation bar. Group Management displays the list of groups. This is a read-only page.
PAGE 138
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Managing Time To manage time in FactoryTalk Historian ME, click Advanced in the main navigation bar, and then click Time Management in the left navigation bar. The Modules’s Current Time field displays the FactoryTalk Historian ME’s current time. Precise timing is critical for most module services including Data Collection, Data Transfer, and Data Storage because all events are time-stamped and the order of these events is important.
PAGE 139
8 • ADMINISTERING THE MODULE at boot time, the module will achieve runtime time precision by periodically resynchronizing with the time source. When changing the module time, do not change the module time to a time earlier than the current module time if Data Collection has already been started. Clock Drifts It is generally a good practice to synchronize all devices to a single reliable time source.
PAGE 140
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Time Synchronization Settings FactoryTalk Historian ME can periodically check external time sources to synchronize its time settings. Synchronization is based on a single selected time source that coordinates time accuracy among different devices in your FactoryTalk environment.
PAGE 141
8 • ADMINISTERING THE MODULE It is critical that you controller’s time is set, configured, and synchronized properly. If your FactoryTalk Historian ME application uses the high speed scan type (collecting data between 10ms and 500ms), the controller generates the timestamp. The RSLogix 5000 installation CD contains a Logix5000 Clock Update tool. The tool lets you view and synchronize the system time of the controllers and devices on a network, using any PC running Microsoft Windows and RSLinx Classic.
PAGE 142
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Due to the potential drift of the real-time clock over time, the Manual Set option should only be used in rare cases such as demonstrations or troubleshooting associated with maintenance. FactoryTalk Historian ME will not synchronize with any time source if you set the time using Manual Set.
PAGE 143
8 • ADMINISTERING THE MODULE Verify your NTP server is listed Note “time reset” and “synchronized to” messages Check the NTP Server field to ensure that your NTP server is properly set. Note the “time reset” and “synchronize to” messages, which indicate successful synchronization. If the time synchronization with an NTP server (including a FactoryTalk Historian SE or PI server) is not successful, you may see the following error messages in the NTP Logs section.
PAGE 144
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE NTP Log Message No reply; clock not set. Message Information The time was not synchronized successfully. Setting the Time Zone Current Time Zone displays the current time zone. Eastern Standard Time (EST) is the default time zone. To set a new time zone, choose a region and time zone from the drop-down menus, and click [Save]. Time zone settings for the module affect the time displayed on the Home page and on system log message timestamps.
PAGE 145
8 • ADMINISTERING THE MODULE . Configuring the Module Name The default module name has the FactoryTalk Historian ME module serial number prepended to -FTHME. For example, A0003027-FTHME. This guarantees a unique name, which is important when the module transfers data to a FactoryTalk Historian SE or PI server. The FactoryTalk Historian ME module name is prepended to the FactoryTalk Historian ME tag name to create the FactoryTalk Historian SE or PI server tag name.
PAGE 146
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Maximum of 64 alpha numeric characters in the name. No special characters (e.g., !, @, #, $, %, ^, &, *) are allowed. Must be unique in relation to other FactoryTalk Historian MEs on the same network. After entering a new FactoryTalk Historian ME name, click [Save]. The new module name is saved. A dialog appears asking you to confirm that you want to change the module name. If you are sure, click [OK].
PAGE 147
8 • ADMINISTERING THE MODULE DHCP is the default setting, and a DHCP server is required to assign the module its initial IP address. Note that the RSLogix 5000 DHCP Server tool can be used to set the IP address. Static IP Address - select this option to use the same IP address every time it powers up. If you enter an IP address that is already in use and reboot the module, you will not be able to access the module through the web interface.
PAGE 148
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Auto-Negotiate - check this box if you want Auto Negotiation to determine speed and duplex parameters. The speed and duplex parameters must match the parameters on the router switch. Speed - the network speed. Ensure that this setting matches the speed set on the switch port that your module is connected to. This field is enabled when Auto-Negotiate is not selected. Duplex - the duplex parameter determines how communication is sent and received.
PAGE 149
8 • ADMINISTERING THE MODULE Follow these steps to upload a file to the module. 1. Select a file type from the drop-down menu. 2. Enter the name of a file in the Please Select File field, or click [Browse...] to locate the file. The file name may only contain the following characters: @, ., -, _, a-z, A-Z, 0-9. The file name may not contain any spaces. 3. Click [Upload To Module] to upload the selected file to the module. The uploaded files are displayed in the table.
PAGE 150
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Backing Up and Restoring Module Configuration Files To back up or restore FactoryTalk Historian ME files, click Configure Historian in the top navigation bar, and click Backup and Restore in the left navigation bar. You must have administrator privileges to back up and restore configuration files. Use Backup and Restore to back up the configuration data of the module to a file and download that file to a remote client.
PAGE 151
8 • ADMINISTERING THE MODULE The backup file contains configuration information for the following: Data Collection Data Storage Data Transfer Security Data Server Point Server Web Server Downloading Files to a Client Computer The Download To Client section shows the last time the backup file was downloaded to the client computer as well as the file name. The file name is based on the date and time the file was created, so you can have more than one configuration file.
PAGE 152
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE After downloading the file from the module, users can use an XML parser to modify the configuration. However, users should not change the following files: datacollection/dconf.xml datastorage/dsconf.xml datatransfer/dtconf.xml Uploading a Backup File to the Module The Upload To Module section shows the last uploaded file name and timestamp. It also allows you to upload a previously backed up file to the module from the client computer.
PAGE 153
8 • ADMINISTERING THE MODULE Restoring the Module from a Backup File To restore the module to a previous configuration, upload the backup file and click [Restore Wizard]. The Restore Configuration Wizard will guide you through a restoration process. After restoring the module configuration, the module will reboot automatically. This may take a few minutes. If a backup file is not stored on the module, the [Restore Wizard] button is greyed out. 1. Stop the module by clicking [Continue].
PAGE 154
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Tags from the module FTHME1 are being transferred to FactoryTalk Historian SE or PI server. When transferred, the module name is added to the tag name (e.g., FTHME1.). FTHME1 is backed up and restored. However, the module name is now FTHME2. The same tags that were already transferred will be transferred again because now their tag name is FTHME2.. These duplicate tags will be counted against your allotted number of points.
PAGE 155
8 • ADMINISTERING THE MODULE 3. Click [Confirm] after you have the confirmed that the backup file is correct, and then click [Continue].
PAGE 156
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 4. Wait for key services to stop and the module to reboot. Using the System Log To work with the FactoryTalk Historian ME system log files, click Advanced in the main navigation bar, and then click System Log in the left navigation bar. The System Log section of FactoryTalk Historian ME web displays messages reported to system log. If you are using IE 7.0 and want to export to Excel, you must install Windows hot fix 929863 (http://support.microsoft.
PAGE 157
8 • ADMINISTERING THE MODULE . When the FactoryTalk Historian ME systems are up and running and connection to the data source is lost, a message similar to the following will be logged: 0 DataCollection 28-Dec-09 19:00:47 [ERROR] HandleNotification() detected erroneous return condition from notify_on_event API. This message is logged once for every 300 errors to keep the log disk space from being flooded with too many error messages.
PAGE 158
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Defining a System Log View The following data fields are provided at the top of the System Log page: Time - use the Time data field to specify time search criteria. The table uses m for minutes and d for days. The default is *-5m. Source - use the Source data field to filter by source. The default is “*”, where “*” or a blank field means no filtering is used and messages from all sources are displayed.
PAGE 159
8 • ADMINISTERING THE MODULE To initiate the archive repair process: 1. Access the FactoryTalk Historian ME Web Diagnostics interface by opening http://:8080 in a browser window. See the “Using Web Diagnostics” more information. The Diagnostics home page displays with the following error message: 2. Click either the Safe Mode link in the left-hand navigation panel or [Repair] and the Safe Mode page displays. The bad archives are listed and selected by default.
PAGE 160
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Use the Safe Mode page to do the following: 150 To download and save an archive file, click Download in the Download Link column. Save the file to the desired location. All archives are downloaded with the extension .rockwell by default. It is recommended that you rename the file. Downloading a file is recommended if you are going to delete the archive file from this page. If you need to create the archive, you will have a copy.
PAGE 161
8 • ADMINISTERING THE MODULE To repair the time, click the Repair Time radio button, enter the correct time, time zone, and region in the fields provided and click [Change Time]. If you choose to repair time, be aware that if you have previously synched your ME module to an external time source such as a controller or an NTP server, clicking [Change Time] will reset your time source to manual.
PAGE 162
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Restoring Defaults To restore FactoryTalk Historian ME to its original configuration, click Advanced in the top navigation bar, and then click Restore Defaults in the left navigation bar. You must have administrator privileges to restore or reset the module. Retaining Backup Files Any backed up configuration file stored on FactoryTalk Historian ME will be deleted as a result of the restoration.
PAGE 163
8 • ADMINISTERING THE MODULE Resetting the Module Clicking [Restore Defaults] restores FactoryTalk Historian ME to its factory default settings. During default restoration, all data will be lost, and the FactoryTalk Historian ME web configuration will be restarted. If you restore the module defaults, you must also restart all module clients.
PAGE 164
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE (admin/admin). If the module was configured for FactoryTalk Security, clicking [Reset Security] will result in the following: Data Collection stops immediately. The module is shut down and restarted using Native security. The administrative piadmin user and users that were created in Native security mode are retained. The piadmin user password is set to blank.
PAGE 165
8 • ADMINISTERING THE MODULE Diagnostics Password]. A dialog appears asking if you are sure you want to reset the password. If you are sure, click [OK]. Shutting Down To shut down the module, click Advanced in the top navigation bar, and then click Module Shutdown in the left navigation bar. The Module Shutdown section displays a message: “Module shutdown will stop all FTH ME related services. Close Module Shutdown, and then remove and re-insert the ME Module.
PAGE 166
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Module shutdown is complete when the scrolling message on the module displays the module’s IP address followed by SHUTDOWN. Remove the module from the chassis after executing the [Module Shutdown] command. You can also shut down the module using the FactoryTalk Historian ME Add-on Profile (AOP) in RSLogix 5000. See “Using the AOP Module Properties Configuration Tab” for more information.
PAGE 167
8 • ADMINISTERING THE MODULE Rebooting the Module To reboot the module, click Advanced in the top navigation bar, and then click Module Shutdown in the left navigation bar.
PAGE 168
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 158
PAGE 169
9 Managing Security This chapter contains the following sections: “Security Overview” “FactoryTalk Security Prerequisites” “Configuring Security” “Managing Passwords” “Understanding User Privileges” “Managing Security Trusts” Security Overview FactoryTalk Historian ME requires a secure user login to access the system. Two types of security can be utilized: Native module security or FactoryTalk Security (FTSecurity).
PAGE 170
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE FactoryTalk Security is a set of services integrated into the FactoryTalk Directory. The module only supports Network Directory centralized security services, managed by FactoryTalk Security. These services are configured in the FactoryTalk Administration Console, which is shipped on your module Client Tools CD. See the FactoryTalk Security documentation for details about FactoryTalk security.
PAGE 171
9 • MANAGING SECURITY Protocol Settings Setting up a secure server is a very complex process and is outside the scope of this documentation. Therefore, Rockwell highly recommends that you have an IT administrator experienced in setting up secure servers set up secure protocols and assist you with module security configuration.
PAGE 172
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE NATIVE SECURITY MODE FactoryTalk Historian ME provides a Native security system so that the module can be used as a standalone device. In this security mode you can set up users and groups to give others access to the FactoryTalk Historian ME system. See “Managing Users” and “Managing Groups” for information on setting up users and groups in Native security mode.
PAGE 173
9 • MANAGING SECURITY FactoryTalk Security can prevent the following: Writes to specified tags from the FactoryTalk Historian ME client. Access to specified displays from the FactoryTalk Historian ME client. For more information about FactoryTalk Security, refer to the FactoryTalk Security help. From the Windows Start menu, go to Rockwell Software > FactoryTalk Tools > FactoryTalk Help.
PAGE 174
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE If you plan to use the auditing features of FactoryTalk Historian ME while using FactoryTalk Security, you must to create user IDs in the User Management page that exactly match user IDs in FactoryTalk Security. This will allow you to track changes through a specific user and not a user group.
PAGE 175
9 • MANAGING SECURITY the network. It is recommended that you use a system that is always up and running to avoid possible failure at login. The secondary server must have the same configuration as the FactoryTalk Directory server, including the FactoryTalk Services Platform CPR 9 SR2, IIS, and web services. See the “FactoryTalk Security Prerequisites” section for additional configuration information. 5. If you selected the HTTPS protocol, select Yes or No to verify certificate parameters.
PAGE 176
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Managing Passwords To manage passwords, click Configure Historian in the top navigation bar, and then click User Management in the left navigation bar. This feature is only available if the module is configured in Native security mode. Changing User Passwords Any user can change their own password, but only members of the piadmin group can reset passwords for other users. 1. On the User Management page, highlight the user whose password you want to reset. 2.
PAGE 177
9 • MANAGING SECURITY 7. Click [Back] to return to the User Management page. Resetting Default Admin Password If the default administrator (piadmin) password is lost or forgotten, and you cannot make administrator level changes to FactoryTalk Historian ME, you must reset the piadmin user password and security settings. On the web interface, go to on the Restore Defaults page located under the Advanced tab and click [Reset Security]. In RSLogix 5000, go to the module properties in AOP.
PAGE 178
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE If the security mode is changed, all groups and users associated with the old security mode is lost.
PAGE 179
9 • MANAGING SECURITY Native Security FTSecurity Operation Administrator Engineer Supervisor Operator piadmin piuser Read Group Information Yes Yes Yes Yes Yes Yes Create/ Modify/Delete Group No No No No Yes No Create/ Modify/Delete Trust Yes No No No Yes No Save NTP Server Yes Yes No No Yes No Synchronize Time Yes Yes No No Yes No Read Backup Status Yes Yes Yes Yes Yes Yes Backup Configuration Yes Yes No No Yes No Download Backup File Yes Yes No No
PAGE 180
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Managing Security Trusts To work with trusts, click Configure Historian in the top navigation bar, then click the Trust Management option in the left navigation bar. Users typically set up trusts in Native security mode to allow client applications that do not support FactoryTalk Security a secure method of accessing FactoryTalk Historian ME.
PAGE 181
9 • MANAGING SECURITY Default Trusts Default Trust records are recreated or edited every time FactoryTalk Historian ME starts. This guarantees access to all applications running on the local machine, even if: The system’s network configuration changes. The address changes as a result of a new network card. The FactoryTalk Historian ME server compares incoming connection credentials with every trust login record. Each field in a Trust record is compared to the corresponding credential field.
PAGE 182
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Creating a Trust To create a trust in the module web interface: 1. Click Configure Historian and then click the Trust Management in the left navigation bar. 2. Click [New]. 3. Enter the name of the trust in the Trust field. The Trust field is required. It is a record name that must be unique within the Trust table. Any alphanumeric combination is acceptable for the name of the trust. Trust names must be made up of English alphabet letters and the numbers 0-9. 4.
PAGE 183
9 • MANAGING SECURITY 9. Enter an IP address in the IP Address field, and enter a subnet mask address in the NetMask field. The IP Address and Net Mask fields are optional and may be used for either PI API or PI-SDK applications. This pair of fields allows matching of exact machine IP addresses or specific subnets. 10. Click [Save] to apply the entered information and submit it to the web server. The newly entered Trust information is displayed in the table.
PAGE 184
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Then go to the module web interface and test the module connection to the FactoryTalk Historian SE or PI server. Depending on what type of data transfer server you are configuring, perform the steps in one of the following sections.
PAGE 185
9 • MANAGING SECURITY 6. Select your FactoryTalk Historian SE from the drop-down menu in the FactoryTalk Historian ME server field. You must create a trust for Data Transfer (datatransfer) and a trust for web applications (webs). This procedure describes creating a Data Transfer trust first. Use this procedure to create a web application trust after you create the Data Transfer trust. Select your FactoryTalk Historian SE server 7. Enter a name for the datatransfer trust in the Trust Name field.
PAGE 186
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE datatransfer Trust webs Trust 13. Repeat steps 3-12 to create a webs trust. Replace datatransfer with webs and add the appropriate information. 14. Select File > Exit from the drop-down menu to exit the SMT application. If you are configuring Data Transfer in the FactoryTalk Historian ME web interface next, you need to ensure that your FactoryTalk Historian SE is configured for Data Transfer.
PAGE 187
9 • MANAGING SECURITY Ensure that licenses to support the FTMS point source have been activated on the FactoryTalk Historian SE server before you configure Data Transfer. To test the module’s connection to the FactoryTalk Historian SE server where the web applications and data transfer trusts you just created reside, perform the following steps. 1. Go to the FactoryTalk Historian SE/PI Server Parameters section. 2.
PAGE 188
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE APPLICATION TRUSTS (PI SERVER) To successfully transfer data between FactoryTalk Historian ME and the PI server, you must create two application trusts on the PI server: webs and datatransfer. To do so, perform the following steps: 1. Launch the OSIsoft SMT application from where you installed it. Navigate to System Management Tools. 2.
PAGE 189
9 • MANAGING SECURITY Select your PI server. 6. Enter a name for the datatransfer trust in the Trust Name: field. Click [Next]. The trust description is optional. 7. Select PI-API application for the trust type. Click [Next]. 8. Enter datatransfer for the application name in the Application Name field. 9. Specify client connection information such as the network path, IP address, and subnet mask for the data transfer trust. Click [Next]. 10. Select a PI user from the drop-down menu. 11. Click [Finish].
PAGE 190
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE datatransfer Trust webs Trust 12. Repeat steps 3-12 to create a webs trust. Replace datatransfer with webs and add the appropriate information. 13. Select File > Exit from the drop-down menu to exit the SMT application. You have completed the trust configuration process.
PAGE 191
9 • MANAGING SECURITY Ensure that licenses to support the FTMS point source have been activated on the PI server before you configure Data Transfer. 1. Under the FactoryTalk Historian SE/PI Server Parameters section, enter the host name or IP address of your PI server in the Host Server field. 2. Click [Test Connection]. An informational message displays at the top of the page if the connection is successful. In addition, a green checkmark displays next to the [Test Connection] button.
PAGE 192
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE 182
PAGE 193
10 Using Web Diagnostics FactoryTalk Historian ME is an embedded system with multiple layers of firmware applications. Firmware applications and hardware components can be found on the FactoryTalk Historian ME Web Diagnostic interface. Information contained in these pages can aid in troubleshooting and performance tuning your module. To access the interface, open http://:8080 in a browser window.
PAGE 194
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Device Description - the version number for FactoryTalk Historian ME. Device Location - the physical slot location of the FactoryTalk Historian ME module in the chassis. Ethernet Address (MAC) - the MAC address of the Ethernet port. IP Address - the IP address of FactoryTalk Historian ME. Production Revision - the revision number of FactoryTalk Historian ME. Firmware Version - the version number of the firmware.
PAGE 195
10 • USING WEB DIAGNOSTICS “Controller Statistics” “ControlBus Statistics” “EtherNet/IP” “Display LED” “Time Management” Overview The Hardware Overview page displays the following information: CPU Usage - the percent of CPU utilization for the module. RAM Usage - the RAM (physical memory) usage in megabytes (and percentage.) NAND Usage - NAND usage (storage) in megabytes (and percentage.) Ethernet Link - displays the module’s Ethernet connection status.
PAGE 196
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE CPU, RAM The CPU, RAM page displays the CPU and RAM statistics as well as results from the Linux top command. To access the page, click Hardware in the top navigation bar of the Web Diagnostics interface, and then click CPU, RAM in the left navigation bar. The CPU, RAM page lists the following information under CPU Statistics: 186 Cache - the amount of CPU cache present on the module. Mode l - CPU information. Speed - CPU speed.
PAGE 197
10 • USING WEB DIAGNOSTICS The CPU, RAM page lists the following information under RAM Statistics: Buffers - total amount of RAM in megabytes that is buffered. Cached - total amount of RAM in megabytes that is cached. Active - total amount of RAM in megabytes that is in use. Inactive - total amount of RAM in megabytes that is not in use. Usage - the percent of total memory utilization for the module. The Top Result section displays results of the Linux top command.
PAGE 198
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The Application section provides FactoryTalk Historian ME server binary files’ disk space allocation statistics. Total Storage - total amount of space allocated for server binary files. Total Storage Used - amount of space in megabytes (and percentage) currently used for server binary files. Total Storage Free - amount of space in megabytes available for server binary files.
PAGE 199
10 • USING WEB DIAGNOSTICS The Controller Statistics page provides information about Logix Controllers in the chassis. Slot Number - the chassis slot in which the Logix Controller is installed. Application Name - the name of the program running on the Logix Controller. Fault Status - the Logix Controller’s current fault status is one of the following: No Fault Minor Fault Major Fault Total Active Points - the total number of active tags between the module and this controller.
PAGE 200
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The ControlBus Statistics page lists the following information: RX bad Multicast CRC - the number of multicast received cyclic redundancy check (CRC) errors since the last power on, module reset, or Internet Cache Protocol (ICP) Object Reset Service received. Multicast CRC Error Threshold - the threshold value for entering a fault state due to multicast CRC errors.
PAGE 201
10 • USING WEB DIAGNOSTICS The EtherNet/IP page lists the following information under Network Settings: Link Status - indicates if FactoryTalk Historian ME is connected to the Ethernet network. IP Address - the FactoryTalk Historian ME IP address. Ethernet Access (MAC) - the FactoryTalk Historian ME MAC address. IP Configuration Mode - indicates the network setting used for the FactoryTalk Historian ME module.
PAGE 202
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Display LED This page displays the current message being displayed or scrolled on the module LED in further detail and the LED statistics. To access the page, click Hardware in the top navigation bar of the Web Diagnostics interface, and then click Display LED in the left navigation bar. The Display LED page lists Current Display and LED Statistics information. Data for either the static or the scroll display will be available.
PAGE 203
10 • USING WEB DIAGNOSTICS Time Management To access the page, click Hardware in the top navigation bar of the Web Diagnostics interface, and then click Time Management in the left navigation bar. Select an NTP log file to view The Time Management page displays the following information: Time Source - the source of the module's current time. See the “Managing Time” section for information about time source options. Current Time Zone - the current time zone for the module.
PAGE 204
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Module's Current Time - the current date and time of the module. RTC Time - the current time of the Real Time Clock (RTC). Last Update Time - the date and time of when the module time was last updated. Controller Path - the path to the Controller system from an external time source. Update Rate - how often the time is updated from an external time source.
PAGE 205
10 • USING WEB DIAGNOSTICS Firmware Diagnostics Firmware components are located on the FactoryTalk Historian ME Web Diagnostics interface under the Firmware tab. To access the interface, open http:// :8080 in a browser window and click the Firmware tab in the top navigation bar.
PAGE 206
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE “Data Server” “Data Collection” “Data Transfer” “Data Storage” “Web Configuration Server” “Web Diagnostics Server” “Startup Log” Overview The Firmware Overview page displays the following information: Component Status - displays the current status of all firmware components, either Running or Stopped. Security Mode - displays the current security mode, either Native or FactoryTalk (FT) Security.
PAGE 207
10 • USING WEB DIAGNOSTICS To access the page, click Firmware in the top navigation bar of the Web Diagnostics interface, and then click Historian Server in the left navigation bar. This page displays the following information: Running Subsystem - lists all runnings subsystems. Tuning Parameters - lists the PI tuning parameters.
PAGE 208
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE The CIP page lists the following information: Process Name - the title of the process. CPU Usage - the percent of CPU utilization. Memory Used - the amount of memory (in megabytes) utilized by CIP. Up Time - the amount of CPU time used. Priority - indicates the precedence order for the process. Nice Value - a value that indicates the CPU process priority. The default value is zero.
PAGE 209
10 • USING WEB DIAGNOSTICS Memory Used - the amount of memory (in megabytes) utilized by the data server. Up Time - the amount of CPU time used. Priority - indicates the precedence order for the process. Nice Value - a value that indicates the CPU process priority. The default value is zero. A high Nice value indicates a lower priority for the process. Negative Nice values are higher priority.
PAGE 210
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Data Transfer The Data Transfer page displays the Data transfer process name, CPU usage, memory used, up time, priority, Nice value, transfer rate, and successful attempts rate. To access the page, click Firmware in the top navigation bar of the Web Diagnostics interface, and then click Data Transfer in the left navigation bar. The Data Transfer page lists the following information: Process Name - the title of the process.
PAGE 211
10 • USING WEB DIAGNOSTICS The Data Storage page displays the following information: Process Information - contains the process name, CPU usage, memory used, up time, priority, and Nice value. Archive Storage Information - displays total archive space, the amount used, and the amount of archive storage space available. Archive Information - displays the total number of archive files, the number of file transferred, total available, and the archive file size.
PAGE 212
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE the web configuration server process. To access the page, click Firmware in the top navigation bar of the Web Diagnostics interface, and then click Web Configuration Server in the left navigation bar. The Web Configuration Server page lists the following information: Process Name - the title of the process. CPU Usage - the percent of CPU utilization. Memory Used - the amount of memory (in megabytes) utilized by the web configuration server.
PAGE 213
10 • USING WEB DIAGNOSTICS The Web Diagnostics Server page lists the following information: Process Name - the title of the process. CPU Usage - the percent of CPU utilization. Memory Used - the amount of memory (in megabytes) utilized by the web diagnostics server. Up Time - the amount of CPU time used. Priority - indicates the precedence order for the process. Nice Value - a value that indicates the CPU process priority. The default value is zero.
PAGE 214
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Admin Components that require administrative privileges are located on the FactoryTalk Historian ME Web Diagnostics interface under the Admin tab. You must provide a user name and password to login. The default is admin/admin. To access the interface, open http://:8080 in a browser window and click the Admin tab in the top navigation bar.
PAGE 215
10 • USING WEB DIAGNOSTICS Click the links in the left navigation bar to view the following Admin diagnostic pages: “Hosts” “Restart Services” “Core Dump Directory” “PI Commands” “Download Logs” “Change Password” If you want to simultaneously log in to the web diagnostics clients for multiple FactoryTalk Historian ME modules, please note the following: If you are using Internet Explorer version 7 or version 8 (compatibility mode), logging out of one tab from a single Internet Expl
PAGE 216
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Use this page to do the following: To add a new host, click [New]. Enter the new host name and IP address and click [Save]. To edit a host, select the host in the list and click [Edit] to make the Host Name and IP Address fields editable. Update the host name and IP address and click [Save]. To delete a host, select the host in the list and click [Delete]. You will be asked to confirm the deletion. Click [OK] to delete the host.
PAGE 217
10 • USING WEB DIAGNOSTICS Core Dump Directory This list contains all core dumps stored on FactoryTalk Historian ME. To access the page, click Admin in the top navigation bar of the Web Diagnostics interface, and then click Core Dump Directory in the left navigation bar. To download a core dump file, highlight it in the list and click [Download]. To delete a core dump file, highlight the file and click [Delete].
PAGE 218
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE PI Commands Executing some PI commands can irreparably damage the data server, stored data, and possibly the FactoryTalk Historian ME module. Rockwell recommends you consult with Rockwell Technical Support before executing any PI command. The PI commands page lists all available PI commands. To access the page, click Admin in the top navigation bar of the Web Diagnostics interface, and then click PI Commands in the left navigation bar.
PAGE 219
10 • USING WEB DIAGNOSTICS When the FactoryTalk Historian ME module is in Safe Mode, PI commands cannot be executed. For information about how to get the module out of Safe Mode, please see “Repairing Archives” on page 148. Download Logs Any kind of firmware upgrade or reinstall will clear out all logs. A firmware upgrade will preserve archived data and application configuration information, but a reinstall will clear out all application configuration information and archived data.
PAGE 220
FACTORYTALK HISTORIAN ME MODULE USER’S GUIDE Current Password: Enter the password for the logged-in user, indicated by the user listed in the User ID field. Desired New Password: Enter the desired new password for the logged-in user. Confirm The New Password: Confirm the new password. A message appears telling you that your password change was successful and that you should now log in with your new password.
PAGE 221
A FactoryTalk Historian ME Rule Editor The FactoryTalk Historian ME Rule Editor allows you to create, change, and delete custom rules for use in the point discovery process. After you create rule files, you can upload them to the module using the Upload Management section of FactoryTalk Historian ME web interface. Tags that match the rules you create will be found and added to the FactoryTalk Historian ME server as part of the tag discovery process in the Add Points Wizard.
PAGE 222
FACTORYTALK HISTORIAN ME USER’S GUIDE If you are using FactoryTalk Historian ME with FactoryTalk Historian SE, you can use the FactoryTalk Historian SE Rule Editor. Rule Editor Overview To launch the Rule Editor, go to the Start menu, and click Programs > Rockwell Software > FactoryTalk Historian ME > Rule Editor. The initial Rule Editor dialog box contains three sections, 1) File Management, 2) Current Rule File, and 3) the Rule table, as well as links to three dialog boxes, 1) View XML File...
PAGE 223
A • FACTORYTALK HISTORIAN ME RULE EDITOR File Management Settings The File Management section contains the following information: Include default rule set Select this option if you want to use the default rules during point discovery. Clear this option if you do not want the default rule set to be used during the discovery process. The default rule set includes rules to find tags in controllers using the built-in data types such as SINT, DINT, REAL.
PAGE 224
FACTORYTALK HISTORIAN ME USER’S GUIDE Tag Attributes File Management… Click to view the Tag Attribute File List dialog box, which provides a means to create and manage your Tag Attributes files. Current Rule File Settings The Current Rule File section contains the following information: File Name - displays the location of the user-defined rule file you selected from the FactoryTalk Historian ME User Defined Rule File List dialog box.
PAGE 225
A • FACTORYTALK HISTORIAN ME RULE EDITOR To create a new rule file: 1. Click [Rule File Management...]. This opens the User Defined Rule File List dialog. The dialog box contains a list of available user-defined You can create multiple user-defined rule files. Within each user-defined file, you can create multiple rules and associate each rule with a Tag Attribute file. However, you can only use one rule file at a time using the Add Points Wizard in the FactoryTalk Historian ME web interface. 2.
PAGE 226
FACTORYTALK HISTORIAN ME USER’S GUIDE 5. (Optional) Create a tag attribute file. Go to “Creating Tag Attribute Files” for details. 6. Add a rule to the current rule file. See “Defining Rules” for more details. 7. Click [Save] to save your work. Defining Rules Once you have your rule file created, use the following steps to add rules to the file. When defining rules, note the following: The data point (tag) name in a FactoryTalk Historian ME consists of multiple nodes separated by a period “.
PAGE 227
A • FACTORYTALK HISTORIAN ME RULE EDITOR 2. Define a description for the rule. This description displays in the FactoryTalk Historian ME Rule Editor list. 3. In the From: section, select the source of historical data. First drop-down menu Use the default selection, LinxEnterprise. Second drop-down menu Use the default selection, LogixController.
PAGE 228
FACTORYTALK HISTORIAN ME USER’S GUIDE based on the sub-elements of the UDT. See “Add these historian points” below. data type Select this option to discover tags based on a match to a data type. Second drop-down menu: select one of the following: starts with Select if the name or data type should start with the string in the string entry field. This option is only available if you have selected Where: name from the list above.
PAGE 229
A • FACTORYTALK HISTORIAN ME RULE EDITOR Using this configuration Select a Tag Attribute File from the list. If you do not select a Tag Attribute file, the default configuration file (FTHMETagDefault.xml) will be used. 5. Click [OK]. The new rule displays in the Rule Table of the FactoryTalk Historian ME Rule Editor. Creating Tag Attribute Files FactoryTalk Historian ME uses a Tag Attribute file named FTHMETagDefault.xml by default. However, you can create your own Tag Attribute files.
PAGE 230
FACTORYTALK HISTORIAN ME USER’S GUIDE 1. Access this dialog by clicking [Tag Attributes File Management...] in the Rule Editor. 2. Click either [New] to add a new tag attribute file or select a file and click [Edit] to edit an existing tag attribute file. 3. Define the following properties: File Name Enter a name for the attribute file. Description Enter a description for the attribute file. A maximum of 80 characters is allowed. Scan class Select a scan rate and scan class.
PAGE 231
A • FACTORYTALK HISTORIAN ME RULE EDITOR unit strings are case-preserving and case-insensitive. The system trims leading and trailing blank spaces during input. A single quote (‘) in a string must be preceded by a double quote (“). Similarly, a double quote in a string must be preceded by a single quote. Long strings can be used for more readable engineering units. Display Digits Controls the format of numeric values on screens and in reports.
PAGE 232
FACTORYTALK HISTORIAN ME USER’S GUIDE Typical value Enter a reasonable value for a point. For a numeric tag, it must be greater than or equal to the value of the Zero property, and less than or equal to the value of the Zero property plus the value of the Span property. Zero Enter the lowest value possible. This attribute is required for all numeric data type points. It does not have to be the same as the instrument zero, but that is usually a logical choice.
PAGE 233
A • FACTORYTALK HISTORIAN ME RULE EDITOR FactoryTalk Historian ME ProcessBook trend with a vertical scale of database. This attribute is not used for non-numeric points. Step Defines how numeric archived values are interpolated. The Step flag affects only numeric points. The default behavior, OFF (0), treats archived values as a continuous signal. Adjacent archived values are linearly interpolated. For example, at 12:00:00, the value 101.0 is archived and at 12:01:00, the value 102.0 is archived.
PAGE 234
FACTORYTALK HISTORIAN ME USER’S GUIDE specifications to determine which of the values that it has received get saved in the Archive subsystem. By filtering out data that you do not need, you get more efficient Archive storage. This process is also called compression testing. The name of the compression testing algorithm used for this process is called the swinging door compression algorithm. To set compression specification attributes, you must set the Compressing Flag to ON (1).
PAGE 235
A • FACTORYTALK HISTORIAN ME RULE EDITOR Exception Maximum (ExcMax attribute) Specifies a limit on how long the interface can go without reporting a value to the FactoryTalk Historian ME server. After the ExcMax time period, the interface sends the next new value to the server, regardless of whether the new value is different from the last reported value. For Digital or String points, only the exception maximum and exception minimum attributes are important.
PAGE 236
FACTORYTALK HISTORIAN ME USER’S GUIDE specification is one work shift (for example, 8 hours). Duplicate values will be archived if the elapsed time exceeds CompMax. You typically set CompMax to the same value for all points in the system. For Digital or String points, only the compression maximum and compression minimum attributes are important. FactoryTalk Historian ME ignores the compression deviation specification for them. See “Compression Filtering” for more information. 6.
PAGE 237
B Data Transfer Sample Scenario The FactoryTalk Historian ME 1G and 2G modules use a CompactFlash memory card to store logged data. Once the module archive becomes full of logged data, it automatically begins overwriting the oldest data. To preserve data collected by the module for long-term storage, you can transfer it to the FactoryTalk Historian SE or PI server.
PAGE 238
FACTORYTALK HISTORIAN ME USER’S GUIDE In the sample scenario described in this chapter, a 2500 tag license has been assigned against the FTMS point source in the FactoryTalk Administration Console for the FactoryTalk Historian SE server. 1. Log into the in FactoryTalk Historian ME web interface as a FactoryTalk Security user with Administrator privileges. 2. Click Configure Historian, and then click Data Transfer in the left navigation bar of the web interface. 3.
PAGE 239
B • DATA TRANSFER SAMPLE SCENARIO Initiating Data Transfer To start the transfer of data to the FactoryTalk Historian SE server, select Configure Historian from the top navigation bar and then select Data Transfer from the left navigation bar. 1. Go to the Data Transfer Parameters section and click [Start]. 2. The Status section changes from Stopped to Running. If the FactoryTalk Historian SE server becomes unavailable, the data will continue to be stored on the module.
PAGE 240
FACTORYTALK HISTORIAN ME USER’S GUIDE again, it will automatically reconnect, and the Data Transfer will continue. The Data Transfer process makes a copy of the data. It remains on the module and also exists on the FactoryTalk Historian SE for centrally accessed data and long-term storage. Using FactoryTalk Historian DataLink This section presents an example of how to use FactoryTalk Historian DataLink to visualize data from both FactoryTalk Historian ME and the FactoryTalk Historian SE.
PAGE 241
B • DATA TRANSFER SAMPLE SCENARIO Using Excel as an Add-In: Example Scenario Open Microsoft Excel where FactoryTalk Historian DataLink is registered as an Add-In. 1. Select cell A10. 2. Navigate to the PI Add-In menu. 3. Select PI > Insert Trend... In this example, MonitorTag is an example tag that is already created in the FactoryTalk Historian ME module. This tag will be trended and compared to the transferred data for the MonitorTag from the FactoryTalk Historian SE server.
PAGE 242
FACTORYTALK HISTORIAN ME USER’S GUIDE a. Select the Data from PI radio button. b. Select the IP address of your module in the Server name: drop-down menu. c. Select the Tag Search picker in the Tag name: section. 5. Under the FactoryTalk Historian ME server option, select the module IP address from the drop-down menu. 6. Click in the FactoryTalk Historian ME server field. The Multi-Server Pick List dialog appears. 7. Click [Ctrl]+ and also select the FactoryTalk Historian SE IP address.
PAGE 243
B • DATA TRANSFER SAMPLE SCENARIO One FactoryTalk Historian ME module IP address One FactoryTalk Historian SE server IP address 8. Click [OK] to save the selection. 9. In the Tag Mask: section, type *mon* and click [Search]. Note that at least two matches appear. One match is from FactoryTalk Historian ME and one from FactoryTalk Historian SE.
PAGE 244
FACTORYTALK HISTORIAN ME USER’S GUIDE 12. Repeat steps 4-11 to select the MonitorTag from the FactoryTalk Historian SE server. The Trend Add-in Wizard screen should appear as follows: 13. Click [Next >] and modify the Start Time from *-8h to *-10m (the last 10 minutes). 14. Check the Enable updates checkbox. 15. Click [Finish].
PAGE 245
B • DATA TRANSFER SAMPLE SCENARIO 235
PAGE 246
FACTORYTALK HISTORIAN ME USER’S GUIDE The report should appear as follows: Note that the green line extends from the FactoryTalk Historian ME module and the blue line extends from the FactoryTalk Historian SE server. The module point is a real-time display and the FactoryTalk Historian SE point lags by a couple of minutes. However, the data is identical. Therefore, the point is positioned directly on top of the FactoryTalk Historian ME module point. 16.
PAGE 247
B • DATA TRANSFER SAMPLE SCENARIO 17. Click and hold the mouse down starting in the bottom right corner and drag to the top left corner to the size the area.
PAGE 248
FACTORYTALK HISTORIAN ME USER’S GUIDE 18. Click [OK] to view the enlarged trend. This concludes the sample scenario for transferring the data logged in the FactoryTalk Historian ME module to the FactoryTalk Historian SE server.
PAGE 249
C FactoryTalk Directory Integration This appendix describes how to integrate a standalone FactoryTalk Historian ME module into an existing FactoryTalk system using FactoryTalk Directory. Integrating a stand-alone module into an existing FactoryTalk system allows you to perform centralized security administration, and it allows existing FactoryTalk clients to connect to the FactoryTalk Historian ME module.
PAGE 250
FACTORYTALK HISTORIAN ME USER’S GUIDE Before you create a connection and register the module in FactoryTalk Directory, you must set the module security mode in the FactoryTalk Historian ME Web. 1. Click Configure Historian, and then click System Security in the left navigation bar of the FactoryTalk Historian ME web interface. 2. Go to the Security Mode section and select the FTSecurity radio button (for FactoryTalk Security). 3. Enter IP address of the FactoryTalk Directory server. 4.
PAGE 251
C • FACTORYTALK DIRECTORY INTEGRATION Creating the Server Connection To create the server connection: 1. From your Windows Start menu, navigate to Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > About PI-SDK. 2. Click Connections to open the Connection Manager. Click Connections to open the Connection Manager 3. From the Server drop-down menu, select Add Server... 4. In the Add Server dialog box, enter the module’s IP address in the Network Node field. 5.
PAGE 252
FACTORYTALK HISTORIAN ME USER’S GUIDE 1. Launch the FactoryTalk Administration Console. From your Windows Start menu, navigate to Programs > Rockwell Software > FactoryTalk Administration Console. 2. Select [OK] to use the Network Directory. FactoryTalk Historian ME and FactoryTalk Historian SE only support the Network option in FactoryTalk Directory. 3. In the FactoryTalk Administration Console Explorer window, go to System > Connections.
PAGE 253
C • FACTORYTALK DIRECTORY INTEGRATION 8. Under Server or Collective Name, either select your FactoryTalk Historian ME IP address from the dropdown menu or enter a new server name or IP address and click [Test Server Connection]. The write-in capability only applies if you are adding the name of a single Historian SE server and not a server collective. For information about adding SE server collectives, please see KnowledgeBase article 61952. You should receive a Server found message.
PAGE 254
FACTORYTALK HISTORIAN ME USER’S GUIDE Management Tools are installed. The FTHAdministrators, FTHEngineers, FTHOperators, and FTHSupervisors user groups represent different levels of user security. For more information about FactoryTalk Security users and groups, see the FactoryTalk Security User’s Guide. The FactoryTalk Historian ME Web login page shows the current FactoryTalk user and the highest privileged group membership.
PAGE 255
C • FACTORYTALK DIRECTORY INTEGRATION A new user property sheet displays. 3. Populate the new user property sheet with user information.
PAGE 256
FACTORYTALK HISTORIAN ME USER’S GUIDE 4. Click the Group Membership tab. 5. Click [Add]. 6. Select the FTHAdministrators group. 7. Click [OK] twice. 8. Click the FTHAdministrators option under User Groups. The FTHAdministrators Properties window will open and the new user is listed as a member in the General tab. Current FactoryTalk user groups Current FactoryTalk users 9. Select File > Exit to close the FactoryTalk Administration Console.
PAGE 257
C • FACTORYTALK DIRECTORY INTEGRATION Using FactoryTalk Historian DataLink FactoryTalk Historian DataLink consists of an add-in for Microsoft Excel. With FactoryTalk Historian DataLink, a user running Excel can exchange information directly with FactoryTalk Historian ME. For additional information on FactoryTalk Historian DataLink, see the FactoryTalk Historian SE DataLink User’s Guide.
PAGE 258
FACTORYTALK HISTORIAN ME USER’S GUIDE 4. Verify that the proper server is selected in the FactoryTalk Historian ME server field of the Tag Search dialog. The FactoryTalk Historian ME server field should contain the module IP address. 5. Type in “*mon*” for the Tag Mask and click [Search]. 6. Select the Monitor tag and click [OK]. The complete tag name should appear in cell B2. 7. Observe that cells B4 and B5 are pre-populated with the start time (five minutes past) and number of values (20).
PAGE 259
C • FACTORYTALK DIRECTORY INTEGRATION 10. Use the cell pick button “_” to populate the Tag Name field cell B2 of the spreadsheet: a. Click the “_” button under the tag name. b. Select cell B2. c. Click [Accept]. 11. Use the cell pick button “_” to populate the Start Time field from cell B4 of the spreadsheet: a. Click the “_” button under the start time. b. Select cell B2. c. Click [Accept].
PAGE 260
FACTORYTALK HISTORIAN ME USER’S GUIDE 12. Use the cell pick button “_” to populate the Number of Values field from cell B5 of the spreadsheet: a. Click the “_” button under the number of values. b. Select cell B5. c. Click [Accept]. 13. Check the show timestamps option. 14. Check the FactoryTalk Historian ME server [opt.] IP Address field to verify that the correct FactoryTalk module server is queried. 15. Click [OK]. The Time Stamp and Value columns in the spreadsheet are populated with data.
PAGE 261
C • FACTORYTALK DIRECTORY INTEGRATION Inserting Trends with the Trend Add-In Wizard Insert trends using the Trend Add-In wizard. 1. Select cell D9.
PAGE 262
FACTORYTALK HISTORIAN ME USER’S GUIDE 2. From the PI menu, choose Insert Trend... 3. In the Trend Add-in Wizard dialog box: a. Select the Data from PI radio button. b. Use the cell picker “_” button to select cell B4 for the tag name. c. Click [Add >].
PAGE 263
C • FACTORYTALK DIRECTORY INTEGRATION d. In the Server name: field, enter the IP address of your module. e. Click [Next >]. f. Check Enable updates. 4. Click the reference worksheet button for Start Time. a. Use the cell picker “_” button to select cell B4 for the Start Time. b. Click [Next >].
PAGE 264
FACTORYTALK HISTORIAN ME USER’S GUIDE 5. Set the optional Trend title to Monitor Tag Levels. 6. Click [Format]. 7. Select the Vertical Scale property and in the Options tab: a. Select General from the Format drop-down menu. b. Select Outside Left from the Position drop-down menu. 8. Click [OK]. 9. Click [Finish].
PAGE 265
C • FACTORYTALK DIRECTORY INTEGRATION The final spreadsheet displays as follows: This concludes the example description of how to: Integrate a standalone FactoryTalk Historian ME module into an existing FactoryTalk system using FactoryTalk Directory. Visualize logged data using FactoryTalk Historian DataLink registered as a Microsoft Excel Add-in component.
PAGE 266
FACTORYTALK HISTORIAN ME USER’S GUIDE 256
PAGE 267
D RSLogix 5000 Add-on Profile The RSLogix 5000 Add-on Profile (AOP) enables integration between a ControlLogix controller and the FactoryTalk Historian ME module. To configure your module in AOP, you need to add the module to the I/O Configuration folder of a project in RSLogix 5000, and then add Ladder logic to your project.
PAGE 268
FACTORYTALK HISTORIAN ME USER’S GUIDE the Modules Profiles Setup Wizard, install Rockwell Automation 1756 Historian Module Profiles. FactoryTalk Historian ME AOP Using AOP: Sample Scenario This section contains a sample scenario for using AOP with your module.
PAGE 269
D • RSLOGIX 5000 ADD-ON PROFILE Setting Up an Ethernet Driver After installing AOP, ensure that you install and configure an Ethernet driver using RSLinx Classic. This allows you to connect to your processor and download Ladder logic to the controller. See the RSLinx Classic online help for additional information. 1. Launch RSLinx Classic by going to Start > Programs > Rockwell Software > RSLinx > RSLinx Classic. 2. Configure an Ethernet driver. a.
PAGE 270
FACTORYTALK HISTORIAN ME USER’S GUIDE c. Click [Add New]. d. Enter the name of the Ethernet module (ENBT or EN2T) in your chassis and click [OK]. .
PAGE 271
D • RSLOGIX 5000 ADD-ON PROFILE e. Enter the Ethernet module IP address in station 0 (the left-most module). f. Click [OK] to save the configuration. g. Click [Close] to exit the Configure Drivers dialog. h. Exit RSLinx Classic. Configuring the Module in RSLogix 5000 This section assumes that: The project file that contains the controller programming and configuration information (also called the .ACD file) already exists in RSLogix 5000.
PAGE 272
FACTORYTALK HISTORIAN ME USER’S GUIDE The processor is in Remote Run mode. To configure the module in RSLogix 5000: 1. Launch RSLogix 5000 by going to Start > Programs > Rockwell Software > RSLogix 5000 Enterprise Series> RSLogix 5000. You can also double-click on an .ACD file to launch RSLogix 5000. 2. Open the RSLogix 5000 project file. Select File > Open. 3. Right-click on the I/O Configuration folder and select New Module. 4. Under Specialty, select the module.
PAGE 273
D • RSLOGIX 5000 ADD-ON PROFILE This step is optional. This field will not set the IP address. It simply displays the information. The IP address is located in the scrolling text across your module’s LED. c. Slot Select the slot number that the module is installed in from the Slot drop-down menu. Note that under Module Definition, [Change] launches a screen to configure Electronic Keying and the Connection Type.
PAGE 274
FACTORYTALK HISTORIAN ME USER’S GUIDE 10. Select the controller. 11. Click [Set Project Path] and ensure that the path is correct. 12. Click [Download] to download to place the controller in Remote Run mode. 13. A window opens. Verify the controller information. The other information in the window warns that the processor will change from Remote Run to Remote Program mode and informs the user that it should be returned to Remote Run mode when the download completes.
PAGE 275
D • RSLOGIX 5000 ADD-ON PROFILE 14. To complete the download process, click [Download]. 15. Click [Yes] when the download is complete to change the mode back to Remote Run mode. The controller will execute the Ladder program. 16. Next, navigate to the Controller folder to find the new tags that were created when the module was added to the I/O Configuration. In the Controller folder, double-click on the Controller Tags folder to list the tags in the right-hand pane. 17.
PAGE 276
FACTORYTALK HISTORIAN ME USER’S GUIDE Starting and Stopping Data Collection: Ladder Logic Control Example In this example, the AOP output tags are used to stop and restart Data Collection. 1. Enter “1” in the StopDataCollection Value field and click [ENTER]. The following occurs: 266 The DataCollectionActive Input status tag will change from 1 to 0.
PAGE 277
D • RSLOGIX 5000 ADD-ON PROFILE The TagsActive Input tag will change from 1001 to 0 because all points are taken off of the scan. This is the number of tags that have been created in FactoryTalk Historian ME with scan set to ON. 2. Enter “1” in the StartDataCollection Value field and click [ENTER]. The following occurs: TagsActive will increase to 1001. DataCollectionActive will change to 1. DataCollectionRate, DataTransferRate, and ArchiveRate will update.
PAGE 278
FACTORYTALK HISTORIAN ME USER’S GUIDE Using the AOP Module Properties Configuration Tab Users can configure FactoryTalk Historian ME module to restore defaults, reset security, shut down or start up from the Module Properties window in AOP. Before clicking any of the buttons on this dialog box, be sure to backup your FactoryTalk Historian ME configuration. The blue left arrow indicates an 'immediate commit' of the specified action, overriding the standard Apply functionality.
PAGE 279
D • RSLOGIX 5000 ADD-ON PROFILE This occurs because the Restore Defaults process takes several minutes to complete. During that time, your web browser will not be available. [Reset Security] resets the module security back to Native mode and sets the piadmin user password to blank. From the keyboard, press [Alt] R. If the FactoryTalk Historian ME module is in safe mode, clicking [Reset Security] will have no effect. For more information about working in safe mode, see “Repairing Archives” on page 148.
PAGE 280
FACTORYTALK HISTORIAN ME USER’S GUIDE 270
PAGE 281
E Hardware Specifications This appendix contains a summary of the FactoryTalk Historian ME hardware specifications. For more hardware information, see the FactoryTalk Historian ME Module Installation Instructions included on the Client Tools CD shipped with your module.
PAGE 282
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Specification Certifications (when product is marked) Description CE: European Union EN61000-6-2, EN61000-6-4, EN61326-1 (Industrial), and 2004/108/EC EMC EN61131-2 (Clause 8, Zones A&B) Directive c-UL-us UL Listed Industrial Control Equipment, certified for US and Canada UL Listed for Class I, Division 2 Group A,B,C,D Hazardous Locations, certified for U.S.
PAGE 283
F Design Considerations and Limitations To design and configure a FactoryTalk Historian ME system successfully, please observe the architectural considerations described in the following sections: “Point Configuration” “Data Collection” “Data Transfer” “Data Storage” “Time Synchronization” “Backup and Recovery” “System Connectivity” “Hardware” “Performance” “FactoryTalk Product Suite” 273
PAGE 284
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Point Configuration This section lists considerations related to point configuration. Point Creation You can create a maximum of 2500 data points per module. If you exceed 2500 data points, the Create button will automatically become deactivated. You can deselect points from the Select field. The Create button will automatically become reactivated when the point count is less than 2510 data points. The maximum number of events per second for tags is 2500.
PAGE 285
F • DESIGN CONSIDERATIONS AND LIMITATIONS Typical Value is between 0 and 100. Typical Value for Digital point types is between 0 and 1. Span value range is always postive. Zero value range is between 0 and 100. EXCEPTION FILTERING Exception Deviation specifies how much a point value must change before a new value is reported. Exception Min limits how often a new event is reported. Exception Max is the maximum length of time the system will run without reporting a new event.
PAGE 286
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Data Collection This section contains Data Collection service considerations. Scan Types Observe the following scan type recommendations: Polled tags are for Data Collection are intended for scan rates greater than 0.5 seconds. Advised tags are for Data Collection are intended for scan rates greater than 0.5 seconds. High Speed tags are for Data Collection are intended for scan rates as fast as 10 ms.
PAGE 287
F • DESIGN CONSIDERATIONS AND LIMITATIONS third-party historians or other upstream servers, use FactoryTalk Historian DataLink to move data out of the module. Observe the following Data Transfer subsystem limits on the module: Transfer a minimum of 5,000 events per transfer session to the FactoryTalk Historian SE or PI server archive. Transfer a maximum of 150,000 events to the FactoryTalk Historian SE or PI server archive. Data Storage This section contains Data Storage considerations.
PAGE 288
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Use the table below to estimate performance impact. Note that Compression and Exception Filtering data storage information in this table is an estimate. Actual compressed data storage ranges will vary with the volatility of the data collected.
PAGE 289
F • DESIGN CONSIDERATIONS AND LIMITATIONS For example, if the Data Collection configuration is based on two scan classes, one with 200 tags at a 250ms scan rate and one with 600 tags at a 2s scan rate, the total events per second is 1100. 200/250ms + 600/2sec <-> 200/.25sec + 600/2sec <-> 800 + 300 events/sec = 1100 events/sec Time Synchronization This section lists considerations related to time synchronization.
PAGE 290
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Hardware ControlLogix Chassis This section lists considerations related to the ControlLogix chassis. Connect up to a maximum of 4 controllers in the same ControlLogix chassis. A maximum of 2 FactoryTalk Historian ME modules in a single chassis. The module does not support a redundant controller chassis.
PAGE 291
F • DESIGN CONSIDERATIONS AND LIMITATIONS Trending is a higher priority task in the Logix controller than user application programs. Trending too many tags at too low of a sample period can impact the Logix controller’s ability to execute user application programs and cause task overlaps. When using FactoryTalk Historian ME, the user must ensure there is sufficient Logix controller bandwidth to service trending without negatively impacting user application programs.
PAGE 292
FACTORYTALK HISTORIAN ME MODULE USER GUIDE View Data If you are monitoring your CPU through the task manager while using View Data, you may see spikes in resource usage due to sorting. To reduce the load on the FactoryTalk Historian ME processor, sorting occurs on the client computer. Web Interface This section contains web interface considerations. The System Status will refresh every 30 seconds to show the current status of several key module services.
PAGE 293
G Troubleshooting This appendix lists some common issues that may occur with your FactoryTalk Historian ME and how to solve them.
PAGE 294
FACTORYTALK HISTORIAN ME MODULE USER GUIDE General Guidelines Providing Issue Information When your FactoryTalk Historian ME is not operating properly, you should collect the following information for Technical Support before rebooting the module or changing the module configuration. This information will assist the Support team in troubleshooting your issues. Check the system log and export log data. Go to the Advanced tab, view the System Log page, and export log data.
PAGE 295
G • TROUBLESHOOTING Rebooting the Module FactoryTalk Historian ME can be rebooted in two ways: In the web interface, go to Advanced in the top navigation bar, and then click Module Shutdown in the left navigation bar. Click [Module Reboot] to reboot the module. See “Rebooting the Module” for more information. Go to the FactoryTalk Historian ME Module Properties page in RSLogix5000 AOP and click [Reset Module]. See “RSLogix 5000 Add-on Profile” for more information.
PAGE 296
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Hardware Symptom If the four-character LED display stops scrolling: Ethernet port lights are not illuminated: 286 Solution Check to see if the data server has stopped functioning. Go to the Web Diagnostics Firmware tab, and check the Data Server page. If the data server has stopped functioning, reboot the module. Check to see if the CIP application has crashed. If so, go to the Web Diagnostics Firmware tab, and check the CIP page for errors.
PAGE 297
G • TROUBLESHOOTING Hardware Symptom If the MAC address scrolls across the display: The ME module is online but you cannot access it through its host name: Solution The Ethernet port has failed to acquire an IP address. Reboot the module. The FactoryTalk Historian ME module host name may have a “_” in its name. According to Microsoft DNS server naming standards, this prevents the module from being recognized by its host name.
PAGE 298
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Web Client Symptom If you can access the FactoryTalk Historian ME web client but cannot log in: If the administrator forgets the login name and/or password: Solution First check that you are using the correct security mode. By default, FactoryTalk Historian ME web client uses Native security, with the administrative user name piadmin.
PAGE 299
G • TROUBLESHOOTING Data Collection Issues This section contains information that may help you troubleshoot FactoryTalk Historian ME Data Collection. For any issue, follow the guidelines provided in the “General Guidelines” section of this appendix. Data Collection Symptom The System Status section on the Home page shows that Data Collection is in “Stopped” mode: Solution Check the module STS LED light. Solid red indicates that Data Collection is inactive.
PAGE 300
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Data Collection Symptom The System Status section on the Home page shows that Data Collection is in “Error” mode: Solution Check the module STS LED light. Solid red indicates that Data Collection is inactive. Go to the Advanced tab to view the System Log page. Check the log for messages about the issue and export log data. Go to the Web Diagnostics Firmware tab, and check the Data Collection page.
PAGE 301
G • TROUBLESHOOTING Data Collection Symptom Snapshot data points displayed on the Current Data page contain timestamps that are not being updated: Solution Check the status of Data Collection on the Home page. Navigate to Time Source > Controller in the web interface. Check for a message that indicates that data collection has discarded data. If Data Collection status is “Running”, check the Collection Rate in the System Status section in the left navigation bar.
PAGE 302
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Data Collection Symptom The module receives a high-speed event with a timestamp 10 minutes into the future, discards that event, and logs the following error message into the system log: Solution Check the controller time. Ensure that the controller time is correct. [ERROR] TagProcessingForPoll edAndAdvised() dropped future event for point with with timeDelta=.
PAGE 303
G • TROUBLESHOOTING Data Storage Symptom The Data Storage page provides information about archive statistics. If unexpected information displays: Solution Go to the Web Diagnostics Firmware tab,. Check the Data Storage page. Process information can confirm whether or not Data Storage is in a undesirable state. N/A indicates an error state. Reboot the module. Data Transfer Issues This section contains information that may help you troubleshoot FactoryTalk Historian ME Data Transfer.
PAGE 304
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Data Transfer Symptom The System Status section on the Home page shows that Data Transfer is in “Error” mode: If Data Collection is running on one or more modules and these modules are transferring data to a FactoryTalk Historian SE or PI server, the FactoryTalk Historian SE or PI server will experience a large load and overflow events if Data Transfer is stopped for some time and then restarted: 294 Solution Go to the Advanced tab to view the System Log pag
PAGE 305
G • TROUBLESHOOTING Data Transfer Symptom If Data Transfer and Data Collection are running on one or more modules, and Data Transfer is stopped and then started on one module after some time has passed, the module may experience data interruption: Solution Restarting Data Transfer on the module may cause data interruption because old timestamps cannot be written to the current archive.
PAGE 306
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Data Transfer Symptom Solution If the FactoryTalk Historian SE or PI server rejects points from a new module that has been added to an existing collection of modules transferring data to that server: Ensure that the points are created in the FactoryTalk Historian SE or PI server before Data Transfer is started. This will ensure that the point database and the archive can be synchronized.
PAGE 307
G • TROUBLESHOOTING Data Export Symptom The export function in the Historian ME web interface does not work: Solution Verify that Microsoft Office Excel version 2007 or 2003 and lower is installed. Open the Registry Editor, navigate to the HKEY_CLASSES_ROOT > .csv folder, and verify that the PerceivedType key is present and has a value of text or document. Auto Recovery Issues This section contains information that may help you troubleshoot FactoryTalk Historian ME auto recovery.
PAGE 308
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Time Management Issues This section contains information that may help you troubleshoot FactoryTalk Historian ME time management. For any issue, follow the guidelines provided in the “General Guidelines” section of this appendix. Time Management Symptom Solution You have forgotten the Go to Web Diagnostics, Hardware tab, Time Management module’s time page. The time source is listed in the Time Source section.
PAGE 309
G • TROUBLESHOOTING Time Management Symptom The module starts in safe mode after a reboot because the user accidentally entered a past time when configuring the module time: Solution The Time Management page will display a warning message. Correct the module time configuration on the Time Management page. Reboot the module. Client Computer Issues This section contains information that may help you troubleshoot the FactoryTalk Historian ME Client Computer.
PAGE 310
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Point Server Symptom The System Status section on the Home page shows that the Point Server is in “Error” mode: Solution This indicates the Point Server is in an undesirable state. Reboot the module. Related FactoryTalk Product Issues This section describes issues related to other FactoryTalk products when they interact with FactoryTalk Historian ME.
PAGE 311
G • TROUBLESHOOTING 1. From Control Panel > Administrative Tools, run the IIS Admin Manager. Expand the virtual directory FactoryTalk/Security/Web Service, then right click on FactoryTalk\Security\WebService\200810.asmx to select Browse. You can now test the FactoryTalk Security (FTSecurity) service interfaces. 2. From Control Panel > Administrative Tools, run Services. Change the startup type for ASP.NET State Service to automatic. Ensure that the asp.net service is started.
PAGE 312
FACTORYTALK HISTORIAN ME MODULE USER GUIDE 302
PAGE 313
Glossary This glossary contains a list of terms and definitions used with FactoryTalk Historian ME. Term Definition .ACD The file extension used for project files created by RSLogix 5000 software. Add-on Profile (AOP) AOP is used by ControlLogix processors to identify and determine characteristics of FactoryTalk Historian ME modules. Archive The historical record of time-series data maintained by the FactoryTalk Historian ME server.
PAGE 314
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Term Definition Attribute, Point A characteristic or parameter of a point that directs an interface and the FactoryTalk Historian ME server in the collection and processing of data values for that point. Available Licensed Points The number of licensed points minus the total number of points already tagged for transfer. This includes tagged points from all modules that are set up to transfer data to the same PI server.
PAGE 315
GLOSSARY Term Definition Compression Maximum See CompMax. Compression Minimum See CompMin. Compression Specification The three base attributes that control the compression process for a particular point: CompDev, CompMax, CompMin. Although it is technically not included in the specification, Span affects CompDev, and Compressing determines whether the specification is needed at all.
PAGE 316
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Term Definition 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 Advanced Computing Engine (ACE) calculations. ExcDev The base attribute that specifies exception deviation in engineering units.
PAGE 317
GLOSSARY Term Definition FactoryTalk Historian ME 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 Security A set of security services are fully integrated into the FactoryTalk Directory. Fixed Archive A type of archive file that allocates all of its disk space at creation time.
PAGE 318
FACTORYTALK HISTORIAN ME MODULE USER GUIDE Term Definition Performance Equation An expression that allows a user to implement an arbitrary and (PE) 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.
PAGE 319
GLOSSARY Term Definition Slot Number The number that indicates the physical location of the slot in the chassis where the module or controller resides. Snapshot Event Either any event sent to the Snapshot subsystem or the event currently residing in the Snapshot table for a particular point.
PAGE 320
FACTORYTALK HISTORIAN ME MODULE USER GUIDE 310 Term Definition Trust A trust allows a system administrator to configure FactoryTalk Historian ME, FactoryTalk Historian SE, or PI server to automatically allow and assign certain credentials to an incoming connection that meets the criteria defined in the trust definition without requiring user authentication. Trusts can be used to allow connections from specific computers, applications, users or a combination of criteria without an interactive login.
PAGE 321
INDEX Index Symbols 8, 20, 22, 59, 60, 63, 113, 129, 149, 171, 173, 174, 178, 186, 189, 192, 201, 202, 269 .ACD files 74, 261, 288, 303, 308 Numerics 1756-EN2T 22 1756-EN2TR 22 1756-ENBT 22 1756-EWEB 22 1756-Lxx 22 A About link 14 page 23 AboutPI-SDK.exe 171 ActiveX 19 trust 171 acview.exe 171 Add Individual Points 73 Add Individual Points See also Tag Browser ADDefault.
PAGE 322
FACTORYTALK HISTORIAN ME USER’S GUIDE diagnostics 189 issues 276 Backup 152 configuration file 142, 279 file contents 141 file download 141 filename and path length limits 142 limitations 279 module configuration 143 module name 140, 143 privileges 124 restore 140 restore procedure 143 status 140 upload 142 Browse tags See also Tag Browser Browser auto refresh 42, 63 current time 129 login 29 logout 32 security protocol 39 time update 129 web client limit 279 web
PAGE 323
INDEX ControlLogix backplane 22 chassis requirements 21 controllers 22 project files 74 system description 10 Core dump directory 207 Core dump files 207, 284 CPU diagnostics 186 requirements 21 speed 186 usage 34, 36, 41 D Data Collection archive rate 97 backup 141 collection rate 97 diagnostics 199 limitations 276 shutdown 155 status 35 stopped 102, 103 troubleshooting 289 data interruption 65, 97, 101, 103, 281, 295 data quality 276 Data Server backup 141 d
PAGE 324
FACTORYTALK HISTORIAN ME USER’S GUIDE EtherNet/IP communication bridge module 22 diagnostics 190 EVENT 81, 88, 90 Event definition 305 out of order 307 scheduling 306 snapshot 309 Event queue 85, 101, 108 ExcDev See also Exception Deviation EXCEL.
PAGE 325
INDEX HTTP 39, 161 HTTPS 39, 165 J Increment condition 90 Instrument tag 81, 90 Item.
PAGE 326
FACTORYTALK HISTORIAN ME USER’S GUIDE FactoryTalk View SE 29 IE7 hot fix 19 Internet Explorer 18 See also Technical Support PE 308 PI commands 209 PI NTP Server 131 PI server 111 PI-SDK trust 171 Point Server backup 141 shutdown 155 status 35 troubleshooting 291, 299 Points Adding to transfer 121 advised 274 attributes 89 Compression filtering properties 85 creating 69, 75, 274 data types 82 digital 110 edit 79 Exception filtering properties 85 failed 72 high spe
PAGE 327
INDEX Polled tags 83 Scan types 83 Advised 83 configuring 87 High speed 84 Output 84 Polled 83 Trigger Input 84 Security backup 141 certificate file upload 138 client log out 160 current settings 39, 196 private key 138 privileges by function 167 privileges by mode 167 reset 154 reset in AOP 167 Selected Rows radio button 61 Selected Tags pane 74 Show Points 57 Show Vertical Bar 57, 59 Shutdown 155, 269 SMT Tag Configurator 14, 65, 153 SMT.
PAGE 328
FACTORYTALK HISTORIAN ME USER’S GUIDE time source 129, 193 troubleshooting 298 Time offset FactoryTalk Historian SE 116 Time zone current 193 setting 134 Timestamps 309 future 148 Trend chart 57 auto refresh 58, 63 configure 57 create 57 TRIG 81, 88, 89, 90 Trigger Input 87, 88 example 91 Trigger Output 87, 88 example 92 Triggers 87 conditions 89 EVENT 81, 88 examples 91 keywords 88, 89, 90 multiple 81 TRIG 81, 88 Trust 11, 45, 124, 169, 310 application 174
PAGE 329
PAGE 330