String value

The global data String value provides a centralized reference point for WinGate components and services to check or use the value of a string (text).

String values can be used for:

• Creating predefined text (message bodies, titles etc.) that can be inserted into any message configuration in WinGate using the Symbol browser, or when you are creating messages using a WinGate scripting system.
• Storing Email addresses, Header information for email generated inside a WinGate configuration such as the Send Mail event processor, or the Send Email policy item in the WinGate Policy system.
• Providing a predefined string value that can be compared with current event data, when configuring a policy or using a WinGate script system.

Creating string values

String values can be created in several ways:

1. Using the Global Data panel

   1. Open the WinGate Management console.
   2. Navigate to Control Panel > Data.
   3. From the Tasks menu select New string. Or alternatively right click anywhere on the Global Data panel and select New string from the menu. This will open the Edit String configuration.

      

      Close | Close all images

   4. In the String name field, enter a suitable name for the String. This is the name that will be used to refer to this string value when accessing global data from throughout WinGate.
   5. In the Value field, set the value that the String value will be set to by default.
   6. Select the Store details between restarts checkbox if you wish the current string value to be stored after the WinGate engine has been stopped and restarted, otherwise it will be deleted the next time the WinGate engine is stopped.
   7. Click OK and the new String value will now be listed in the Global Data panel.

2. Using script

   When using a WinGate scripting system (such as the Lua or Javascript event processors) or a configuration that has access to a Symbol browser, you can use the Data object published by the Data module to create, manage and use global data string values. The Data object provides the GetString(Text StringName) method which you can use to create a global data string.

   

   Close | Close all images

   e.g. A script could contain:

   Data.GetString("teststring")

   This would attempt to get the value of a global data string called teststring. If this string did not exist, a new string will be created automatically with the name teststring. Like other global data items, if the specified global data counter does not exist then it is created automatically.

   Read more about using WinGate objects

Note

Using Lists

Like other global data items, strings can be referenced, modified, and deleted whenever you are:

1. Using a WinGate script system.
2. Using a WinGate configuration that has access to the Symbol browser.

Read about accessing global data items