Element Details: Action.Add+Dashboard+Panel
 Back


Available in: Logi Info Source code name: Action.AddDashboardPanelIntroduced in: v11.0.727

The Action.Add Dashboard Panel element adds the targeted content in a new Panel to a specified Dashboard. A bookmark for the content can be created by adding a Bookmark Linkback element beneath this action.

When a user clicks on this element's parent at runtime, a pop-up panel is displayed soliciting a title and a description for the new Panel.

Except for @Function tokens and @Request tokens listed in the AddPanelRequestIDs attribute, tokens are resolved and saved in the panel. @Function tokens will be left intact in the new Panel, to be resolved when the Panel runs, as they're most likely to be related to the date/time or the current user.

The Image attribute specifies the thumbnail image that appears for the new Panel in the Dashboard Configuration page. For the best appearance, the image should be less than 200 pixels wide.

Element Group:Links



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
AddPanelButtonCaption
UserDefined
This value specifies the text inside the button that triggers the addition of the target content as a new panel in the specified Dashboard.
AddPanelContentElementID
UserDefined
(Required) This value specifies the ID of the element that will be added to the new Dashboard Panel. Only one ID is valid here; the value may not be a comma-delimited list of IDs.
AddPanelContentHeight
UserDefined
This value specifies the height of the new Dashboard Panel content, in pixels.
AddPanelDescription
UserDefined
This value specifies the new Panel's description, which will appear in the Dashboard Configuration page.
AddPanelLocalDataIDs
UserDefined
This value specifies the @Local token IDs that need their values carried into the Dashboard panel @Local token IDs listed here are normally saved in the Panel in a LocalData element with a Static DataLayer. 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 LocalData DataLayer re-run when the dashboard is run, set AddPanelLocalDataLayerIDs attribute with the ID of the LocalData element. This way, the @Local values can change over time. @Local IDs listed will remain in the panel to be resolved by LocalData defined either in the Dashboard or copied to the Dashboard panel with the AddPanelLocalDataLayerIDs ("Add Panel LocalData IDs") attribute. Multiple token IDs can be specified by entering as a comma-separated list.
AddPanelLocalDataLayerIDs
UserDefined
This value specifies the IDs of LocalData elements to be copied into the the Dashboard panel. The LocalData DataLayers get run when the Dashboard is run, replacing @Local tokens. Multiple LocalData IDs can be specified by entering as a comma-separated list.
AddPanelParamsElementID
UserDefined
This value specifies the ID of the element that will be added to the new Dashboard Panel Parameters.
AddPanelPopupCaption
UserDefined
This value specifies the title text shown for the Add to Dashboard Popup Panel.
AddPanelRequestIDs
UserDefined
This value specifies the @Request token IDs that need their values to be carried into the Dashboard panel. @Request token IDs listed get saved in the Panel in a DefaultRequestParams element. Multiple token IDs can be specified by entering as a comma-separated list.
AddPanelSecurityRightID
UserDefined
When entered, access to the Panel can be controlled with Logi security. Supply the ID of a right defined in the applications settings’ Security element. Only users that have a right in the SecurityRightID will be able to see the element. Note that when rights come from RightFromRole elements under Security/UserRights, and this element's SecurityRightID does NOT match any of the Right IDs defined in the Settings definition, then the user DOES have access. But when Right IDs are instead derived from RightsFromDataLayer or RightsFromRoles elements, and the user DOES NOT have a matching Right, then the user DOES NOT have access. You can enter multiple right IDs, separated by commas. In this case, the user sees the element if he has any one of the Rights.
AddPanelSessionIDs
UserDefined
This value specifies the Session tokens IDs that need to be carried along with the Dashboard panel. Multiple token IDs can be specified by entering as a comma-separated list.
AddPanelSkipElementIDs
UserDefined
This value specifies the ID of one or more elements that will be excluded from being added to the new Dashboard Panel Parameters. Multiple elements can be specified by entering IDs as a comma-separated list.
AddPanelTitle
UserDefined
This value specifies the new Panel's title.
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.
DashboardSaveFile
UserDefined
(Required) Identifies the dashboard to be modified by the Custom Dashboard Panels element. 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. Dashboard file information may be stored in a relational database. See the Settings FileToDatabaseMapping element.
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.
Image
UserDefined
An image filename. The name can come from the images in the support files, or a relative URL within the same web application, or, for IndicatorState elements, a complete file system path.
MultipleInstances
True
False
When 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. Note: To prevent duplicate ID attributes in the HTML output, MultipleInstances automatically appends a unqiue string to many IDs.
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.
SecurityRightID
UserDefined
When entered, access to this element can be controlled with Logi security. Supply the ID of a right defined in the applications settings’ Security element. Only users that have a right in the SecurityRightID will be able to see the element. Note that when rights come from RightFromRole elements under Security/UserRights, and this element's SecurityRightID does NOT match any of the Right IDs defined in the Settings definition, then the user DOES have access. But when Right IDs are instead derived from RightsFromDataLayer or RightsFromRoles elements, and the user DOES NOT have a matching Right, then the user DOES NOT have access. You can enter multiple right IDs, separated by commas. In this case, the user sees the element if he has any one of the Rights.



PARENT ELEMENTS

Click element to drill down for more information.

Button
Division
Event Handler
HTML Tag
Image
Label
Menu Leaf
Popup Option


CHILD ELEMENTS

Click element to drill down for more information.

Bookmark Linkback


 Back to top


 Chart Debug