Application Notes

These application notes apply to
FactoryTalk® Edge Gateway™
 version 1.04.00.
Mitigation for
Microsoft
 DCOM Hardening patch
In response to
Microsoft
 Distributed Component Object Model (DCOM) Hardening patch (MS KB5004442), the minimum DCOM authentication level used by
Rockwell Automation
 products was raised to Packet Integrity.
IMPORTANT:
Installing this product’s latest version with earlier unpatched versions of other
FactoryTalk
 products or products using Classic OPC DA connections may cause a loss of connectivity due to the difference in DCOM authentication level used. For additional information, see the Knowledgebase Document ID: IN39461 - Microsoft DCOM Hardening Information TOC.
Microsoft
 releases the DCOM Hardening patch in response to CVE-2021-26414. This patch elevates the minimum DCOM authentication level that is required to establish a DCOM connection. DCOM is used by many
Rockwell Automation
 products and may be affected by the change that is made by the
Microsoft
 patch. For additional information about the affected
Rockwell Automation
 products, see the Knowledgebase Document ID: PN1581 - Product Notification 2022-01-001 - Rockwell Automation products unable to establish proper DCOM connection after installing Microsoft DCOM Hardening patch (MS KB5004442).
Unattended or Silent Install
Use command-line parameters to perform an unattended or silent installation of the software.
Installation Command-line Parameters
This table identifies the installation command-line parameters. Command-line parameters are case-insensitive. However, if a specified value includes a space, be sure to enclose the value in quotation marks (for example, "value with spaces").
Parameter
Description
/?
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.
This parameter is required if /QS is not specified.
/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.
This parameter is required for /Q or /QS parameters.
/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 that must be agreed to before the installation is completed.
/Record
Records the installation options chosen to a recording file.
This parameter is optional.
/Playback
Plays back a recording file to specify the installation options.
This parameter is optional.
/Repair
Runs a repair operation on the installed products.
This parameter is optional.
/Uninstall
Uninstalls the product.
This parameter is optional.
/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 operating system user interface language.
/Product="value"
Specifies which sub-products will be installed.
Only required if sub-products are included with the install package.
If the software does not include sub-products this parameter is not 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"
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.
/IgnoreWarning
Specifies that the setup ignores warnings and continues.
This parameter is optional. If it is not specified, the setup exits when a warning occurs.
/SerialNumber="value"
Specifies the serial number of the software being installed. This is used to activate the software 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.
/ProductKey="value"
Specifies the product key used to get activation keys 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.
/Version="value"
Specifies the version of the software to activate which corresponds to the product version 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.
/InstanceName
(Applicable only for FactoryTalk Live Data Remote Connector installation)
Instance name cannot be empty. It must begin with a lowercase letter and can be 2-40 characters long including alphanumeric, hyphen(s), and underscore(s).
/IP
(Applicable only for FactoryTalk Live Data Remote Connector installation)
IPv4 IP Address
/Port
(Applicable only for FactoryTalk Live Data Remote Connector installation)
Port numbers must be between 0 to 65535.
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
  • 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.
    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 record file the clipboard.
    5. Perform silent install by using this command line:
      Setup.exe /Record
The
Setup
 page appears.
      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 Code
Value
Description
ERROR_SUCCESS
0
The installation completed successfully.
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.
ERROR_SUCCESS_REBOOT_REQUIRED
3010
A restart is required to complete the installation. After restart the product is successfully installed.
ERROR_REBOOT_PENDING
3012
A restart is pending and is required before the installation can continue.
ERROR_SUCCESS_NOT_APPLICABLE
3013
The installation cannot proceed because the products are already installed.
Data flow limits
For best results, observe these data flow limits for data sources and destination systems:
Application
Data source type (polling update rate)
Limit for atomic tags per single application
Notes
SQL Server®
CIP device
10000 tags@ 1000 ms
FactoryTalk® Live Data shortcut
10000 tags@ 1000 ms
OPC DA server
10000 tags@ 1000 ms
Azure® IoT Hub
CIP device
1100 tags@ 1000 ms
FactoryTalk® Live Data shortcut
1100 tags@ 1000 ms
OPC DA server
900 tags@ 1000 ms
InfluxDB®
CIP device
10000 tags@ 1000 ms
FactoryTalk® Live Data shortcut
10000 tags@ 1000 ms
OPC DA server
Data not available
MQTT v3.1
CIP device
1300 tags@ 1000 ms
FactoryTalk® Live Data shortcut
1100 tags@ 1000 ms
OPC DA server
1300 tags@ 1000 ms
PTC ThingWorx®
CIP device
Data not available
FactoryTalk® Live Data shortcut
6800 tags@ 1000 ms
10000 tags@ 1000 ms with multiple applications
OPC DA server
Data not available
Device and drives limits
Description
Limit
Notes
Drives and IMC devices
Minimum spacing between messages to a drive is 100 ms
Example: If reading 20 parameters, it would take a minimum of 2s to read the parameters
Upgrading from previous versions
To use the WebSockets for IoT application, after upgrading
FactoryTalk Edge Gateway
 from a previous version, select
Use WebSockets
 in the IoT application configuration.
Update failed data sources following a
FactoryTalk Edge Gateway
 upgrade to the current version
Starting the configuration tool after a
FactoryTalk Edge Gateway
 version upgrade triggers an update of data sources. Before the update, a backup of the resources is saved, and model CSV files are exported to specific locations. For example:
FactoryTalk Edge Gateway\fteg-ct\backups\update_2021-07-15T14-08-54-005Z\resources
FactoryTalk Edge Gateway\fteg-ct\backups\update_2021-07-15T14-08-54-005Z\models
Following the update,
FactoryTalk Edge Gateway
 creates the
Update
folder in
FactoryTalk Edge Gateway\fteg-ct
. The
Update
 folder contains an update log file (update.log).
If data sources fail to update after you start the configuration tool, follow these recovery steps. If you do not perform these recovery steps, you might experience difficulties completing certain actions.
  1. In the error message, select
    Open log file
     to see errors.
  2. In
    FactoryTalk Edge Gateway
    , perform one of these actions:
    • Clear all data sources, restart the configuration tool, and then populate all data sources.
    • Create all data sources with the same information as before the upgrade. Use any new data source name in the model CSV file before importing the models.
  3. In the
    Backups
    folder, locate and then import all model CSV files (for example, export_data_source_<name of model>.csv) into
    FactoryTalk Edge Gateway
    .
  4. (Optional) Reconfigure tags if the application contains tags that are separate from the model.
  5. Redeploy the application.
    If the update fails and a
    ThingWorx
     application is using
    FactoryTalk Smart Object
     models, clearing and then populating
    FactoryTalk Smart Object
     data sources creates namespace IDs. In the
    ThingWorx
     application, these IDs are used in node (Thing) names. Changes to these IDs could require the reconfiguration of mashups in
    ThingWorx
    .
Export of models and update of data sources fail
When both the export of models and the update of data sources fail, follow these recovery steps. If you do not perform these recovery steps, you might experience difficulties completing certain actions.
  1. In
    Models
    , export models and then refer to the log file to identify which models failed to export.
  2. Export the failed models as a template.
  3. Clear all data sources, restart the configuration tool, and then populate all data sources.
  4. In the
    Backups
     folder, locate and then import all model CSV files into
    FactoryTalk Edge Gateway
    .
  5. Import models after binding the tags to the exported model template.
  6. Redeploy the application.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal