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.

Tip

See also: Example of retrieving data by means of DMS messages

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.

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.

Retrieving data by means of DMS messages

From DataMiner 10.3.4/10.4.0 onwards, ad hoc data sources can retrieve data by means of DMS messages.

To do so, the IGQIDataSource interface must implement the IGQIOnInit interface, of which the OnInit method can also be used to initialize a data source:

OnInitOutputArgs OnInit(OnInitInputArgs args)

When passed to the OnInit method, OnInitInputArgs will contain the following new property:

GQIDMS DMS

Generally, an ad hoc data source implementation will want to add a private field where it can store the GQIDMS object to be used later in other callbacks when columns and rows are created.

Example of retrieving data by means of DMS messages

Below you can find an example script that uses the GQIDMS object provided in the OnInitPutArgs to create a data source of active client connections. The name of the data source, as defined in the GQIMetaData attribute, will be "Client connections".

Two interfaces are implemented: IGQIDataSource and IGQIOnInit. The GetNextPage method retrieves client connections using a GetInfoMessage request and returns a GQIPage containing the data.

using System;
using System.Collections.Generic;
using System.Linq;
using Skyline.DataMiner.Analytics.GenericInterface;
using Skyline.DataMiner.Net.Messages;

[GQIMetaData(Name = "Client connections")]
public class ClientConnectionSource : IGQIDataSource, IGQIOnInit
{
    private GQIDMS _dms;

    public OnInitOutputArgs OnInit(OnInitInputArgs args)
    {
        _dms = args.DMS;
        return default;
    }

    public GQIColumn[] GetColumns()
    {
        // Return desired columns
        // Omitted for brevity
    }

    public GQIPage GetNextPage(GetNextPageInputArgs args)
    {
        var connections = GetConnections();
        var rows = connections.Select(CreateRow).ToArray();
        return new GQIPage(rows);
    }

    private IEnumerable<LoginInfoResponseMessage> GetConnections()
    {
        // Retrieve client connections from the DMS using a GetInfoMessage request
        var request = new GetInfoMessage(InfoType.ClientList);
        var responses = _dms.SendMessages(request);
        return responses.OfType<LoginInfoResponseMessage>();
    }

    private GQIRow CreateRow(LoginInfoResponseMessage connection)
    {
        // Return a GQIRow representing the client connection
        // Omitted for brevity
    }
}