Element Details: Action.Add+Bookmark
 Back


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

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

Action.AddBookmark adds a new bookmark for the current report, saving the request parameters so the report can be re-run later with the same input values.

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.
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 *".
BookmarkDescriptionMessage
UserDefined
Sets the text that appears in a popup text box prompting the user to enter a description for the bookmark. For Action.AddBookmark elements, if BookmarkDescriptionMessage is blank, the user will not be prompted. For Action.EditBookmark elements, this attribute is required.
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".
BookmarkSaveCaption
UserDefined
The text of the button that saves the bookmark. The default is "Save".
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.
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.



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.

Action.Refresh Element Action.Report


 Back to top


 Chart Debug