topic Re: Check the Session Collaboration button through soap request in QlikView

Check the Session Collaboration button through soap request

bl-jeremy — Sat, 16 Nov 2024 19:57:08 GMT

Hi all !

I'm trying to have the 'Session Collaboration' checkbox active through a soap request.

I've generated java code from the wsdl, and now I'm searching how to check this case.

I've already tried the following without success:

QMSClient.DocumentTask().getServer().getAccess().setEnableSessionCollaboration(true)

Does someone have a solution?

Thanks in advance

Re: Check the Session Collaboration button through soap request

Damien_V — Mon, 14 Oct 2019 09:55:23 GMT

Hello,

You would need to use the QMS API endpoint "SaveQVSSettings"

Please see:

https://support.qlik.com/articles/000085901

https://help.qlik.com/en-US/qlikview-developer/April2019/APIs/QMS+API/html/M_PIX_Services_V12_Api2_IQMS2_SaveQVSSettings.htm

Re: Check the Session Collaboration button through soap request

bl-jeremy — Mon, 14 Oct 2019 10:53:43 GMT

I've already tried to 'AllowServerCollaboration' through SaveQVSSettings endpoint, no success

Re: Check the Session Collaboration button through soap request

Damien_V — Mon, 14 Oct 2019 12:16:32 GMT

It works perfectly fine in my test environment.

Could you post the code you are using to call the API ?

Re: Check the Session Collaboration button through soap request

bl-jeremy — Mon, 14 Oct 2019 12:42:01 GMT

On my call to setQVSSettings, I do the following:

...
var documents = new QMSBackendServiceStub.QVSSettingsQVSDocuments();
var server = new QMSBackendServiceStub.QVSSettingsQVSDocumentsQVSDocumentsServer();
server.setAllowSessionCollaboration(true);
documents.setServer(server);
qvsSettings.setDocuments(documents);

qmsClient.saveQVSSettings(qvsSettings);

And when creating my documentTask:

...
var server = new QMSBackendServiceStub.DocumentTaskTaskServer();
var access = new QMSBackendServiceStub.DocumentTaskTaskServerTaskServerAccess();
access.setEnableSessionCollaboration(true);
server.setAccess(access);
documentTask.setServer(server);

//Create task
qmsClient.saveDocumentTask(documentTask);

Re: Check the Session Collaboration button through soap request

Brett_Bleess — Mon, 14 Oct 2019 13:55:15 GMT

You are generating a service key at the beginning of things, may be a dumb question, but did not want to assume anything here.... It would likely help if you include all the code, not just the snippet.

https://help.qlik.com/en-US/qlikview-developer/April2019/APIs/QMS+API/html/2be1e405-a7e5-4a43-b1b6-9540b23a6226.htm

Regards,
Brett

Re: Check the Session Collaboration button through soap request

bl-jeremy — Tue, 15 Oct 2019 09:35:09 GMT

Here's the code you asked for (I narrowed it for obfuscation reasons)

