SelectServerEx Method
Overloads
SelectServerEx(Guid, String) |
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) and return fully qualified host name. |
SelectServerEx(Guid, String)
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) and return fully qualified host name.
Declaration
Uri SelectServerEx(Guid qvwsID, string document)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | qvwsID |
The ID of the QVWS |
System.String | document |
The name of the document |
Returns
Type | Description |
---|---|
System.Uri |
Full URI address of the most suitable QVS. |
Remarks
security
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.
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.SelectServerEx(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();
}
}
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!