System Name Usage Reference
The system name of a Gateway is fairly important since many systems within Ignition use that name as a reference. Changing the system name could cause one or more of these dependent systems to fail. This page contains a listing of features that uses a Gateway's system name.
Alarming​
Remote Gateway Notification Profiles​
Remote Gateway Notification Profiles reference a specific Gateway by name. If the system name of the remote Gateway was changed, then the remote notification profile may not function as intended.
Remote Alarm Journal Profiles​
Configuring a remote alarm journal profile involves specifying the system name of the remote Gateway. Changing the remote Gateway's system name could cause the profile to stop functioning.
EAM​
Agent Configurations​
Agent Gateways are identified by their system name. Changing the system name on the agent could result in unintentional behavior.
Edge​
Edge Sync Services​
Edge Sync Services forwards data to a standard edition Gateway. Changing the remote Gateway's system name without updating the Data Sync configuration on the Edge Gateway could cause synchronization attempts to fail.
Gateway Network​
Security Settings​
The Connection Policy and Specified List settings under the Gateway Network general settings can be used to restrict Gateway network connections based off the system name on the incoming connection. Changing the system name of a Gateway may prevent other gateways that use a SpecifiedList connection policy from accepting the incoming connection.
Scripting​
Message Handling Functions​
Some functions can trigger message handling events on separate Gateways. These functions make use of a remoteServer parameter to specify the target Gateway by system name. Changing a Gateway's system name might cause the functions below to no longer target the Gateway. In these cases you can simply update the calling scripts so they use the updated system name.
Tag History Functions​
System functions that directly interact with the historian tables may be impacted by changing a Gateway's name, since these functions typically include a historian driver in their path. See History Tag Search and Export for more details. The functions below may fail if the targeted Gateway had its system name changed. Should this occurs, you simply need to update the scripts to account for the new name.
- system.tag.browseHistoricalTags
- system.tag.deleteAnnotations
- system.tag.queryAnnotations
- system.tag.queryTagHistory
- system.tag.storeAnnotations
Security Zones​
Security Zone Configuration​
Security Zone configurations have a Gateway Names setting that is used to approve of Gateways by their system name. Changing the system name of a Gateway that was previously accepted by a zone's Gateway Names setting may result in the newly named Gateway being placed into a different security zone than before.
Tag Historian​
History Records​
The tables used to store records for the Tag Historian system can support records from multiple Gateways. This is facilitated by entries in the sqlth_drv table. Each tag provider on a Gateway that inserts values into the historian provider receives a separate entry on the sqlth_drv table, and all recorded values are mapped to their associated "drv" or driver entry.
Thus, changing the system name of a Gateway will cause future records to be stored under a different driver entry in the sqlth_drv table. These new driver entries will not be linked to the previous records, meaning any recorded values will not be associated with older entries. This typically manifests as historical queries with "missing" records from before the change. For example, a charting component might only be able to show data points from after the change, making it appear as if there are no records from before the change.
This can typically be fixed by modifying the sqlth_drv table entries. However it's is highly recommended to reach out to our support department should this happen, instead of modifying the tables yourself.
Internal Historian Provider Configuration​
System names are directly referenced by the Sync Settings on Internal Historian Providers. Changing the system name of a Gateway that is being targeted by these sync settings could interrupt the synchronization process.
Remote History Provider Configuration​
System names are directly referenced by the Remote Gateway settings on Remote Historian Providers. Changing the system name of a Gateway that is being targeted by these settings could interrupt the transfer of historical values to the remote Gateway.
Tag Providers​
Remote Tag Provider Configuration​
The Gateway setting on a Remote Tag Provider references the system name of the target Gateway. Changing the system name of the remote Gateway could prevent the remote tag provider from functioning properly.
Vision​
Tag Browse Tree Component​
The Root Node Path property on the Tag Browse Tree component can use a historical tag path, which includes the system name. Changes to the target system name could cause the component to not work.