Quick Start Guide
Original Instructions
FactoryTalk Edge Gateway Quick Start Guide
FactoryTalk Edge Gateway Quick Start Guide
personal injury or death, property damage, or economic loss.
Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
IMPORTANT
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present.
temperatures.
for Personal Protective Equipment (PPE).
Important User Information
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 may lead to
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss.
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.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
ARC FLASH HAZARD:
will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and
Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash
2
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
Summary of changes
Topic Name
Reason
This manual includes new and updated information. Use these reference
tables to locate changed information.
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.
Additional resources on page 7 Added link to the FactoryTalk Edge Gateway User Manual.
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
3
Table of Contents
Summary of changes
Welcome to FactoryTalk Edge
Gateway
Index
Preface
Studio 5000 environment .......................................................................... 7
Additional resources ................................................................................... 7
Legal notices ................................................................................................ 7
Chapter 1
Data ingress ................................................................................................. 9
Data contextualization ............................................................................... 9
Data egress .................................................................................................10
System requirements ................................................................................. 11
Install FactoryTalk Edge Gateway ............................................................. 12
Perform an unattended or silent install ................................................... 12
Configuring the FactoryTalk Edge Gateway ............................................ 15
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
5
Preface
Resource
Description
Studio 5000 Smart Object Configurator Quick Start
Guide
Provides guidelines for using Studio 5000 Smart
Object Configurator.
Studio 5000 environment
Additional resources
Legal notices
The Studio 5000 Automation Engineering & Design Environment® combines
engineering and design elements into a common environment. The first
element is the Studio 5000 Logix Designer® application. The Logix Designer
application is the rebranding of RSLogix 5000® software and will continue to
be the product to program Logix 5000™ controllers for discrete, process,
batch, motion, safety, and drive-based solutions.
he Studio 5000® environment is the foundation for the future of
T
Rockwell Automation® engineering design tools and capabilities. The Studio
5000 environment is the one place for design engineers to develop all
elements of their control system.
These documents contain additional information concerning related
Rockwell Automation products.
FactoryTalk Edge Gateway User Manual Provides complete instructions for using
FactoryTalk Edge Gateway.
View or download publications at
http://www.rockwellautomation.com/literature
technical documentation, contact the local Rockwell Automation distributor
or sales representative.
ockwell Automation publishes legal notices, such as privacy policies, license
R
agreements, trademark disclosures, and other terms and conditions on the
Legal Notices
page of the Rockwell Automation website.
. To order paper copies of
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
7
Preface
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 install folder on your
hard drive.
The default location of this file is:
C:\Program Files (x86)\Common Files\Rockwell\license.rtf.
Open Source Software Licenses
The software included in this product contains copyrighted software that is
licensed under one or more open source licenses.
You can view a full list of all open source software used in this product and
their corresponding licenses by opening the index.html file located your
product's OPENSOURCE folder on your hard drive.
The default location of this file is:
C:\Program Files (x86)\Common Files\Rockwell\Help\<product
name>\Release Notes\OPENSOURCE\index.htm
You may obtain Corresponding Source code for open source packages
included in this product from their respective project web site(s).
Alternatively, you may obtain complete Corresponding Source code by
contacting Rockwell Automation via the Contact form on the Rockwell
Automation website:
us/contact/contact.page. Please include "Open Source" as part of the request
text.
http://www.rockwellautomation.com/global/about-
8
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
Chapter 1
Welcome to FactoryTalk Edge Gateway
FactoryTalk® Edge Gateway™ connects operational technology (OT) to
information technology (IT) destination systems. FactoryTalk Edge Gateway
collects and organizes data with improved context and makes the data
available to stream into higher-level IT applications and databases.
FactoryTalk Edge Gateway enables contextualizing OT data at the OT level.
FactoryTalk Edge Gateway supports improved data collection and
organization by using these capabilities:
• Data ingress on page 9
• Data contextualization on page 9
• Data egress on page 10
Data ingress
Data ingress is implemented as data sources in FactoryTalk Edge Gateway.
Data sources allow an OT engineer to identify data critical for analysis. Use
FactoryTalk Edge Gateway to configure a pathway to collect data from these
sources:
• Logix project file (.acd)
• Logix controller
• FactoryTalk® Live Data shortcut
• Drive/IMC device
• OPC DA device
• KEPServer Enterprise device for 3rd party data connectivity
Data contextualization
Data contextualization is implemented as models in FactoryTalk Edge
Gateway. Models help align data to reflect the specific scenario needing
analysis. Having aligned data adds resolution and accuracy to the analysis.
FactoryTalk Edge Gateway offers two options for data contextualization:
• Information models
• FactoryTalk Smart Object instances
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
9
Chapter 1 Welcome to FactoryTalk Edge Gateway
An information model is a framework that allows building relationships at the
OT layer as pertaining directly to the OT assets and system attributes.
Information models allow for the consideration of the overall operational
aspects and their organization in reference to the operational hierarchy. Use
the configured data sources to build information models.
FactoryTalk Smart Object instances are created in the Studio 5000 application
environment and are imported into FactoryTalk Edge Gateway via Logix
project files (.acd). A FactoryTalk Smart Object is an extension of the base
Logix tag with additional configuration properties. These user-defined
configuration properties allow for additional data analysis. FactoryTalk Smart
Object instances also provide high-speed data collection with time
synchronization and are based on the configuration properties and
information model hierarchy. When used with FactoryTalk Smart Object
instances, FactoryTalk Edge Gateway offers contextual resolution of high
speed data with time synchronization.
The object-based methodology of FactoryTalk Smart Object instances provides
these advantages:
• Common data across the system
• Re-use and library management at the automation layer
• Automatic use by the information layer
• Contemporary foundation for application development
FactoryTalk Smart Object instances are supported in Logix firmware revisions
28.00 or later. FactoryTalk Smart Object instances are automatically
discovered from offline Logix project files (.acd) when using an EtherNet/IP
driver for data collection. FactoryTalk Smart Object instances organize the
data to collect from data sources. After configuring data sources that contain
FactoryTalk Smart Object instances, the FactoryTalk Smart Object models
become available in Models.
FactoryTalk Smart Object instances are not editable from FactoryTalk Edge
Gateway. Modify FactoryTalk Smart Object models in the project for the
controller.
Data egress
Data egress is implemented as applications in FactoryTalk Edge Gateway that
have store and forward capabilities. Use applications to configure pathways
that deliver contextualized data to the destination system. Data analysis or
machine learning data preparation is executed at the destination system
using your preferred analytics engine.
10
FactoryTalk Edge Gateway supports these destination systems:
• Azure IoT Hub
• MSSQL
• ThingWorx®
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
Chapter 1 Welcome to FactoryTalk Edge Gateway
System requirements
FactoryTalk® Edge Gateway™ works within the system requirements of all
Rockwell Automation® software products.
Hardware requirements
FactoryTalk Edge Gateway requires hardware that meets or exceeds these
specifications:
• 2 GB of memory
• Dual-core processor
Rockwell Automation recommends at least 32 GB of available drive space for
FactoryTalk Edge Gateway.
Software requirements
FactoryTalk Edge Gateway requires the following software on the host
computer:
• Operating system
FactoryTalk Edge Gateway runs on the following Windows® operating
ems:
syst
• Windows 10 Professional or Enterprise edition (64-bit)
• Windows 10 IoT Enterprise 2016
• Windows Server 2019 Standard
• Windows Server 2016 Standard
• Windows Server® 2012 R2 Standard
When you install FactoryTalk Activation Manager v4.04 the following software
will be installed if not already present:
FactoryTalk Diagnostics version 2.90
.NET Framework 4.5.2
Wibu CodeMeter runtime version 6.30
Flexera version 11.14
FactoryTalk® Services Platform 6.20.00
FactoryTalk OPC UA functionality was tested with Kepserver EX.
Supported browsers
The following web browsers have been tested and are supported for use with
this release:
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
11
Chapter 1 Welcome to FactoryTalk Edge Gateway
• Google® Chrome™ browser
• Internet Explorer® 11
• Mozilla® Firefox®
Install FactoryTalk Edge Gateway
Use the Rockwell Automation common installer to install FactoryTalk Edge
Gateway.
Install FactoryTalk Edge Gateway on the same operating systems that Studio
5000 Logix Designer® supports.
Install FactoryTalk Edge Gateway alongside Studio 5000 Logix Designer
versions 28.00 to 33.00.
To install FactoryTalk Edge Gateway
Tip: FactoryTalk Edge Gateway does not support Windows® 7.
1. Launch the Rockwell Automation common installer.
2. Select Setup.exe.
3. Select Customize.
4. Customize FactoryTalk Edge Gateway by selecting options or keep the
default options.
5. Select a location on your computer for the FactoryTalk Edge Gateway
application.
6. Select Install.
7. Accept the End User License Agreement.
8. Activate FactoryTalk Edge Gateway or skip the activation.
9. Restart your computer. The Factory Talk Gateway Configuration Tool
appears in the program list.
Perform an unattended or silent install
Unattended or silent install
Use command-line parameters to perform an unattended or silent installation
of the software. For more information, see the FactoryTalk Edge Gateway
Quick Start Guide publication 95055-QS002.
12
Installation Command-line parameters
This table identifies the installation command-line parameters. Commandline parameters are case-insensitive. However, if a specified value includes a
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
Chapter 1 Welcome to FactoryTalk Edge Gateway
Parameter
Description
This parameter is required if /QS is not specified.
This parameter is required for /Q or /QS parameters.
that must be agreed to before the installation is completed.
This parameter is optional.
This parameter is optional.
This parameter is optional.
This parameter is optional.
operating system user interface language.
If the software does not include sub-products this parameter is not available.
space, be sure to enclose the value in quotation marks (for example, "value
with spaces").
/? Displays the usage options for installation parameters.
/Q Silent Install, install runs in a quiet mode without any user interface.
This parameter is recommended when deploying the software installation using an IT tool or script,
and don’t expect any error or restart messages. When using this parameter, check the error codes,
and respond as needed. For example, if the installation returns error code 1641, then the IT tool or
script should restart the computer and relaunch the installation after restart.
/QS Unattended Install, install runs in a quiet simple mode and shows progress through the UI, it does not
accept any input but still shows error or restart messages.
When using this parameter, the installation will stop and display a prompt if there are error or restart
messages. For example, if an immediate restart is required to complete the install, a restart message
will be displayed to confirm the restart. Installation resumes automatically from the point of
interruption after restart.
This parameter is required if /Q is not specified.
/IAcceptAllLicenseTerms Acknowledges acceptance of the license terms.
/AutoRestart Automatically restarts the computer after the installation is complete. Used when a restart is
required to complete the installation.
This parameter is optional. If this parameter is not used silent install (/Q) will return either error code
1641 or 3010 if a restart is required, and unattended install (/QS) will result in a confirmation prompt
/Record Records the installation options chosen to a recording file.
/Playback Plays back a recording file to specify the installation options.
/Repair Runs a repair operation on the installed products.
/Uninstall Uninstalls the product.
/SetupLanguage="value" Specifies which language is displayed during install process.
The value must be the one of these:
• ENU
• CHS
• DEU
• ESP
• FRA
• ITA
• JPN
• KOR
• PTB
This parameter is optional. If this parameter is not used, the default language is the current user or
/Product="value" Specifies which sub-products will be installed.
Only required if sub-products are included with the install package.
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
13
Chapter 1 Welcome to FactoryTalk Edge Gateway
Parameter
Description
available.
/ProductLanguage="value" Specifies the language version of the software being installed.
The value must be the one of these:
• ENU
• CHS
• DEU
• ESP
• FRA
• ITA
• JPN
• KOR
• PTB
This parameter is optional. If this parameter is not used, the default language is the same as the
setup language.
If the software does not support multiple languages this parameter is not available.
/InstallLocation="value"
Or
/InstallDrive="value"
/IgnoreWarning Specifies that the setup ignores warnings and continues.
/SerialNumber="value" Specifies the serial number of the software being installed. This is used to activate the software
/ProductKey="value" Specifies the product key used to get activation keys during installation.
/Version="value" Specifies the version of the software to activate which corresponds to the product version
Specifies the install location or install drive respectively.
This parameter is optional. If this parameter is not used, the default install location is "C:\Program
Files (x86)\Rockwell Software".
Some software restricts the installer to only change the drive the software is installed on. Use /? to
determine which parameter is supported.
This parameter is optional. If it is not specified, the setup exits when a warning occurs.
during installation.
This parameter is optional. If it is not specified the software must be activated manually after
installation if activation is required.
Some software does not require activation. If activation is not required this parameter is not
available.
This parameter is optional. If it is not specified the software must be activated manually after
installation if activation is required.
Some software does not require activation. If activation is not required this parameter is not
associated with the SerialNumber and ProductKey.
This parameter is optional. If it is not specified the installer uses the most recent product version
available.
Some software does not require activation. If activation is not required this parameter is not
available.
14
Examples
These examples show how to use the installation commands.
• To install the software with no user interface using the default settings
during the installation process. (Silent install)
Setup.exe /Q /IAcceptAllLicenseTerms
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
Chapter 1 Welcome to FactoryTalk Edge Gateway
Error Code
Value
Description
ERROR_INVALID_PARAMETER
87
One of the parameters was invalid.
ERROR_INSTALL_USEREXIT
1602
The installation was cancelled by the user.
ERROR_INSTALL_FAILURE
1603
A fatal error occurred during installation.
ERROR_BAD_CONFIGURATION
1610
The configuration data for this product is corrupt. Contact your support personnel.
ERROR_REBOOT_CONTINUE
1641
A reboot is required to continue to installation.
successfully installed.
ERROR_REBOOT_PENDING
3012
A restart is pending and is required before the installation can continue.
• To install the Chinese language version of the software on the D: drive
and display the progress, error, or complete messages during
installation and restart the computer if necessary. (Unattended install)
Setup.exe /QS /IAcceptAllLicenseTerms /AutoRestart
/SetupLanguage=CHS /InstallDrive=D:
• To customize components and features for installation, record inputs
to a record file and playback on other machines. (Record and Playback)
1. Launch the installation in record mode.
Setup.exe /Record
The Setup page appears.
2. Select Next.
The Customize page appears.
3. Select the required check boxes and select Next.
The Recording complete page appears.
4. Select the link for the record file (.rec) to copy the path or the recor
file the clipboard.
5. Perform silent install by using this command line:
Setup.exe /Q /IAcceptAllLicenseTerms
/Playback="<path the record file>"
Error codes
This table identifies the error codes that can be returned by an installation.
ERROR_SUCCESS 0 The installation completed successfully.
ERROR_SUCCESS_REBOOT_REQUIRED 3010 A restart is required to complete the installation. After restart the product is
ERROR_SUCCESS_NOT_APPLICABLE 3013 The installation cannot proceed because the products are already installed.
d
Configuring the FactoryTalk Edge Gateway
Configuring FactoryTalk Edge Gateway involves connecting to your data
sources, contextualizing the data by creating information models, and
mapping the contextualize data to applications.
Consult the FactoryTalk Edge Gateway online help for more information.
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
15
Index
C
configuration 15
S
silent install 12
system requirements 10
Index
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
17
Rockwell Automation support
Technical Support Center
updates.
Knowledgebase
Access Knowledgebase articles.
rok.auto/knowledgebase
Literature Library
find associated firmware.
Use these resources to access support information.
Local Technical Support Phone Numbers
Product Compatibility and Download Center
(PCDC)
Find help with how-to videos, FAQs, chat, user forums, and product notification
Locate the telephone number for your country. rok.auto/phonesupport
Find installation instructions, manuals, brochures, and technical data publications. rok.auto/literature
Get help determining how products interact, check features and capabilities, and
rok.auto/support
rok.auto/pcdc
Documentation feedback
Your comments help us serve your documentation needs better. If you have any suggestions on how to improve our content, complete the form at
rok.auto/docfeedback
.
Waste Electrical and Electronic Equipment (WEEE)
At the end of life, this equipment should be collected separately from any unsorted municipal waste.
Rockwell Automation maintains current product environmental information on its website at rok.auto/ pec.
Allen-Bradley, expanding human possibility, Logix, Rockwell Automation, and Rockwell Software are trademarks of Rockwell Automation, Inc.
EtherNet/IP is a trademark of ODVA, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Rockwell Otomayson Ticaret A.Ş. Kar Plaza İş Merkezi E Blok Kat:6 34752, İçerenkÖy, İstanbul, Tel: +90 (216) 5698400 EEE YÖnetmeliğine Uygundur
Rockwell Automation Publication 95055-QS002B-EN-P - March 2021
Supersedes Rockwell Automation Publication 95055-QS 002A-EN-P - November 2020 Copyright © 2021 Rockwell Automat ion Technologies, Inc. All Rights Reserved. Printed in the U.S.A.
Loading...