Skip to main content Skip to complementary content

GetDSCAPISettings Method

Overloads

GetDSCAPISettings(Guid)

Gets Directory Service Connector (DSC) settings.

GetDSCAPISettings(Guid)

Gets Directory Service Connector (DSC) settings.

Declaration

      DirectoryServiceConnectorAPISettings GetDSCAPISettings(Guid dscID)
    

Parameters

Type Name Description
System.Guid dscID

The ID of the DSC

Returns

Type Description
DirectoryServiceConnectorAPISettings

The current DSC settings.

Remarks

security

Requires membership of local group QlikView Management API and the role Document Folder Administrator.

Examples

The following code example uses the QMS API to retrieve DSC settings. It changes its name and then saves it. If everything goes well, it prints the original name 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 System.Linq;
using QMSAPI;

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

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

           //get a list of all DSCs
           ServiceInfo[] dsConnectors = apiClient.GetServices(ServiceTypes.QlikViewDirectoryServiceConnector);

           //get DSC settings for the first DSC in the list
           DirectoryServiceConnectorAPISettings settings = apiClient.GetDSCAPISettings(dsConnectors[0].ID);
           if (settings != null)
           {
                //retrieve and print the current name
                Console.WriteLine("DSC name before change: " + settings.Name);
                //change the name
                settings.Name = "NewName";
                //save settings
                apiClient.SetDSCAPISettings(settings);
                Console.WriteLine("Settings saved. DSC name changed.");
           }
        }
        catch(Exception e)
        {
            Console.WriteLine("An error occured: " + e.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

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