IQMS.GetLicense Method

IQMSGetLicense Method

Retrieves the currently set license for a service.

Namespace: PIX.Services.V12
Assembly:

Syntax

License GetLicense(
	LicenseType licenseType,
	Guid serviceID
)

Function GetLicense ( 
	licenseType As LicenseType,
	serviceID As Guid
) As License

Parameters

licenseType: Type: PIX.QMSAPI.DataObjects.EnumsLicenseType
The type of license to return.
serviceID: Type: SystemGuid
The ID if the service.

Return Value

Type: License
The license of the service. If there is no license for the service, null is returned.

Remarks

If the licenseType parameter is set to LicenseType.Publisher, the serviceID will be ignored and can be set to Guid.Empty.

Security Note
Requires membership of local groups QlikView Management API and QlikView Administrator.

Examples

The following code example uses the QMS API to retrieve the Publisher and QlikViewServer licenses and prints them to the console.

The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.

Copy

 using System;
 using System.Collections.Generic;
 using System.Linq;
 using QMSAPI;

class Program
{
     static void Main(string[] args)
     {
         try
         { 
             // create a QMS API client
             IQMS apiClient = new QMSClient();

             //retrieve a time limited service key
             ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();

             List<License> licenses = new List<License>();
             // get the publisher license
             License publisherLicense = apiClient.GetLicense(LicenseType.Publisher, Guid.Empty);
             if (publisherLicense != null)
               licenses.Add(publisherLicense);

             ServiceInfo qvsService = apiClient.GetServices(ServiceTypes.QlikViewServer).FirstOrDefault();
             if (qvsService != null)
             {
                 // get a QlikViewServer license
                 License qlikViewServerLicense = apiClient.GetLicense(LicenseType.QlikViewServer, qvsService.ID);
                 if (qlikViewServerLicense != null)
                     licenses.Add(qlikViewServerLicense);
             }

             //Write license information
             licenses.ForEach(currentLicense =>
             {
                 Console.WriteLine(currentLicense.LicenseType);
                 Console.WriteLine(currentLicense.Name);
                 Console.WriteLine(currentLicense.Corporation);
                 Console.WriteLine(currentLicense.Serial);
             });
         }
         catch (Exception ex)
         {
             Console.WriteLine("An exception occurred: " + ex.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}

Reference

IQMS Interface

PIX.Services.V12 Namespace

PIX.QMSAPI.DataObjects.EnumsLicenseType