All events that have been registered with the Events system are displayed on the Events panel located at Control Panel > Events in the WinGate Management console.
The Events panel allows you to specify and configure which event processors will respond to a selected event taking place. When you specify which event processor should process the event, the relevant event processor configuration will be opened so you can configure the details of how it should respond when the event occurs.
When a source registers an event, it will often have an Events tab where you can access and configure those particular events. Most WinGate network services will have an Events tab within their properties which allow you to specify processing for their events.
Similarly, when you create scheduled events with the Scheduled Events system, these can be accessed on the Scheduled Events panel, located at Control Panel > Scheduled Events in the WinGate Management console.
When using a WinGate script system (such as the Lua or Javascript event processors) or using any WinGate event processor that has access to a Symbol Browser, you can use the Event object published by the Events system to manage the event. The Event object provides methods (functions) to access and manipulate a select amount of data that is available from the Events system regarding the registered event.
Member |
Description |
|---|---|
Control |
A read/write member that allows you to read the current event flow control value and if required change it to a different value. Flow control values are: 0 = Pass 1 = Block 2 = Resubmit Commonly used when you are controlling event processing using a WinGate script system. e.g. A script could be set to change the Event controls current value: Event.Control=1 (block the current event) |
Name
|
The internal name of the selected Event in WinGate. This is the Event type section of an Event name in WinGate. e.g. A script could contain: Event.Name.Contains("ClientConnect", 0) Using the Event.Name.Contains() will always return true if the event name contains (or is called) ClientConnect (regardless of case). |
Result |
This is the system result of the processing outcome of the event. |
GetData(Text Key) |
This will retrieve the data value previously set with the Event.SetData(Text Key, Text Value) method (described below) |
SetData(Text Key, Text Value) |
This method allows you to store a data value against a specified text key, for subsequent referral and use by the event processors that have been set to process this particular event. For example, this function could be used to set a value in a Javascript script event processor that has been configured to process an event. The script could contain: Event.SetData("Reference", "456") This would store the value 456 against a key called Reference. If another event processor has also been specified to process this event after the Javascript (such as the Send Mail event processor, or another script event processor etc.) then it would be able to access and use this value by using the Event.GetData(Text Key) method (listed above). For example the value set in the Javascript example above could be called and used in the body of the Send email event processor, which is set to process the event next: Ref:{{Event.GetData("Reference")}} When the Send Email event processor processes this event, the body of the email would read Ref: 456
|
Source
|
The source type (component or service) in WinGate that registered the event. |
You can use basic Full-Text Searches against the page title and body to find matching articles. Use the following search modifiers to refine your query:
