topic Why are bookmarks not based on object ID? in App Development

Why are bookmarks not based on object ID?

RenzoFantini — Fri, 11 Oct 2024 06:27:17 GMT

Good morning community,

I don't understand why bookmarks are based on master item label and not on master item ID.
This behavior affects bookmarks stability --> if you change the master item label all bookmarks based on it will stop working.
Thank you for sharing your thoughts and opinions.
Have a great day.

Re: Why are bookmarks not based on object ID?

nhenckel — Tue, 17 Dec 2024 21:07:53 GMT

Behind the scenes, bookmarks in Qlik Sense do have immutable unique IDs. For example, when using the Engine API, you can retrieve a bookmark by its unique qId like this:

{
	"handle": 1,
	"method": "GetBookmark",
	"params": {
		"qId": "74b5c74e-d54f-48e2-8cb6-fa92cdaf99aa"
	}
}

The qId is stable and does not change even if the label (title) of the bookmark or associated master items is modified. Here's a simplified getLayout response for that same bookmark:

{
	"qInfo": {
		"qId": "74b5c74e-d54f-48e2-8cb6-fa92cdaf99bb",
		"qType": "bookmark"
	},
	"qMeta": {
		"title": "New Bookmark",
		"description": ""
	},
	"qBookmark": {
		"qStateData": []
	}
}

If you’re working with APIs or custom extensions, this qId can be used reliably as a reference.

That said, to help clarify the issue, could you share more details about where you’re seeing bookmarks break? For example, is it happening in sheet actions, when using APIs, or somewhere else?

Re: Why are bookmarks not based on object ID?

RenzoFantini — Wed, 18 Dec 2024 13:53:06 GMT

Hi @nhenckel,

thanks very much for you detailed answer!
My bug it's happening in the front-end >> if you create a bookmark today based on a specific master item with a defined label if the day after you change the label of the master item the bookmark will stop working.