Element Details: Auto+Bookmark
 Back


Available in: Logi Info Source code name: AutoBookmarkIntroduced in: v11.3.049

The AutoBookmarks element automatically bookmarks (saves) the current state of its parent element every time the user makes a change. Users do not need to click a link to save changes.

To create a new bookmark with an automatically generated BookmarkID, pass the URL parameter rdNewBookmark=True with a LinkParams element. The bookmark will be a GUID, it may be retrieved later with DataLayer.Bookmark. If the report has ReportCenterItem element, the bookmark will be listed later with the ReportCenterMenu element.

To create a new bookmark with a specific BookmarkID, set the BookmarkID attribute to a new value and pass rdLoadBookmark=True. If the request parameter rdBookmarkCollection is set, that value takes precedence over the BookmarkCollection.

Use the Action.RunBookmark element to run an existing bookmarked report. Alternatively, load a bookmark by setting the BookmarkID and including rdLoadBookmark=True in the URL LinkParams.

For Dashboards, when there is an AutoBookmark element, do not set the SaveFile attribute.



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
BookmarkCollection
UserDefined
(Required) Bookmarks are stored in Bookmark Collection XML files, which are located in a folder specified in the BookmarkLocation attribute of the settings.lgx General element. BookmarkCollection sets the name of the collection. The information for each collection is stored in a file. Typically, there is one BookmarkCollection for each user. In this case, the BookmarkCollection attribute should be set to "@Function.Username~". To help keep consistency, set the settings' General element's BookmarkCollectionDefault attribute with a global value, rather than setting BookmarkCollection in individual elements.
BookmarkCustomColumn1
UserDefined
The value of this attribute is saved in the Bookmark and returned by DataLayer.Bookmarks. This might be used to display information in a table or with a ConditionFilter element to remove bookmarks from a list.
BookmarkCustomColumn2
UserDefined
The value of this attribute is saved in the Bookmark and returned by DataLayer.Bookmarks. This might be used to display information in a table or with a ConditionFilter element to remove bookmarks from a list.
BookmarkDescription
UserDefined
BookmarkDescription is normally a user-entered description. This attribute sets the default value. With Action.EditBookmark, this attribute is often set to "@Data.Description~", to get the previous description from a DataLayer.Bookmarks. For Action.CopyBookmark, this attribute names the newly created bookmark. Including the copied bookmark's description can be achieved with a "*". The default value is "Copy of *".
BookmarkID
UserDefined
Each bookmark in a bookmark collection gets a unique ID. The ID is returned by DataLayer.Bookmarks.
BookmarkName
UserDefined
The value of this attribute is saved in the Bookmark and returned by DataLayer.Bookmarks. It is typically used to store the report name.
BookmarkRequestIDs
UserDefined
Sets the list of input parameters to be saved when adding new bookmarks. Enter a list of input parameters, each separated by a comma. For example, if a report has two input parameters, like @Request.SearchName~ and @Request.SearchYear~, set BookmarkRequestIDs = "SearchName,SearchYear".
BookmarkSessionIDs
UserDefined
Sets the list of session variables to be saved when adding new bookmarks. Enter a list of session variable names/IDs, each separated by a comma. For example, if a report has two session variables, like @Session.Preference1~ and @Session.Preference2~, set BookmarkSessionIDs = "Preference1,Preference2". When the bookmark is run, either interactively or from the scheduler, these session variables will be reset from values stored with the Bookmark.



PARENT ELEMENTS

Click element to drill down for more information.

Analysis Grid Dashboard Report Author


CHILD ELEMENTS

Click element to drill down for more information.



 Back to top


 Chart Debug