Qlik Community

Ask a Question

Integration, Extension & APIs

Discussion board where members can learn more about Integration, Extensions and API’s for Qlik Sense.

Announcements
QlikWorld Online 2021, May 10-12: Our Free, Virtual, Global Event REGISTER TODAY
cancel
Showing results for 
Search instead for 
Did you mean: 
master_t
Partner
Partner

Bookmarks in the hub vs. Bookmarks in the Engine API

Hello

I'm trying to use the APIs described here:

https://help.qlik.com/en-US/sense-developer/April2018/Subsystems/EngineAPI/Content/DiscoveringAndAna...

to list/create/manage/publish bookmarks from an extension.


However, the problem is that the bookmarks created using these APIs do not show up in the bookmark list in the hub. And, vice-versa, bookmarks created in the hub do not show up when listing bookmarks from the API!

Are bookmarks created from the GUI and bookmarks created through the API two different entities? Unfortunately the documentation is very vague on this matter... can anyone help me out?

11 Replies
ErikWetterberg

Hi,

You should probably see bookmarks created in the built-in client in your list, and it's also possible to make your bookmark appear in th client, if you give them the same type and properties.

Erik  Wetterberg

master_t
Partner
Partner
Author

I "should"... but that's not the case!

Can you elaborate on the "types and prototypes" thing? I'm creating "Bookmark" objects when using the API. Don't know what type they're when creating them through the hub's user interface, because as I've said I don't see them when listing them through the engine API. Unfortunately the documentation is incredibly vague... it tells you what kind of objects you should pass but not what you should put inside those objects... basically what I've managed to do so far I've done by trial and error through the engine api explorer in the dev-hub...

ErikWetterberg

Hi,

To get a list of bookmarks you would create a list like this:

qBookmarkListDef: {

                                    qType: 'bookmark'

                                }

                           

The type 'bookmark' is needed. You probably would not get anything without it. Also to create a bookmark that is available in the client you need to specify qType: 'bookmark'. There are probably also other properties that the client needs.

Erik Wetterberg

master_t
Partner
Partner
Author

Hi

Thank you very much for your help, it's really appreciated.

I was already using qType: "Bookmark" (otherwise, as you said, the list is empty).

But that list, as I said, only contains the bookmarks created using the engine API. Not the ones created by the user through the hub.

There are probably also other properties that the client needs.

I agree, that is probably the problem... but we come back to the same issue: the documentation tells you almost nothing! Where should I look for these misterious "other properties" that are needed?

mikaelsc
Creator III
Creator III

not sure this will help your specific dev problem, but have a look at this on Qlik Branch

ErikWetterberg

Well the properties are needed to display your bookmarks in the client, client bookmarks should still be in your list, so there is another problem...

What is your environment? Desktop or server? What kind of bookmarks exist in the app? Are they included with the app when importing it or user created? What userid does your API calls use? If you open the app with the same user id can you see the bokkmarks?

Erik Wetterberg

master_t
Partner
Partner
Author

Thanks, I'll check it out, seems to have some interesting code that could be useful.

In particular, an extra property that I wasn't setting when creating the bookmark is the sheetId. I'll try as soon as I'm able to see if that changes anything.

master_t
Partner
Partner
Author

This is a QlikSense server (enterprise)

There are no bookmarks that come with the app itself, I've just created a few in the hub, so I'm assuming they're "user" bookmarks? I'm not clear what the distinction is here to be honest.

As for users, I'm trying to use the API with the same user that created the bookmarks in the hub, but I still can't see them in the BookmarkList i obtain from the API, only the ones created through the API itself are shown. As for other users: when creating the BookmarkList it seems that every user can only see the bookmarks he/she created AND the ones others created only if they're published, which is correct I'd say.

balabhaskarqlik

Did you resolved the issue, post the solution.