may lead to personal injury or death, property damage, or economic loss.
economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
may be present.
Read this document and the documents listed in the additional resources section about installation, configuration,
and operation of this equipment before you install, configure, operate, or maintain this product. Users are
required to familiarize themselves with installation and wiring instructions in addition to requirements of all
applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance
are required to be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the
equipment may be impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting
from the use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many
variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume
responsibility or liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits,
equipment, or software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell
Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or
IMPORTANT
Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach
dangerous temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc
Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory
requirements for safe work practices and for Personal Protective Equipment (PPE).
Preface
About this manual
Legal notices
This manual provides procedural instructions for the FactoryTalk Historian ME. It is
one of a set of related manuals that describe installing, programming, and operating
the FactoryTalk system.
To review FactoryTalk Historian release notes and the latest information regarding
product compatibility refer to the Product Compatibility and Download Center
(PCDC).
Rockwell Automation publishes legal notices, such as privacy policies, license
agreements, trademark disclosures, and other terms and conditions on the
Notices page of the Rockwell Automation website.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA") by
opening the License.rtf file located in your product's installation folder on your
hard drive. The default location of this file is: C:\Program Files (x86)\Common
Files\Rockwell\license.rtf
)
Legal
Other licenses
You can view the Open-Source Software (OSS) licenses used in this product by
accessing the FactoryTalk Historian ME Online Help.
Topic name
Reason
153
page 154
page 154
Understand privileges for user
Table updated with SNMP access.
Resource
Description
Summary of
This manual includes new and updated information. Use these reference tables to
locate changed information.
changes
Global changes
None for this release.
New or enhanced features
This table contains a list of topics changed in this version, the reason for the change,
and a link to the topic that contains the changed information.
SNMP community strings on page
Enable SNMP on page 154 New topic.
Create SNMP community strings on
Delete SNMP community strings on
groupson page 143
New topic.
New topic.
New topic.
Additional
These documents contain additional information concerning related products from
Rockwell Automation.
resources
FactoryTalk Historian Machine
Edition Module, 1756-in106
Installation instructions for
FactoryTalk Historian ME Series B.
Overview
Get started
Table of Contents
Chapter 1
Features .......................................................................................................13
10 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 12
Features
Chapter 1
Overview
The FactoryTalk Historian Machine Edition (ME) Module is a fully embedded
historian in a ControlLogix module that you can insert into a Rockwell
ControlLogix chassis to utilize backplane communications and collect data
from multiple controllers. It collects data at very high speeds as well as runs
calculations and statistics on the data inside its storage archive, utilizing
exception and compression filtering to significantly reduce the data archive
space. You can view system and data information through the FactoryTalk
Historian ME web interface and all standard FactoryTalk Historian web
clients.
In this document you will find information on both hardware and software of
FactoryTalk Historian ME.
The FactoryTalk Historian Machine Edition (ME) Module's web interface
allows you to do the following:
• View module information, including status, system utilization, and
system statistic information.
• View current, archive, and trend data.
• Create, edit, and delete points.
• Start and stop the data collection.
• Configure, start, and stop the data transfer.
• Manage users and groups.
• Configure time synchronization.
• Configure the system settings.
• Upload files to the FactoryTalk Historian ME Module.
• Back up and restore configuration files.
• Restore the default settings.
• Shut down or reboot the FactoryTalk Historian ME Module.
• Manage security.
Key advantages of FactoryTalk Historian ME include:
• Easy, automated installation and configuration as well as interactive
browser experience.
As an embedded historian in a ControlLogix chassis connected to the
backplane, FactoryTalk Historian ME is easily installed and
configured. It communicates at very high speeds with the controllers
in its backplane, reducing implementation time from hours, days, or
months to minutes. It quickly auto-detects ControlLogix controllers
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 13
Chapter 1 Overview
and configures all relevant tags to be historized. The web interface
provides easy configuration, administration, and reporting.
• High-speed data collection rates that are ten times (or more) faster
than traditional historian collection rates.
FactoryTalk Historian ME is not limited by network bandwidth. It
leverages backplane communication to increase the speed of data
collection and, with down to a 10 millisecond scan rate, the unit
provides more granular data than is possible on a traditional,
network-connected plant historian.
• 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. It can be pre-qualified from an
OEM in a Factory Acceptance Test (FAT), thereby significantly
reducing overall validation efforts for end users.
Benefits
• Scalable data collection from machine through enterprise.
FactoryTalk Historian ME is modular. It is rack-ready to stand alone,
or can easily be rolled up and configured into a plant-wide historian
for full resolution data collection and data transfer. It can capture data
from up to 5 local controllers and 5 remote controllers.
FactoryTalk Historian ME provides these benefits:
• Reduces time-to-market by monitoring and analyzing operational and
product quality in accord with specifications, operations, and product
constraints.
• Helps reduce time to execute product changes by:
• Assisting with product waste reduction, recycling, and blending.
• Increasing effective equipment capacity and positively impacting
materials cost management.
• Improving product development as it collects and evaluates data
related to new operation actions, materials, equipment, equipment
capabilities, and procedures.
• Identifying operational or production bottlenecks and improving
operating efficiency to avoid unnecessary capital spending.
• Increases compliance by:
• Facilitating, validating, and documenting performance within
regulatory or permitted boundaries.
• Increasing management effectiveness.
• Reducing validation by including OEM delivery and testing.
14 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Distributed FactoryTalk
Historian architecture
Chapter 1 Overview
• Enhances performance by:
• Monitoring or calculating 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.
• Maximizes delivery, quality, and continuous process improvement by:
• Documenting actual versus model production, and identifying
deviations.
• Analyzing for new process and operational boundaries when
throughput, material, or equipment changes occur.
Data or process historians are software applications that log data from
process equipment, manufacturing devices, and other main data sources that
are important and relevant for the overall manufacturing process and for
product quality. The FactoryTalk Historian collects time series data. It collects
data points at given intervals whether or not the data points are changing.
This allows customers to see how these data points are trending, and allows
them to look at correlations of data points.
Because the FactoryTalk Historian continuously collects data, it allows
customers to review past data, and view what occurred at a specific past
point(s) in time. This means that if a specific event such as a downtime event,
a bad batch, or an alarm occurs, an operator can look at any process variable in
the FactoryTalk Historian for the same time frame as the event, and search for
correlations that might explain the event. This allows the user to improve
production and operational processes, eliminating the anomaly in the future.
The FactoryTalk Historian distributed architecture is multi-tiered. It
redefines available options for manufacturers who want to maximize their
ability to collect and analyze process data. It introduces a scalable, modular,
synchronized methodology for collecting, maintaining, and analyzing process
data at each level of manufacturing operations - machine or line, plant and
enterprise (multi-plant). Specifically, FactoryTalk Historian ME:
• 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.
• Offers Rockwell customers a feature-rich set of commercially proven,
industry-focused applications that are widely regarded as the de-facto
standard for plant and enterprise historian capabilities.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 15
Chapter 1 Overview
License points for the data
The following diagram depicts the three levels of the FactoryTalk Historian
distributed architecture.
FactoryTalk and Logix
integration
FactoryTalk licensing
FactoryTalk Historian ME works with the FactoryTalk product suite and
Rockwell ControlLogix and CompactLogix devices. The Logix hardware and
software provide easy and secure access to resources (data, status, and
configuration) within these.
For the up-to-date information on the product compatibility, see FactoryTalk Historian ME Release Notes.
FactoryTalk Historian ME limits the clients that can access it. Client
connections are limited to Rockwell Automation preferred clients. This means
that no anonymous connections will be accepted. The following applications
can access FactoryTalk Historian ME:
• FactoryTalk VantagePoint and FactoryTalk VantagePoint EMI
• FactoryTalk Historian DataLink
• FactoryTalk Historian ProcessBook
• FactoryTalk View SE Trending
• FactoryTalk Administration Console
• PI System Management Tools (SMT)
• PI SMT Tag Configurator and PI Builder
transfer
16 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
The data transfer subsystem works with the data storage and the data
collection services to transfer historical and real-time data to a FactoryTalk
Historian Site Edition (SE) or PI server. Before you can transfer data to
FactoryTalk Historian SE, you must first purchase a point license for
FactoryTalk Historian SE. The point license determines the number of points
that can be transferred to FactoryTalk Historian SE. For each FactoryTalk
Historian ME, the licensed limit is 2500 points.
FactoryTalk Historian ME
Hard disk
Additional resources
Chapter 1 Overview
FactoryTalk Historian ME has the following product number: 1756-HIST2G.
product number
The 2G in the part number indicates how much data storage is associated
with the module.
FactoryTalk Historian ME firmware is stored on the mSATA 8GB SLC hard
disk along with the customer data.
A minimal amount of data is lost if the module suddenly loses power and the
file system remains intact. Archived and snapshot data interruption occurs
only during the first minute of downtime.
In addition, power loss may prevent the data collection from restarting, the
data transfer from reconnecting if it was running, and other processes from
restarting. If power loss occurs, the module may need to be started in the
Logix Designer Module Profile. For details, see "
Use Studio 5000 Logix
Designer Module Profile (page 169)".
These documents contain additional information for FactoryTalk Historian
ME. You can view or download publications from the Client Tools DVD
shipped with your FactoryTalk Historian ME module.
• FactoryTalk Historian ME Release Notes
• FactoryTalk Historian ME Client Tools Release Notes
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 17
This value:
Is the maximum number of:
5 controllers in remote chassis.
50
Modules that can be used to transfer data simultaneously from the ME to a single
SE server.
access to the module based on the total number of connections exceeded.
System connectivity
Get started
In this section you will learn about the following:
Chapter 2
System connectivity (page 19
)
Software and hardware requirements for FactoryTalk Historian ME (page 20)
Upgrade or reinstall the firmware (page 20)
Set up your ControlLogix environment (page 26)
Install FactoryTalk Historian ME Client Tools (page 27)
Configure Internet Explorer for FactoryTalk Historian ME (page 32)
Access the FactoryTalk Historian ME web page (page 42)
While setting up the FactoryTalk Historian ME environment, pay attention to
the following guidelines:
2 Modules per chassis.
10 Controllers that can transfer data to a single module.
There can be a maximum of 5 controllers in the local chassis and a maximum of
5 Clients that can have simultaneous access to the module.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 19
This number includes a web browser, the FactoryTalk Historian SE or PI server,
and any other client tool. After the limit is reached, any client will be denied
Chapter 2 Get started
IMPORTANT
For details, see "Use Studio 5000 Logix Designer M odule Profile (page 169)".
Software and hardware
requirements for
FactoryTalk Historian ME
The hardware and software required for FactoryTalk Historian ME depends
on the demands an application places on the system. A simple stand-alone
architecture is shown below.
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.
Upgrade or reinstall the
firmware
For up-to-date information on the software and hardware requirements, see
FactoryTalk Historian ME Release Notes.
You can upgrade or reinstall the firmware of your Historian ME module using
ControlFLASH.
For details on differences between upgrade and reinstallation, see
"Differences between upgrade and reinstallation (page 21
)".
The process consists of the following steps:
1. Prepare the module for the upgrade or reinstallation.
1. Collect the module-related information (page 21
)
2. Back up the module (page 21)
3. Prepare the module for the upgrade or reinstallation (page 21)
2. Upgrade or reinstall the firmware of your Historian module (page 22).
If you click Restore Defaults or Reset Security from the FactoryTalk
Historian ME Logix Designer Module Profile, the module goes into a pending
state. The pending state blocks you from upgrading or reinstalling the
firmware before one of the following occurs:
• The five (5) minute window expires.
• The module is physically reset in the chassis.
• You power-cycle the module.
Therefore, you can only upgrade or reinstall the firmware when the module is
not in a pending state.
20 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Differences between
upgrade and reinstallation
Back up the module
Prepare the module for the
There are the following differences between upgrading and reinstalling the
firmware:
Chapter 2 Get started
Upgrade
• Updated binary files are installed.
• All log files are deleted.
• The module's configuration data and the archive files are preserved.
Reinstallation
• Updated binary files are installed.
• All log files, module configuration data, and archive files are deleted
• The module's factory settings are restored.
Collect the module-related
information
upgrade or reinstallation
Collect the following information:
• The catalog number of the Historian ME module: 1756-HIST2G.
• The network configuration information.
• The network path to the Historian ME module.
• The firmware version number, which is listed on the Historian ME
module's home page.
As a best practice, we suggest that you back up your module configuration
and download the backup configuration file to your client computer before
performing an upgrade.
For details, see "Back up and restore configuration files (page 131
)".
To prepare the module for the upgrade or reinstallation:
1. In the module web interface, stop the following services:
• The data collection (Configure Historian > Data Collection).
• The data transfer (Configure Historian > Data Transfer).
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 21
2. Open the web browser, and type
http://<ModuleIP_address>:8080. The module Web
Diagnostics interface appears.
3. Record the firmware version number from the Home page.
Chapter 2 Get started
default login and password are admin/adm in.
Upgrade or reinstall the
firmware of your Historian
module
4. (Optional) Click Admin > Download Logs to download all log files.
Tip: To access the Admin section, you must sign in with administrator privileges. The
5. Identify the network path across the backplane in the local chassis
from the network module to FactoryTalk Historian ME as defined in
RSLinx Classic. This is not the path through the front port of the
module. To view the network path across the backplane, see the image
in step 4 in "Upgrade or reinstall the module's firmware".
6. Log out and disconnect all clients (including web clients).
FactoryTalk Historian ME modules' firmware kits are delivered as individual
Device Management Kit (DMK) files. They are compatible with ControlFLASH
in version 13.00 and newer. The installation of ControlFLASH is separate from
the firmware kits, and you need to install it only once.
Tip: We recommend that you use ControlFLASH in version 14.01 or newer.
A DMK is a single, digitally signed file that contains the firmware binaries.
ControlFLASH authenticates DMK’s origin and validates its contents,
providing enhanced protection against malicious threats. You can just
download and use it, no need to install or unzip it. The file is named for easy
identification and management, for example, 1756-HIST2G_5.100 (Install).dmk.
To flash the module firmware, you must have FactoryTalk Linx or RSLinx
Classic installed.
The process consists of the following steps:
1. (Optional) Download ControlFLASH (page 23
)
Perform this step, if you don't have the recommended version already
installed.
2. (Optional) Install ControlFLASH (page 23
)
Perform this step, if you don't have the recommended version already
installed.
3. Download the module firmware kit (page 23
)
4. Upgrade or reinstall the module firmware (page 24)
22 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
(Optional) Download
ControlFLASH
Download the module
Tip: We recommend that you use ControlFLASH in version 14.01 or newer.
Chapter 2 Get started
To download ControlFLASH:
1. Open the PCDC page in your web browser:
http://compatibility.rockwellautomation.com/Pages/home.aspx
To use this site, you must register and log in.
5. Select the package, and then click the download icon.
6. Follow the on-screen instructions to complete the process.
Starting from ControlFLASH version 13.00, when the installation completes,
FactoryTalk Security is enabled by default. When launched, ControlFLASH
logs on to the FactoryTalk Network Directory.
Tip: For details on using ControlFLASH, see its documentation.
To install ControlFlash:
1. Extract the installation package and double-click setup.exe.
The ControlFLASH Setup wizard appears.
2. Follow the instructions to complete the installation process.
To download the module's firmware kit:
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 23
1. Open the PCDC page in your web browser:
http://compatibility.rockwellautomation.com/Pages/home.aspx
To use this site, you must register and log in.
2. Under Download, click Find Downloads.
3. In the search field under FIND DOWNLOADS, type 1756-HIST.
The product name is displayed.
4. Click the product name and choose a version number on the right.
Chapter 2 Get started
folders, or a large number of folders.
Upgrade or reinstall the
module firmware
5. Click DOWNLOADS.
6. Under DOWNLOADS, click Select Files.
The Available Downloads window appears.
7. Choose a file that matches the operation that you want to perform on
the module (Install or Upgrade).
For example, click 1756-HIST2G_5.100 (Upgrade).dmk.
8. Click Downloads in the upper right corner of the window.
9. In the window that appears, click DOWNLOAD NOW.
10. Follow the on-screen instructions to complete the process.
Tip: Before you upgrade or reinstall your module, stop Data Transfer and Data Collection.
To upgrade or reinstall the module's firmware:
1. In the Start menu, find and open ControlFLASH.
The Welcome to ControlFlash window appears.
The In u se information points you to the version of RSLinx that you
currently use. If you have both RSLinx Classic and FactoryTalk Linx
installed on your computer, the Change RSLinx Edition button will be
available and you may choose the edition that you want to use to
perform the steps.
2. Click Next.
The Catalog Number window appears.
If you don't see the catalog number of your Historian module, click
Browse.
Tip: When you download DMK firmware kits from Rockwell Automation PCDC,
ControlFLASH automatically saves the folder location where the DMK files were downloaded
to. By default, ControlFLASH monitors two folders:
• C:\Program Files\ControlFLASH for 32-bit or C:\Program Files (x86)\ControlFlash for
64-bit
• C:\Users\Public\Downloads\RA0
For best performance, we recommend you not using shared folders on a network, disk root
The Firmware Kit Locations window appears.
3. Click Add.
The Browse for Folder window appears.
4. Select the location to which you saved the module's firmware kits, and
then click OK.
The location is added to the Firmware Kit Locations window.
5. Click OK.
6. In the Catalog Number window, select your module's type, and then
click Next.
24 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
The Select the device to update and click OK window appears.
between upgrade and reinstallation (page 21)".
Updates and application
Chapter 2 Get started
7. Choose the device that you want to update with the firmware, and then
click OK.
The Firmware Revision window appears.
The window lists the firmware kits that you have downloaded. The list
may differ from what you see on the image above.
8. Choose the revision of the firmware kit and the operation type that you
want to use, and then click Next.
Tip: To learn about differences between upgrade and reinstallation, see "
Differences
The Summary window appears.
9. Click Finish.
10. In the confirmation message, click Yes.
11. In the warning message, click OK.
The process of upgrading or reinstalling the module begins.
When the process completes, an update status message appears.
It will take the module a couple of minutes to fully initialize. Once the
middle LED (STS) is either flashing or solid color, you can log in to the
module.
notes
12. Start Data Transfer and Data Collection.
Rockwell Automation provides technical information on the web to assist you
in using its products. Refer to our extensive online Knowledgebase for the
most current information about FactoryTalk Historian ME. Visit
https://rockwellautomation.custhelp.com/ to:
• View technical and application notes.
• Obtain software patches and firmware updates.
• Subscribe to product and service e-mail notifications.
• Ask questions.
For an additional level of technical phone support for installation,
configuration, and troubleshooting, we offer TechConnect support programs.
For more information, contact your local distributor or Rockwell Automation
representative, or visit the Rockwell Automation Technical Support site
(http://www.rockwellautomation.com/support/
).
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 25
Chapter 2 Get started
Set up your ControlLogix
To set up your ControlLogix environment:
environment
1. Set up the ControlLogix chassis.
2. Insert the ControlLogix controller(s) into the chassis.
You can connect up to 5 controllers in a single ControlLogix chassis.
3. Power on the system.
4. Configure the ControlLogix device(s).
For details, refer to the ControlLogix Chassis and ControlLogix Controller
documentation.
FactoryTalk Historian ME can connect to:
• The controllers in the same chassis in which it is placed.
• The controllers placed in a remote chassis (ControlLogix and
controllers from the CompactLogix 5370 family).
Tip: For more information about the supported controllers refer to FactoryTalk Historian ME
Release Notes.
If FactoryTalk Historian ME must connect to data in other chassis hardware
such as non-ControlLogix or third-party controllers, you can configure a
ControlLogix controller to act as a data concentrator in the same chassis. This
controller can then be configured to expose the data from the remote
controllers to the FactoryTalk Historian ME. However, it is critical to consider
the increased load that an extra data server will introduce in a ControlLogix
system when configuring the data collection.
FactoryTalk Historian ME’s data gathering and trending impact on a Logix
controller is dependent on the ControlLogix system configuration. This
includes the available Logix controller bandwidth as well as the number of
tags being trended and the sample period. The Logix controller bandwidth is
determined by the controller type, free memory, the system overhead time
slice, and user application programs.
Trending is a higher priority task in the Logix controller than user application
programs. Trending too many tags at a too low sample period can impact the
Logix controller’s ability to execute user application programs and cause task
overlaps. When using FactoryTalk Historian ME, you must ensure that there
is sufficient Logix controller bandwidth to service trending without negatively
impacting user application programs.
26 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Install the module in the
Install FactoryTalk
Chapter 2 Get started
FactoryTalk Historian ME has the following product number: 1756-HIST2G.
chassis
Historian ME Client Tools
The 2G in the part number indicates how much data storage is associated
with the module.
To install the FactoryTalk Historian ME Module, follow the instructions
presented in the Installation Instructions for FactoryTalk Historian ME Module.
FactoryTalk Historian ME receives data from the ControlLogix the data
collection interface and stores it locally in the module. The module data and
system information can be viewed and managed through the FactoryTalk
Historian ME web page.
After you install the module, you can log on to FactoryTalk Historian ME web
page. See "Log on to FactoryTalk Historian ME (page 42
)" for details.
The FactoryTalk Historian ME Client Tools are a set of the following tools:
• FactoryTalk Historian ME Management
See "Install FactoryTalk Historian ME Management (page 28
)".
• FactoryTalk Historian ME Rule Editor
See "Install FactoryTalk Historian ME Rule Editor (page 30
)".
• FactoryTalk Historian ME Logix Designer Module Profile
See "Install FactoryTalk Historian ME Logix Designer Module Profile
(page 31)".
The Client Tools are available on the FactoryTalk Historian ME installation
DVD and as a download package on the
Rockwell Automation Product
Compatibility and Download Center) website.
Tip: If you download the Client Tools from the Rockwell Automation Product Compatibility and
Download Center website and cannot extract the content of the package, check the length of the
path to the directory to which you want to extract the package. If the length of the path to the
directory is longer than 116 characters, you will not be able to extract the package to this location.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 27
Chapter 2 Get started
information.
Install FactoryTalk
Historian ME Management
The FactoryTalk Historian ME Management is available on the FactoryTalk
Historian ME Client Tools installation DVD.
Tip: The FactoryTalk Historian ME Management requires FactoryTalk Services Platform version 2.50
(FTSP SR5) or newer to be installed. Refer to FactoryTalk Services Platform documentation for more
The package is installed with the following FactoryTalk Historian
components:
• PI Software Development Kit (PI SDK)
• FactoryTalk Historian SE RA Components
• MS Runtime Redistributables
For details on the component versions and supported systems, see the
FactoryTalk Historian ME Client Tools Release Notes.
To install FactoryTalk Historian ME Management:
1. Run the FactoryTalk Historian ME Client Tools DVD.
2. On the welcome page of the installation wizard, click Install
FactoryTalk Historian ME Client Tools > Install FactoryTalk
Historian ME Management.
The installation wizard appears.
If there are any software prerequisites missing from the computer or
services that must be stopped, they are listed in red at the bottom of
the installation wizard Welcome page.
Click Cancel, and then click Finish to exit the wizard, install the
prerequisites and/or stop the services, and then start the installation
wizard again.
3. On the Welcome... page, click Next.
4. On the License Agreement page, read and accept the terms of the
license agreement, selecting the I accept... option.
5. Click Next.
6. On the Review Component Installation page, review the list of the
components that are already installed and those that will be installed
during the installation process.
7. Click Next.
8. On the Destination Drive page, select the drive on which you want to
install the product.
If the space available on the drive is not sufficient for the installation, a
warning message will appear below the Installation drive list. In such
a case, select another drive or increase the available space on the drive
you have originally selected. After you have increased the available
space on the selected drive, you can continue with the installation
without restarting the installation wizard.
28 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Tip: You can choose the destination drive only if you install a FactoryTalk Historian
component on the selected machine for the first time. If there have been any FactoryTalk
Historian components installed on the machine before, the Installation drive list will not be
available.
9. Click Next.
The Installation Progress page appears. It lists the components that
are going to be installed. The status of the installation is displayed in
the Status column of the component table.
10. Click Install to start the installation.
If there are any applications, interfaces and/or services that are
currently running on the computer and need to be stopped so that you
can continue with the installation, a message will appear listing the
items to be stopped.
11. Stop the items, and then click Install again.
The following message appears:
12. Click Yes to continue with the installation.
13. Wait until the components are installed.
Chapter 2 Get started
The installation time will vary depending on the number of
components being installed and the computer performance.
Depending on your security settings, you may be prompted to confirm
the installation of individual components.
The installation status is displayed below the component table.
14. Identify the computer that hosts the FactoryTalk Directory server.
- If it is the current computer (localhost), click OK.
- If it is a remote computer, point to the proper FactoryTalk Directory
computer:
1. In the User name box, type the account username with which you
will log on to the FactoryTalk Directory computer.
2. In the Password box, type the password to the account with which
you will log on to the FactoryTalk Directory computer.
3. Click OK.
The Browse for Computer dialog box appears.
4. Select the machine that hosts the FactoryTalk Directory, and then
click OK.
The name of the machine appears in the FactoryTalk Directory Server Location Utility dialog box.
5. Click OK.
6. In the message box informing you that you will need to restart the
computer, click OK.
7. In the Log On to FactoryTalk (New Server) dialog box, type the user
name and password to the newly selected FactoryTalk Directory
machine.
8. Click OK. The system connects to the FactoryTalk Directory server.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 29
Chapter 2 Get started
the Historian suite>\FTHInstallerLogs\<Date and Time of the Installation>
.
Install FactoryTalk
Historian ME Rule Editor
9. In the message box prompting you to restart the computer, click No.
15. On the Installation Wizard Completed page, click Show the
installation log, if you want to view the installation log after the
installation wizard closes.
Tip: The installation log, fth_installer.log, is available in the following location:
C:\Program Files\Rockwell Software\FactoryTalk Historian\Installation Manager\<Name of
If any of the installed components requires rebooting the computer, a
relevant message will appear on the installation wizard page, and you
will be prompted to restart the machine after the installation wizard
closes.
16. Click Finish to exit the installation wizard.
17. Restart the computer.
The Rule Editor allows you to create and edit user-defined rules for the point
discovery process. The selections you make in the dialog box are automatically
written to this file. The data points matching these rules are found and added
to the FactoryTalk Historian server. You can upload the rule file to FactoryTalk
Historian ME using the FactoryTalk Historian ME Upload Manager feature.
To install the Rule Editor:
1. Run the FactoryTalk Historian ME Client Tools DVD.
The installation wizard appears.
2. Click Install FactoryTalk Historian ME Client Tools > Install
FactoryTalk Historian ME Rule Editor.
The FactoryTalk Historian ME Rule Editor installation wizard appears.
3. Follow the on-screen instructions to complete the process.
30 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Install FactoryTalk
Historian ME Logix Designer
(Optional) Install
FactoryTalk Historian ME can be configured to communicate with a
ControlLogix controller through the FactoryTalk Historian ME Logix
Designer Module Profile.
Chapter 2 Get started
Module Profile
FactoryTalk Historian SE
patch
Tip: Install the Module Profile on the computer with RSLogix 5000 or Studio 5000 installed.
To install the Module Profile:
1. Run the FactoryTalk Historian ME Client Tools DVD.
The installation wizard appears.
2. Click Install FactoryTalk Historian ME Client Tools > Install
FactoryTalk Historian ME Logix Designer Module Profile.
The Logix Designer Module Profile installation wizard appears.
3. Follow the on-screen instructions to complete the process.
If you want to integrate your FactoryTalk Historian ME with FactoryTalk
Historian SE 2.1, you need to install the FactoryTalk Historian SE patch. Once
installed, FactoryTalk Historian ME can work with FactoryTalk Historian SE
to collect, store, analyze, and visualize data using reporting tools such as
time-series trends, bar charts, pie charts, pareto, and tabular trends.
EDS files
The Historian SE patch must be installed on the FactoryTalk Directory and
any other computer that will be administering the Historian ME module
through the FactoryTalk Administration Console.
The patch is not necessary for machines with FactoryTalk Historian SE 2.2 or
newer.
You can download the FactoryTalk Historian SE patch from the Rockwell
Automation Knowledgebase page
Electronic Data Sheet (EDS) files are simple text files used by network
configuration tools to help you identify products, and easily commission
them on a network.
The EDS files for the Historian series A module are located on the FactoryTalk
Historian ME installation DVD in the \5.xx.xx-FTHistorianME\EDS folder.
The files are currently a part of RSLinx Classic product installation.
The EDS files for the Historian series B module can be downloaded directly
from the device. The files will be a part of RSLinx Classic product installation
for newer versions of RSLinx Classic.
).
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 31
Chapter 2 Get started
the IP address.
Configure Internet Explorer
for FactoryTalk Historian
ME
In this section you will learn how to configure Internet Explorer to work with
FactoryTalk Historian ME websites.
The following browsers are supported:
• Internet Explorer 11
• Internet Explorer 10
The following operating systems are supported:
• Windows 10
• Windows 8
• Windows 7
• Windows Server 2012
• Windows Server 2008
Tip: This section has been prepared assuming that you access the module by typing its IP
address in the browser. If you acc ess the module by typing the Fully Qualified Domain Name
(FQDN) of the module in the browser, follow the instructions and type the FQDN instead of
Internet Explorer
configuration checklist
To configure Internet Explorer to work with FactoryTalk Historian ME
websites, you need to perform the following actions:
• Add the module site to the Local intranet or the Trusted sites security
zone (page 33).
•Enable the Initialize and script ActiveX controls not marked as safe
for scripting option (page 35) for the particular security zone.
• Enable Compatibility View for the module site (page 35).
• Disable Pop-up Blocker for the module site (page 36).
• Disable ActiveX Filtering (page 36).
• Install and/or enable the Microsoft XML DOM Document add-on (page
36).
• Enable TLS (page 37)
• If you are using Internet Explorer 10, perform the following in the F12
developer tools (page 37):
• Select the Script, Pop-Up Blocker, or CSS option on the Disable
menu.
• Clear the Disable images option on the Images menu.
• Clear the Disable cookies option on the Cache menu.
• Install the module certificate in Internet Explorer (page 38
).
• Clear the browser's cache (page 41).
• Add a registry entry for exporting files to Excel (page 42).
32 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Tip: Internet security is subject to the security policy and it may be changed by the system
administrators. The zone that you choose depends on the corporate Internet security policy.
Add the module site to
Local intranet or Trusted
Add the module website to
sites
Chapter 2 Get started
By default, if you visit a website by typing an IP address in the browser, it is
identified as a website in the Internet security zone. Thus, if you open the
FactoryTalk Historian ME client website using the IP address of the module,
the website will be added to the Internet security zone. However, to work
with the FactoryTalk Historian ME client website, you have to change the
security zone and add the module website to:
the Local intranet security
zone
• The Local intranet security zone (page 33
).
• The Trusted sites security zone (page 34).
By default, the Local intranet security level is medium-low. The Trusted sites
security level is medium.
The medium-low security level is the same as the medium level but without
prompts. Use the Local intranet zone if you do not want to be prompted when
the content of the page is run.
To add the module website to the Local intranet zone:
1. Open the FactoryTalk Historian ME website using the IP address of
the module.
2. On the Tools menu, click Internet Options.
The Internet Options dialog box appears.
Tip: If the top menu is not visible, press the left Alt key on your keyboard to bring up the top
menu.
3. Click the Security tab, and then select Local intranet.
4. Click Sites.
The Local intranet dialog box appears.
5. Click Advanced.
The Local intranet dialog box appears.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 33
Chapter 2 Get started
menu.
Add the module website to
6. Verify that in the Add this website to the zone text box there is a URL
of your module site, and then click Add.
The URL of the module website appears in the Websites list.
Depending on the security protocol used to communicate with the
module, the website URL will be prepended by either the http or the
https prefix. You need to add both URLs, starting with http and https
prefixes, to the Websites list.
7. In the Add this website to the zone text box, type the IP address of the
module with the prefix other than the one of the URL already added to
the Websites list, and then click Add.
Both URLs for the module website appear in the Websites list.
8. Click Close, and then click OK.
the Trusted sites security
zone
To add the module website to the Trusted sites zone:
1. Open the FactoryTalk Historian ME website using the IP address of
the module.
2. On the Tools menu, click Internet Options.
The Internet Options dialog box appears.
Tip: If the top menu is not visible, press the left Alt key on your keyboard to bring up the top
3. Click the Security tab, and then select Trusted sites.
4. Click Sites.
The Trusted sites dialog box appears.
5. Verify that in the Add this website to the zone text box there is a URL
of your module site, and then click Add.
The URL of the module website appears in the Websites list.
Depending on the security protocol used to communicate with the
module, the website URL will be prepended by either the http or the
https prefix. You need to add both URLs, starting with http and https
prefixes, to the Websites list.
6. In the Add this website to the zone text box, type the IP address of the
module with the prefix other than the one of the URL already added to
the Websites list, and then click Add.
34 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Both URLs for the module website appear in the Websites list.
7. Click Close, and then click OK.
menu.
Tip: If you access the website by typing the hostname or DNS name of the module, make
Enable Active X controls
Enable Compatibility View
Chapter 2 Get started
When you are interacting with the FactoryTalk Historian ME websites, scripts
are run on the page to complete various actions (e.g., uploading a file on the
Upload Management page). For this reason, FactoryTalk Historian ME
requires that you customize the security level and enable the Initialize and script ActiveX controls not marked as safe for scripting option.
To enable Active X controls:
1. In the Internet Options dialog box, click the Security tab, and then
click Custom level.
The Security Settings dialog box appears.
2. Under Settings, browse to the ActiveX controls and plug-ins node.
3. Under Initialize and script ActiveX controls not marked as safe for
scripting, click Enable, and then click OK.
Tip: See "Appendix 2: Internet Explorer security zone settings" for a list of all security zone
settings configured for FactoryTalk Historian ME websites.
4. Click OK.
To enable Compatibility View:
1. Open the FactoryTalk Historian ME website using the IP address of the
module.
2. On the Tools menu, click Compatibility View settings.
The Compatibility View Settings dialog box appears.
Tip: If the top menu is not visible, press the left Alt key on your keyboard to bring up the top
3. Verify that in the Add this website text box there is the IP address of
your module site, and then click Add.
sure that they are set in the text box.
4. Click Close.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 35
Chapter 2 Get started
menu.
menu.
Disable Pop-up Blocker
Disable ActiveX Filtering
The FactoryTalk Historian ME website requires pop-up windows to display
online help. You must allow the browser to display pop-ups for the module
site.
To allow pop-ups in Internet Explorer:
• If a warning message appears informing that Internet Explorer has
blocked a pop-up window, in the Options for this site list, select Always allow.
ActiveX Filtering allows or filters out the ActiveX controls running in the
browser on a website. When you are interacting with the FactoryTalk
Historian ME websites, the ActiveX controls are used on the page to complete
various actions (e.g., uploading a file on the Upload Management page). For
this reason, FactoryTalk Historian ME requires that the controls are not
filtered out when you visit the website.
Enable the XML DOM
Document add-on
To disable ActiveX Filtering:
• On the Tools menu, verify that the ActiveX Filtering option is cleared.
Tip: If the top menu is not visible, press the left Alt key on your keyboard to bring up the top
The FactoryTalk Historian ME website requires the Microsoft XML DOM
Document add-on to communicate with the module and send data. Make
sure that the add-on is installed and enabled.
To enable the XML DOM Document add-on:
1. On the Tools menu, click Manage add-ons.
The Manage Add-ons dialog box appears.
Tip: If the top menu is not visible, press the left Alt key on your keyboard to bring up the top
2. Under Microsoft Corporation, verify that all XML DOM Document
add-ons are enabled.
3. If the add-ons are disabled, under Show, select All add-ons.
4. Under Microsoft Corporation, click each XML DOM Document
add-on, and then click Enable.
5. Click Close.
36 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Tip: If the top menu is not visible, press the left Alt key on your keyboard to bring up the top
Enable TLS
Verify the browser
Chapter 2 Get started
The FactoryTalk Historian ME website requires TLS 1.2. Make sure that TLS
1.2 is enabled.
To enable TLS:
1. On the Tools menu, click Internet Options.
The Internet Options dialog box appears.
menu.
2. Click the Advanced tab, and then under Settings select the following
check boxes:
• Use TLS 1.0
• Use TLS 1.1
• Use TLS 1.2
3. For security reasons, clear the following check boxes:
• Use SSL 2.0
• Use SSL 3.0
configuration using the F12
developer tools
4. Click OK.
The F12 developer tools allow you to toggle certain browser features on and
off. These features allow you to properly display the content of the
FactoryTalk Historian ME websites. Verifying the browser configuration
using the developer tools is especially recommended:
• If you are using Internet Explorer 10 or earlier.
• If you are using Windows Server (for more information, see "Appendix
1: Configure Internet Explorer on Windows Server").
To verify the browser configuration using the developer tools:
1. Go to the FactoryTalk Historian ME website, and then press F12.
2. On the Disable menu, make sure that the Script, Pop-Up Blo cker, and
CSS options are cleared.
3. On the Images menu, make sure that the Disable images option is
cleared.
4. On the Cache menu, make sure that the Disable cookies option is
cleared.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 37
Chapter 2 Get started
Install the module
certificate in Internet
Explorer
If you are using a secure communication protocol (HTTPS) to communicate
with the FactoryTalk Historian ME websites, you need to install a security
certificate in the browser. For more information on the security settings
available for FactoryTalk Historian ME, see "Manage security (page 141
)".
To install the module certificate in Internet Explorer:
1. Open the FactoryTalk Historian ME website using the HTTPS protocol
and the IP address of the module (e.g., https://10.76.38.162). You should
see a screen like the one below because your self-signed certificate is
not trusted.
2. Click Continue to this website (not recommended).
The website is loaded and the address bar is shown in red with a
"Certificate error" message in the security status bar next to it.
3. Click Certificate error.
The Certificate Invalid message appears.
4. Click View certificates.
The Certificate dialog box appears with information that the website’s
certificate is not trusted.
5. Verify the certificate:
• Verify that value in the Issued to field corresponds to your module
IP or hostname.
• Verify the value in the Valid to... field. Check if the certificate has
not expired.
6. If the certificate has not expired, click Install Certificate, and follow
the steps in the Certificate Import Wizard to complete the process.
For details, see "
Install the certificate using the Certificate Import
Wizard (page 39)".
If you do not see the Install Certificate button:
1. Close Internet Explorer.
2. Right click the Internet Explorer icon, and click Run as
administrator.
3. Open the FactoryTalk Historian ME website again, and repeat steps
1-6.
38 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Tip: To show the certificate storage hierarchy and allow you to expand the listed stores,
Authorities, select Local Computer.
Install the certificate using
Chapter 2 Get started
To import the certificate using the Certificate Import Wizard:
the Certificate Import
Wizard
1. On the Welcome… page, click Next.
2. Click the Place all certificates in the following store option, and then
click Browse.
The Select Certificate Store dialog box appears.
3. Select Trusted Root Certification Authorities.
select the Show physical stores check box. Then, under Trusted Root Certification
4. Click OK.
5. Verify that the selected certificate store is set to Trusted Root
Certification Authorities, and then click Next.
6. Click Finish.
A warning message appears.
7. Click Yes, and wait for a message informing you that the import was
successful.
8. Click OK to close the message, and then click OK to close the
Certificate dialog box.
9. Exit Internet Explorer.
10. Open the FactoryTalk Historian ME website again.
Verify the certificate
The closed padlock icon next to the address indicates that the
certificate is installed properly.
You can verify the current certificate used by FactoryTalk Historian ME
websites in two ways:
• On the security report of the web browser.
It is a recommended method to verify the certificate. This report
provides detailed information on both the self-signed certificate and
the CA certificate.
For details, see "Verify the certificate on the security report (page 40
• On the System Security page of the Historian website.
This page provides basic information about the self-signed certificate
only, and does not provide any details on the CA certificate.
• For details, see "Verify the certificate on the System Security page
(page 40)".
)".
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 39
Chapter 2 Get started
"Verify the certificate on the security report (page 40)" of the web browser.
Verify the certificate on the
To verify the certificate details on the security report:
security report
1. Open the FactoryTalk Historian ME website using the IP address of
the module.
2. Click the padlock icon located to the right of the address field in
Internet Explorer.
The Website Identification dialog box appears. This is the security
report for the webpage.
3. Click View certificates.
The Certificate dialog box appears.
4. On the General tab, review the following information:
•Issued to
By default, the certificate is issued to IP address of the ME module.
•Issued by
The same as Issued to.
•Valid from - to: The validity date of the certificate.
The certificate is valid for 5 years.
On the General tab, only the date (without the time) is displayed.
You can see both the date and time on the Details tab.
The Valid from value is not only the start date and time of the
certificate's validity period, but also the date and time the certificate
was created.
Verify the certificate on the
System Security page
The date and time changes each time you renew the certificate on the
System Security page.
To verify the certificate on the System Security page:
1. Log on to the Historian ME website using your credentials.
2. Click Configure His torian, and then click System Security.
3. Under HTTPS Settings, in the HTTPS certificate type list, select
Self-Signed Certificate.
4. Verify the certificate information.
Tip: For details on the self-signed certificate, or information about the CA certificate, see
40 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Preserve Favorites website data check box.
Clear the browser cache
Clear the browser cache
Clear the browser cache
If you have already been using the FactoryTalk Historian ME websites, some
of their elements (for example, scripts enabling you to perform actions on the
page) may be stored in your browser cache. To get the latest version of these
elements, you need to clear the browser cache.
You can clear the browser cache manually or automatically.
For details, see:
Chapter 2 Get started
manually
automatically
• "Clear the browser cache manually (page 41
• "Clear the browser cache automatically (page 41)"
)"
To clear the browser cache manually:
1. On the Tools menu, click Delete browsing history.
Tip: Alternatively, you can press Ctrl + Shift + Delete.
The Delete Browsing History dialog box appears.
2. Select the Temporary Internet files and website files check box, and
clear all other check boxes.
Tip: If your FactoryTalk Historian ME site is not added to your Favorites, select the
3. Click Delete, and wait for the confirmation message.
To configure the browser to clear the cache automatically every
time you visit the site:
1. Open Internet Explorer.
2. On the Tools menu, click Internet options.
The Internet Options dialog box appears.
3. On the General tab, click Settings.
The Website Data Settings dialog box appears.
4. On the Temporary Internet Files tab, select the Every time I visit the
webpage option.
5. Click OK.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 41
Chapter 2 Get started
Tip: You have to configure the browser properly to work with the FactoryTalk Historian ME
to access the web interface.
Add a registry entry for
Access the FactoryTalk
Log on to FactoryTalk
exporting files to Excel
Historian ME web page
In some versions of Internet Explorer there is an issue when you try to export
a file to Excel on the System Log page of the FactoryTalk Historian ME client
website, and the Save As dialog box does not appear.
For more information about editing registry entries, refer to Microsoft
documentation.
FactoryTalk Historian ME receives data from the ControlLogix through the
data collection interface and stores it locally in the module. The module data
and system information can be viewed and managed through the FactoryTalk
Historian ME web page. The web interface supports multiple layers of
firmware applications that are designed to collect data, as well as provide
system and module status and statistics.
You can access the FactoryTalk Historian ME web page through a web
browser after the installation of the module.
Historian ME
websites. For details, see "Configure Internet Explorer for FactoryTalk Historian ME (page 32)".
Tip: If a large number of tags is being transferred from the controller to the module when the
module is going through the initial booting up, please wait about five to ten minutes before trying
To log on to FactoryTalk Historian ME:
1. Open your Internet Explorer browser.
2. In the address bar, type the IP address of FactoryTalk Historian ME,
and then press Enter.
The IP address scrolls across the LED display on the front panel of
FactoryTalk Historian ME.
The logon page appears.
Tips:
• The default network configuration type is DHCP. If a DHCP server is not available, then the IP
address will not be displayed. You will either need to configure a DHCP server or use RSLinx
Classic or the FactoryTalk Historian ME Logix Designer Module Profile to set the IP address. For
details, see "Use Studio 5000 Logix Designer Module Profile (page 169
• You can also type the Fully Qualified Domain Name (FQDN) of the FactoryTalk Historian ME
module in the address bar to access the logon page. Type the FQDN in the following format:
<modulename>.<domainname>.<top-level domain>
For example,
module1.mycompany.com
)".
3. Type the default user name piadmin and leave the password text box
blank.
42 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
piadmin
For details on the user and group security, see "Manage security (page 141)".
Log out of FactoryTalk
The first time you log on, the default user name is piadmin and the
password is blank (no password). After logging on, it is highly
recommended that you change the password for the default
user.
4. Click Login.
Tip: It is recommended that you change the blank default
immediately.
Chapter 2 Get started
piadmin
user password
Historian ME
To log out of FactoryTalk Historian ME:
• Click Logout in the upper right corner of the Historian web page.
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.
It is recommended that every user should log out after every session to
prevent unauthorized users from accessing the module without logging into
the module.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 43
This item:
Displays:
page is loaded.
collection and data transfer rates.
Chapter 3
View the module information
The module information is displayed on the following pages of the Home tab:
•Status
This page is open by default.
See "Status (page 46
•Module Identity
)".
System status
See "Module identity (page 48
)".
•System Utilization
See "System utilization (page 51
)".
•System Statistics
See "System statistics (page 51
)".
Additionally, there is also the System Status (page 45) section in the left
bottom corner of every page of the web client.
The system status information appears when you log on to FactoryTalk
Historian ME. It is located in the left bottom corner of every page, and
provides the system status information detailed in the table below.
The information is refreshed automatically every 30 seconds.
CPU usage Percentage of the module’s CPU that is being used.
Note: 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 on the System Utilizatio n page (see "System utilization (page 51
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
)"),
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 45
Memory usage Percentage of the module’s system memory that is being used.
Collection rate Current collection rate from the data collection service in events per minute.
Transfer rate Current transfer rate from the data transfer service in events per minute.
Archive rate Current archiving rate from the Archive subsystem through the server variant
table in events per minute.
Archive usage Percentage of used archive files remaining on FactoryTalk Historian ME. It is
calculated based on the type of data being collected and the rate of the data
collection.
Archive capacity The number of days/hours/minutes (dd:hh:mm) until the storage space on
FactoryTalk Historian ME is used. This calculation is based on the module’s data
Chapter 3 View the module information
Module information
Status
To open the Status page, click the Home tab.
The page displays the following information:
• Module information
See "Module information (page 46
)".
• System status
See "System status (page 47
)".
• System utilization
See System utilization (page 47
)"".
• Point statistics
See "Point statistics (page 47
)".
In the ControlLogix chassis figure, the location of the Historian module in the
chassis slot is marked with green, while the location of the controller with
grey.
The Module Information section displays the following information:
This item: Displays:
Name The name of the module.
Firmware Version The version of the firmware.
Current Time The current time of the module.
Up Time The total time the module has been running.
46 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
This item:
Displays:
Point Server
FactoryTalk Historian ME server that manages the archives and provides access
System status
System utilization
Point statistics
Chapter 3 View the module information
The System Status section displays the following information:
to historical data. The status may be Running or Error.
Data Collection Service FactoryTalk Historian ME data collection subsystem. The status may be Running,
Stopped, or Error.
Data Transfer Service FactoryTalk Historian ME data transfer subsystem. The status may be Running,
Stopped, or Error.
The System Utilization 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.
The Point Statistics section displays information about points configured on
the module in the form of statistics and a pie chart.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 47
Chapter 3 View the module information
Item
Description
rejected by the data server with an error.
Module identity
Review the following for additional information.
Total Points The number of total points on the module.
Total Active Points The number of points actively receiving data.
Incl. Bad Points The number of points out of the Total Active Points which are configured for
collecting data but are not actively receiving it because the point is being
The pie chart rounds the percentage to the nearest whole percent. For
instance, if there are 1000 total points in the system and 995 active points, the
pie chart will still display 100%, but if there are 994 active points, the pie chart
will display 99% and 1%.
To open the Module Identity page, click Module Identity on the Home tab.
The page displays the following information:
• Module information
Module information
See "Module information (page 48
• Network settings
See "Network settings (page 49
• Security configuration
See "Security configuration (page 50
• Client connections
See "Client connections (page 50
)".
)".
)".
)".
48 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
This item:
Displays:
Up Time
The total time the module has been running.
This number cannot be changed.
This item:
Displays:
DHCP is the default configuration.
details, see "Configure system settings (page 127)".
Network settings
Chapter 3 View the module information
The Module Information section displays the following information:
Name The name of the module.
To change your module name, click the Advanced tab, and then click System Settings.
For details on the module name and information on the impact of changing the
module name, see "Change the module name (page 127)" .
Firmware Version The version of the firmware.
Current Time The current time of the module.
To configure time settings, click the Advanced tab, and then click Time Management.
Module Slot Location The location of the module in a slot in the ControlLogix chassis.
Serial Number The serial number of the module.
The Network Settings section displays the following information:
MAC Address The Unique Media Access Control (MAC) address of the module.
This number cannot be changed.
IP Address The Internet Protocol (IP) address of the module.
IP Configuration The Dynamic Host Configuration Protocol (DHCP) or static IP address will display.
Link Status The current connection status of the module's front Ethernet port.
Tip: To change the network settings, click the Advanced tab, and then click System Settings. For
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 49
Chapter 3 View the module information
This item:
Displays:
Security configuration
Client connections
The Security Configuration section displays the following information:
Security Mode The security mode used.
Browser Protocol The browser protocol used.
Tip: For details on changing the security settings, see "Manage security (page 141
)".
The Client Connections section displays the number of clients currently
connected to FactoryTalk Historian ME. There may be up to 5 clients
connected simultaneously to the Historian module.
The following client applications are supported:
• FactoryTalk VantagePoint
• FactoryTalk VantagePoint EMI
• FactoryTalk Historian DataLink
• FactoryTalk Historian ProcessBook
• FactoryTalk View SE Trending
• FactoryTalk Administration Console
• PI System Management Tools (SMT)
50 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
This item:
Displays:
once the page is loaded.
free, as well as the archive file size.
Choose this option:
To display:
See "Network manager (page 52)".
See "Snapshot and archive (page 53)".
See "Archive files (page 56)".
System utilization
System statistics
Chapter 3 View the module information
To open the System Utilization page, click Sys tem Utilization on the Home
tab.
The page displays the following information:
CPU and Processes The current percent of the CPU in use and the processes currently running.
Note: The CPU usage percent listed in the System status section (see "
status (page 47)") 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. It does not change
RAM The memory usage of the module.
Ethernet Statistics The total amount of data sent and received by the module through the network.
Storage (NAND) The total storage space used and available on the installed flash drive. This
section also displays the total number of archive files and how many of them are
System
To open the System Statistics page, click System Statistics on the Home tab.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 51
Network Manager The network management statistics.
Snapshot and Archive The snapshot and archive statistics.
Archive Files The archive file statistics.
Chapter 3 View the module information
Item
Description
ID
The connection ID. This is the primary key.
ID
The process ID number.
Reg App Name
The registered application name.
Peer Name
The host name of connecting machine.
Peer Address
The IP address of connecting machine.
Net Type
The network type.
ConStatus
The connection status.
Elapsed Time
The amount of time passed.
Bytes Sent
The number of bytes sent.
Msg Recv
The number of messages received.
Errors Recv
The number of errors received.
SDK Count
The number of SDKs.
Server ID
The identification number of the server.
The information available on this page may be helpful when troubleshooting
any issues with your module.
Tip: For details on sorting and viewing information in tables, see "Change views (page 67)".
Network manager
Click the Network Manager option to view the current network manager
connection statistics.
The Network Manager section displays the following information:
Path The root directory on the server. This directory is the same for all connections.
Name The connection name.
Reg App Type The registered application type.
Protocol Version The protocol version of connecting application.
52 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Peer Port The port number of connecting machine.
ConType The connection type.
ConTime The time of the connection.
Last Call The time of the last call.
Bytes Recv The number of bytes received.
Msg Sent The number of messages sent.
Errors Sent The number of errors sent.
API Count The number of APIs.
NetMgr Version The number of the network manager version.
Item
Description
Item
Description
53)".
Counter name
Description
point is created and decremented when a point is deleted.
archive.
directly to the archive. This counter shows the number of times this has occurred.
Snapshot and archive
OS Sys Name The operating system name.
OS Node Name The operating system node name.
OS Release The operating system release number.
OS Version The operating system version number.
Machine The system name.
User The user name.
OS User The operating system user name.
Trust The name of the trust connection.
Chapter 3 View the module information
Snapshot and archive
Click the Snapshot and Archive option to view the current FactoryTalk
Historian ME snapshot and archive statistics.
The Snapshot And Archive section displays the following information:
Type The snapshot or archive file type.
Counter The performance counter. For details, see "Snapshot and archive counters (page
Value The current snapshot and/or archive value.
Change The value change between updates.
The following table presents information on snapshot and archive counters.
counters
Point Count The Point Count is the number of points that are currently defined in the Point Database. It is incremented when a
Snapshot Events An "r;event" is the fundamental Historian data element. It represents a value or status of a unique data source at a
Out of Order Snapshot Events Events older than the current Snapshot event are out-of-order events. These events bypass compression and are sent
Snapshots Events Reads Count of all Snapshot reads. This is a simple measurement of how many Snapshot values are read by all applications.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 53
specific time. Specifically an event is a Value, Timestamp, and PointID. Most events come from Historian API- or
Historian SDK-based interfaces. The Historian subsystems ("r;Applications" Historian Batch, Historian Performance
Equations, Historian Total, and Historian Alarm), as well as manual input and laboratory systems are also event
sources.
Every Snapshot event increments the Snapshot Events Counter. The Snapshot Subsystem applies a compression
algorithm to every event. The compression algorithm determines if the previous Snapshot event is passed on to the
Chapter 3 View the module information
Counter name
Description
If a point has its Compressing point attribute set to FALSE, all new events are sent to the Archive Subsystem.
same rate as they come in.
(primary queue).
all the events not yet processed by the archive.
count includes delete and edit events.
Out of Order Events
The Archive Subsystem receives events from the Snapshot Subsystem. If the timestamp of the event is older than the
I/O, and archives filling faster than expected.
of order events on the archive.
specified time period. This counter is incremented for each event returned.
Cache Clean
Rate at which archive cache records are removed from memory.
Unflushed Points
Indicates the number of points with any number of events not yet flushed.
Events Sent to Queue Events that pass compression, or are out of order, are sent to the Event Queue, and thus increment this counter.
Under normal operating conditions, this count indicates the number of events that passed the compression test (that
is, the events were different from existing events and could not be eliminated) and are being sent to the archive.
The ratio of Snapshot events to Events Sent to Queue is the system aggregate compression ratio. This ratio gives a
quick view of overall system compression tuning. Ratios less than 2:1 indicate low compression; a compression tuning
evaluation should be performed. Ratios greater than 10:1 indicate over-compression; a compression tuning evaluation
should also be performed.
Three Point Database attributes affect compression: CompDev, CompMin, and CompMax. These are known as the
compression specifications.
Events in Queue Events passed to the EventQueue are put in the First-In-First-Out order. The Events in Queue
Counter is incremented when the event is put in the Queue; it is decremented when the
Archive Subsystem successfully retrieves and processes the event.
When the system is shut down, the Event Queue is preserved in the file PI\dat\pimapevq.dat.
This assures no data loss when the system shuts down, or when the archive subsystem is not processing events at the
Number of Overflow Queues If the queue PI\dat\pimapevq.dat becomes completely full, a new queue is created. This should not occur under
normal circumstances and this number will be 0. However, if the archive is not processing events, a number of such
queues (up to 65536) can be created. This counter shows how many queues were created. These additional queues
are automatically deleted after the archive subsystem processes them.
Note: When multiple Event Queues exist, the file pimapevq.dat is renamed to pimq0000.dat, and additional queues
are named pimq<id>.dat where id is the queue number in hexadecimal representation (from 0000 to FFFF). The
piartool &endash;qs command always shows information from the queue to which the Snapshot Subsystem is writing
Total Overflow Events This is the total number of events in all Overflow Queues. The sum of this counter and the Events in Queue counter are
Estimated Remaining Capacity Estimated maximum number of events with the current queue file.
Archived Events The Archived Events counter is incremented for every new event written to the archive (via the archive cache). This
last event in the target record, it is considered an out-of-order event and is added to this counter.
Excessive out-of-order events might lead to system problems such as excess processor consumption, excessive disk
Events Cascade Count Out of order events are inserted into the target record. The insert requires moving other events within the record. If
the record is full, one or more events are forced out of the record into the adjacent record. This counter is
incremented each time an insertion forces an event out of a record. This counter is an indication of the impact of out
Events Read Number of events read by all applications. For example, a trending application requests an array of events over a
Read Operations Number of archive read requests. Each archive read request increments this counter once, regardless of the number
of events returned.
Cache Record Archive cache records in memory.
Cache Records Created Rate at which archive cache records are created in seconds.
Cache Record Memory Reads Rate of archive cache memory hits in seconds.
Archive Record Disc Reads Rate of archive record disc reads in seconds.
Archive Record Disc Writes Rate of archive record disc writes in seconds.
Unflushed Events Indicates the total number of events not yet flushed to disk.
Point Flush Number of points flushed to disk. Busy points might get flushed several times per cycle.
54 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Counter name
Description
as a Windows Performance Counter.
Note that the Primary Archive will never overwrite itself.
piartool -be
with the piartool -systembackup command.
consumption.
Chapter 3 View the module information
Primary Archive Number 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.
The primary number is the internal index number of archive currently assigned to primary position.
Archive Shift Prediction (min) Archive Shift (hr) estimates the predicted time to the next archive shift. Use piartool -al to list the target archive file
for shift. The target archive will be initialized on shift; if it contains data, make sure it is backed up. If this data is
required to remain online, a new archive of adequate size should be created and registered.
When the current archive is less than 20% full, the estimate is 0. In order to determine whether a zero estimate
means the archive is nearly full or not, run piartool -al. The message will tell you if there is not enough data for a
prediction.
Shift Time: Not enough information for prediction
The shift prediction in piartool -as differs slightly from the one in piartool -al. The piartool -al figure is calculated
when called. The piartool -as command shows the latest 10 minutes average. The latter number is availabl e
Archiving Flag Indicates whether or not events may be written to the archive.
A value of 1 indicates that events may be written. A value of 0 indicates that events may not be written.
The Archiving Flag is set to 1 when there is a mounted Primary Archive. A Primary Archive may be registered but not
mounted, for example during an archive shift. In this case, the Archiving Flag would be set to 0. This flag is also set to
0 when in backup mode.
All registered archives may be viewed using piartool -al. The Archive Flag is set to 0 if the
Primary Archive becomes full and there is no other archive file available into which to shift.
Archive Backup Flag This flag is set to 1 when the archive is in the backup mode. The value is 0 when the archive is available for normal
access.
To enter the backup mode, run the
Toe exist the backup mode, run the
piartool -bs command.
command.
Archive Loaded Flag This flag is 1 when a valid primary archive is mounted. It is 0 if the primary archive is not mounted.
Shift or System Backup Flag This flag is 1 when the archive is in the shift mode or the Archive Subsystem has been placed in the backup mode. The
shifts occur automatically or can be forced via the piartool -fs command. System backup mode is entered
Failed Archive Shift Flag Set to 1 when a shift should occur but no shiftable archive exists. Under normal conditions this flag is 0.
Overflow Index Record Number of index records. Index records speed up access to overflow records. Index records are created when two
overflow records for a point are full, and third one is being created. This counter is a measurement of archive file
Overflow Data Record Number of non-primary data records. Each archive has a primary record for each point. When this record is full, data
is written to overflow records. This counter gives a measurement of archive consumption.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 55
Chapter 3 View the module information
Item
Description
Empty - indicates that the archive has no data.
Start Time
The time that data was first written to the archive file.
Backup Time
The last time and date the archive file was backed up. Never indicates that the
• Mounted
Archive files
Click the Archive Files option to view archived system 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. When the primary archive is being
backed up, you cannot modify that archive or the Point database.
Each archive file contains events for a time period specified by the archive
start time and end time. The archive files on each FactoryTalk Historian ME
server should cover all time ranges, without overlapping time ranges or gaps
in time. A list of archive files stored on FactoryTalk Historian ME are
displayed by default when you select the Archive Files option.
The Archive Files section displays the following information:
Archive File The archive file name, which includes the full path.
Status The archive status displays one of the following:
• Primary - the archive file that is currently receiving data.
• Has Data - indicates that the archive file contains data and is full.
•
Size (MB) The archive file size in megabytes.
End T ime The time that data was last written to the archive file.
Lifetime The archive file age in days, hours, minutes, and seconds.
Last Modified Time The last time and date the archive file was modified.
State The state of the file:
Type Indicates the type of file, which is always Fixed size.
Write Flag Specifies if a file is writable or read-only.
Shift Flag Specifies if a file is shiftable or not shiftable.
Add Rate/Hour The rate at which files are added to the archive per hour.
56 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
file has never been backed up.
• Created
• Initialized
• Dismounted
Item
Description
Chapter 3 View the module information
% Full The percentage of the archive that is being used.
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.
Record Size The record size for each archive record.
Version The version of the archive header.
# The archive number used by FactoryTalk Historian ME.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 57
Define search criteria
Chapter 4
View data
You can view the following types of data on the pages of the View Data tab:
• Current data
See "View current data (page 62
• Archive data
See "View archive data (page 62
• Trends
See "View trends (page 63
To display data, define your search criteria first. For details, see "Define search
criteria (page 59)".
To export data, see "Export data (page 61)".
To change the way in which the data is displayed, see "Change views (page
67)".
The search rules presented below apply to all the pages on the View Data tab.
)".
)".
)".
To search data:
1. Define your search criteria in the boxes at the top of the page.
2. Click Search.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 59
The information specified in the search criteria is displayed.
Using the asterisk (“*”) in the search boxes
The asterisk that appears in the search boxes functions as a wildcard value.
You can use it to:
• Represent a contiguous series of characters (for example: *xxx*, *xxx,
or xxx*).
• Return data that meets all conditions for the given search box.
• Return ALL points in the system. To do so, leave the asterisk in all the
search boxes.
Chapter 4 View data
Point source
Description
Point type
Description
Int32
A 32-bit integer value.
String
A string value.
Option
Description
search conditions.
Option
Description
search conditions.
To define search criteria:
1. In the Point Name box, type the point name criteria such as the full
name, partial name, or wildcard value for the data you would like to
search.
2. In the Point Source box, type the point source for the current data.
The point source is the base attribute that identifies the interface or
other scanning software responsible for providing data for the
associated point. Common point sources depend upon your
environment. They include the following:
FTME The default point source for FactoryTalk Historian ME.
T The Totalizer utility subsystem.
C The Performance Equation subsystem.
3. In the Point Type list, select the point type.
Point types include:
Int16 A 16-bit integer value.
Float16 A 16-bit floating point value.
Float32 A 32-bit floating point value.
Float64 A 64-bit floating point value.
Digital A digital value.
Timestamp A timestamp value.
4. In the Scan Rate list, select a scan rate.
The scan rate is the rate (in seconds) at which the data is collected.
5. In the Archiving list, select one of the following options 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
6. In the Scan list, select one of the following options to search for points
with a specific scan bit setting:
60 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
On Returns points where the scan bit is set to On.
Off Returns points where the scan bit is set to Off.
Asterisk (*) Returns points that meet either condition (On or Off) and meet the other
7. Click Search to initiate the tag search.
Item
Description
option.
Timestamp
The time that the last value was returned for the specified data point.
Type
The data type for the listed point. If the point is of Boolean or String
Tip: For information on filtering the search results, see "Filter search results data (page 67)".
configuration page, Excel generates an ”r;Output exceeds dimension” message.
Export data
Chapter 4 View data
The search populates the Points table with the following information
for each data point:
Select column check box To create a specific list of points to view, check the box in the Select
column for a specific tag or set of tags, then mark the Selected Rows
Name The name of the data point.
Value The most recently returned value of the data point.
type, no check box will be displayed in the Select column.
To clear all your search criteria, click Reset.
You can export all points that are listed in your search results. The data is
exported to a CSV (comma-separated values) document that you can open in
Microsoft Excel.
To export data:
1. Find the data that you want to export by defining your search criteria.
For details, see "Define search criteria (page 59
2. Export data:
To export all the data displayed in the search results:
•Click Export.
To export specific data:
• Select a check box in the Select column next to the data row that you
want to export.
• Click Export.
The Save HTML Document dialog box appears.
3. Navigate to the place in which you want to save the file.
If you change the name of the file, make sure to leave the .csv file
extension in the File name box.
Leave the default settings in the Save as type and Language boxes.
4. Click Save.
Tip: The FactoryTalk Historian DataLink Excel Reporting Tool provides a Historian Add-In for
Microsoft Excel. If you export more than 65,535 rows of FactoryTalk Historian ME events to
FactoryTalk Historian DataLink using the Compressed Data (Start Time/End Time)
)".
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 61
Chapter 4 View data
View current data
View archive data
To view data that is currently being collected by FactoryTalk Historian ME,
click the View Data tab, and then click Current Data.
To view current data:
1. Under Current Data, define your search criteria.
For details, see "Define search criteria (page 59
)".
2. Click Search.
The data is displayed in the search results table.
To view archive data in FactoryTalk Historian ME, click the View Data tab,
and then click Archive Data.
The page displays a list of points and the latest value collected for each point.
To view archive data:
1. Under Select Points For Archive Data, define your search criteria.
For details, see "Define search criteria (page 59
2. Click Search.
The data is displayed in the Points table.
3. Under Points, click a point for which you want to view data.
Tip: You can view archive data only for one point at a time.
)".
4. In the Start T ime and End Time boxes, type the start and end time for
which you want to view the data.
For details, see "Set start and end times (page 69
)".
5. Click View.
62 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
View trends
Chapter 4 View data
To view data in trends, click the View Data tab, and then click Trends.
The page allows you to select multiple points and draw a trend chart to view
data. Each trend chart provides a visual representation of the data collected
over a specific period of time.
To view a trend:
1. Under Select Points For Trend Chart, define your search criteria.
For details, see "Define search criteria (page 59
)".
2. Click Search.
The data is displayed in the Points table.
3. Select check boxes in the Select column next to the points that you
want to present on the trend.
4. (Optional.) In the Start Time and End Time boxes, type the start and
end time for the selected point(s).
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 63
For details, see "Set start and end times (page 69
)".
5. (Optional.) Using the Auto Refresh list, define the frequency with
which the data in the trend will be refreshed (in seconds).
The default value is 1 second.
6. Click .
Chapter 4 View data
the Show Points option due to the large number of points that will be displayed.
The button color changes to grey (). The trend is drawn. The data
in the trend is being refreshed with the frequency specified in the Auto Refresh list.
The trend chart displays trends for selected points using colored
variants to distinguish between the different points. You will not be
able to select the point for viewing in the trend chart until data has
been collected for the new point.
The numbers on the horizontal axis at the bottom of the chart
represent the point timestamps. The numbers on the vertical axis on
the left of the chart represent the point values.
The small window next to the trend displays the chart in the total time
period set by the time parameters.
Display points on the trend
Use the Show Points option to display individual points on the trend.
To display points on the trend:
1. Click .
The button color changes to grey (). The data on the trend is no
longer refreshed.
2. Select the Show Points option next to the trend.
Individual points are displayed on the trend as small circles.
3. Click .
64 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Tip: If you want to draw a trend chart that consists of high-speed points, avoid selecting
occur until later.
Display the vertical bar on
the trend
Zoom the trend
Chapter 4 View data
Use the Show Vertical Bar option to display a vertical bar across all points on
the X axis. At the bottom of the trend, timestamps will be adjusted when you
click inside the trend and drag the vertical bar across it.
To display the vertical bar on the trend:
1. Click .
The button color changes to grey (). The data on the trend is no
longer refreshed.
2. Select the Show Vertical Bar option next to the trend.
When you move the mouse pointer over the trend, a vertical bar moves
along with the pointer.
3. Click .
Tip: When Daylight Savings Time (DST) occurs, the timestamps displayed will be
automatically updated to reflect the time change. If you adjust the start time to an earlier
start time, the timestamps reflected will coincide with DST even if the DST transfer did not
To zoom in on a specific time span for a set of data:
1. Click .
The button color changes to grey (). The data on the trend is no
longer refreshed.
2. Click and drag the mouse pointer to draw a grey box over the time
span on which you want to zoom in.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 65
Chapter 4 View data
Reset the trend
Remove points from the
3. Release the mouse pointer.
The point data from the time span that you marked with the box
appears in the trend. The selected time span is highlighted in the total
time period window next to the trend.
To reset the zoomed in trend to the regular view, click Reset or .
trend
To remove a point from the trend:
• In the point list below the trend, clear the check box next to the point
name that you want to remove.
66 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
see increased processor usage due to the sorting.
Change views
Filter search results data
Chapter 4 View data
You can modify how the data is displayed on the Current Data, Archive Data,
and Trends pages by:
• Filtering search results data.
See "Filter search results data (page 67
)".
• Arranging columns.
See "Arranging columns (page 67
)".
• Refreshing views.
See "Refreshing views (page 68
)".
• Setting start and end times.
See "Set start and end times (page 69
)".
To filter search results, select either the All Rows or the Selected Rows option.
Your filter selection will apply to all the pages on the View Data tab.
If you select the Selected Rows option, all the data that you have searched and
selected with check boxes on any of the View Data tab pages will be listed in
the search results table.
For example, if you have selected the
page, and then the
int32tag999 point on the Trends page, both points will
MonitorTag point on the Current Data
be listed in the search results table when you click the All Rows option on any
page on the View Data tab.
Arrange columns
To reset the search boxes to their default settings and clear the row selection
check boxes, click Reset.
Use the following options to arrange columns and their content.
To change the sorting order in a column:
1. Move the mouse pointer over a column heading.
An arrow at the top of the column heading indicates its current sorting
order:
The sorting order is ascending.
The sorting order is descending.
2. Click the column heading to change the sorting order.
Tip: To reduce the load on the FactoryTalk Historian ME processor, sorting occurs on the
client computer. If you are monitoring your processor through the task manager, you may
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 67
Chapter 4 View data
Refresh views
To select columns to display:
1. Move the mouse pointer over a column heading.
A down arrow appears next to the heading.
2. Click the arrow to list available table columns.
• To add a column to the table, select the check box next to the column
that you want to add.
• To remove a column from the table, clear the check box next to the
column that you want to remove.
You can refresh the content of the search results table either manually or
automatically.
To refresh the search results table manually:
• Click Search.
To refresh the search results table automatically:
Below the table, in the Auto Refresh box, type a refresh interval in seconds.
When using the Auto Refresh option, note the following:
• It is recommended that you turn off the option if you do not need it.
• Display the minimum amount of data necessary to reduce the memory
consumption.
• Choose the refresh rate prudently. The faster the auto refresh
frequency is, the more memory it consumes.
• Turn the auto refresh option off before closing the Internet browser or
opening another page to release the memory that was being used.
68 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
This expression:
Means:
y
Yesterday at midnight (00:00:00).
+45m
The future 45 minutes.
25 8
08:00 on the 25th of the current month.
sat-1m
11:59:00 p.m. last Friday.
Set start and end times
Chapter 4 View data
The start and end times are set with relation to the time on the client
computer.
The default start time is two minutes before the current time on the client
computer. The default end time is the current time on the client computer.
You can use the following expressions to set time:
* The current time.
t Today at midnight (00:00:00).
t 15:00:00 Today at 3:00:00 pm.
y 15:00:00 Yesterday at 3:00:00 pm.
-60s The past 60 seconds.
-5h The past 5 hours.
-3d The past 3 days.
sun The most recent Sunday at midnight (00:00:00).
Bad quality data
25 8:10 08:10 on the 25th of the current month.
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.
FactoryTalk Historian ME tracks data quality during the data collection and
the data transfer. It may happen that data is of bad quality (e.g., if the
controller loses its connection to the FactoryTalk Historian ME, or if a
running tag is removed from the controller but not from FactoryTalk
Historian ME).
Bad quality data is displayed in the point list with the Bad_Quality value.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 69
Recommendations related
Manage points
In this section you will learn about the following:
Chapter 5
to managing points
Recommendations related to managing points (page 71
Add points using the Add Points Wizard page (page 72)
Add points using the Add Individual Points page (page 76)
Manage individual points using the Edit Points page (page 77)
Define point attributes (page 79)
Configure scan types (page 84)
Configure Trigger Input and Output points (page 85)
Manage shortcuts (page 90)
Use scan classes (page 94)
When managing points, pay attention to the following recommendations:
• Always stop the data collection before you intend to change the
Historian configuration or manage points either in the Historian web
client or the System Management Tools of FactoryTalk Historian SE.
• Make sure that you never delete the FTHMEScanRateDefinition tag or
other system-generated tags with names such as
bae9cf24-c8b3-46c0-ad5d-a64df2174ed9 and values such as No data.
The FTMEScanRateDefinition tag is a system-generated tag that
contains scan class definitions. If it is deleted, all scan class definitions
will be removed. Deleting other system-generated tags will cause the
system log to overflow with error messages.
• Every time the point configuration is changed you should expect data
interruption.
)
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 71
Chapter 5 Manage points
IMPORTANT
Add points using the Add
Discover tags
Points Wizard page
You can use the Add Points Wizard page to add multiple points to your
Historian module.
The process consists of the following steps:
1. Discover tags (page 72
).
2. Create points (page 74).
3. Review results (page 75).
This is the step 1 of adding points using the Add Points Wizard
Stop the data collection before adding and creating points to ensure minimal impact
on the Logix controller memory.
To discover tags:
1. Click Manage Points.
The Add Points Wizard page appears.
2. In the Rule File list, do either of the following:
• To discover specific tags, select a file with tag discovery rules. The
default is ADDefault.xml.
To view the content of the file, click next to the list.
For details on defining rules, see "Define point discovery rules (
157)".
page
• To discover all tags from Logix controllers, select None.
Rule files are managed through the Rul e Ed itor . For details, see "
the Rule Editor (page 155)".
Since the search only applies to the cached information of the web
client, it is limited to the first 2000 tags from a single controller. If you
want to browse for more tags, change the tag point discovery limit in
the point discovery rule file. For details, see "
Define point discovery
rules (page 157)".
3. In the Tag File list, select a tag attribute file. The default is
FTHMETagDefault.xml.
The tag attribute file defines the attributes of the points to be created.
To view the content of the file, click next to the list.
Rule files are managed through the Rul e Ed itor . For details, see "
the Rule Editor (page 155)".
4. In the Scan Rate list, do either of the following:
• The scan rate defines how frequently the data is collected.
If you want to set a global scan rate, select a value in seconds.
Points with invalid scan rates will not be created.
Use
Use
72 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
For this scan type:
Use this scan rate:
• For details on uploading the files, see "Upload files to the module (page 129)".
Chapter 5 Manage points
The valid scan rates are the following:
• Advised
• Polled
• High-speed Equal to or greater than 0.01 seconds, and equal to or less
Equal to or greater than 0.5 seconds.
than 0.5 seconds.
The maximum number of events per second is 2500. For the data
collection rates slower than 500 ms, use Polled and Advised tags.
• If you use multiple tag attribute files that define different scan
rates, and you want to use these scan rates rather than a global one,
select default.
5. In the Start Search In list, select a check box next to each controller
that you want to search.
The list contains all online controllers from the same chassis.
FactoryTalk Historian ME supports the data collection from a
maximum of four controllers.
6. Click Sho w Ta gs in the right bottom corner of the page.
If the button is disabled, check whether:
• The selected rule file is valid.
• The selected tag file is valid.
• You have selected at least one connector to search.
Tips:
• For details on creating and editing rule and tag files, see "Use the Rule Editor (page 155
)".
The discovered tags are listed on the Create Points wizard page.
The process of retrieving data from a controller is indicated with a
message similar to the following:
INFO: Retrieving data from JCWStandard2500_1_6
If the number of available points has exceeded the discovery tag limit
defined in the rule file, the following message appears:
WARNING: You have reached the maximum number of points that
can be create d.
The search results are displayed in the table below the search boxes.
By default, all the points displayed in the table are selected.
The number of selected points is provided in the Selected Points box
below the table.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 73
Chapter 5 Manage points
Discover tags wizard page (See "Discover tags (page 72)").
Discover Tags wizard page.
Create points
This is the step 2 of adding points using the Add Points Wizard
Tip: You can create a maximum of 2500 data points per Historian module.
To create points:
1. Among the discovered tags, search those that you want to use to create
points:
1. In the Name box, type a name of the tag.
The * symbol displays all the tags.
2. In the Controller list, select the controller from which you want to
filter tags.
3. In the Type list, select the type of the tag.
The * symbol displays all the tag types.
4. Click Search.
The search results are refined based on the search criteria that you
have selected.
2. Select the tags that you want to use to create points.
• To select all the tags in the search results table, select the All/None
check box below the table.
• To select no tags from the search results table, clear the All/None
check box below the table.
3. (Optional). Change the scan rate of the selected tags:
1. In the list, select a new scan rate.
2. Click Change Scan Rate.
Tip: This setting will override the scan rate setting that you have defined on the
4. Click Create, and confirm your action in the message box that appears.
The result of the point creation process is displayed on the Review Result wizard page.
If you have selected more than 2500 tags, the Create button will not be
available. To make it available again, reduce the number of selected
tags to less than 2501.
Tip: If you want to restart creating points with the Add Points W izard, click Restart
Wizard, and confirm your action in the message box that appears. You will return to the
74 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
This is the step 3 of adding points using the Add Points Wizard
The Review Result wizard page contains information on the points that have
been processed.
The page contains the following information on points:
• The number of points that were created based on the tags that you
have selected on the Create points wizard page (See "Create points
(page 74)").
• The number of points that were not created because of either of the
following reasons:
• A specific point already exists in the archive.
• An error occurred.
For details, see "System log related issues (page 136
)".
• The total number of points in the module, including the newly created
ones.
The points that have not been created are listed in the Points No t Created
table, along with an explanation for the point creation failure.
Once you finalize the data point creation, restart the data collection by
clicking Restart Data Collection. The process may take several minutes.
Tip: If the FactoryTalk Historian ME Module receives an event with a timestamp 10 minutes or more
into the future, it will discard that event and log an error message in the system log as follows:
[ERROR] TagProce ssingForPolledA ndAdvised() droppe d
future event for point<ID> with <timestamp> with
timeDelta=<number of seconds into future>
For example:
6-Oct-09 15:54:29 Data Collection [ERROR] TagPr
for point 450 with timestamp 13-Oct-
Note that if the data transfer service is in the auto transfer mode, it may
continue running. If the auto transfer mode is not enabled, you must
manually select points to transfer, and then restart the data transfer service.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 75
Chapter 5 Manage points
For this scan type:
Use this scan rate:
Advised
Equal to or greater than 0.5 seconds.
High-speed
Equal to or greater than 0.01 seconds, and equal to or less
Add points using the Add
To add points using the Add Individual Points page:
Individual Points page
1. Click Manage Points, and then click Add Individual Points.
The Add Individual Points page appears.
2. In the Tag File list, select a tag attribute file. The default is
FTHMETagDefault.xml.
The tag attribute file defines the attributes of the points to be created.
To view the content of the file, click next to the list.
Rule files are managed through the Rul e Ed itor . For details, see "
the Rule Editor (page 155)".
3. In the Scan Rate list, do either of the following:
• If you want to set a global scan rate, select a value in seconds.
The scan rate defines how frequently the data is collected.
Points with invalid scan rates will not be created.
For tags, the maximum number of events per second is 2500. For
the data collection rates slower than 500ms, use Polled and Advised
tags.
The valid scan rates are the following:
•
• Polled
•
than 0.5 seconds.
Use
• If you use multiple tag attribute files that define different scan rates
and you want to use these scan rates rather than a global one, select
default.
4. Under Folders, expand the tree and select the controller from which
you want to use tags.
The controller's tags are displayed under Contents.
To refresh the list of the controllers, click Refresh.
5. (Optional.) To further filter the tag search results, filter the tags using
the Tag Filter box below Fo lders:
• In the Tag Filter box, type a tag name or a part of a tag name with *,
and then press Enter.
The tags that are displayed under Contents are filtered using the
filter criteria that you have specified in the Tag Filter box.
To display all the tags again with no filter applied, type * in the Tag Filter box, and then press Enter.
6. Under Contents, select the tags that you want to use to create points.
To select all the tags, select the All/None check box below Contents.
7. Click Add Tag(s) to List.
76 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
The tags that you have selected are listed in the Selected Tags table.
Manage individual points
Chapter 5 Manage points
8. Click Create, and confirm the action in the message box that appears.
The points are created.
The following information is displayed:
• The number of points that were created based on the tags that you
have selected.
• The number of points that were not created because of either of the
following reasons:
• A specific point already exists in the archive.
• An error occurred.
using the Edit Points page
Create points
For details, see "System log related issues (page 136
)".
• The total number of points in the module, including the newly
created ones.
The points that have not been created are listed in the Points Not Created
table, along with an explanation for the point creation failure.
Once you finalize the data point creation, restart the data collection by
clicking Restart Data Collection. The process may take several minutes.
You can perform the following actions on individual points using the Edit
Points page:
• Create points (page 77
)
• Edit points (page 78)
• Rename points (page 78)
• Delete points (page 79)
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 77
To create points:
1. Click Manage Points, and then click Edit Points.
The Edit Points page appears.
2. At the bottom of the page, click New.
3. The Point Property page appears.
4. Fill in the point attributes.
For details, see "Define point attributes (page 79
5. Click Save.
If the data transfer service is set to the auto transfer mode, the new points will
be created with the new tag names automatically. Otherwise, you need to add
the new points to the data transfer manually.
)".
Chapter 5 Manage points
Edit points
Rename points
To add new points to the data transfer:
1. Click Configure Historian, and then click Data Transfer Points.
The Data Transfer Points page appears.
2. Using the search boxes, find the points that you want to add to the data
transfer.
3. In the search results table, select the points that you want to add to the
data transfer.
4. Click Save.
5. In the left pane of the window, click Data Transfer.
6. Restart the data transfer service.
To edit points:
1. Click Manage Points, and then click Edit Points.
The Edit Points page appears.
2. Using the search boxes, set your point search criteria, and then click
Search.
3. In the search results table, click the point that you want to edit, and
then click Edit.
The Point Property page appears.
4. Change the point attributes.
For details, see "Define point attributes (page 79
)".
If you want to cancel your changes and bring back the original
attributes of the point, click Reset.
Tip: Resetting will not work after you save the changes using the Save button.
5. Click Save.
To rename points:
1. Click Manage Points, and then click Edit Points.
The Edit Points page appears.
78 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
2. Using the search boxes, set your point search criteria, and then click
Search.
3. In the search results table, click the point that you want to edit, and
then click Rename.
The Point Property page appears.
4. Change the point name.
Delete points
Define point attributes
Chapter 5 Manage points
If you want to cancel your changes and bring back the original
attributes of the point, click Reset.
Tip: Resetting will not work after you save the changes using the Save button.
5. Click Save.
To delete points:
1. Click Manage Points, and then click Edit Points.
The Edit Points page appears.
2. Using the search boxes, set your point search criteria, and then click
Search.
3. In the search results table, click the point that you want to edit, and
then click Delete.
4. The Point Property page appears.
5. Confirm the message.
Point attributes tell FactoryTalk Historian ME how and when the server
should collect data from a particular data source. They contain the following
information:
• The location of the data source.
• The frequency with which the server should get new values from the
data source.
• The value that the server can ignore.
• The data that is valid.
In the Historian web client, the point attributes are presented in the following
groups:
• General (page 80
)
• Exception filtering (page 82)
• Compression filtering (page 83)
• Snapshot value (page 83)
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 79
Chapter 5 Manage points
Use this attribute:
To:
• The following characters: * ' ? ; : { } [ ] | \ / ( ) ` "
Extended Description
Specify a relevant expression or a tag name. For details, see "Configure Trigger Input and Output points (page 85)".
Use this attribute only with trigger input and output points.
Instrument Tag
Provide a full path to the controller and the tag from which the data is coming. If you replace the controller with a different one
Use this attribute only with the Trigger Input or Output tags.
General
The General group contains the following point attributes:
Name Name the point, following these rules:
• The name must be unique.
• The first character must be alphanumeric or the percent sign (%).
• The name must not contain:
• Control characters (such as line feeds or tabs).
Descriptor Type a basic description of the point. The description will be displayed in client applications and user reports.
that measures the same process value, it is usually best to continue using the same point. Edit the point as required so that it
will collect the new data.
Use the following format of the path:
When a source tag receives events from the controller, the tag that you set in this attribute reads (or writes back) events from
the controller.
Notes:
• It is recommended that you do not change the tag name in the attribute, since it may make the tag invalid, and make it stop
• If the full path points to a controller in a remote chassis, and the tag from which data is coming is a high-speed or an output
Source Tag Type the trigger tag name. If you type a tag name, the source tag referenced must not be high-speed or have a scan rate of
faster than 1 second. Otherwise, the module will generate an error and you will not be able to save the point.
collecting data.
tag, the configuration will not be supported.
Type Set the data type of the point values. When you change the point type, the archive subsystem closes the current archive record,
and starts 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.
Choose from the following:
• Int16
For points whose values are 16-bit integers.
• Int32
For points whose values are 32-bit integers.
• Float16
For points whose values are 16-bit floating point values.
• Float32
For points whose values are 32-bit floating point values.
• Float64
For points whose values are 64-bit floating point values.
• String
Used to store string data up to 1000 characters.
Note: Strings are not supported for the high-speed data collection.
• Digital
For points whose values can only be one of several discrete states, such as ON/OFF. You can define digital set contents.
• Timestamp
For points whose values are timestamps.
80 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Use this attribute:
To:
This attribute only appears if the point is of type digital.
Note: For details, see "Configure scan types (page 84)".
source to FHTME.
non-numeric points.
Chapter 5 Manage points
Digital Set Select the type of the digital set for the point.
Choose from the following:
• SYSTEM
• BatchAct
• Phases
• Modes
• RABoolean
Use the System Management Tools of FactoryTalk Historian SE to create additional digital sets. For more information, refer to
the
PI Data Archive 2015 R2 Introduction to System Management Guide.pdf
.
Scan Type Determine the scan type for the point.
Choose from the following:
• Polled
• Advised
• Trigger Input
• Output
• High-speed
Scan On Identify active tags. The active tags are updated. If you want a point to be the active point, set this attribute to On and the point
Typical Value Type a reasonable value for a point.
For a numeric tag, it must be greater than or equal to the value of the Zero attribute, and lower than or equal to the sum of the
Zero and Span attribute values.
The typical value range is between 0 and 100.
The typical value range for the points of type Digital is between 0 and 1.
Point Source Identify the interface to which the point belongs.
When you configure an interface, you specify a point source for the interface. All the points that belong to the interface must
use that point source code as the value for the Point Source attribute.
The default point source is FTME. Other options include:
• T, for the Totalizer utility subsystem in PI.
• C, for the Performance Equation tags.
Scan Rate Set the period of time in seconds, which tells FactoryTalk Historian ME how often to collect the data.
For the Trigger Input and Output scan types, it is recommended that the scan rate be defined as two seconds or longer.
For details, see "Use scan classes (page 94)".
Span Value Set the difference between the top and the bottom of the range.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 81
This attribute is required for all numeric data type points.
For Float16 point types, the Span value is used with the Zero value for scaling values in the archive. The Span property must be
a positive value. If the value for a Float16 point type is greater than the top of the range, it is recorded in the archive as Over Range.
For other point types, the Zero and Span values do not affect the values recorded in the archive. The Span property is also
used when defining a FactoryTalk Historian ProcessBook trend with a vertical scale of database. This attribute is not used for
Chapter 5 Manage points
Use this attribute:
To:
Exception filtering
Zero Value Type 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.
The zero value range is between 0 and 100.
The exception reporting information determines when to send data to the
snapshot subsystem.
The Exception Filtering group contains the following point attributes:
• Exception Min
This value specifies the minimum time span between the exceptions.
The default value is 0 seconds.
• Exception Max
This value specifies the maximum time span between the exceptions.
The default value is 10 minutes.
• Exception Deviation
This value specifies how much a point value must change before a new
value is reported.
The default value is 0.25 engineering units.
The following are value ranges that you can use to specify parameter values:
• The range of Exception Min Day and Exception Max Day is between 0
and 100.
• The range of Exception Min Hr and Exception Max Hr is between 0
and 15.
• The range of Exception Min Min and Exception Max Min is between 0
and 59.
• The range of Exception Min Sec and Exception Max Sec is between 0
and 59.
• The Exception Deviation range is between 0 and 100.
Tip: For details on the exception filtering configuration, see "Exception filtering (page 103)".
82 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Use this attribute:
To:
If the compression is deactivated, all values sent to the snapshot subsystem are saved in the archive.
should equal 0.
Compression Max
Set a value indicating that events are archived when the elapsed time is greater than the maximum time.
filters events that are externally generated.
Use this attribute:
To:
Compression filtering
Chapter 5 Manage points
When a new snapshot arrives, the previous one is evaluated according to the
compression information to check whether it is a significant event. If so, it is
sent to the event queue. Otherwise it is discarded. The result is that only
significant data is written to the archive. This process is called compression.
The Compression filtering group contains the following point attributes:
Compression On Activate the compression for the point.
The compression should be activated for all real-time points in the system.
Compression Min Set a value indicating that events are archived when 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.
Compression Minimum sets a minimum limit on the time between events in the archive. Typically, the minimal compression
Compression Maximum sets a maximum limit on the time between events in the archive. The recommended maximum time
specification is one work shift (such as, eight hours). Duplicate values will be archived if the elapsed time exceeds the
Compression Max value. Under no circumstances does this cause the FactoryTalk Historian ME server to generate events; it only
Compression Deviation Set a value for the compression deviation.
If you set the value too low, too little compression is imposed on data and lot of space is wasted in the archive.
If you set the value too high, you may lose important data.
For most flows, pressures, and levels, use a deviation of 1% or 2% span. For temperatures, the deviation should usually be one
or two degrees.
The following are value ranges that you can use to specify parameter values:
• The Compression Deviation range is between 0 and 100.
• The range of Compression Min Day and Compression Max Day is
between 0 and 100.
• The range of Compression Min Hr and Compression Max Hr is
between 0 and 23.
• The range of Compression Min Min and Compression Max Min is
between 0 and 59.
• The range of Compression Min Sec and Compression Max Sec is
between 0 and 59.
Snapshot value
The Snapshot value group contains the following point attributes:
Value View the current value of the tag, which is based on the tag type.
Timestamp View the current time and date of the current tag value.
These attributes do not contain any data when you are creating a new point.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 83
Chapter 5 Manage points
Scan type
Description
If you need data collection rates faster than 0.5 seconds, use high-speed tags.
Trigger Input
Triggered input tags are used to collect a data point after a particular triggering event has occurred.
For details, see "Configuration example: Trigger Input points (page 87)".
For details, see Configuration example: Output points (page 89)".
created with a scan rate faster than 500ms.
Configure scan types
The points are collected based on the scan type and scan rate. You must
ensure that the scan types and scan rates are correctly configured for the data
collection service.
When you add points using the Add Points Wizard page (see "
Add points
using the Add Points Wizard page (page 72)"), make sure to set the correct
scan type in the rule file.
When you create individual points manually (see "Create points (page 77)"),
make sure to set the correct scan type in the point attributes.
The following scan types are available:
Polled Polled tags are scanned and the data event (with a value and a timestamp) is sent to the local FactoryTalk Historian ME server
at the specified scan time interval.
Usually, polled tags are intended for scan rates greater than 0.5 seconds.
Advised Advised tags are scanned for new values at timed intervals that are defined by the scan class. However, a new event happens
(becomes available) only if the value has changed from the previous event.
Usually, advised tags are intended for scan rates greater than 0.5 seconds. A point will not be put on scan if it is configured at a
rate faster than 0.5 seconds.
Use this scan type for trigger input tags.
Output Triggered output tags are used to output (write-back) a data point to a controller after a particular triggering event has
occurred.
Output scan types are not supported for tags created from shortcuts pointing to remote controllers.
High-speed High-speed tags are scanned and the data event (with a value and a timestamp) is logged at the specified scan time interval.
Usually, high-speed tags are intended for fast data collection speeds with scan rates of 10 ms. A point will not be put on scan if
it is configured at a rate slower than 0.5 seconds.
The module will not allow high-speed tags to be created with a scan rate slower than 500ms, or advised or polled tags to be
84 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
IMPORTANT
Since the output tag values reach the controller with variable latency, they cannot be
monitoring purposes only.
Configure Trigger Input and
Output points
Chapter 5 Manage points
Trigger Input points (tags) are points for which data flows from a controller
to the FactoryTalk Historian ME archive. For Trigger Input points, you need
to configure separate trigger points.
Output p oints (tags) are points for which data flows from the FactoryTalk
Historian ME archive to a controller. For Output points, the timestamp of the
trigger value must be greater than the timestamp of the previous value.
used for applications requiring real-time update. The output tags are meant for
The following diagram illustrates the data flow of the trigger mechanism for
Trigger Input and Output points:
When you configure the Trigger Input or Output points, pay attention to the
following:
• The scan rate is not applicable to the Trigger Input point.
• Set the Scan On attribute to On.
• Put trigger names in single quotes.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 85
Chapter 5 Manage points
This variable:
Is:
<keyword>
<trigger_tag_name>
<condition>
Keyword
Trigger condition
This condition triggers an event on:
Example
Configure Trigger Input
points
You can associate an Input point with a trigger point by defining the
Extended Description attribute of the Input point using the following
expression:
<keyword>=‘<trigger_tag_name>’;<condition>
Where:
Either of the following:
• TRIG
• EVENT
Note: The keywords must be written in uppercase.
The name of the trigger point.
Any of the following:
• Any
• Anychange
• Nonzero
• Decrement
• Increment
Note: The condition names are case-sensitive.
TRIG Any - -
EVENT Any - -
Nonzero Any non-zero value. An event is triggered on a value change from “Pt Created”
Anychange Any change as long as the value of the current event is
Increment Any increase in the value. An event is triggered on a value change from 0 to 1.
Decrement Any decrease in the value. An event is triggered on a value change from 1 to 0.
86 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Any scan tag that is referenced in the Extended Description or Scan Tag point
attributes must not be high-speed or have a scan rate higher than 1 second.
Otherwise, the module will generate an error and you will not be able to save
your point.
If you provide an expression in the Extended Description point attribute, the
point for which you have defined it is considered by the system to be
trigger-based rather than scan-based. As a result, an input is triggered when a
new value is sent to the snapshot of the trigger point.
The TRIG keyword in the expression does not require any condition. Its
default condition is Any and you cannot change it.
The EVENT keyword requires a trigger condition to function properly. If you
use multiple trigger definitions, you can separate them with a space, a
comma, or a semicolon.
The following table lists the two keywords and their possible values.
to 1 but it is not triggered on a value change from 1 to “bad
Input”.
An event is triggered on a value change from 0 to “bad
different from the value of the previous event.
Input” or from “bad Input” to 0.
Configuration example:
Trigger Input points
Trigger Input point
Trigger Input point with the TRIG keyword
Chapter 5 Manage points
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 87
Trigger Input point with the EVENT keyword and the Increment
condition
Chapter 5 Manage points
IMPORTANT
monitoring purposes only.
Configure Output points
Since the output tag values reach the controller with variable latency, they cannot be
used for applications requiring real-time update. The output tags are meant for
You can trigger Output points in the following ways:
• By configuring a separate trigger point.
The Output point must have the same point source as the interface,
FTME. The trigger point can be associated with any point source. The
point type of the trigger point and the point type of the Output point
may differ.
You can associate an Output point with a trigger point by setting the
Source Tag attribute of the Output point to be the same as the tag
name of the trigger point.
Any scan tag that is referenced in the Extended Description or Scan Tag attributes must not be high-speed or have a scan rate higher than 1
second. Otherwise, the module will generate an error and you will not
be able to save your point.
An output is triggered when a new value is sent to the snapshot of the
trigger point. The new value does not need to be different than the
previous one that was sent to the snapshot to trigger an output, but the
timestamp of the new value needs to be more recent than the previous
value.
• By writing a new value to the snapshot of the output point itself.
The new value does not need to be different from the previous one to
trigger an output, but the timestamp of the new value must be more
recent than the previous value.
88 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Configuration example:
Output points
Output point
Triggered Output point with the TRIG keyword
Chapter 5 Manage points
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 89
Triggered Output point with the EVENT keyword and the Anychange
condition
Chapter 5 Manage points
Tip: All actions performed on shortcuts are logged. You can view the logged information
under Advanced > System Log.
Manage shortcuts
Create shortcuts to the
Shortcuts are user-defined names for connections with controllers located in
a local or remote chassis. A shortcut additionally contains the CIP path to a
controller in a chassis.
You can use shortcuts to:
• Assign meaningful names to controller connections.
• Search for data points in the Add Points Wizard and on the Add
Individual Points page.
In FactoryTalk Historian ME, you can perform the following actions on
shortcuts:
local chassis
• Create shortcuts to the local chassis (page 90
)
• Create shortcuts to a remote controller (page 91)
• Edit shortcuts (page 92)
• Delete shortcuts (page 93)
When creating local shortcuts, take into consideration the following points:
• You can create up to 5 shortcuts to the local chassis.
• The shortcut paths must be unique. This means that each shortcut
must point to a different controller or have a different CIP path.
• If you create a shortcut to a controller which is used for time
synchronization, the time will no longer be synchronized with this
controller after you save your changes.
This is because adding a shortcut to a controller changes the name
structure of the tags from the controller, which means previously
defined tags will be disabled. For details, see "Tag naming conventions
(page 94)".
• If you create a shortcut to a controller which is used for collecting data,
the data will no longer be collected from this controller after you save
your changes.
This is because adding a shortcut to a controller changes the name
structure of the tags from the controller, which means previously
defined tags will be disabled. For details, see "Tag naming conventions
(page 94)".
• Creating shortcuts to local controllers is optional.
90 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
at the top of the page.
Create shortcuts to a
Chapter 5 Manage points
To create a shortcut to the local chassis:
1. Click Manage Points, and then click Manage Shortcuts.
2. Click Add.
3. Select the controller to which you want to create a shortcut.
Alternatively, select the Add the shortcut using a CIP path instead
option, and type the CIP path to the controller.
4. Type the name of the shortcut.
When typing the name, take into consideration the following points:
• The name can contain only the characters a-z, A-Z, 0-9 and an
underscore.
Tip: To learn about the convention of naming tags added to the Historian module using
the shortcuts, see "Tag naming conventions (page 94)".
• The maximum length of the name is 40 characters.
Tip: To minimize the complexity of tag names, we recommend that you keep the
shortcut names short.
• The name must start with a letter or an underscore.
• The name cannot contain two underscores side by side, or an
underscore with a number at the end of the name (e.g., shortcut_12).
• The shortcut name must be unique.
remote controller
5. Click Save.
The shortcut is added to the shortcut table.
Tip: If any error occurs when creating the shortcut, it is indicated with a message displayed
When creating shortcuts to remote controllers, take into consideration the
following points:
• The remote controller should be located in a local area network (LAN)
rather than a wide area network (WAN) or a low-speed network.
• You can create up to 5 shortcuts to remote controllers.
• The shortcut paths must be unique. This means that each shortcut
must point to a different controller or have a different CIP path.
To create a shortcut to a remote controller:
1. Click Manage Points, and then click Manage Shortcuts.
2. Click Add.
3. Under Add New Shortcut, click Remote controller.
4. Select a local communication module.
5. Type the IP address of a remote communication module, and then
click Load Controllers.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 91
Controllers will not be loaded if:
• The IP address is incorrect.
Chapter 5 Manage points
Notes.
the shortcuts, see "Tag naming conventions (page 94)".
Tip: If any error occurs when creating the shortcut, it is indicated with a message displayed
Edit shortcuts
• There are no supported controllers detected in the remote chassis.
Tip: For a list of supported controllers, refer to the FactoryTalk Historian ME Release
6. Select the remote controller to which you want to create the shortcut.
Alternatively, select the Add the shortcut using a CIP path instead
option, and type the CIP path to the controller.
7. Type the name of the shortcut.
When typing the name, take into consideration the following points:
• The name can contain only the characters a-z, A-Z, 0-9 and an
underscore.
Tip: To learn about the convention of naming tags added to the Historian module using
• The maximum length of the name is 40 characters.
Tip: To minimize the complexity of tag names, we recommend that you keep the
shortcut names short.
• The name must start with a letter or an underscore.
• The name cannot contain two underscores side by side, or an
underscore with a number at the end of the name (e.g., shortcut_12).
• The shortcut name must be unique.
8. Click Save.
The shortcut is added to the shortcut table.
at the top of the page.
To edit a shortcut:
1. Click Manage Points, and then click Manage Shortcuts.
2. In the table, click the shortcut that you want to edit, and then click
Edit.
3. Under Edit Shortcut, make your changes to the shortcut.
Tips:
• You can make all the changes to the shortcut except for changing its name.
• If any change to the shortcut might result in a change in the functionality of time
synchronization or data collection, you will be prompted for confirmation.
4. Click Save.
When editing shortcuts, take into consideration the following points:
• If you select a new controller from the list and that controller is already
used for time synchronization, the time will no longer be synchronized
with this controller after you save your changes to the shortcut.
This is because adding a shortcut to a controller changes the name
structure of the tags from the controller, which means previously
92 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
synchronization or data collection, you will be prompted for confirmation.
Chapter 5 Manage points
defined tags will be disabled. For details, see "Tag naming conventions
(page 94)".
• If you select a new controller from the list and that controller is used
for collecting data, the data will no longer be collected from this
controller after you save your changes to the shortcut.
This is because adding a shortcut to a controller changes the name
structure of the tags from the controller, which means previously
defined tags will be disabled. For details, see "Tag naming conventions
(page 94)".
• If you change the type of a local shortcut used for time synchronization
to remote, the time will no longer be synchronized after you save your
changes.
• If you edit a shortcut used for time synchronization and change the
controller to a different one, the time synchronization may be broken.
To correct the time synchronization, you may have to restart the
module.
Delete shortcuts
To delete a shortcut:
1. Click Manage Points, and then click Manage Shortcuts.
2. In the table, click the shortcut that you want to delete, and then click
Delete.
If you want to delete the shortcut, click OK.
Otherwise, click Cancel.
Tip: If deleting the shortcut might result in a change in the functionality of time
When deleting shortcuts, take into consideration the following points:
• If you delete a shortcut used for time synchronization, the time will no
longer be synchronized after you save your changes.
• If you delete a shortcut used for collecting data, the data will no longer
be collected from this shortcut after you save your changes. However,
the data will be collected from the controller used in this shortcut if
data points were defined for the controller before the shortcut was
created.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 93
Chapter 5 Manage points
Tag naming conventions
Edit scan classes
Tag names are created following certain conventions that depend on whether
a tag has been added to the Historian module from a controller for which
there exists or does not exist a controller shortcut:
• The names of the tags from controllers for which no shortcuts exist on
the Historian module have the following structure:
<Controller name>_1_<Slot number>.<Tag name>
Example: Standard2500_1_2.booltag1
• The names of the tags from controllers for which shortcuts exist on the
Historian module have the following structure:
<Controller shortcut name>.<Tag name>
Example: ShortcutToStandard2500.booltag1
Use scan classes
Create scan classes
FactoryTalk Historian ME uses scan classes to schedule the data collection. A
scan class provides 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 delete scan classes.
Tip: You must have administrator privileges to create scan classes.
To create a scan class:
1. Click Manage Points, and then click Edit Scan Class(es).
2. At the bottom of the page, click New.
The new consecutive name of the scan class appears in the Scan Point
box.
3. At the top of the page, in the Time text box, type a time value in
seconds.
4. Click Save.
5. Click OK to close the dialog box, and then click Restart.
Tip: You must have administrator privileges to edit scan classes.
94 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
To edit a scan class:
1. Click Manage Points, and then click Edit Scan Class(es).
2. In the table, select the scan class that you want to edit.
3. At the bottom of the page, click Edit.
4. At the top of the page, in the Time text box, change the scan rate value.
5. Click Save.
6. Click OK to close the dialog box, and then click Restart.
Delete scan classes
Tip: You must have administrator privileges to delete scan classes.
Chapter 5 Manage points
To delete a scan class:
1. Click Manage Points, and then click Edit Scan Class(es).
2. In the table, select the scan class that you want to edit.
3. At the bottom of the page, click Delete.
4. Click OK to close the dialog box, and then click Restart.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 95
Collect data
Collect and store data
In this section you will learn about the following:
Chapter 6
Collect data (page 97
)
View the data storage information (page 99)
Filter data (page 101)
The FactoryTalk Historian ME server collects data from the Logix controller
through the chassis backplane. The data collection service then optionally
performs a series of deadband tests on the data (exception and compression
tests) and stores the data in the FactoryTalk Historian ME archive.
When started, the data collection service performs the following actions:
• Identifies all points listed as active, based on the value of the Scan
property in the points definition.
• Identifies (or registers) all controllers in the same Logix chassis by
logical names, device IDs, and location (slot numbers).
FactoryTalk Historian ME supports up to 10 controllers. There is a
maximum of 5 controllers in the local chassis and a maximum of 5
controllers in the remote chassis.
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 97
• Begins collecting data for all points based on the specified scan rate
associated with each point.
Chapter 6 Collect and store data
This item:
Displays:
The data is being collected and archived.
archive.
increasing the number of total archive files free and reducing the number of total archive files used.
Access the data collection
Start and stop the data
To access the information on the data collection:
information
1. Click the Configure Historian tab.
The Data Collection page appears.
The page provides the following information:
Status The current status of the data collection:
• Stopped
The data is not being collected or archived.
Running
•
Collection Rate The number of events per second that the data collection receives for configured ports.
Archive Rate The number of events per second that pass exception and compression tests and are committed to the
Archive Capacity The number of days, hours, and minutes until all available archive files are full.
This number is an estimate. When all archive files are full, data interruption may occur.
Note: For details on long-term storage on a FactoryTalk Historian SE or PI server, see "Transfer data to
FactoryTalk Historian SE or PI servers (page 109)".
Total Archive Files The total number of archive files residing in the archive. The size of each archive file is 10 MB.
Approximately 130 archive files are preallocated as data containers.
Total Archive Files Used The number of archive files currently being used to store data in the archive subsystem.
Total Archive Files Free The number of archive files in the archive subsystem that neither store data nor contain data to be
overwritten once it is transferred by the data transfer service.
If the data transfer service is configured and it is transferring events to the FactoryTalk Historian SE or PI
server, the module frees the archive disk space once the events are successfully transferred. It results in
collection
Tip: You must have administrator privileges to start and stop the data collection.
To start the data collection:
1. Click the Configure Historian tab.
The Data Collection page appears.
2. Click Start.
98 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.