IQMS.SelectServer Method

Selects the QlikView Server (QVS) currently most suitable for opening the specified document according to the load balancing settings of the given QlikView WebServer (QVWS).

Namespace: PIX.Services.V12
Assembly:

Syntax

Copy

Uri SelectServer(
	Guid qvwsID,
	string document
)

Function SelectServer ( 
	qvwsID As Guid,
	document As String
) As Uri

Parameters

qvwsID: Type: SystemGuid
The ID of the QVWS
document: Type: SystemString
The name of the document

Return Value

Type: Uri
URI address of the most suitable QVS.

Remarks

Security Note
Requires membership of local group QlikView Management API.

Examples

This example uses the QMS API to pick the most suitable QVS for opening the specified document.If everytig goes well, it prints the URI address of the selected QVS. If anything goes wrong it prints an error message.

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();

            //get a list of all QVWSs
            ServiceInfo[] webServers = apiClient.GetServices(ServiceTypes.QlikViewWebServer);

            //select the QVS based on the load balancing settings of the first QVWS in the list for the document named "MyDocument"
            Uri uri = apiClient.SelectServer(webServers[0].ID, "MyDocument");
            Console.WriteLine("The URI address of the QVS: " + uri);

         }
         catch(Exception e)
         {
             Console.WriteLine("An error occured: " + e.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}

Reference

IQMS Interface

PIX.Services.V12 Namespace