Skip to main content Skip to complementary content

SaveQDSSettings Method

Overloads

SaveQDSSettings(QDSSettings)

Updates the settings for a certain QlikView Distribution service.

SaveQDSSettings(QDSSettings)

Updates the settings for a certain QlikView Distribution service.

Declaration

      string SaveQDSSettings(QDSSettings qdsSettings)
    

Parameters

Type Name Description
QDSSettings qdsSettings

The settings to apply.

Returns

Type Description
System.String

If everything went well, an empty string is returned. If there were some issues, a description of those is returned.

Remarks

security

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

Examples

The following example retrieves the settings for all registered QlikView Distribution Services. It updates the settings and sends it

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 QlikView Distribution Services.
           List<ServiceInfo> qdsServices = apiClient.GetServices(ServiceTypes.QlikViewDistributionService);

           //Loop through the list
           foreach(ServiceInfo info in qdsServices)
           {
               Console.WriteLine("Updating QDS at " + info.Name);

               //Get the General settings for a QlikView Distribition Service.
               QDSSettings settings = apiClient.GetQDSSettings(info.ID, QDSSettingsScope.General);

               if(settings != null)
               {
                   //Set the LogLevel and set the updated settings.
                   settings.General.LogLevel = LogLevel.Normal;
                   string result = apiClient.SaveQDSSettings(settings);

                   if (string.IsNullOrWhiteSpace(result))
                       Console.WriteLine("Update OK.");
                   else
                       Console.WriteLine("Issues while updating: " + result);
               } else
               {
                   Console.WriteLine("Failed to retrieve the settings.");
               }
           }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

Exceptions

Type Condition
System.Exception

If an error occurs, an exception will be thrown.

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