Rockwell Automation 1756-HIST2G User manual
User Manual
Original Instructions
FactoryTalk Historian ME
Configuration Guide
Catalog Number 1756-HIST2G Series B
Important User Information
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
groups on 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
Benefits ....................................................................................................... 14
Distributed FactoryTalk Historian architecture ...................................... 15
FactoryTalk and Logix integration ............................................................ 16
FactoryTalk licensing ................................................................................. 16
License points for the data transfer .................................................... 16
FactoryTalk Historian ME product number............................................. 17
Hard disk ..................................................................................................... 17
Additional resources .................................................................................. 17
Chapter 2
System connectivity ................................................................................... 19
Software and hardware requirements for FactoryTalk Historian ME ..20
Upgrade or reinstall the firmware ........................................................... 20
Differences between upgrade and reinstallation .............................. 21
Collect the module-related information ............................................ 21
Back up the module .............................................................................. 21
Prepare the module for the upgrade or reinstallation ...................... 21
Upgrade or reinstall the firmware of your Historian module ......... 22
(Optional) Download ControlFLASH ...........................................23
(Optional) Install ControlFLASH ..................................................23
Download the module firmware kit .............................................23
Upgrade or reinstall the module firmware ................................. 24
Updates and application notes............................................................25
Set up your ControlLogix environment ................................................... 26
Install the module in the chassis ...............................................................27
Install FactoryTalk Historian ME Client Tools ........................................27
Install FactoryTalk Historian ME Management ............................... 28
Install FactoryTalk Historian ME Rule Editor .................................. 30
Install FactoryTalk Historian ME Logix Designer Module Profile ... 31
(Optional) Install FactoryTalk Historian SE patch ............................ 31
EDS files ................................................................................................ 31
Configure Internet Explorer for FactoryTalk Historian ME ..................32
Internet Explorer configuration checklist .........................................32
Add the module site to Local intranet or Trusted sites ..................... 33
Add the module website to the Local intranet security zone...... 33
Add the module website to the Trusted sites security zone ....... 34
Enable Active X controls ...................................................................... 35
Enable Compatibility View .................................................................. 35
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 3
Table of Contents
View the module information
View data
Disable Pop-up Blocker ........................................................................ 36
Disable ActiveX Filtering ..................................................................... 36
Enable the XML DOM Document add-on .......................................... 36
Enable TLS ............................................................................................ 37
Verify the browser configuration using the F12 developer tools ...... 37
Install the module certificate in Internet Explorer ...........................38
Install the certificate using the Certificate Import Wizard ....... 39
Verify the certificate ............................................................................ 39
Verify the certificate on the security report ................................ 40
Verify the certificate on the System Security page .................... 40
Clear the browser cache ....................................................................... 41
Clear the browser cache manually ................................................ 41
Clear the browser cache automatically......................................... 41
Add a registry entry for exporting files to Excel ............................... 42
Access the FactoryTalk Historian ME web page ..................................... 42
Log on to FactoryTalk Historian ME ................................................. 42
Log out of FactoryTalk Historian ME ................................................. 43
Chapter 3
System status ............................................................................................. 45
Status .......................................................................................................... 46
Module information.............................................................................46
System status ........................................................................................ 47
System utilization ................................................................................ 47
Point statistics ...................................................................................... 47
Module identity ......................................................................................... 48
Module information............................................................................ 48
Network settings ..................................................................................49
Security configuration ........................................................................ 50
Client connections .............................................................................. 50
System utilization ...................................................................................... 51
System statistics ......................................................................................... 51
Network manager ................................................................................52
Snapshot and archive ........................................................................... 53
Snapshot and archive counters..................................................... 53
Archive files .......................................................................................... 56
4 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Chapter 4
Define search criteria ................................................................................ 59
Export data ................................................................................................. 61
View current data ...................................................................................... 62
View archive data ...................................................................................... 62
Manage points
Table of Contents
View trends ................................................................................................. 63
Display points on the trend .................................................................64
Display the vertical bar on the trend .................................................. 65
Zoom the trend ..................................................................................... 65
Reset the trend .....................................................................................66
Remove points from the trend ............................................................66
Change views .............................................................................................. 67
Filter search results data...................................................................... 67
Arrange columns .................................................................................. 67
Refresh views ....................................................................................... 68
Set start and end times ........................................................................69
Bad quality data ..........................................................................................69
Chapter 5
Recommendations related to managing points .......................................71
Add points using the Add Points Wizard page ........................................ 72
Discover tags ........................................................................................72
Create points ........................................................................................ 74
Review results ....................................................................................... 75
Add points using the Add Individual Points page ................................... 76
Manage individual points using the Edit Points page ............................ 77
Create points ........................................................................................ 77
Edit points ............................................................................................78
Rename points......................................................................................78
Delete points ......................................................................................... 79
Define point attributes .............................................................................. 79
General ................................................................................................. 80
Exception filtering .............................................................................. 82
Compression filtering ..........................................................................83
Snapshot value......................................................................................83
Configure scan types ................................................................................. 84
Configure Trigger Input and Output points ............................................85
Configure Trigger Input points ......................................................... 86
Configuration example: Trigger Input points .............................87
Configure Output points .................................................................... 88
Configuration example: Output points....................................... 89
Manage shortcuts ...................................................................................... 90
Create shortcuts to the local chassis .................................................. 90
Create shortcuts to a remote controller ............................................. 91
Edit shortcuts ...................................................................................... 92
Delete shortcuts.................................................................................... 93
Tag naming conventions .....................................................................94
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 5
Table of Contents
Collect and store data
Transfer data to FactoryTalk
Administer the module
Historian SE or PI servers
Use scan classes ..........................................................................................94
Create scan classes ...............................................................................94
Edit scan classes ...................................................................................94
Delete scan classes ............................................................................... 95
Chapter 6
Collect data ................................................................................................. 97
Access the data collection information .............................................. 98
Start and stop the data collection ...................................................... 98
View the data storage information ...........................................................99
FactoryTalk Historian ME storage capacity .................................... 100
Filter data .................................................................................................. 101
Exception filtering ............................................................................. 103
Compression filtering ........................................................................ 105
Chapter 7
Data transfer prerequisites ..................................................................... 109
Configure the data transfer ..................................................................... 110
Start the data transfer .............................................................................. 112
Stop the data transfer .............................................................................. 112
View data transfer statistics .................................................................... 112
Add points to the data transfer ............................................................... 112
Remove points from data transfer ........................................................... 113
View the data transfer information .........................................................114
Check the data transfer status in the system log ....................................114
Data transfer considerations....................................................................115
6 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Chapter 8
Manage users ............................................................................................ 117
Create users ......................................................................................... 117
Modify users ....................................................................................... 118
Remove users ...................................................................................... 118
Change user passwords ..................................................................... 119
Reset passwords ................................................................................. 119
Reset the default admin password.................................................... 120
View groups .............................................................................................. 120
Manage time ............................................................................................. 121
View and edit the current time ......................................................... 122
Considerations for using an NTP server as the time source .... 123
Verify time synchronization ............................................................. 124
Set the time zone ................................................................................ 125
Clock drifts ......................................................................................... 125
Configure system settings
Manage security
Table of Contents
Battery clock ....................................................................................... 126
Chapter 9
Change the module name ...................................................................127
Configure network settings .............................................................. 128
Upload files to the module ....................................................................... 129
File types ............................................................................................. 130
Manage the uploaded files .................................................................. 131
Back up and restore configuration files .................................................. 131
View the backup status and perform backup.................................... 131
Download the backup file to a client computer ............................... 132
Upload the backup file to the module ............................................... 133
Restore the module from the backup file ......................................... 133
Why restoring PI Server ID? ....................................................... 134
Check and restore the module name ................................................ 135
Use the system log .................................................................................... 135
System log related issues ................................................................... 136
Repair archives using safe mode ............................................................. 136
Repair the time setting ...................................................................... 137
Restore and reset module-related settings............................................. 137
Restore the module's defaults ........................................................... 138
Reset the security mode ..................................................................... 138
Reset the Web Diagnostics password ............................................... 139
Close and start the module ...................................................................... 139
Shut down the module ....................................................................... 139
Reboot the module ............................................................................. 140
Restart the module ............................................................................. 140
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 7
Chapter 10
Configure security .................................................................................... 141
Configure how to log on to the module ............................................. 141
Log on using the FactoryTalk Directory with FactoryTalk
Historian ME ................................................................................ 142
Understand privileges for user groups ...................................... 143
Configure where to use the secure communication protocol
(HTTPS)............................................................................................... 144
Manage security trusts ............................................................................. 146
Default trusts ...................................................................................... 147
User-defined trusts ............................................................................ 147
Create trusts for the data transfer .............................................. 147
Create trusts for FactoryTalk Historian clients ......................... 148
Edit trusts ........................................................................................... 149
Table of Contents
Use the Rule Editor
Use Studio 5000 Logix Designer
Module Profile
Create trends with the
Delete trusts........................................................................................ 150
Integrate the module into a FactoryTalk environment with the
FactoryTalk Directory .............................................................................. 150
Integration prerequisites .................................................................. 150
Register the module in the FactoryTalk Directory .......................... 150
Add the Historian ME module in the PI SDK Utility ................ 150
Register the Historian ME module in the FactoryTalk
Administration Console ...............................................................151
Create users in the FactoryTalk Administration Console ............... 152
Configure secure groups in the FactoryTalk Administration Console
............................................................................................................. 153
SNMP community strings ....................................................................... 153
Enable SNMP ...................................................................................... 154
Create SNMP community strings ..................................................... 154
Delete SNMP community strings ..................................................... 154
Chapter 11
View the default point discovery rule file................................................ 155
Create point discovery rule files .............................................................. 156
Define point discovery rules .................................................................... 157
Change the point discovery limit ...................................................... 159
Edit point discovery rule files .................................................................. 159
Remove point discovery rule files ........................................................... 160
Create tag attribute files .......................................................................... 160
Edit tag attribute files .............................................................................. 166
Remove tag attribute files ........................................................................ 167
FactoryTalk Historian DataLink
Add-in
8 Rockwell Automation Publication 1756-UM106F-EN-E - February 2021
Chapter 12
Configure your Historian module in the Module Profile ......................169
Configure the module properties ............................................................169
Example: Use the Module Profile............................................................. 171
Add an Ethernet driver .......................................................................171
Add the module to Studio 5000 Logix Designer .............................. 172
Use output tags to start and stop the data collection ...................... 174
Use the input and output tags to read the Historian ME status ........... 175
Chapter 13
Define the server connection ...................................................................178
Insert trends in a Microsoft Excel workbook .........................................178
Create trends visualizing the data transfer ............................................ 179
Use Web Diagnostics
Troubleshoot
Table of Contents
Chapter 14
Home......................................................................................................... 184
Hardware .................................................................................................. 184
Overview ............................................................................................. 184
CPU, RAM ........................................................................................... 185
NAND .................................................................................................. 186
Controller statistics ............................................................................ 187
ControlBus statistics .......................................................................... 188
EtherNet/IP ........................................................................................ 189
Display LED ........................................................................................ 189
Time management ............................................................................. 190
Firmware ................................................................................................... 191
Overview ............................................................................................. 191
Historian server.................................................................................. 192
CIP ....................................................................................................... 192
Data server .......................................................................................... 193
Data collection .................................................................................... 193
Data transfer....................................................................................... 194
Data storage ........................................................................................ 194
Web configuration server .................................................................. 195
Web diagnostics server ...................................................................... 196
Startup log .......................................................................................... 196
Admin ........................................................................................................ 196
Hosts ................................................................................................... 197
Restart services ................................................................................... 197
Core dump directory .......................................................................... 198
PI commands ...................................................................................... 198
Download logs .................................................................................... 198
Change password ............................................................................... 198
Rockwell Automation Publication 1756-UM106F-EN-E - February 2021 9
Chapter 15
Provide issue information ....................................................................... 201
Reboot the module ................................................................................... 202
Work in the safe mode ............................................................................ 202
Hardware issues ...................................................................................... 202
Web client issues ..................................................................................... 203
Data collection issues .............................................................................. 204
Data storage issues .................................................................................. 205
Data transfer issues................................................................................. 206
Data export issues ................................................................................... 207
Auto recovery issues ................................................................................ 207
Time management issues ....................................................................... 207
Table of Contents
Glossary
Index
Client computer issues............................................................................ 208
Point server issues ................................................................................... 208
Related FactoryTalk product issues ....................................................... 208
Chapter 16
Glossary terms .......................................................................................... 209
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
• ControlFLASH Firmware Upgrade Kit Quick Start Guide
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.
2. Under Downloads, click Find Downloads.
3. Under Find Downloads, type ControlFLASH.
The search results appear below.
4. Click ControlFLASH Firmware Upgrade Tool (Accessories/Software).
The package appears in the right pane.
(Optional) Install ControlFLASH
firmware kit
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
Loading...