Skill: Adapter

Methods that should be provided by a device adapter module

Functions

Result	Name / Params			Comment
StaticExtObject[]	object.Query			Returns the Objects available in the third-party system. Should return all existing child Objects of the specified parent. The strategy of determining these depends on the third-party system (e.g., query via active connection to the system, importing a config file, etc). The function is called from the data supply dialog.
		url	string	(Value: AopUrl) The URL of the parent Object to query. Can be the URL of the whole Extension (e.g., 'ext[CODE]:') or of the Object whose children are requested. In the latter case, the parent Object should also be part of the result.
		params	value{}	(Key: SymbolPath) User-defined parameters for the query. These are declared in the Module XML and shown in the data supply dialog.
StaticExtObject[]	object.Browse			Returns the structure of the next lower level in the hierarchy. This function may return real Objects (similar to object.Query) or virtual structural Objects that do not have to correspond to a declared Object type (URL/type) in the Module XML. In the latter case, a 'Name' Property can be set to provide a display name. The URLs of returned Objects may be passed to object.Query in subsequent calls. This function only needs to be implemented when an Extension has discoverable Nodes or a Node is browsable.
		url	string	(Value: AopUrl) The URL of the parent Object to browse. Can be the URL of the whole Extension (e.g., 'ext[CODE]:') or of the Object whose immediate children are requested. In the latter case, the parent Object should also be part of the result. The first case is only called for the extension URL of discoverable adapters as part of Automatic Data Supply (requires adapter skill version 0.1.2).
		params	value{}	(Key: SymbolPath) User-defined parameters for the query. These are declared in the Module XML and shown in the data supply dialog.
ExtActivityResult	activity.Start			Starts a new Activity.
		url	string	(Value: AopUrl) URL of the new Activity.
		type	string	(Value: SymbolPath) Type of the Activity to start.
		members	ExtActivityMember[]	List of members which are part of the Activity.
		props	value{}	(Key: Symbol) Properties required to create the Activity.
ExtActivityResult	activity.End			Ends an Activity.
ExtActivityResult		url	string	(Value: AopUrl) URL of the Activity to end.
ExtIncidentResult	incident.Create			Requests creation of a new Incident.
		props	value{}	(Key: Symbol) Properties required to create the Incident. These are the Properties of the Incident Create Request declared in the Module XML.
		events	IncidentEventRef[]	Information about the Event(s) for which this Incident is being created.
OperationResult	operation.Execute			Executes the given Operation. The return value is either a result, an error, or a token to signal a long-running Operation.
OperationResult		operation	Operation	Operation to execute.
void	operation.Cancel			Cancels a long-running Operation.
void		token	int	Token from the OperationResult of the object.Execute call.
ResourceResult	resource.Get			Gets a resource from the Extension.
		url	string	(Value: AopUrl) The resource URL.
		props	value{}	(Key: Symbol) Additional Properties required to get the resource.
bool	Exit			Requests a graceful shutdown of the Extension. Returns true if the Extension handled the request successfully.

Notifications

Name / Params			Comment
operation.Progress			Progress message for one or more long-running Operations.
	progress	OperationProgress[]	List of progress reports.
operation.Result			Result message for one or more long-running Operations.
	result	OperationResult[]	List of result reports.

Objects

Operation

Property	Type	Description
Url	string	(Value: AopUrl) URL of the Operation target, which can be an Object, Event (URL may include Event key if applicable), Activity or Incident.
Type	string	(Value: SymbolPath) Type of Operation to execute.
Props	value{}	(Key: Symbol, Optional) Parameters for the specific Operation.
Resources	Resource{}	(Key: Symbol, Optional) List of resources. Key is the resource Id.

OperationProgress

Property	Type	Description
Token	int	Identifies a long-running Operation for the Extension uniquely.
Percentage	int	Completion percentage (range: 0 to 100).
Props	value{}	(Key: Symbol, Optional) Additional information/data with regard to the progress.

OperationResult

Property	Type	Description
Token	int	(Optional) Identifies a long-running Operation uniquely. This is only set if the Operation is long-running. If set, Error and Props must not be set.
Error	string	(Optional) Contains a string error Id to indicate a failure. In this case, Props can contain further information with regard to the error.
Props	value{}	(Key: Symbol, Optional) The result of the Operation, or details with regard to the error if the Operation failed.

Is used both for operation.Execute as well as in the notification operation.Result. In the first case, only either token + props or error + props is set; in the notification, the token is always required.

Last modified September 25, 2026