App Settings

Application-specific Settings

WinGuard automatically provides a number of application-specific Extension Settings, so-called App Settings. A <setting> that is defined in the Module XML can reference such an App Setting by using the value from the “Setting” column on this page as the Setting ID. This allows to set a new Extension-specific default value for this App Setting and makes this Setting available in the Extension for its own handling there.

Extension

The Settings defined in this section are primarily evaluated and used by the Extension (or the SDK) itself. However, they are automatically available in each Extension Settings dialog.

Logging

In the Extension’s Module XML file it is possible to override the default value for these Settings.

Setting Type Description Default
App.LogLevel int Logging level for the Extension protocol.
Possible values:
- 0: Normal
- 1: Detailed
- 2: Debug		 0 (Normal)
App.IOLogLevel int Logging level for the I/O protocol.
Possible values:
- 0: Off
- 1: Normal
Is only available to extensions that have the “Adapter” Trait.		 0 (Off)

WinGuard

The Settings defined in this section are primarily evaluated and used by WinGuard individually for each Extension. They are automatically available in each Extension Settings dialog.

Event priority

In the Extension’s Module XML file it is possible to override the default value for these Settings. These settings are only available to extensions that have the “Adapter” Trait.

Setting Type Description Default
App.PrioAlarm int Standard priority for Events of type alarm. 7
App.PrioPreAlarm int Standard priority for Events of type pre-alarm. 6
App.PrioWarning int Standard priority for Events of type warning. 5
App.PrioFault int Standard priority for Events of type fault. 4
App.PrioMessage int Standard priority for Events of type message. 3
App.PrioRevision int Standard priority for Events of type revision. 2
App.PrioOff int Standard priority for Events of type switch-off. 1
App.PrioActive int Standard priority for Events of type active. 3

Event handling

In the Extension’s Module XML file it is possible to override the default value for these Settings. These settings are only available to extensions that have the “Adapter” Trait.

Setting Type Description Default
App.EventAcceptedOperation string Event Operation that is sent to the Extension when an App Event is accepted.
Possible values:
- Ack (Operation Ack)
- Reset (Operation Reset)		 Ack
App.EventDeferredOperation string Event Operation that is sent to the Extension when an App Event is parked.
Possible values:
- Ack (Operation Ack)
- Reset (Operation Reset)		 Ack
App.EventCompletedOperation string Event Operation that is sent to the Extension when an App Event is completed.
Possible values:
- Ack (Operation Ack)
- Reset (Operation Reset)		 Reset
App.CreateEventsForUnlinkedObjects bool Indicates whether App Events are created for Objects that are not linked to a Datapoint in WinGuard.

This Setting will only be displayed in the Settings dialog if it is defined in the Module XML, because App Events for unlinked objects can only be created if the Extension actually creates these objects.		 true
App.EndEventsImplicitly bool Indicates whether App Events should be ended implicitly if the Extension or an Object is disconnected.

For Extension Objects that means as soon as their @connected State is set to false, any App Events that might be associated with this Object are ended (without an end time).

For the Extension that means as soon as it’s disconnected, any App Events that might be associated with any of its Objects are ended (without an end time).		 true
App.AutoComplete int Defines how Events should be completed at this Extension.
Possible values:
- 10 (Default - the system setting applies)
-   0 (Always, even if no display - at event end, the event is immediately completed)
-   1 (If accepted - at event end, the event is immediately completed if the event was accepted by the user beforehand)
-   2 (If deferred - at event end, the event is immediately completed if it was deferred beforehand)
-   3 (No - events are not completed automatically)		 10
App.Toolbar string Assign a separate toolbar for the event list for Events of this Extension.
Empty: The toolbar predefined in the system is applied.		 Empty

Automatic data supply

WinGuard provides a number of application-specific Extension Settings, to override the scheme that is used for the generation of the code, name and description of the new application object (e.g., a Datapoint) during the Automatic Data Supply. In the Extension’s Module XML file it is possible to override the default value for these Settings. These settings are only available to extensions that have the “AP” Trait. The value of these application-specific Settings can contain specific placeholders.

