Skip to main content Skip to complementary content

GetQVSSettings Method

Overloads

GetQVSSettings(Guid, QVSSettingsScope)

Gets settings for the QlikView Server with the specified ID.

GetQVSSettings(Guid, QVSSettingsScope)

Gets settings for the QlikView Server with the specified ID.

Declaration

      QVSSettings GetQVSSettings(Guid qvsID, QVSSettingsScope scope)
    

Parameters

Type Name Description
System.Guid qvsID

The QlikView Server ID.

QVSSettingsScope scope

The scope of settings to retrieve.

Returns

Type Description
QVSSettings

The QlikView Server settings for the specified scope.

Remarks

The scope parameter indicates which parts of the returned object that will be populated with data.

All settings except General and Distribution requires that the QlikView Management Service is able to communicate with the QlikView Server.

security

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

Examples

The following code example uses the QMS API to retrieve a registered QlikView Server and its logging settings. It changes the log folder and then saves the logging settings. If everything goes well, it prints the original logging folder and then a message when it's done. 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 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 QVS services
            List<ServiceInfo> qvsServices = apiClient.GetServices(ServiceTypes.QlikViewServer);
            if (qvsServices.Count > 0)
            {
                // retrieve logging settings for the first QVS in the list
                QVSSettings qvsSettings = apiClient.GetQVSSettings(qvsServices[0].ID, QVSSettingsScope.Logging);
                Console.WriteLine("QVS log folder before change: " + qvsSettings.Logging.Folder);
                // change log folder
                qvsSettings.Logging.Folder = @"\\myshare\logs";
                // save settings
                apiClient.SaveQVSSettings(qvsSettings);
                Console.WriteLine("Settings saved. Log folder changed.");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadKey();
    }
}
  

See Also

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!

Join the Analytics Modernization Program

Remove banner from view

Modernize without compromising your valuable QlikView apps with the Analytics Modernization Program. Click here for more information or reach out: ampquestions@qlik.com