import generated.qms.*; import org.apache.axis2.AxisFault; import org.apache.axis2.databinding.types.UnsignedInt; import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOUtils; import org.apache.logging.log4j.util.Strings; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageRequest; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Service; import java.io.File; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.rmi.RemoteException; import java.util.*; @Service public class Service { private final Logger logger = LoggerFactory.getLogger(Service.class); public Service() { } public void executeQlik() { createQlikTasks("PRODUCT_NAME", "PASSWORD"); } private void createQlikTasks(String productName, String pwd) throws Exception { setQVSSettings(productName); String taskDescription = "Creating a task " + productName + " via QMS API"; String documentNameTemplateLd = "%SourceDocumentName%"; createDocumentTasksForProduct(productName, taskDescription, documentNameTemplateLd, pwd); } private void setQVSSettings(String productName) throws Exception { QMSClient qmsClient = new QMSClient(); java.lang.String timeLimitedServiceKey = this.getTimeLimitedServiceKey(new QMSBackendServiceStub.GetTimeLimitedServiceKeyE()).getGetTimeLimitedServiceKeyResult(); List<NamedValue> namedValuePairs = new ArrayList<>(); namedValuePairs.add(new NamedValue("X-Service-Key", timeLimitedServiceKey)); qmsClient._serviceClient.getOptions().setProperty(HTTPConstants.HTTP_HEADERS, namedValuePairs); QMSBackendServiceStub.ServiceInfo[] serviceInfo = qmsClient.getServices(QMSBackendServiceStub.ServiceTypes_type0.QlikViewServer); QMSBackendServiceStub.QVSSettings qvsSettings = qmsClient.getQVSSettings(serviceInfo[0].getID(), QMSBackendServiceStub.QVSSettingsScope_type0.Folders); QMSBackendServiceStub.QVSMount[] qvsMounts = qvsSettings.getFolders().getUserDocumentMounts().getQVSMount(); var mountFolderPath = "MOUNTED_PATH"; QMSBackendServiceStub.QVSMount newQvsMount = new QMSClient.QVSMount(true, mountFolderPath, productName); qvsSettings.getFolders().getUserDocumentMounts().addQVSMount(newQvsMount); ezfz var documents = new QMSBackendServiceStub.QVSSettingsQVSDocuments(); var server = new QMSBackendServiceStub.QVSSettingsQVSDocumentsQVSDocumentsServer(); server.setAllowSessionCollaboration(true); documents.setServer(server); qvsSettings.setDocuments(documents); qmsClient.saveQVSSettings(qvsSettings); logger.debug("New mount folder {} created", mountFolderPath); } private void createDocumentTasksForProduct(String productName, String taskDescription, String documentNameTemplateLd, String password) throws Exception { String docName = productName + ".qvw"; String taskName = productName + ".qvw"; setDocumentTaskLoad(docName2, taskName, "", taskDescription, productName, "None", documentNameTemplateLd, password); } private void setDocumentTaskLoad(String docName, String taskName, String taskParentName, String taskDescription, String productName, String typeDistribute, String documentNameTemplate, String password) throws Exception { logger.debug("Adding task {}", taskName); QMSClient qmsClient = new QMSClient(); java.lang.String timeLimitedServiceKey = this.getTimeLimitedServiceKey(new QMSBackendServiceStub.GetTimeLimitedServiceKeyE()).getGetTimeLimitedServiceKeyResult(); List<NamedValue> namedValuePairs = new ArrayList<>(); namedValuePairs.add(new NamedValue("X-Service-Key", timeLimitedServiceKey)); qmsClient._serviceClient.getOptions().setProperty(HTTPConstants.HTTP_HEADERS, namedValuePairs); QMSBackendServiceStub.ServiceInfo[] serviceInfo = qmsClient.getServices(QMSBackendServiceStub.ServiceTypes_type0.QlikViewDistributionService); QMSBackendServiceStub.Guid qdsGuid = serviceInfo[0].getID(); QMSBackendServiceStub.TaskInfo[] taskInfo = qmsClient.getTasks(qdsGuid); QMSClient.DocumentTask documentTask = new QMSClient.DocumentTask(); documentTask.setQDSID(qdsGuid); documentTask.setGeneral(new QMSClient.DocumentTaskTaskGeneral(true, taskName, taskDescription)); QMSBackendServiceStub.DocumentNode[] sourceDocuments = qmsClient.getSourceDocuments(qdsGuid); QMSBackendServiceStub.DocumentNode documentNode = Arrays.stream(sourceDocuments).findFirst().orElseThrow(); documentTask.setDocument(documentNode); documentTask.setReload(new QMSBackendServiceStub.DocumentTaskTaskReload()); documentTask.getReload().setMode(QMSBackendServiceStub.TaskReloadMode.Full); if (docName.equals(productName + ".qvw")) { documentTask.getReload().setSectionAccessMode(QMSBackendServiceStub.QDSSectionAccessMode.SpecifyCredentials); documentTask.getReload().setSectionAccessUserName(""); documentTask.getReload().setSectionAccessPassword(""); } documentTask.setScope(QMSBackendServiceStub.DocumentTaskScope_type0.General, QMSBackendServiceStub.DocumentTaskScope_type0.Reload, QMSBackendServiceStub.DocumentTaskScope_type0.Reduce, QMSBackendServiceStub.DocumentTaskScope_type0.Triggering); var server = new QMSBackendServiceStub.DocumentTaskTaskServer(); var access = new QMSBackendServiceStub.DocumentTaskTaskServerTaskServerAccess(); access.setEnableSessionCollaboration(true); server.setAccess(access); documentTask.setServer(server); //Create task qmsClient.saveDocumentTask(documentTask); logger.debug("Task {} added", taskName); } }

Re: Check the Session Collaboration button through soap request

Brett_Bleess — Tue, 15 Oct 2019 12:26:05 GMT

@Damien_V Any chance you can have another look at this one? Jeremy, I am not very good with the code side of things, if Damien cannot have a look, I will try to see if I can find someone else to check it out for you, but it may take a few days.

Regards,
Brett

Re: Check the Session Collaboration button through soap request

bl-jeremy — Tue, 15 Oct 2019 12:27:17 GMT

Thank you !

Re: Check the Session Collaboration button through soap request

Damien_V — Tue, 15 Oct 2019 12:43:54 GMT

Does it return a specific error when you run the code ? It may guide us to the actual problem.

Otherwise, I will need to debug the code in my environment, I will have time to do that on Thursday.

Meanwhile , you could also debug it yourself and compare with the PowerShell example sent. If you use wireshark, you will see exactly how does the soap request sent looks like and that will show if there is anything wrong inside the request.

Re: Check the Session Collaboration button through soap request

bl-jeremy — Tue, 15 Oct 2019 12:49:33 GMT

No error returned unfortunately, everything seems to work...

And the SOAP request contains the two 'Session Collaboration' fields

Re: Check the Session Collaboration button through soap request

Brett_Bleess — Thu, 17 Oct 2019 13:45:00 GMT

Jeremy, just wanted to let you know Damien got tied up on other stuff today, and he will not be able to get to things tomorrow either, but he did have a question as to what underlying language you were using in your project, so if you can answer that, he should be ready to go when he can get back to the post. He was not sure if it was .Net or Java? Any details you can post on that will help him, sorry for the delay.

Regards,
Brett

Re: Check the Session Collaboration button through soap request

bl-jeremy — Thu, 17 Oct 2019 13:47:31 GMT

Don't be bothered by the delay, thank you for helping me !

I use Java in my project. I generated the Java QLIK client from the wsdl.

Re: Check the Session Collaboration button through soap request

Brett_Bleess — Thu, 17 Oct 2019 21:37:52 GMT

Thanks Jeremy, I have also reached out to another person as well, but he is generally quite busy, so I suspect Damien will likely get back to you before he does, but maybe we will get lucky! 🙂 Hopefully we can help you get things sorted.

Regards,
Brett

Re: Check the Session Collaboration button through soap request

bl-jeremy — Wed, 23 Oct 2019 08:52:56 GMT

Hi Brett,

Any news on my problem ?

Re: Check the Session Collaboration button through soap request

Brett_Bleess — Wed, 23 Oct 2019 14:16:53 GMT

Jeremy, not yet, sorry.

Regards,
Brett

Re: Check the Session Collaboration button through soap request

Damien_V — Thu, 24 Oct 2019 07:55:05 GMT

Hi Jeremy,

Is that how you generated the client? https://stackoverflow.com/questions/4172118/web-service-client-given-wsdl

I do not have much experience with how you do that in java.

Alternately, if you provide us a wireshark trace of the failing request, we could compare with one that is working.
My guess is that there is some misformatting somewhere in the request sent.

Re: Check the Session Collaboration button through soap request

bl-jeremy — Thu, 24 Oct 2019 08:17:14 GMT

Hi,

I don't have wireshark, but Fiddler.

Anyway, I've extracted the soap request (obviously obfuscated):

<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <ns10:SaveDocumentTask xmlns:ns10="http://ws.qliktech.com/QMS/11/"> <ns10:documentTask> <Document xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects"> <FolderID>TT</FolderID> <ID>TATA</ID> <IsOrphan>false</IsOrphan> <IsSubFolder>false</IsSubFolder> <Name>TOTO.qvw</Name> <RelativePath>TITI</RelativePath> <TaskCount>0</TaskCount> <Type>Source</Type> </Document> <General xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects"> <Enabled>true</Enabled> <TaskDescription>Creating a task</TaskDescription> <TaskName>TN.qvw</TaskName> </General> <s5:QDSID xmlns:s5="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects">AAAA</s5:QDSID> <Reduce xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects"> <DocumentNameTemplate>%SourceDocumentName%</DocumentNameTemplate> <Dynamic> <Type>ByField</Type> </Dynamic> <Static> <Reductions /> </Static> </Reduce> <Reload xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects"> <Mode>Full</Mode> </Reload> <ns5:Scope xmlns:ns5="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects">General Reload Reduce Triggering</ns5:Scope> <Server xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects"> <Access> <EnableSessionCollaboration>true</EnableSessionCollaboration> </Access> </Server> <Triggering xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects"> <ExecutionAttempts>1</ExecutionAttempts> <ExecutionTimeout>1440</ExecutionTimeout> <TaskDependencies /> <Triggers> <Trigger xmlns="http://schemas.datacontract.org/2004/07/PIX.QMSAPI.DataObjects.Triggers" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ExternalEventTrigger"> <Enabled>true</Enabled> <ID>AAA</ID> <Type>ExternalEventTrigger</Type> <Password>TRULULU</Password> </Trigger> </Triggers> </Triggering> </ns10:documentTask> </ns10:SaveDocumentTask> </soapenv:Body> </soapenv:Envelope>

Re: Check the Session Collaboration button through soap request

Damien_V — Thu, 24 Oct 2019 09:34:49 GMT

So the request that is failing is the one to set up the setting on the document ? not the one to enable on the QVS ? or is that one also failing ?

Re: Check the Session Collaboration button through soap request

bl-jeremy — Thu, 24 Oct 2019 09:37:14 GMT

This is the request to create a task.

Actually, none of the requests fail. But the 'Session Collaboration' checkbox is not checked when creating a new task with the provided soap request