Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

What Is a Plugin?

Ignition Edge offers different plugins that each add unique functionality to the Edge Gateway. There are three plugins available: Panel, Enterprise, and MQTT. Each Edge installation must contain at least one plugin, but any combination of plugins can be used as well. Select the ones that you need and don't use the rest, just like the modules in a standard Ignition installation.

Panel

The Panel plugin is to provide a remote terminal for operators, usually to act as a backup in case there is a network failure. Panel provides up to two launchable clients for your Edge project, one local and one remote can be open at the same time. In addition, Panel provides alarm notification in a limited form. This means the Edge Gateway has only one email notification profile and no alarm pipelines.


On_this_page




Configuring Alarm Notification

Because of this alarm limitation, when navigating to the Alarm Notification page in the Gateway, you will be taken immediately to edit the Edge Notification Profile. In the settings, you can select an SMTP profile to use as well as a roster. Both your SMTP profiles and Rosters must be configured first, and the 'From' address of the notification email will be the email address that is used to log in to the SMTP server.

When a Tag goes into alarm, it will automatically go through this notification profile and be sent to all users in the selected roster. This alarm notification is one-way, meaning alarms can't be acknowledged from the notification email.



 Alarm Journal 

You can configure the settings for the Alarm Journal under the Alarming > Journal tab. The Edge alarm journal and audit log can sync under EAM.

Journal Properties

Main

EnabledBy default the journal profile is enabled.
Minimum PriorityOnly events equal to or greater than the specified priority will be stored. The default is Low. You can set the priority to be: Diagnostic, Low, Medium, High, and Critical.
Store Shelved EventsNot enabled by default. If enabled, events generated by "shelved" alarms will still be written to the journal system.

Stored Event Data

Alarm events consist of two main types of data: the primary information about the alarm, such as transition state, time, etc. , and the event data
The following settings specify what type of event data is stored:
Static ConfigBy default, it is not selected. If selected, will store the values of static alarmconfiguration. That is, the alarm properties that are not bound. These do not change during evaluation, only when a user modifies them in the Designer, and so they are not stored by default.
Dynamic ConfigIf selected, will store the values of dynamically bound alarm configuration properties. The value of these properties can change at any time, and the values at the time of the alarm are captured on the alarm event.
Static Associated DataIf selected, will store the values of non-bound associated data (properties created by the user) properties on alarm that do not change during execution.
Dynamic Associated DataIf selected, will store the values of dynamically bound associated data (properties created by the user) properties.

Data Filters


The following three properties interact via logical AND, meaning an alarm must meet the criteria for all three for it to be logged in the Journal. Thus, if you supply values for all three Data Filer properties, then an alarm must match the Filter by Alarm SourceFilter by Display Path, and Filter by Display Path or Source properties.

Example: if a Journal has values for all three properties, and an alarm only meets the requirements for Filter by Alarm Source and Filter by Display Path or Source, but not Filter by Display Path, then the alarm will not be logged to the Journal!

If you want to filter on both the Display Path and Source Path, you would want to use only one of the two following approaches:

  • Filter by Alarm Source and Filter by Display Path
  • Only use Filter by Display Path or Source

It is recommended to avoid using all three properties simultaneously on the same Journal.

Filter by Alarm SourceOnly events matching the source will be stored. Multiple sources to match can be comma separated. Leave blank to store events from all sources.
Filter by Display PathOnly events matching the display path will be stored. Multiple display paths to match can be comma separated. Leave blank to store events from all display paths.
Filter by Display Path or SourceOnly events matching the display path, if defined, will be stored. Multiple matches can be comma separated. If no display path is defined, only events matching the source will be stored. Leave blank to store all events.



Enterprise

The Enterprise plugin includes the Gateway Network, bringing in all of the remote distributed services that come with that. Other Ignition Gateways can use the distributed services to query Tag values, Tag history, and alarms from Edge Gateways with the Enterprise Plugin. However, Edge can only be the target of distributed services, meaning Ignition Gateways will have the ability to setup Remote History Provider connections to Edge, but Edge will not be able to setup a Remote History Provider connection to an Ignition Gateway.  The Enterprise plugin also allows you to setup the Edge Gateway as an EAM agent. This allows you to remotely monitor and manage Edge Gateways from a central Ignition Gateway.

The Enterprise plugin introduces Tag History Synchronization. Tag History Synchronization allows you to sync your history data from the Edge Gateway to a full Tag History Provider on an Ignition Gateway, allowing you to save past the one week data limit. The Edge Gateway will still only see the one week of data that it can hold internally, but it will allow you to store the data in a more permanent database that can be viewed from other Ignition systems. This is setup by navigating to the Tag History Sync page link at the bottom of the Edge Gateway Configure page.

Tag History Synchronization Properties

Here, you can setup the history sync to point to a Tag history provider in another Gateway that is connected through the Gateway Network.

Settings

Remote Sync EnabledAllows you to turn Tag History Synchronization on or off.
Remote Gateway NameHere you specify the name of an Ignition Gateway that is connected through the Gateway Network. The Ignition Gateway must have the Tag Historian module installed and will need at least one Tag History provider. The Ignition Gateway's security settings will also need to be configured to allow remote storage.
Remote Provider NameThe name of the Tag History Provider that the Edge Gateway's history data will be stored to. The Tag History Provider can be any type of history provider that the Ignition Gateway has.

Sync Schedule

Sync Frequency How often data will be sent to the Ignition Gateway based on the units specified in the Sync Frequency Units.
Sync Frequency UnitsThe unit of time that will be used with the Sync Frequency.
Max Batch SizeThe maximum number of records that will be sent in a single batch to the Ignition Gateway.
Enable ScheduleIf enabled, data synchronization will only happen during the schedule specified. This allows you to limit Tag history traffic being sent over the network to a time when network traffic is a little lighter.
Schedule PatternA comma separated list of time ranges that will determine when data will be sent over the network.


Tag History Sync is unique in that if the connection to the remote Ignition Gateway is severed, the Edge Gateway will use its week of storage as a Store and Forward buffer, allowing you to store up to a week of data before data is lost. Once the connection is restored, the Edge Gateway will send data over based on the max batch size and data frequency until all previous data is sent.

 

MQTT

The MQTT plugin allows this copy of Edge to push data directly into a Broker using the fast and lightweight MQTT data transfer protocol. In effect, this makes your computer (and whatever devices are attached to it) into a remote MQTT Publisher. If you are already rolling out new smart devices that connect to your Broker, this allows you to connect all of your legacy devices into the same system.

Installing the MQTT Plugin

  1. To install the Ignition Edge MQTT plugin, first download the MQTT Transmission Module from the Inductive Automation website. 
  2. Next go to the Config tab of your Edge Gateway. 
  3. On the Overview page, scroll down to the MQTT and click the Install+ button.



  4. Scroll down and click on Install or Upgrade a Module...




  5. Next click on Choose file.



  6. Navigate to the folder where you downloaded MQTT-Transmission-signed.modl.
  7. Click the Install button. 
  8. At the License agreement, click on I accept the terms in the License Agreement, then click the Accept License button.
  9. At the Trusted Certificates window, click I want to add this certificate to my trusted certificates and install the module. Then click the Add Certificate and Install Module button.



  10. You'll see a message indicating the module was successfully installed. And the Module will show up on the Module Configuration page in the Edge Gateway now. 



For more information, check out the documentation at the Cirrus Link website https://docs.chariot.io/display/CLD.
 

 


Next_link