Skill: ext.common

Common extension objects and callbacks

The EXT service is intended for use by Extension only. It is tailored for use by a specific Extension and filter their output accordingly.

The Extension does not have to add their Id as a parameter but is determined automatically from the Id of the calling client.

In contrast to data service functions, EXT service functions do not require any access rights that have to be set in WinGuard, i.e., they are always available and access to them cannot be restricted.

Functions

Result	Name / Params			Comment
value{}	ext.setting.Query			Returns all Settings for the local coupling point of the requesting Extension. Result: The key is SymbolPath.
void	ext.log.Add			Adds a new entry to the extension log. Only information concerning the functionality of the Extension should be logged here. Entries regarding communication with the third-party system belong in the IO log. Changes to States/Events/Activities are automatically logged to the extension log by the host.
		text	string	The message to be logged. This can be an LNG string.
		props	value{}	(Optional, Key: Symbol) Additional properties. These are used to translate the log text if it is an LNG string.
		time	time	(Optional) Time that the log entry should have. If not set, the current time will be used.
		iotag	string	(Optional) Tag for association to IO log entries or Events.
		url	string	(Optional, Value: AopUrl) URL of the Object the log entry is related to.
		type	int	(Optional) Type of log entry. See ExtLogEntryType.
data	ext.GetFile			Reads the file with the given name from the Extension's data folder and returns its content as binary data. If a custom folder is set for the Extension and the file doesn't exist there or if no custom folder is set, it looks for the file in the Modules data folder (e.g. 'data/mod/demopanel'). Returns an empty byte buffer if the file doesn't exist or is empty.
data		fileName	string	Name of the requested file. Can be a path relative to the Extension's data folder or custom folder (if set). Example: 'test.txt' or 'mypath\test.txt'
bool	ext.PutFile			Writes the given data to a file in the Extension's data folder (e.g. 'data/mod/demopanel') or custom folder (if set). If the file doesn't exist, it is created. If the file exists, its content is replaced by the given data. If the path contains non-existing folders (e.g. 'mypath\newfolder\test.txt'), the missing folders are created automatically. It is not possible to overwrite the Module's LNG files or any of its Module/App/Legacy/Config XML files. Returns true if the file was written successfully, otherwise false.
		path	string	Name of the file to be written to. Can be a relative path to the Extension's data folder or custom folder (if set). Example: 'test.txt' or 'mypath\test.txt'
		data	data	The complete file content.

Notifications

Name / Params			Comment
ext.setting.Updated			Settings of the Extension have been changed at the host.
	ext	string	(Value: Code) Code of the Extension.
	setting	value{}	(Key: SymbolPath) List of changed Settings.

Enums

ExtLogEntryType

Name	Value	Description
Unspecified	0	The type is not specified (default), e.g., for debug information.
Info	1	The entry is purely informational (neutral).
Warning	2	An unusual condition is detected in the Extension.
Error	3	An error is detected in the Extension, e.g., a loss of connection.
Success	4	An action is successful.
Fail	5	An action fails, e.g., a call to an API method.
Send	6	The entry relates to data sent by the Extension.
Receive	7	The entry relates to data received by the Extension.

Last modified September 25, 2026