topic Re: QMS API GetUserDocuments - relative path missing in QlikView

QMS API GetUserDocuments - relative path missing

cbushey1 — Mon, 26 Jan 2026 18:19:17 GMT

Hi there,

New to using the QMS API so bare with me.

We are already using the GeUserDocuments function to return a list of documents, however we recently instituted publisher and added mounted folders. Since doing this, the relative path value is missing for our documents. Is there a way to correct this or possibly another way to identify the path of the file (we use the path for a list of documents in our own custom site)?

I used the powertools utility and am attaching what it returns (for a single application).

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Thu, 03 Oct 2019 21:09:08 GMT

Hi @cbushey1

Do you have a basic sample of your code, just the connection to the API and the GeUserDocuments call?

Could you also provide a sample of the expected result vs the current result?

Kind regards.

Re: QMS API GetUserDocuments - relative path missing

cbushey1 — Mon, 07 Oct 2019 13:51:00 GMT

@NadiaB - I don't think you really need that to recreate my scenario.

All I did was point the powertools utility at my QMC server and called the GetUserDocuments function. This returned a list of documents on my server, however the path to where those documents are stored was omitted from the relative path field. Regardless of my code, the powertools showed the same result.

In situations where the document has the same name, "SomeApplication.qvw" I need to be able to identify what unique path exists for each document and the relative path provided that.

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Mon, 07 Oct 2019 17:21:55 GMT

Hi @cbushey1

Could you please confirm this was working before?

If so could you provide the following information?

*In what QlikView version

*what is the folder structure where is expected to get a relative path. ( a basic sample can be provided)

Unfortunately we do not support the PowerTools but if this was working before in your code and stopped working , if I can reproduce we can file a product defect investigation.

Kind regards.

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Mon, 07 Oct 2019 17:47:07 GMT

Hi @cbushey1

I did a quick test in 12.4 and the API is returning a relative path:

I'm not applying any filters to the DocumentNode List.

I used the following documenation to verify when is expected the relative path, I didn't find the details in the documentation for 12.4 but it should be the same:

https://help.qlik.com/en-US/qlikview-developer/12.1/apis/QMS+API/html/M_PIX_Services_V12_Api2_IQMS2_GetUserDocumentNodes.htm

Kind regards.

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Tue, 08 Oct 2019 12:47:54 GMT

Hi @cbushey1

I just tested the PowerTools, the RelativePath it's also available there:

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Thu, 10 Oct 2019 14:46:07 GMT

Hi @cbushey1

Did the provided information resolve your questions, if so, could you mark the post as "Accepted Solution"

Thank you.

Re: QMS API GetUserDocuments - relative path missing

cbushey1 — Thu, 10 Oct 2019 17:26:42 GMT

Sorry for the delay.

From what I can tell, you followed the same steps I am however you have a value in the relative path where I do not. The only thing I can think of that is different is I have mounted folders where the applications live. Can you try that and see if you can replicate?

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Thu, 10 Oct 2019 18:18:07 GMT

Hi @cbushey1

Did you have the chance to look at the documentation ?

https://help.qlik.com/en-US/qlikview-developer/12.1/apis/QMS+API/html/M_PIX_Services_V12_Api2_IQMS2_GetUserDocumentNodes.htm?_ga=2.169695265.1810885715.1570453346-725826489.1568062201

The relative path is shown when there are subfolders in the User Documents folder:

User Documents\

User Documents\Sales

User Documents\Finance

So for the posted question, the QMS API is working as designed.

If you have a code where you are getting different results depending on the QlikView version you were using before, it will be necessary to open a case request and provide the code and the scenario so we can replicate.

Kind regards.

Re: QMS API GetUserDocuments - relative path missing

cbushey1 — Thu, 10 Oct 2019 19:01:37 GMT

I looked at the document however I am not an expert in web development. I didnt write the code we have but happy to get someone to review. I already have a case open and unfortunately was told they were nothing they could do without involving consulting services (not a great support answer). If you would like to look at my case it's 01714385.

I asked my web guy to send me the code we use, that still works in other environments that are also on 12.40, and I am pasting it below.

