topic Re: Qlik Engine API Does Not Work after June 2017 update in Integration, Extension & APIs

Qlik Engine API Does Not Work after June 2017 update

Anonymous — Mon, 21 Aug 2017 08:52:14 GMT

Hi,

With the June 2017 upgrade of the Qlik server, most of the Qlik Engine API calls fail now (GetConnections, SetScript, GetScript, etc.). Did anyone experience this issue?

I tested the Engine API in the Engine API Explorer in the Dev Hub and the calls work there. But, using the exact same parameters through a websocket connection, the Engine API returns {'code': -32602, 'parameter': 'Invalid handle', 'message': 'Invalid Params'}

The handle and parameters I send are exactly the ones in the Engine API Explorer. Can anyone relate to this issue?

Thanks,

Chris

Re: Qlik Engine API Does Not Work after June 2017 update

Øystein_Kolsrud — Mon, 21 Aug 2017 10:28:17 GMT

You'll probably need to add the method calls you use. Can you attach an example? From the "invalid handle" string, I would suspect that there is something fishy with how you use the handle. How do you get hold of the handle and how do you use it?

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Mon, 21 Aug 2017 11:48:46 GMT

Hi Øystein,

Sure, below flow in the client I've implemented. Everything is pretty much hardcoded, so I really can't see what is the matter.

First, I open an app by sending this:

data = {

   "jsonrpc": "2.0",
   "id": 2,
   "method": "OpenDoc",
   "handle": -1,
   "params": [

{"qDocName": "293dght3-cd32-40ff-99afF-380e46c384a3"}

],
}

The server responds:

{

'jsonrpc': '2.0',

'id': 2,

'result': {

'qReturn': {

'qType': 'Doc',

'qHandle': 1,

'qGenericId': '293Dght3-CD32-40FF-99AF-380E46C384A3'

}}, 'change': [1]

}

Then, I send through the websocket connection a method such as GetConnections(), formatted as this:

data = {

     "jsonrpc": "2.0",
     "id": 2,
     "method": "GetConnections",
     "handle": 1,
     "params": [],

}

To which the server responds with an error containing the line I pasted in my question:

{'jsonrpc': '2.0', 'id': 2, 'error': {'code': -32602, 'parameter': 'Invalid handle', 'message': 'Invalid Params'}}

Please reply should you need any additional info on this. My initial thought was that something had changed along with the June 2017 update, because this worked perfectly (I actually got all the connections with the GetConnections() method) before updating the Qlik server.

Thank you,

Chris

Re: Qlik Engine API Does Not Work after June 2017 update

Øystein_Kolsrud — Mon, 21 Aug 2017 11:55:50 GMT