Setting Type Description Default
App.ObjectCode.Default string Default scheme for the application object’s code if the scheme is not explicitly defined for the respective object type. ${extension.code}.${objecttype.code}.${address}
App.ObjectCode.<ObjectType> string Scheme for the code that is used for newly generated objects of type <ObjectType>.
App.ObjectName.Default string Default scheme for the application object’s name if the scheme is not explicitly defined for the respective object type. ${objecttype.name} ${address}
App.ObjectName.<ObjectType> string Scheme for the name that is used for newly generated objects of type <ObjectType>.
App.ObjectDesc.Default string Default scheme for the application object’s description if the scheme is not explicitly defined for the respective object type.
App.ObjectDesc.<ObjectType> string Scheme for the description that is used for newly generated objects of type <ObjectType>.
App.QueryObjectsLocally bool This Setting is only relevant for Extensions that can also run locally on multiple stations (Trait “multistation”).

When objects are queried by WinGuard for the Automatic Data Supply, this Setting indicates whether the data should be requested remotely from the primary connection or from the local connection.

This Setting will only be displayed in the Settings dialog if it is defined in the Module XML.		 false

Other

In the Extension’s Module XML file it is possible to override the default value for these Settings. These settings are only available to extensions that have the “Adapter” Trait.

Setting Type Description Default
App.TooltipTemplate string Enter a WinGuard text file that defines the layout for tooltip display.
Empty: The system preset is applied.		 Empty
App.ExclusiveControl bool Manage control for this Extension exclusively on one station.
If this Setting is active, commands will be handled in such a way that control/responsibility from the executing station must first be accepted before the command can be executed.

This Setting will only be displayed in the Settings dialog if it is defined in the Module XML.		 false
App.AcceptCallsOnlyFromKnownParticipants ≥ext.adapter 0.1.2 bool If true, a Call Activity is only acceptable if the number of the caller (i.e. the num property of the Activity member with source role) matches a Person in the database.
The Extension must avoid creating unacceptable Activities using the HasPermission rights API function with the following parameters:
  • action: “start”
  • item: “extactivity”
  • object: The Activity object with all relevant properties.

If the Extension creates an Activity that is considered unacceptable by the application, the behaviour of the application is undefined.

This Setting will only be displayed in the Settings dialog if it is defined in the Module XML.

 false

Function support

In addition to the App Settings that allow further configuration of a particular function, there are App Settings that determine if a corresponding function is supported by the Extension at all. They are not available in the respective Settings dialog of the Extension, but can only be defined in the Extension’s Module XML.

Video

Setting Type Description Default
App.CanExportImages bool Specifies whether the Extension can export individual camera images. false
App.CanExportVideos bool Specifies whether the Extension can export clips. false
App.CanExportVideosDirect bool Specifies whether the Extension can export to the default directory without consultation. false
App.ExportImageExtensions string[] File extensions the Extension supports when exporting images.
This value is decisive for the list of chooseable file extensions and determines, how the extension filter of the file dialog is constructed. If empty, then saving an image is not supported. Any “Option” sub elements are not evaluated.
App.ExportVideoExtensions string[] File extensions the Extension supports when exporting clips.
This value is decisive for the list of chooseable file extensions and determines, how the extension filter of the file dialog is constructed. If empty, then saving a video is not supported. Any “Option” sub elements are not evaluated.

Extension filter of the file dialog

Each file extension <ext> is translated by using a language entry “[sys.filter.<ext>]”. For common file extension like “jpg”, “png” or “mp4”, there are predefined language entries. For other file extensions, it is required to add matching language entries to the Extension’s language files.

  • If the language entry is correctly set, the file dialog’s extension filter will display the file extension as a separate line.
  • Without a matching language entry, the file extension does not show up in the dialog’s filter.

Example 1: Already known file formats

  • For the file format “png” there exists a language entry “[sys.filter.png]” with the translation value “PNG - Portable Network Graphic (*.png)|*.png|”.
  • If App.ExportImageExtensions contain a value “png”, then the translated value above will be added to the filter string for the file dialog.
  • As a result, “PNG - Portable Network Graphic (*.png)” is shown in the file dialog’s extension filter as a separate line.

Example 2: New file formats

  • In order to add a new file format “new_file”, a language entry “[sys.filter.new_file]” must be added to the language files of the extension adapter.
  • For the translation, the value could be set to for example “NEW_FILE Files (*.new file)|*.new file|”.
  • As a result, “NEW_FILE File (*.new file)” is shown in the file dialog’s extension filter as a separate line.
Last modified September 25, 2026