public static List<DocumentNode> GetExistingQVDFileNames() { var nodes = new List<DocumentNode>(); var backendClient = new QMSClient(); ServiceKeyClientMessageInspector.ServiceKey = backendClient.GetTimeLimitedServiceKey(); var serviceList = backendClient.GetServices(ServiceTypes.QlikViewServer); foreach (var server in serviceList) { var userDocs = backendClient.GetUserDocuments(server.ID); var includedDocs = userDocs.Where(docNode => !String.IsNullOrEmpty(docNode.RelativePath) ) .Where(x => x.IsSubFolder == false && x.IsOrphan == false && !(x.RelativePath.Substring(1,1) == ":") ); // ...and does not begin with a drive letter nodes.AddRange(includedDocs); } return nodes.OrderBy(n => n.Name).ToList<DocumentNode>(); }

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Thu, 10 Oct 2019 21:27:44 GMT

Hi @cbushey1

There are two things to consider here:

1. If you have a code that was working before and is not working anymore, it is necessary to provide the scenario, for example you will need to have the same User Document structure in both environments and verify in one is working and the other is not. For this test I just created a subfolder in the User Documents folder (my access point folder) and ran the code. You can try that too and verify. The documentation that was provided doesn't mention the specific method call you are using, but it does describes when the relative path should be available, so it was provided as a reference only.

2. If the enviroment configurations are different, and because of that the result is different, then unfortunately is result of the configurations and not because the API is not working properly, any code like the one that was provided to implement the API is considered out of support unless there is evidence that it was working before and stopped working, and the scenario hasn't changed. What caught my attention is that is was mentioned that the same code works on a different environment that also has 12.40, so it is more possible that a configuration is the problem and not the API.

Let us know if there are any questions.

Re: QMS API GetUserDocuments - relative path missing

cbushey1 — Fri, 11 Oct 2019 19:15:39 GMT

The 2 environments are not the same. I didnt bring it up here because it just confuses the problem.

The code we are using worked before

1. the introduction of a publisher server (standalone)

2. We changed the user documents location (due to the publisher server being introduced).

What I am not understanding is why we are seeing null for the relative path when we use either our code or the power tools utility when documents do exist. Shouldn't there always be a path defined for the files? I should add that the code does find the files, just not the path.

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Sat, 12 Oct 2019 13:37:16 GMT

Hi @cbushey1

That is not what the documentation stands about the relativePath, but if you can show us a different behavior and how your code is showing the relativepath for the other working environments we can look at it.

Kind Regards.

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Tue, 15 Oct 2019 21:01:06 GMT

Hi @cbushey1

Could you provide a screenshot of how the value comes from your other environments?

Kind regards.

Re: QMS API GetUserDocuments - relative path missing

cbushey1 — Wed, 16 Oct 2019 18:12:31 GMT

@NadiaB

If I understand the documentation (and what you wrote) the relative path field will only be filled in when there exists QVWs within subfolders of the root directory specified for the user documents.

If this is the case, then the relative path should be filled in since my QVWs exist in subfolders of the root directory, however it is blank.

I am attaching two screenshots, 1 were it works and 1 where it doesn't. The only difference between these two environments is that where it doesn't work we have a stand alone publisher server. What you should notice though, is that the configuration is the same between them, with each having a root directory and subfolders, with QVWs in the subfolders.

Re: QMS API GetUserDocuments - relative path missing

cbushey1 — Mon, 21 Oct 2019 19:56:10 GMT

@Nadia Did you get a chance to see my reply from last week?

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Mon, 21 Oct 2019 21:27:29 GMT

Hi @cbushey1

Let me replicate.

Kind Regards.

Re: QMS API GetUserDocuments - relative path missing

cwolf — Tue, 22 Oct 2019 13:47:02 GMT

Each document node has a "FolderID" that points to a path (root or mounted). The full path to a document is given by :

Path represented by FolderID + '\' + RelativePath + '\' + Name

If a document is located directly in the root folder or in a mounted folder, the relative path is empty.

Re: QMS API GetUserDocuments - relative path missing

NadiaB — Wed, 23 Oct 2019 20:59:43 GMT

Hi @cbushey1

I did a quick test using the PowerTools first before checking with .net. I'm selecting "Service Version" 11.00 IR that is the latest that the Power Tools has, I'm not sure if there a newer version, configuring paths as you mentioned and the outcome is not the one is shown in the picture.

What I found is that the API call will retrieve the structure under User Documents (tree structure that appears in the QMC, QMC\Documents|User Documents). If you see a tree folder structure there that is what the API is returning.

I'm using the PowerTools available in community but in my previous versions with .net I got the same results in both API versions.

There are different things to consider, one that I'm sure was done is that the Service reference in your .net project has to be updated, the second is to verify what version is being used:

IQMS: QlikView 11.20 and 12.00
IQMS2: QlikView 12.10
IQMS3: QlikView 12.30 (November 2018)
IQMS4: QlikView 12.40 (April 2019)

https://help.qlik.com/en-US/qlikview-developer/April2019/APIs/QMS+API/html/7b30b3a1-77da-4bbe-bdc2-1320dfa4f726.htm

From the Powertools you might not be able to make changes but in your .net protect you could verify the service reference and the version being used.

Kind Regards.