Skip to main content Skip to complementary content

GetQVSDocumentsAndUsers Method

Overloads

GetQVSDocumentsAndUsers(Guid, QueryTarget)

Gets each document loaded on the QVS and the users connected to each on respectively.

GetQVSDocumentsAndUsers(Guid, QueryTarget)

Gets each document loaded on the QVS and the users connected to each on respectively.

Declaration

      Dictionary<string, List<string>> GetQVSDocumentsAndUsers(Guid qvsID, QueryTarget target)
    

Parameters

Type Name Description
System.Guid qvsID

The QVS ID.

QueryTarget target

The target of the query.

Returns

Type Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

If successful, the documents and connected users are returned.

Remarks

security

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

Examples

The following code example retrieves documents and connected users from a specific qvs and prints it to standard output.

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

            Guid qvsId = new Guid("c7c66836-f00b-47c4-8099-23ff7f178423"); // The originating QVS ID.
            Dictionary<string, List<string>> docsAndUsers = apiClient.GetQVSDocumentsAndUsers(qvsId, QueryTarget.Resource);
            foreach(string doc in docsAndUsers.Keys)
            {
                Console.Write("Document: " + doc + ", User(s):");
                foreach(string user in docsAndUsers[doc])
                {
                    Console.Write(" " + user);
                }
                Console.Write("\n");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.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!

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