Monitoring WinGate data

WinGate components will publish what data they have available to be monitored with the Data system. This is displayed on the Monitoring tab, located at Control Panel > Data in the WinGate Management console.

From here you can select which of the published pieces of data on the Monitoring tab will actually be monitored.

Note

To monitor a piece of WinGate data using the Monitoring tab:

1. Open the WinGate Management console.
2. Navigate to Control Panel > Data.
3. On the Monitoring tab, double click the piece of data that you wish to monitor. This will open the Monitoring properties.

   

   Close | Close all images

4. On the Monitoring properties, ensure the Collect data for monitoring checkbox is ticked (this is selected by default).

   Note

   When you are configuring the properties of piece monitored data, the Threshold checking options are optional.

   Read about threshold checking

5. Click OK to confirm the data will be monitored. The piece of monitored data will now display Receiving data in its Status column on the Monitoring tab.

   Note

   You can stop WinGate from monitoring a piece of data by right clicking on it (in the Monitoring tab) and selecting Disable monitoring.

To monitor WinGate data using scripting or the Symbol browser:

It is also possible to begin monitoring data (that has been published for monitoring) when using a WinGate scripting system, or a configuration that has access to a Symbol browser. The Data system publishes the Data.GetMonitor(Text DataSource, Text DataItem) method for this purpose.

When you use this method, it will check to see if the specified published data provided by the specified data source is currently being monitored. If it isn't, it will automatically turn on monitoring for the selected piece of published data. This alleviates the need to switch on monitoring for the selected data from the Monitoring tab, before being able to access or refer to it in script.

e.g.

A script could contain:

This would attempt to see if a piece of data called TestMonitor(DataItem) published by Events (DataSource) is currently being monitored. If it isn't, then WinGate will begin monitoring the published data named TestMonitor.

Read more about using WinGate objects

Using monitored data

Once you have set a piece of data to be monitored, it is available to be read and referred to by other WinGate services and components just like global data items.

Read about accessing monitored data