GQIDMS class

Definition

• Namespace: Skyline.DataMiner.Analytics.GenericInterface
• Assembly: SLAnalyticsTypes.dll

Represents the DataMiner System (DMS). Can be used to request information from the system or subscribe on events. Communication happens through DMSMessage objects.

Available from DataMiner 10.3.4/10.4.0 onwards.

Note

The GQIDMS class itself cannot be used for constructor injection. From DataMiner 10.5.0 [CU18]/10.6.0 [CU6]/10.6.9 onwards, when using the Skyline.DataMiner.Core.GQI.Extensions API and the GQI DxM, use IGQIDMSInterface to inject DMS access via the constructor. In earlier versions, use the DMS property of OnInitInputArgs.

Tip

See also:

• Retrieving data from DataMiner
• Building a GQI data source that retrieves data from a DMS

Methods

The GQIDMS class contains the methods listed below. These can be used to request information in the form of DMSMessage objects.

Important

DMS messages are subject to change without notice. If you can implement an alternative using the built-in data sources, we highly recommend that you do so instead.

IConnection GetConnection()

Available from DataMiner 10.4.6/10.5.0 onwards.

Provides a connection interface from GQI to SLNet. This connection can be used to request data from the DMS or to subscribe on events.

Returns

An IConnection object representing the connection between GQI and SLNet.

Tip

Because of its complexity, instead of interacting directly with the IConnection interface, the best way you can use it is by integrating with existing DataMiner libraries.

Note

• The real underlying connection may be shared by other extensions and queries but can be used as if it were a dedicated connection.
• From DataMiner 10.5.0 [CU18]/10.6.0 [CU6]/10.6.9 onwards, when the GQI DxM is used, GetConnection() can be called again to receive a fresh connection if the underlying SLNet connection was dropped.

Important

GQIDMS can only be used during the lifetime of the associated extension instance. Do not store or reuse it outside that lifetime.

DMSMessage SendMessage(DMSMessage message)

Sends one request to retrieve one response from the DMS.

This is a shortcut for SendMessages.

Parameters

• DMSMessage message: The request message for the DMS.

Returns

A single response from the DMS or null. If the DMS replied with more than 1 response, the first one will be returned.

DMSMessage[] SendMessages(params DMSMessage[] message)

Sends one or more messages to retrieve multiple responses from the DMS.

Parameters

• DMSMessage[] messages: The request messages for the DMS.

Returns

A DMSMessage array of all responses from the DMS.