Element Details: Action.Run+Bookmark
 Back


Available in: Logi Info Source code name: Action.RunBookmarkIntroduced in: v9.5.91

Bookmarks make it easy for users to build a menu of reports with saved input parameters. Bookmarks also save user changes for AnalysisGrids, AnalysisCharts, OlapGrids and DimensionGrids.

Action.RunBookmark runs a bookmarked report, passing the BookmarkID and BookmarkCollection attributes so the report can get the bookmark parameter values that will replace @Request tokens.

The default value for BookmarkID is @Data.BookmarkID~, which is useful when the value comes from a DataLayer.Bookmarks element. And the default for Report is @Data.rdReport~

When running a shared bookmark, attribute BookmarkUserName must be set. Typically, it should be @Data.BookmarkUserName~ to get the value from a DataLayer.Bookmarks element.

A shared bookmark which has been dragged into the current user's collection is a bookmark "shortcut". To run a bookmark shortcut, SharedBookmarkID, BookmarkID and BookmarkUserName are required. With DataLayer.Bokmarks, these values come from @Data.SharedBookmarkID~, @Data.BookmarkID~ and @Data.BookmarkUserName~.

Element Group:Bookmarks



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.
BookmarkID
UserDefined
(Required) Each bookmark in a bookmark collection gets a unique ID. The ID is returned by DataLayer.Bookmarks.
BookmarkUserName
UserDefined
BookmarkUserName is required when working with bookmarks which have been shared to the current user.
Class
UserDefined
Sets the Cascading Style Sheet class used by the element. When set, this class will also be used by all child elements that don't have their own class. The class should be defined in the report's style sheet file.
ID
UserDefined
(Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
PopupMenuCaption
UserDefined
When there are multiple Action elements, a simple popup menu appears allowing selection of the desired Action. PopupMenuCaption specifies the caption for an Action's popup option.
Report
UserDefined
The name of a Report definition file. The default value is the current report. For some elements, the value can be set to "CurrentReport". This builds the same report with the same data and sort order, which is especially useful when exporting reports. You cannot use "CurrentReport" within Process definitions or MasterReport elements.
SharedBookmarkID
UserDefined
SharedBookmarkID is the BookmarkID in the sharers bookmark collection.



PARENT ELEMENTS

Click element to drill down for more information.

Button
Column Cell
Data Table Column
Division
Event Handler
HTML Tag
Image
Label
Menu Leaf
Popup Option
Responsive Column


CHILD ELEMENTS

Click element to drill down for more information.

Link Parameters Target.Run Bookmark Wait Panel


 Back to top


 Chart Debug