Action Elements
Action elements are an essential part of Logi reporting and the primary mechanism for providing HTML links in a definition. Different types of Action elements are available for developers to use in specific situations. Developers will find them easy to use; they save a lot of time when creating reports.
The following topics provide examples of how to use the Action Element:
- Example: Link to Another Report
- Example: Link to a URL
- Example: Link that Executes JavaScript
- Example: Export to PDF
- Example: Email Report as Attachment
- Example: Showing and Hiding Elements
- Example: With an Event Handler
- Example: With Event Handler for Popup Menu
About Action Elements
The following table provides a description of the available Action elements. The links connect to the Element Reference page or a relevant topic for each element.
| Element | Description |
|---|---|
| Action.Add Bookmark | Allows users to add a new bookmark for the current report, saving the request parameters so the report can be re-run later with the same input values. For more information, see Bookmarks. |
| Action.Add Dashboard Panel | At runtime, allows user to add a new Dashboard panel, containing specified content from one report, in a specified Dashboard in another report. |
| Action.Copy Bookmark | Allows bookmarks to be copied and added to a user's bookmark collection. |
| Action.Dial Phone | Launches a mobile device's phone application with a phone number. The user still needs to click a "Call" button to place the call. Mobile Report definitions only. |
| Action.Draft Email | Launches a mobile device's email application. The user still needs to click a "Send" button, and possibly enter Addressees, Subject and email Body text. Mobile Report definitions only. |
| Action.Draft Text Message | Launches a mobile device's SMS text messaging application with pre-filled phone number. The user still needs to enter the message text and click a "Send" button. Mobile Report definitions only. |
| Action.Drag Bookmark | Allows bookmarks to be dragged into the folders of the Bookmark Organizer element in the same Report definition. For more information, see Organizing Bookmarks. |
| Action.Edit Bookmark | Displays a pop-up text box that allows the user to change a bookmark's Description. For more information, see Creating a Bookmark Manager. |
| Action.Email Report | Sends a report as an email attachment. When the link is clicked, a dialog box is displayed so that To, From, Subject, and Message can be entered. |
| Action.Exit | Abandons the users session and takes him to another URL. |
| Action.Export CSV | Exports the report's Data Table data into a comma-delimited CSV file. |
| Action.Export Native Excel | Runs a report for export as a native Excel document. |
| Action.Export Native Word | Runs a report for export as a native Word document. |
| Action.Export PDF | Runs a report for export as a PDF document. |
| Action.Export Word or Excel | Runs a report so that it can be exported to Word or Excel. |
| Action.Export XML | Returns the XML generated by the target report's datalayers. |
| Action.Google Spreadsheet | Runs a report for export as a Google Spreadsheet document. |
| Action.Javascript | Runs JavaScript in the user's browser, which can also call JavaScript functions defined in script files with the Script File attribute and AdditionalScriptFiles element. |
| Action.Link | Together with Target.Link, runs a specific URL or executes embedded JavaScript. |
| Action.Map Location | Runs a Google Map query on a mobile device to show a map with one or more locations highlighted. Mobile Report definitions only. |
| Action.Map Marker Info | Used with a Google Map; displays an information panel when the user clicks on a map marker. Logi Info only. |
| Action.Popup Menu | Displays a pop-up menu offering various options to the user. |
| Action.Pre-Action Javascript | Runs client-side JavaScript before its parent Action element executes, enabling custom code to be run prior to the action occurring. The parent Action element will only be executed if custom JavaScript returns a value of true. For more information, see Scripting. |
| Action.Process | Executes a task in a Process definition. Logi Info only. |
| Action.Refresh Element | Refreshes one or more elements in the report, using AJAX technology so that the entire report page is not necessarily redrawn. |
| Action.Remove Bookmark | Allows the user to delete a bookmark. For more information, see Creating a Bookmark Manager. |
| Action.Report | Runs a report definition, in the same window, another window, or within an IncludeFrame. |
| Action.Run Bookmark | Runs a report while applying the parameters of a bookmark to it. For more information, see Bookmarks. |
| Action.Show Bookmark Sharing | Displays a pop-up panel for adding, listing, and removing users who those who may share a bookmark. For more information, see Sharing Bookmarks. |
| Action.Show Element | Shows or hides one or more elements on the current page, using Show Modes. |
| Action.Template | Runs a Logi Template definition. |
| Action.Widget | Loads a Logi widget. |
Actions are usually attached to a parent element, such as a Label or Image element. The parent element controls when and how the action is triggered. For example, a Label element can be combined with an Action.Link element to create a hyperlink to a web site.
Action elements make use of Target sub-elements when linking to another page or site. The Target element sets what page is to be loaded and how it will be displayed.
You can only use one Action element directly under a user input element, Label, or Image. Additional Action elements will be ignored. You can use multiple Event Handlers, each with its own Action element. See Action Elements Example: With an Event Handler for more information.
The Action.Refresh Element
The Action.Refresh Element element uses AJAX technology to refresh specific elements or portions of a report page without reloading the entire page, which produces a smooth-looking update. However, developers should keep these guidelines in mind when using this element:
- The best practice is to refresh a Division or another container element (and thereby its contents) whenever possible.
- Don't attempt to refresh super-elements or Google Maps, which contain possibly-conflicting internal AJAX calls.
- Local Data datalayers are not re-run with all AJAX refresh requests. They are only re-run when the element being refreshed, using Action.Refresh Element, contains either a DataLayer.Linked element linked to the Local Data datalayer, or when it contains an @Local token.
- All "LoadDefinition" plug-in calls will be re-run with each refresh request.
- When refreshing a visualization that you then want to export and send via email, be sure to include the container (usually a Div) for the Action.Email Report and Export elements in the list of elements Action.Refresh Element will refresh.
- You can refresh multiple elements at once by listing their IDs in the Element ID attribute, separated by commas.
- You cannot refresh Responsive Row and Responsive Column elements directly by specifying their IDs in an Action.Refresh Element element. However, you can enclose the entire table in a Division and refresh it, or place the Responsive Column's child elements in a Division and refresh it.
- The Action.Refresh Element element's Element ID attribute supports tokens.
-
The element's Post Refresh Javascript attribute allows you to call custom browser JavaScript after Action.Refresh Element has completed updating the page.
Using the Wait Panel
The Wait Panel element (which was called the Wait Page at one time) displays a modal "busy" icon when an action takes more than a few seconds, letting users know processing is in progress. Simply adding the Wait Panel as a child of the following Action elements makes it work:
- Action.Link
- Action.Process
- Action.Refresh Element
- Action.Run Bookmark