Table of Contents

Configuring an ad hoc data source in a query

When you create a query, you can also use an ad hoc data source (i.e. external data source).

To use an ad hoc data source in a query:

  1. In the Automation app, add a script containing a new class that implements the IGQIDataSource interface.

    Note

    All object types needed to create an ad hoc data source can be found within SLAnalyticsTypes.dll, which is located in the folder C:\Skyline DataMiner\Files.

  2. Above the class, add the GQIMetaData attribute in order to configure the name of the data source as displayed in the Dashboards app.

    For example (see Example ad hoc data script for a full example):

    using Skyline.DataMiner.Analytics.GenericInterface;

[GQIMetaData(Name = "People")]
public class MyDataSource : IGQIDataSource
{
...
}
    Note

    This is the name that will be shown to the user when they select the data in the Dashboards app. If you do not configure this name, the name of the class is displayed instead, which may not be very user-friendly.

  3. Compile the script as a library (see Compiling a C# code block as a library). You can use the same name as defined in the GQIMetaData attribute, or a different name. If there are different data sources for which the same name is defined in the GQIMetaData attribute, the library name is appended to the metadata name.

  4. Validate and save the script. It is important that you do this after you have compiled the script as a library, as otherwise the compiler will detect errors.

  5. In the Dashboards app, configure a query and select the data source Get ad hoc data or Get custom data, depending on your DataMiner version.

  6. In the Data source dropdown box, select the name of your ad hoc data source.

Depending on how the script is configured, there can be additional configuration possibilities. You can for instance use the IGQIInputArguments interface in the script to define that a specific argument is required, for instance to filter the displayed data. For more information, refer to the sections below.

Note

From DataMiner 10.2.5/10.3.0 onwards, you can link the arguments of an ad hoc data source to an existing feed in the Dashboards app. Depending on the linked feed, more information may need to be specified. For example, if you link to an existing query feed with a table listing elements, in the Type box, you will then need to select whether you want to use a specific data type (e.g. elements) or query rows. Then you will need to select the property you want to use. In most cases, you can select the property in a dropdown list, except if Type is set to Query rows or Script output, in which case you will have to specify the value yourself. For query rows, when you start typing the value, DataMiner will propose any matching values it can find.

Tip

See also: Best practices for developing GQI extensions.

Propose changes