I see you are reusing the request ID. (It's set to 2 in both calls.) Don't know if that is the problem here, but I would expect those numbers to be unique. Have you tried with different ids?

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Mon, 21 Aug 2017 12:01:49 GMT

Sure, I tried it with unique IDs, also

Re: Qlik Engine API Does Not Work after June 2017 update

Øystein_Kolsrud — Mon, 21 Aug 2017 12:48:17 GMT

I just tried to do that GetConnections operation through the .Net SDK, and it seems to work fine with the June2017 release. How do you set up the server connection in your case? Could it be that the two calls somehow go to different sessions?

Are there any methods using the app handle that you are able to run successfully?

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Mon, 21 Aug 2017 13:31:47 GMT

As a matter of fact, no methods using the app handle (1) work. They all reply the same thing: {'code': -32602, 'parameter': 'Invalid handle', 'message': 'Invalid Params'}.

I am using a Python client to connect to the server and make the calls. This is how I connect:

async def connect(self😞

ssl_ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)

ssl_ctx.load_cert_chain(certfile=self.certfile, keyfile=self.keyfile)

conn = aiohttp.TCPConnector(ssl_context=ssl_ctx)

session = aiohttp.ClientSession(connector=conn, headers={"X-Qlik-User": "UserDirectory=MyUserDirectory; UserId=MyUserId"})

ws = await session.ws_connect(f"wss://{self.host}:{self.port}/app")

The funny thing is that this worked perfectly until upgrading to the June2017 version.

Re: Qlik Engine API Does Not Work after June 2017 update

Øystein_Kolsrud — Mon, 21 Aug 2017 15:09:42 GMT

Well, I'm afraid I'm out of ideas, but if you are familiar with C#, then you might want to try doing it through the .Net SDK and see if you get it working there. If you don't then perhaps there is some sort of server setting that has changed? You mentioned that you upgraded to June 2017, so perhaps some form of access privilege is not what it aught to be? I'm not very familiar with those settings though so just guessing...

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Wed, 23 Aug 2017 00:33:20 GMT

Hi Øystein!

I saw this discussion and I'm very interested in how do you achieve to connect with Qlik Sense Desktop sing the .Net SDK. I'm using the documented examples, but can't connect with my Qlik Sense Desktop installation:

var location = Qlik.Engine.Location.FromUri(new Uri("http://127.0.0.1:4848"));

location.AsDirectConnectionToPersonalEdition();

using(IHub hub = location.Hub())

{

Console.WriteLine(hub.ProductVersion());

}

Problem is when trying to do location.Hub(), this throws an exception with this message:

Connection failed after 4 attempts. Error message:

No se puede establecer una conexión ya que el equipo de destino denegó expresamente dicha conexión [::ffff:127.0.0.1]:4848

Can you guide me on how to do this? I'm following this documentation:

Getting started with the Qlik Sense .NET SDK ‒ Qlik Sense

Re: Qlik Engine API Does Not Work after June 2017 update

Øystein_Kolsrud — Wed, 23 Aug 2017 07:10:10 GMT

Just to make sure: In order to connect like that you need to have Qlik Sense Desktop up and running on your local machine, and you need to be logged in as well. Have you done that?

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Wed, 23 Aug 2017 15:54:57 GMT

Hi again!

To clarify, I'm trying to launch QlikSense using a background process to interact with an specific app. So, are you telling me this is not possible due to the login step? Is there any way to send to Qlik Sense Desktop my credentials? I tried out my code skiping the QlikSense launch and another exception was trhown: System.ComponentModel.WarningException: 'SDK target system version mismatch. SDK target system version (v4.0) should match server version(v3.2)'

Nevertheless, even if I fix the version mismatch, this is not the expected behavior.

Any help will be very appreciate.

Regards!

Re: Qlik Engine API Does Not Work after June 2017 update

Øystein_Kolsrud — Thu, 24 Aug 2017 07:29:24 GMT

I'm not sure if it possible to pass along credentials to Desktop, so I hope someone else can chime in on that one.

The version mismatch is easy to avoid though. If you don't want to use the 3.2 version that matches the server, then you can deactivate the version check like this:

location.IsVersionCheckActive = false;

Keep in mind that this means that the SDK will be out of sync with the engine API, so you might get some strange behaviors. But in reality the API's change so little that it usually works anyway.

Re: Qlik Engine API Does Not Work after June 2017 update

Alexander_Thor — Thu, 24 Aug 2017 08:48:51 GMT

The licensing terms for Qlik Desktop requires you to log in.

If you wish to run it as a automated process then it should be connected to a Qlik Sense Enterprise server and authenticated through whatever mechanism the virtual proxy is configured for.

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Thu, 24 Aug 2017 08:55:48 GMT

I found the solution to my initial issue. It was related to not awaiting the receive() method on the websocket object created with the line from my above code: ws = await session.ws_connect(f"wss://{self.host}:{self.port}/app"). In short, when I also awaited ws.receive() everything started to work again.

Now, to explain why it worked before without calling receive() on the websocket object, I can only presume that in version 3.2, Qlik Engine did not return any message upon successfully connecting through its websocket API. And now, in version 4.0, it does. So that message had to be awaited also.

Re: Qlik Engine API Does Not Work after June 2017 update

Anonymous — Thu, 24 Aug 2017 15:24:20 GMT

Agreed, I used that approach to fix the versión mismatch. So, if the full automation is not possible, we will need another solution to our needs. Anyway, all your help is very appreciated.

Thank you!