Logi Info Dashboard
This topic introduces Logi Info developers to one of the "super-elements", the Dashboard. Dashboards provide an organized arrangement of visualizations in tabs and panels. Like all super-elements, they have a built-in user interface and specialized functionality.
Information about using a Dashboard, intended for end-users, is available in Logi Info Dashboard .
About the Dashboard
A Logi "dashboard" is a collection of dashboard panels, each containing a data visualization (table, chart, gauge, etc.). A dashboard can be configured to allow end-users to customize it at runtime by adding, removing, or rearranging its panels. A dashboard can also be configured to have tabbed pages, so that different collections of dashboard panels can be viewed. Dashboard panel content is interactive and end-users can be allowed to vary the data criteria for them at runtime. Links within the panels and visualizations can be used to drill-down and drill-through to supporting data. Dashboards present a very flexible way of presenting a range of information that's easy to take in with a single glance.
A simple dashboard, with no user customization features, styled using the standard Signal theme, is shown above.
In the example above, we see a more complex dashboard which includes tabs and has end-user customization enabled.
Dashboards are created using the Dashboard element, and its child elements, and they provide attributes that control customization features. AJAX-based techniques are used for web server interactions, allowing selective updates of dashboard panels. There's also a mechanism for saving runtime customizations between sessions, on an individual-user basis.
A dashboard or tab's layout usually consists of one or more columns
and, if the dashboard is configured to be adjustable, users can
drag-and-drop the panels into the columns and the arrangement of their
If the dashboard is adjustable, then using the dashboard or tab's gear
icon and Settings menu, users can change the number of columns in a tab or
dashboard, as shown above.
Depending on your application's configuration, a "Free-form Layout"
option may also available. If it's enabled, users can resize and rearrange
dashboard panels without regard to any predetermined columns.
Dashboard panels are the basic building blocks of the dashboard and can be added programmatically or dynamically at runtime.
As shown above, panels have a Caption and content, and may be configurable by users at runtime in other ways. If the dashboard is adjustable, a panel can have its caption changed or be removed from its dashboard via its Settings menu. If the panel has been created with parameters, users can adjust the parameter values, affecting the panel content.
In the definition, the Panel element creates a dashboard panel. Its Panel Content and Panel Parameters child elements are used to create and configure the panel.
At runtime, users can drag a panel to a new location by clicking on its caption bar, as shown above (note the cursor change). As the panel is dragged into a different column or position, a yellow "drop zone" indicator appears to help snap the panel into its new location.
In a columnar layout, panels will automatically resize based on the
width of the column they're dropped into, and the column's width is
determined by the widest panel it contains. If the contents of a panel are widened, then the panel and its column will widen, too.
This is a change from panel behavior in previous versions! In a columnar layout, panels will automatically resize based on the width of the column they're dropped into. Column width is a fixed width,
determined by the layout chosen and screen width. Panel content will
be automatically scaled up to the maximum width that fits in the panel.
In support of this change, charts in panels in columnar layouts no
longer have horizontal resizing handles.
The Dashboard Wizard
The "Create a Dashboard" wizard is one of Logi Studio's collection of wizards. This wizard assists developers in creating dashboards by populating the report definition with the necessary dashboard-related elements. More information about this wizard is available in our Dashboard Wizard.
Only one Dashboard element is allowed per
report definition. Four child elements, discussed in separate sections below, are used with the Dashboard element. We do not recommend that you use this element within an embedded sub-report.
Let's examine the Dashboard element's attributes:
|ID||(Required) Specifies a unique identifier for this element.|
(Required) Specifies the fully-qualified file path and name of an XML file where dashboard changes users make at runtime are saved.
This value is not required and you must leave it blank if you're using the Auto Bookmark child element with the dashboard, see Introducing Bookmarks.
Tokens may be used in this attribute, however, @Request tokens are not recommended as they're not persistent. If the file doesn't exist it will be created at first use; however its containing folder will not be automatically created.
If Logi Security has been used in the project to control access, the user's name will appear in the @Function.UserName~ token. This can be embedded into the Save File attribute to provide separate files for individual users. For example, the attribute value might be: @Function.AppPhysicalPath~\DashSaveFiles\@Function.UserName~.xml
which might translate to: C:\inetpub\wwwroot\MyDashboardApp\DashSaveFiles\BillGates.xmlSave files can also be stored in a database, see Introducing Bookmarks.
|Allow Free-form Layout||Specifies whether Free-form Layout mode is enabled. This layout mode allows dashboard panels to be placed wherever desired by the user, instead of fitting into a columnar arrangement. When disabled, users must arrange panels in pre-defined columns. When this attribute is True, the Dashboard Columns attribute must be 0. Default: False|
Auto Global Filters
||Specifies whether dashboard panels with Analysis Filters, and/or those generated from an Analysis Grid that uses the Active Query Builder element, will have global filters created automatically. Default: False|
Auto Panel Filters
||Specifies whether dashboard panels generated from an Analysis Grid that uses the Active Query Builder element will have panel filters created automatically, based on its metadata. Default: False|
|Dashboard Adjustable||Determines if the user is allowed to add, remove and manage tabs and panels. Set this attribute to False for a static dashboard that users cannot change. When set to True, the user's dashboard changes are saved to the location specified in the Save File attribute. Note that when set to False, the user cannot save changes, but the Save File is still used to control the dashboard appearance. Therefore, set this to True during the development process so that you, the developer, can make desired changes. Then, if a static dashboard is desired, set it back to False. Finally, be sure to deploy the actual .xml Save file with the reporting application to the production server. Default: True|
Specifies the number of vertical columns (1- 8) the dashboard should be divided into. Columns are automatically sized to fit the available space. When Allow Free-form Layout is True, this attribute must be 0. Default: 3
|Dashboard Tabs||When True, allows the user to put dashboard panels into different tabs. The user can create, rename, reposition and remove tabs. The initial tab is created automatically.|
Disable Gallery Updates
||Specifies whether users can delete panels at runtime from the gallery specified below in the Gallery File attribute. The default value is True.|
Disable Global Filters from Panels
||When Auto Global Filters attribute set to True, the user is able to click certain types of visualizations, such as charts, to add or update a global filter. Setting the attributes to True will prevent those clicks from adding dashboard global filters.|
||Specifies a caption for the gallery specified below in the Gallery File attribute. This caption appears in the list of galleries in the Add Panels pop-up panel.|
Specifies the fully-qualified file path and name of an XML file where charts and tables created by users at runtime using an Analysis Grid can be accessed for use in the dashboard. This file is independent of the dashboard's Save File, allowing the visualizations to be
shared and used by multiple dashboards. For example, the attribute value might be:
When a Gallery File is specified here, do not add Panel child elements under the Dashboard element. A Gallery File is created by using an Analysis Grid with a Custom Dashboard Panels element. The latter element's Dashboard Save File attribute is set to the name of an XML file that becomes the Gallery File. This file will be created and updated as the user adds visualizations in the Analysis Grid. Gallery files can also be stored in a database, see Introducing Bookmarks.
|Save File Starter||Specifies a file to be used as the initial Save File in cases when the Save File does not exist yet. For example, when the Save File is different for each user, the Save File Starter file can include a set of default tabs and panels. See the Creating a Default Panel Arrangement section for more information.|
Template Modifier File
The name of the template modifier file, if any. See section below for more information about template modifiers. The template modifier file can be in any folder accessible to the web application; if a fully-qualified file path is not provided in this attribute value, then the application expects it to be is your project's _SupportFiles folder.
The dashboard Panel element is simply a required container for the other child elements and multiple panel elements are generally used to create a dashboard.
If specifying a Gallery File in the Dashboard element attributes do not use Panel elements. See the Attributes table above for more information.
The presence of Panel elements means simply that the panels are available, but they will not be displayed in the dashboard unless configured through the dashboard configuration page to be visible. The Panel element has these attributes:
|Caption||(Required) Specifies the text displayed in the panel's title bar, and used as a title in the dashboard configuration page.|
|ID||(Required) Specifies a unique identifier for this element.|
|Allow Caption Rename||Specifies if the user is allowed to change the dashboard panel caption. When True, the "Rename" item appears in the panel Settings menu. When selected, the caption can be edited in place then saved by pressing Enter or clicking outside of the text box. The default value is True.|
|Image||Specifies the file name of a thumbnail image that will appear on the left side of the Add Panels panel. For the best appearance, images should be less than 200 pixels wide. The image name can come from an image in the _SupportFiles folder or from a relative URL within the same Logi application.|
|Minimum Height||When the dashboard has been configured for Free-form Layout, specifies the minimum height, in pixels, to which a panel can be resized. The default value, if left blank, is 100 pixels.|
|Minimum Width||When the dashboard has been configured for Free-form Layout, specifies the minimum width, in pixels, to which a panel can be resized. The default value, if left blank, is 100 pixels.|
Specifies whether multiple instances of a panel can be added to a dashboard. When set to True, the dashboard panel can be added multiple times to the same dashboard or tab. This is especially useful for panels that have input parameters because the user can show different versions of the same panel with different parameters in the same dashboard or tab.
|Panel Description||Specifies the descriptive text for this panel that appears in the Add Panels panel.|
|Security Right ID||If entered, controls access to this element via Logi security. Supply the ID of a Right defined in the application's settings/security section. Only users that have a Role referenced in the Right will be able to see the element. (Be careful - when the Right is not defined in the settings, the element is visible.) Multiple Right IDs, separated by commas may be entered. In this case, the user will see the element if he has access to any one of the Rights.|
|Tooltip||Text that appears in a small balloon when the user hovers his mouse pointer over the panel's Title Bar.|
The Panel Content element is the first child element of a dashboard panel. This element is a container for the actual content to be displayed. Its only attribute, Height, is optional and used to set a fixed panel height. When left blank, the height is resized automatically to fit the contents. If a fixed height is set, a vertical scroll-bar appears when necessary if the content's height is greater than the fixed height specified.
As shown above, left, content can be included as a sub-report, or be included directly in the Panel Content element or, as shown above, right.
Inclusion of content as a sub-report, especially if there are many panels, is a very desirable approach: it keeps the main definition containing the dashboard from becoming overly long and complex and allows panel content to be developed and tested independently before being integrated into the dashboard. In addition, if you plan to export panel content, we highly recommend that you use sub-reports.
Dashboard panels are processed in separate threads at the web server, resulting in improved performance, especially for dashboards with large numbers of panels. Each Panel Content element is an individual reporting environment and, as such, can have its own Default Request Parameters element, Local Data element, etc. If necessary, panels can be identified with the token @Function.InstanceID~. The Load Panels Plugin Call element allows developers to use a plug-in to access the underlying definition code for a dashboard panel.
A dashboard can consist of a single collection of panels (a base page) or a series of tabbed pages, each with its own collection of panels. If a dashboard has been configured to be adjustable and to have tabs, then users can add, remove, and rearrange the tabs at runtime.
In the example above, the Dashboard element's attributes have been set to make it adjustable and to have tabs.
A dashboard with tabs will have one tab created by default. In the example shown above, an additional dashboard tab has been added. Tabs can be dragged with the mouse to rearrange them, as shown above.
Adjustable dashboards display this Gear icon on the selected tab; click the icon to configure their settings. To add a new tab to the dashboard, click the Plus Sign icon, as indicated above.
A tab's Settings pop-up menu, shown above, appears when its Gear icon is clicked and allows you to add panels to the tab, change the number of columns being used in the tab, to rename the tab, and to remove the tab.
Given that users can potentially customize a dashboard at runtime, it's useful to be able to save those customizations for future use. There are several ways to do this.
The Save File is an XML file that stores a record of the dashboard changes users make at runtime. Its data is associated internally with IDs for the dashboard and panels used to create it.
The Dashboard element's Save File attribute specifies a fully-qualified path and file name, as shown above, for the Save File. Tokens may be used in the path and file name. This creates the opportunity for reusing an individual user's configuration for their next session through the use of Logi Security, or a GUID-and-cookie scheme, tying the user name to the Safe File. For example:
In the examples shown above, a special folder "SavedDash" has been created by the developer in the application folder to hold dashboard Save Files and is shown
as part of the Save File path. (Extra spaces in the examples are just there for reading clarity).
A Gallery File contains the same data as a Save File and its attribute accepts the same values and tokens. However, unlike a Save File, it's not associated internally with a specific dashboard and its panels. Instead, it's created using an Analysis Grid and can be copied, moved, and shared between Logi applications and users, providing an independent collection of visualizations as a resource.
The Extra Gallery File element, a child of the Dashboard element, allows you to specify additional gallery files. When multiple gallery files have been specified and the user is adding panels to a dashboard, he'll be able to select them from different visual galleries.
The general Logi Info development rule that elements requiring an element ID be given unique IDs is very important when dealing with Extra Gallery Files. For example, if a dashboard and a gallery file both refer to dashboard panels that have the same element ID, an "duplicate panel" error will occur.
How are extra gallery files useful? Imagine a scenario in which a gallery file of pre-configured "standard" panels is created and then shared with all users as an extra gallery file. They could then build dashboards using panels from this standard gallery and/or from their personal gallery.
The Extra Gallery File element, shown above, requires a fully-qualified file path and name, with .xml extension, to the file. Other optional attributes allow you to specify whether users can modify the panels in the gallery (Disable Gallery Update) and specify the name
that will appear in the list of gallery choices (Gallery Caption) that will appear in the Add Panels pop-up panel.
The element also has a Security Right ID attribute, so access
to gallery files can be controlled using security rights. Multiple Extra Gallery File elements may be used.
Using a Report Definition as an Extra Gallery File
There's also another interesting way to share gallery visualizations: the Extra Gallery File element's Gallery File attribute can be configured to point to a regular Logi report definition (.lgx) file. If that definition file includes a Dashboard element with child Panel elements containing visualizations, the application will locate those panels in the definition and also make them available in the Visual Gallery.
Do not use definitions with Panels that get their data using linked datalayers as Extra Gallery Files. Linked datalayers used to create the content of Panel elements in this scenario are not recognized and the content will not be available. If possible, replace the linked datalayers with regular datalayers in order to make definitions work as Extra Gallery Files.
A Bookmark for a report page that includes a dashboard, when created manually using Action.Add Bookmark, stores Request and Session variables and a reference to the dashboard's Save File. It does not contain the dashboard configuration data itself. For more information, see Introducing Bookmarks.
Manual bookmarks can be created independently of updates to the dashboard configuration (and, therefore, updates to the Save File). So running a bookmark for a page containing a dashboard may not necessarily reproduce the dashboard configuration that existed at the time the bookmark was created.
Automatic Bookmarks (see Introducing Bookmarks), created using the Auto Bookmark element, on the other hand, will automatically create a bookmark and the bookmark equivalent of a Save File whenever the dashboard configuration is changed, giving you the best of both worlds. Do not specify a Save File value when using this child element.
When Automatic Bookmarks are in use, Undo and Redo icons will appear beside the tabs, as shown above. You can also store your Bookmarks, Save files, and Gallery files in a SQL database. See Introducing Bookmarks for more information.
You may want all of your users to start using the dashboard with the exact same, pre-defined tab and panel arrangement. A default tab and panel arrangement can be saved for later use by working with the Dashboard element attributes Save File and Save File Starter. As mentioned earlier, the "Save" file specified in the Save File attribute value is created automatically the first time the user changes the dashboard configuration. It records any configuration changes a user makes to the dashboard, such as which panels are included, panel arrangement, and tabs. When the user returns to use the dashboard in a subsequent session, this file is used to automatically configure the dashboard. As mentioned earlier, this file can be identified on a per-user basis, providing each user with their own personal arrangement every time they use the dashboard. If a file is specified in the Save FileStarter attribute, and no Save File has been created yet (because this is the first time the user is using the dashboard), then the Save File Starter file will provide the initial dashboard configuration. This allows each user to begin with a standard initial dashboard configuration. Follow these steps to create a default panel and tab arrangement:
- Create your dashboard and panels in Logi Studio, as usual.
- Configure the Dashboard element's Save File attribute with a value that will create a separate file for each user, as discussed earlier and shown above. The example above demonstrates the use of tokens in the value and assumes Logi Security is in use.
- Run the application and, in your browser, create and arrange the tabs, panels, and panel parameters (if any) desired for your default arrangement. Close your browser.
- In the file system, find the Save file that was just created during your session, and copy it to the _SupportFiles folder. Rename the copy using an arbitrary but meaningful name, such as DashDefaultLayout.xml.
- Back in Studio, configure the Dashboard element's Save File Starter attribute with the complete path and file name of your renamed Save file copy, as shown above.
All first-time users will now see the default dashboard arrangement, and any customizations they're allowed to make will be saved for their next session.
The Analysis Filter super-element can be used with dashboard panels to provide individual panel or global data filtering. Global filtering allows all visualizations in a dashboard tab that use similar data to be updated based on a single filter the user can adjust at runtime. Two related Dashboard element attributes, Auto Global Filters and Auto Panel Filters, are available. They're used when dashboard panels are included that were saved from an Analysis Grid that used the Active Query Builder. Filters can be created based on the metadata for the panel data. Detailed information about this element, including how to implement it in dashboard panels, is available in The Analysis Filter.
It's often desirable to let users change dashboard report criteria at runtime. This can be done using user input elements that are included within the panel content definition, or by using the Panel Parameters element, which allows the data entry feature to be de-coupled from the panel content.
In this way, user input elements are placed into a special pop-up panel. This approach is useful as it prevents user
input controls from permanently taking up valuable screen real estate.
The images above illustrate how the Panel Parameters element is used in a report definition and how it looks on the screen. Notice the Gear icon in the upper right hand corner of the panel images:
- Click the Gear icon to display the Settings menu.
- Click the Edit item to get the Panel Parameters panel to pop-up.
- Select or change the user input controls as desired. Click Done to close the panel, write the user input values to the Save File (discussed earlier) and refresh the panel's content using the new values.
- Or, click X to close the panel. If the Panel Parameter element's Refresh For Cancel attribute is True, the dashboard panel will be refreshed using the original values (i.e. no change); if the attribute is False (the default), the new values are used.
The next time the application is run, the user input values are retrieved from the Save File and presented to the Panel as @Request variables. This allows the content definition to use them, for example, by embedding @Request.variable~ tokens in a DataLayer.SQL statement. Note that, if you're using a sub-report for your content, you will need to pass these Request variables to it, using Link Parameters.
Dashboards are often used to display time-sensitive or transactional data and it's very useful to be able to update the dashboard panel contents periodically and automatically. This can be accomplished using the Refresh Element Timer element. This element uses AJAX techniques to automatically refresh one or more elements in a panel's content using an adjustable time interval.
The attributes for this element (all required) include:
- Element ID - Specifies the ID of the element that you want to periodically refresh. Multiple IDs, separated by commas, can be entered but the scope of each timer element is limited to its own panel. Multiple elements can also be refreshed by placing them under a Division element and specifying the Division element ID here. Do not specify elements that are children of Data Table elements (datalayers, columns, etc.)
- ID - Specifies a unique element ID for this element.
- Refresh Interval - Specifies the amount of time, in seconds, between refreshes of the element specified in Element ID. Use caution when specifying a very short interval if a large number of users will access this dashboard: database server performance could be seriously impacted.
When there's a data table in the report being refreshed and it has Interactive Paging or Sorting elements, set the Data Table element's AjaxPaging attribute to True.
The Refresh Element Timer element works by re-running the panel's report with just those elements that are to be refreshed. The report runs using request parameters from 1) Input elements on the report, 2) LinkParams and 3) URL request parameters when Request Forwarding = True.
When debugging has been turned on for an application, you can view debug information generated for each Refresh Element Timer request. These appear as additional links at the bottom of the Debug Trace page. For more information, see Debug Reports.
The Action.Add Dashboard Panel element, used in other definitions with elements like data tables and Analysis Grids, adds specified content to a new dashboard panel
which is added to a specified dashboard. A bookmark for the content can optionally be created by adding a
Bookmark Linkback element beneath this action element.
Essentially the element works by allowing the developer to specify all of the necessary content in the current report that will be copied into the new dashboard panel. This includes the properties of the panel itself and any relevant parameters. On execution at runtime, the report definition containing the specified dashboard, and its supporting files, are edited to include the new dashboard panel and its content.
At runtime, when a user clicks on this element's parent element (Button, Label, Image, Event Handler, or Popup Option), a pop-up panel, shown above, is displayed soliciting a title and a description for the new
Dashboard Panel, which is used in the Dashboard Configuration Page. Optional attributes allow default information, and a thumbnail image, to be specified by the developer.
Reports often include input elements that allow users to filter the displayed data at runtime.
Action.Add Dashboard Panel includes a mechanism for copying these elements into the new dashboard panel as Panel Parameters, as shown above. The Add Panel Params Element ID attribute allows you to specify the IDs of the elements to be added as parameters.
You can specify the ID of a Division or other container element and all of its contents will be added to the panel parameters, with the exception of any elements specified in the Add Panels Skip Element IDs attribute. This allows you to exclude, for example, a Submit button that's in a Div, along with Input elements, in the current report but which won't be needed in the dashboard parameters panel (which has its own Done button).
In anticipation of the need at runtime to "pass along" some tokens (i.e. don't resolve them now) associated with the new content into the new dashboard panel (where they will be resolved when the dashboard definition is run), a special token handling scheme has been provided:
- In general, @Function tokens will not be resolved, but will be passed along with the content into the panel for resolution when the panel is viewed. This was done in anticipation that these tokens will most likely be used to provide date/time- or user-related information.
- @Local tokens, specified by the developer in the Add Panel Local Data IDs attribute, will not be resolved and will be passed along. Multiple tokens can be entered in a comma-separated list. Tokens not listed will be resolved before the panel is created.
- @Request tokens, specified by the developer in the Add Panel Request IDs attribute, will not be resolved and will be passed along. Multiple tokens can be entered in a comma-separated list. Tokens not listed will be resolved before the panel is created.
- @Session tokens, specified by the developer in the Add Panel Session IDs attribute, will not be resolved and will be passed along. Multiple tokens can be entered in a comma-separated list. Tokens not listed will be resolved before the panel is created.
If a value is entered in the Add Panel Security Right ID attribute, access to the resulting dashboard panel access can be controlled with Logi Security. This value should be ID of a security Right defined in the application's _Settings definition, under the Security element. This value is written into the panel's Security Right ID attribute and, with Logi Security enabled, only users with that Right will be able to see the new dashboard panel. Note these two special conditions:
- When user rights come from Right From Role elements under the SecurityUser Rights elements, and this element's Security Right ID does not match any of the Right IDs defined in the Settings definition, then the user does have access.
- But when rights are instead derived from Rights From DataLayer or Rights From Roles elements, and the user does not have a matching Right, then the user does not have access.
Multiple Right IDs can be entered in a comma-separated list. The user will see the dashboard panel if he has any one of the Rights.
The Action.Add Dashboard Panel element has the following attributes:
|Add Panel Content Element ID||(Required) Specifies the ID of the element that will be added to the new dashboard panel. Only one ID is valid, multiple IDs are not allowed. However, you can specify the ID of a Division or similar container element and all of its contents will be added to the new panel.|
|Dashboard Save File||(Required) Specifies the dashboard that will become the parent of the new dashboard panel. Provide a fully-qualified web server file path and file name, with .xml extension, for the target dashboard's existing Save File. Hint: This can be copied directly from the dashboard's Save File attribute.|
|ID||(Required) Specifies a unique element identifier.|
|Add Panel Button Caption||Specifies the text inside the button, in the popup panel, that triggers the addition of the target content as a new panel in the specified Dashboard. Default: Add to Dashboard|
|Add Panel Content Height||Specifies the height of the new dashboard panel content, in pixels.|
|Add Panel Description||Specifies the new panel's default description, which will appear in the Dashboard Configuration Page. Users can change this text prior to executing the process.|
Add Panel Local IDs||
Specifies @Local token IDs whose values should be passed into the Dashboard panel. Token IDs listed here are normally saved in the Panel in a Local Data element with a static datalayer. In this way, when the dashboard is run, the @Local tokens get replaced with the same values from when the panel was added.|
To have the Local Data datalayer re-run when the dashboard is run, set the Add Panel Local Data IDs attribute to the ID of the Local Data element. In this way, the @Local values can change over time.
@Local IDs listed will remain in the panel to be resolved by the Local Data defined either in the Dashboard or copied to the Dashboard panel via the Add Panel Local Data IDs attribute.
Multiple token IDs can be entered as a comma-separated list.
|Add Panel Local Data IDs||Specifies the element IDs of Local Data elements to be copied into the Dashboard panel. The Local Data datalayers will be run when the Dashboard is run, replacing @Local tokens. Multiple Local Data IDs can be entered in a comma-separated list.|
|Add Panel Params Element ID||Specifies the ID of the element in the current definition that will be added to the new panel's child Dashboard Panel Parameters element. This is used to include Input elements and supporting data in the panel, accessible using the panel's Edit button. This can be the ID of a Division or other container element, causing all of its child elements to be included. Some of those child elements can be excluded by specifying their IDs individually in the Add Panel Skip Element IDs attribute.|
|Add Panel Popup Caption||Specifies the title text shown in the popup panel displayed when the user clicks the Action.Add to Dashboard Panel element's parent element.|
|Add Panel Request IDs||Specifies the IDs of @Request tokens that will be passed along, unresolved, to the new panel. These tokens will be resolved in the new panel's Default Request Params or Dashboard Panel Parameters. @Request tokens not listed here will be resolved when the panel gets saved into the dashboard. Multiple token IDs can be entered as a comma-separated list.|
|Add Panel Security Right ID||Specifies the security Rights a user must have in order to access the new dashboard panel. Multiple Right IDs can be entered as a comma-separated list. Please see the Security section above for special conditions.|
|Add Panel Session IDs||Specifies the @Session token IDs that will be passed along, unresolved, to the new panel. @Session tokens not listed here will be resolved when the panel gets saved into the dashboard. Multiple token IDs can be entered as a comma-separated list.|
|Add Panel Skip Element IDs||Specifies the ID of one or more child elements of the element named in Add Panel Params Element ID that will be excluded from being added to the new Dashboard Panel Parameters. Multiple element IDs can be entered as a comma-separated list.|
|Add Panel Title||Specifies the new dashboard panel's default caption. Users can change this text prior to executing the process.|
|Image||Specifies the file name of an image that will appear on the left side of the Add Panels section of the Dashboard Configuration page. For the best appearance, images should be less than 200 pixels wide. The file name can be selected from a list of the images in the _SupportFiles folder or be entered manually as a relative URL to a file within the same Logi application. URLs to external sites or applications are not valid.|
|Multiple Instances||Specifies whether or not the new dashboard panel can be added multiple times to the same dashboard or dashboard tab. Default: False|
|Security Right ID||Specifies the security Rights a user must have in order to use this Action element. Users without Rights that match Rights specified here will not be able to execute the action. Multiple Right IDs can be entered as a comma-separated list.|
With Bookmark Linkback
The optional Bookmark Linkback element can be added as a child of Action.Add Dashboard Panel:
As shown above, once you include the element and configure a few attributes, it will automatically add a link to the new dashboard panel which will run the target content with the request variables that were used in the original report. You must provide the name for the Bookmark Collection (usually associated with a user) and provide a Caption, which is the text that appears as the bookmark link in the new dashboard panel. You can optionally decide to "run" the bookmark in a new window or selected window. For more information about this feature, see Introducing Bookmarks.
Dashboard appearance can be changed most easily by applying a
theme to the report definition. Most of the screen shots in this
document were taken with the Signal theme applied.
You can create your own custom theme, based on a standard theme, using the Theme Editor tool.
Changing Appearance Using Style Classes
Dashboard appearance can also be customized using style classes and Logi Studio provides the following standard style sheet for all dashboards:
Developers can override classes in this style sheet by copying them into their own application style sheet and modifying them there.
Do not make changes in the standard style sheet in the rdTemplate folder! Note that, if you're using a Theme, it will override some of the Dashboard classes.
As shown above, to ensure that style classes cascade correctly, in your report definition your Style element should be lower in the element tree than the Dashboard element (the Style Sheet element has to be processed after the Dashboard element in order to override the default classes). Here are some examples of specific classes, with their default values, that can be overridden by adding them to your project style sheet and then setting additional elements:
Change font size of all panel captions:
Change pop-up parameters panel caption:
Change color of the pop-up parameters panel "Done" button text:
Many of the class names needed to override dashboard styling can be discovered by using your browser's development tools (press F12 in many browsers).
Changing Appearance Using Template Modifiers
The Dashboard element uses a "template file" to define certain element properties that are not otherwise available as attributes to the developer for modification. These include language- and culture-specific Caption attributes that you may want to change for locale-based reasons (or you may simply want to change the captions to better suit your application). The Dashboard element's Template Modifier File attribute identifies a custom XML file developers can create containing elements that will override the same elements in the template file. For example, the Dashboard template file:
contains several Label elements. One of them has an ID = "lblAddPanelsTitle"; this controls the title in the Add Panels selection list (shown earlier). The title for that selection list can be modified by changing the Caption associated with that Label element.
To change the title from its default "Add Panels" to "Add New Dashboard Panels", create your own XML file, identify it in the Template Modifier File attribute, and add this code to it:
<SetAttribute ID="lblAddPanelsTitle" Caption="Add New Dashboard Panels" />
You can set the attributes for any number of elements in this file; examine the rdDashboard2Template.lgx file to learn the ID and Caption attributes available. The template modifier file can be in any folder accessible to the web application; if a fully-qualified file path is not provided in the Template Modifier File attribute value, then the application expects it to be is your project's _SupportFiles folder. More detailed information about template modifier files can be found in Template Modifier Files.