topic Re: Qlik Sense: Update a variable via API in Integration, Extension & APIs

Qlik Sense: Update a variable via API

Fri, 12 Feb 2016 12:11:51 GMT

Hi,

I'm trying to update a variable Definition using the NET SDK.

I loaded all the variables using the client as follows (I don't know if there's a better way):

Qlik.Sense.Client.IVariableList variables = Qlik.Sense.Client.AppExtensions.GetVariableList(qsApp);

I then try to change the values using:

qsVariable.Set<string>("Definition", kpv.Value.Definition);

But this does not work.

I am lost as to which API has the information and the actions I would need to do to achieve what I want.

Thanks in advance for your help.

Re: Qlik Sense: Update a variable via API

petter — Mon, 15 Feb 2016 23:22:03 GMT

You don't show in your snippets above how you define and set the reference in the qsVariable. Furthermore I can see that I find a Method called Set - have a look at this list of methods:

https://help.qlik.com/sense/2.1/en-US/developer/#../Subsystems/APIs/Content/MashupAPI/qlik-variable-interface.htm%3FTocP…

Re: Qlik Sense: Update a variable via API

Tue, 16 Feb 2016 06:18:23 GMT

I'm using a dictionary as follows:

if (pVariables != null && pVariables.Count > 0) {

foreach (KeyValuePair<string, NxVariableListItem> kpv in pVariables) {

NxVariableListItem qsVariable = kpv.Value;

.......

I have tried the following:

qsVariable.Set<string>("Definition", kpv.Value.Definition);

GenericVariable tmp = qsApp.GetVariableByName(kpv.Value.Name);

GenericVariableProperties tmpp = tmp.GetProperties();

tmpp.Set<string>("Definition", kpv.Value.Definition);

Neither works...

Re: Qlik Sense: Update a variable via API

petter — Tue, 16 Feb 2016 08:43:37 GMT

When are you trying to update the definition of the variable? You can only do that before the application is published? Are you doing this on Qlik Sense Desktop?

Have a look at the documentation here to see how to create variables:

https://help.qlik.com/sense/2.1/en-US/developer/Subsystems/NetSDKAPI/Content/WorkWith/Net-Sdk-Work-With-Variables.htm

Re: Qlik Sense: Update a variable via API

Tue, 16 Feb 2016 09:03:57 GMT

I'm (trying to) updating the variables in the qvf file locally before publishing the file in QS Server via the API.

I have looked at the examples provided. Does that mean that I should destroy the variables I want to update and create again? Seems odd!

FYI, I am able to update Connections correctly before publish.

Re: Qlik Sense: Update a variable via API

Øystein_Kolsrud — Thu, 25 Feb 2016 13:19:46 GMT

I would assume you would need to do something like this:

GenericVariable tmp = qsApp.GetVariableByName(kpv.Value.Name);

GenericVariableProperties tmpp = tmp.GetProperties();

tmpp.Definition = kpv.Value.Definition;

tmp.SetProperties(tmpp);

Notice that I do not use the generic Set method for the properties structure, but instead rely on the C# class property. Also, note that your have to do a "SetProperties" after you have modified the properties structure, otherwise the engine will never be informed that the properties has changed.

Re: Qlik Sense: Update a variable via API

Øystein_Kolsrud — Thu, 25 Feb 2016 13:36:35 GMT

And a small note on the line with the generic "Set" method for setting the variable definition: The engine will actually look for a property named "qDefinition", not "Definition" when evaluating a variable. The C# property "Definition" of the "GenericVariableProperties" class maps to that engine property. Actually, these two operations should be equivalent in your case:

1) tmpp.Definition = kpv.Value.Definition;

2) tmpp.Set<string>("qDefinition", kpv.Value.Definition);

Note that the property name starts with a 'q' in version 2)! The engine uses that prefix to identify properties that are to be evaluated by the engine. (Other typical examples you will encounter are "qHyperCubeDef" and "qListObjectDef".)

Re: Qlik Sense: Update a variable via API

Mon, 29 Feb 2016 11:10:57 GMT

Still KO!

Maybe i'm doing something wrong?

In fact, I have a local file.

1. I connect to QS and upload the file using the REST api. (qrs/app/upload?name={0})

2. I get the AppId and change the variables as per your previous message.

3. I publish/replace the file (qrs/app/{0}/publish?stream={1} or qrs/app/{0}/replace?app={1})

When I check on the published app, the variable definition is unchanged...

Any ideas??

Re: Qlik Sense: Update a variable via API

Wed, 13 Apr 2016 05:41:33 GMT

It's now working in 2.2.

Cheers!