Qbik Helpsys

Symbol Browser

The Symbol Browser provides a tree like structure of the registered WinGate objects that are available from the location that you open it from. When you are in a WinGate configuration that provides access to the Symbol Browser, you can open the browser by clicking the Insert Symbol button .

The Symbol Browser allows you to select a property or method from an object (object symbol) which will be used in the configuration where you opened the Symbol Browser from.

When each object is expanded, the browser lists all of the properties and member functions provided by that object. For example, the Session object can supply session oriented data about an event such as IP addresses, Ports used, etc. Similarly the WinGateUpdate object contains functions that allow you to manage WinGate Updates.

The Symbol Browser divides available objects into two sections:

  1. Scope:Local

    This section contains objects provided by the component or source of the registered event that you are configuring processing for. These objects provide access to event data and functions related to the specific event taking place. As such, the appearance of objects in the Scope:Local section can vary based on the particular type of event that you are configuring processing for.

  2. Scope:Global

    This section contains objects provided by WinGate components, that will always be available for use regardless of the event being processed.

Using the Symbol Browser

When using a configuration that has access to the Symbol Browser, you will generally be selecting an object symbol to place in a dialog field, or add to a statement in the body of a script.

Whenever you select a property or function from the Symbol Browser, it will insert the selected symbol into the configuration you have accessed it from. This allows you to provide parameters (if required) to the method you have chosen. The property value will be used, or the method will be executed when it is required. This could be on the occurrence of an event if it is being placed in an event processing script, or inside a policy item based on a particular event.

In the example below the Run Javascript policy item is configured to check the value of client IP address and the port they made the request to as part of the policies processing. The policy is based on the WWWProxyService:Proxy Request event.

This is achieved by selecting two symbols from the browser:

  1. Session.ClientIp

    The Session object in this instance is registered by the WWW Proxy Service and provides the Client IP address where the proxy request came from.

  2. Request.Port

    The Request object provides the port the request was made to.

In mail oriented configurations (the Send Mail event processor, Send Email policy item) you can insert object symbols into the body of the email, by placing the mouse cursor in the email editor at the position you want the data to appear in the actual email, as displayed by the symbols that have been inserted in the example below.

Each time the email is sent the object symbols that you have inserted will be parsed with the most current data available at the time. This allows you to create dynamic and informative emails when needed.

Note

Available data

When you open a Symbol Browser, the appearance of the objects in the browser can vary depending on the configuration that you are in. This is due to a number of factors:

  • If you are in an event processor configuration, then the availability of certain objects will be dependent on the type of event you are specifying processing for, and the data the source of the event is able to supply.

    Since the structure of components and services can vary greatly, the sort of event data they can supply can also vary. For example, when configuring an event processor to respond to an event from the Notifications system, you will never see a Session or Request object in the associated Symbol Browser, since notification events do not create sessions.

  • The context and purpose within WinGate of the configuration you are using.

  1. no comments yet...

Download helpfile

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:

  • event management (no quotes) will find all pages containing the words "event" OR "management"
  • "event management" (with quotes) will find all pages containing the phrase "event management"
  • +event -management will find all pages containing the word "event", AND NOT the word "management"