Skip to main content Skip to complementary content

GetSourceDocuments Method

Overloads

GetSourceDocuments(Guid)

Gets all source documents for the QlikView Distribution Service with the specified ID.

GetSourceDocuments(Guid)

Gets all source documents for the QlikView Distribution Service with the specified ID.

Declaration

      List<DocumentNode> GetSourceDocuments(Guid qdsID)
    

Parameters

Type Name Description
System.Guid qdsID

The ID of the QlikView Distribution Service for which to retrieve source documents.

Returns

Type Description
System.Collections.Generic.List<DocumentNode>

All source documents for the QlikView Distribution Service with the specified ID.

Remarks

Only source documents that belongs to source document folders that the caller have access to will be returned.

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 a registered QlikView Distribution Service and all its source documents. The names and paths of the source documents are then printed. 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.IO;
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 QDS services
            List<ServiceInfo> qdsServices = apiClient.GetServices(ServiceTypes.QlikViewDistributionService);
            if (qdsServices.Count > 0)
            {
                // retrieve all source documents for the first QDS in the list
                List<DocumentNode> sourceDocuments = apiClient.GetSourceDocuments(qdsServices[0].ID);
                // print the names of all source documents
                Console.WriteLine("The " + qdsServices[0].Name + " contains the following source documents:" + Environment.NewLine);
                foreach (DocumentNode sourceDocument in sourceDocuments.OrderBy(x => x.RelativePath).ThenBy(x => x.Name))
                {
                    Console.WriteLine(Path.Combine(sourceDocument.RelativePath, sourceDocument.Name));
                }
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadKey();
    }
}
  

See Also

GetSourceDocumentNodes(System.Guid, System.Guid, System.String)
GetUserDocuments(System.Guid)

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