topic Re: Engine API select range in .NET application in Integration, Extension & APIs

Engine API select range in .NET application

Tue, 07 Jun 2016 06:58:21 GMT

Hi All,

I apologise if this sounds like a stupid question but how do I use the Qlik Engine API in a .NET application? The reason I ask is because I want to select based on a range instead of an absolute value. E.g. select all transactions where, 500 <= amount <= 10,000, or where name like "sm%".

In order to try this out I created .NET WPF app where I display a Qlik Sheet using a <WebBrowser> control and that works fine. I honestly have no idea what to do next, I looked at the examples and got nowhere fast. I'm using the Helpdesk Management app as my test app. I'm also using the sheet Performance to do my select range testing. Hopefully the pic below will better explain what I'm trying to do. Basically I wan't to use Qlik Engine to filter selections where the Open Cases value is > 20 but < 80.

Regards,

Alex

Re: Engine API select range in .NET application

konrad_mattheis — Tue, 07 Jun 2016 08:04:02 GMT

Hi Alex,

the text is a little bit confusing for me. The .NET SDK has nothing todo with a Webbrowsercontrol.

If you like to use the .NET SDK you can create a GenericSessionObject as Listbox make than a

currentSessionListBox.SearchForAsync("500 <= amount <= 10,000)

and than a AcceptSearchAsync(true).

bye Konrad

Re: Engine API select range in .NET application

Tue, 07 Jun 2016 23:36:38 GMT

Thank you for your response.I will do my best to simplify. I have a .NET application, how do I then call the Qlik Engine API. Say for example I wanted to run the following:

{ "jsonrpc": "2.0", "id": 7, "method": "ClearAll", "handle": 1, "params": [] }

I would ultimately like to get familiar with the Qlik Engine API, if I can get the ClearAll call working, I can go from there. Again if this is confusing, I'm sorry, I'm very new to Qlik Development.

Re: Engine API select range in .NET application

konrad_mattheis — Wed, 08 Jun 2016 10:29:36 GMT

Hi Alex,

you can use for example ClearAll also on the app object.

http://help.qlik.com/en-US/sense-developer/2.2/Subsystems/APIs/Content/MashupAPI/Methods/clearAll-method.htm?q=ClearAll

bye Konrad

Re: Engine API select range in .NET application

Thu, 09 Jun 2016 00:00:50 GMT

Hi Konrad,

Thanks, I am aware of that method. I used the ClearAll only as an example. I wanted to generate a script which could then be passed to Qlik Engine in a .NET application.

Clearly I don't know enough about Qlik to be asking the right question, so I can going to consider this question closed but unanswered. Again thank you for taking the time to respond.

Alex

Re: Engine API select range in .NET application

Tue, 14 Jun 2016 12:43:14 GMT

Hi,

If you don't want to use the .Net SDK Api but instead use the Engine API you can use SendAsync.
Example:

var serverAddress = "http://server.domian.com";

var qlikSenseServer = Qlik.Engine.Location.FromUri(new Uri(serverAddress));

var appId = qlikSenseServer.AppWithNameOrDefault("AppName", noVersionCheck: true);

qlikSenseServer.AsNtlmUserViaProxy();

var task = await qlikSenseServer.App(appId, noVersionCheck: true).Session.SendAsync("your json");

Best Regards
Lars-Göran Book

Re: Engine API select range in .NET application

konrad_mattheis — Wed, 15 Jun 2016 06:21:09 GMT

Hi Lars-Göran,

I found only the following signatures of the Function SendAsync() in the Interface

Task SendAsync(Request request);

Task<T> SendAsync<T>(Request request, Func<Response, T> continueWith);

Task<Response> SendAsync(int wsHandle, string wsMethod, IEnumerable<string> argumentNames, params object[] arguments);

Please can you give an examaple to one of them.

bye Konrad

Re: Engine API select range in .NET application

Wed, 15 Jun 2016 07:09:34 GMT

I couldn't figure out who to send JSON but I found this works, I'm using Qlik Sense Desktop though:

var qlikLocation = Location.FromUri(new Uri("ws://127.0.0.1:4848"));

qlikLocation.AsDirectConnectionToPersonalEdition();

IAppIdentifier helpdeskManagementAppId = qlikLoc.AppWithNameOrDefault("Helpdesk Management");

var qlikRequest = new Qlik.Engine.Communication.IO.Request(1, "ClearAll");

await qlikLocation.App(helpdeskManagementAppId, noVersionCheck: true).Session.SendAsync(qlikRequest);

Re: Engine API select range in .NET application

Øystein_Kolsrud — Wed, 15 Jun 2016 08:07:45 GMT

Hi! You might want to check out the following page that provides information for getting started with the .Net SDK:

http://help.qlik.com/en-US/sense-developer/2.2/Subsystems/NetSDKAPI/Content/GettingStarted/Net-Sdk-Get-Started-Intro.htm

You can also find a couple of examples on how to use it here:

Download code samples ‒ Qlik Sense

You can check out the "Custom desktop" example if you want to see how to use the "ClearAll" operation from the SDK.

Re: Engine API select range in .NET application

Øystein_Kolsrud — Wed, 15 Jun 2016 11:34:27 GMT

The .Net SDK provides C# wrappers for the underlying Json RPC API. The .Net SDK basically translates the C# method calls into the json strings you need so that you don't have to worry about things like handles and request ids. Documentation for the particular method "ClearAll" can be found here:

IApp.ClearAll Method

There is also an asynchronous version here:

http://help.qlik.com/en-US/sense-developer/2.2/apis/net%20sdk/html/M_Qlik_Engine_IApp_ClearAllAsync_1.htm

Re: Engine API select range in .NET application

konrad_mattheis — Wed, 15 Jun 2016 12:30:54 GMT

Hi,

under the link I get only that page, if I try to download the DEMO.

bye Konrad

Re: Engine API select range in .NET application

Øystein_Kolsrud — Wed, 15 Jun 2016 12:42:07 GMT

What link is it that you are having a problem with?

Re: Engine API select range in .NET application

konrad_mattheis — Wed, 15 Jun 2016 13:58:03 GMT

Go here and click on the marked position.

Download code samples ‒ Qlik Sense

Re: Engine API select range in .NET application

Thu, 16 Jun 2016 00:08:53 GMT

Hi Guys,

I have looked at the documentation and after a while it took me some time to figure out part of it, just enough to display a sheet and make a selection, then be able to also clear all selections. I don't have the years experience in Qlik, so I found the concepts a little difficult to grasp and for the most part, just skipped them. I still don't understand the majority of it.

My intention for looking at the qlik engine was because I was directed their by a person who thought it would do what I was asking. What I really wanted to do was make a selection based on a condition and get values based on a condition, and I thought I could do that using the Qlik Engine. See below for an example:

App Id: Helpdesk Management

Field/Dimension: Case Owner

Values:

For the field/dimension Case Owner in app Helpdesk Management, I would like to be able to select all values of Case Owner which start with A or alternatively, be able to get all values of Case Owner which start with A.

1. Select all Case Owner values that start with A:

So if I selected all values of Case Owner that start with A I would get the following screen for the Dashboard sheet:

2. Get all Case Owner values that start with A:

I would then also like the ability to get all values which start with A. So:

Aileen C. Millimaki
Aaracelis K. Ranum

Re: Engine API select range in .NET application

Øystein_Kolsrud — Thu, 16 Jun 2016 07:29:54 GMT

That link seems to be working fine for me at least. It should trigger a download session for the vsix file. Could there be some setting in your browser that somehow blocks that type of operations? I've tried it in IE, Firefox and Chrome, and it works fine in all three of them.

Re: Engine API select range in .NET application

Øystein_Kolsrud — Thu, 16 Jun 2016 08:49:12 GMT

The general selection and data retrieval mechanism of Qlik Sense is based on the concepts of hypercubes‌ and list objects‌. You might want to read a little about those to get an understand for how they work. However, for the case where you want to select all case owners based on a pattern matching on the values of the field, you probably want to use selection methods found in the class Field‌. Then once you have performed the selection, you can use the class IExtendedCurrentSelection to retrieve a list of the values that were selected.

The code for your example would look something like this (where "theApp" is the "Helpdesk Management" app in your example):

var fieldOfInterest = "Case Owner";

// Select the relevant values of the field

var theField = theApp.GetField(fieldOfInterest);

theField.Select("A*");

// Get the set of field values that were selected

var currentSelection = theApp.GetExtendedCurrentSelection();

var largePage = new NxPage { Top = 0, Left = 0, Width = 10, Height = 100 };

var pages = currentSelection.GetSelectedData(fieldOfInterest, new [] { largePage });

var selectedValues = pages.SelectMany(p => p.Matrix.Select(r => r[0].Text));

Re: Engine API select range in .NET application

Fri, 17 Jun 2016 06:24:21 GMT

I was able to use your example to do what I wanted to do. I also tried to use a List instead and think I got it working, so yay!