Difference between revisions of "Widgets"

From AgileApps Support Wiki
imported>Aeric
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Widgets enable you to quickly access and update information, including tasks, web sites, and custom objects.  
Widgets enable you to quickly access and update information, including tasks, web sites, and custom objects.  


==About Widgets==
{{Note| A user can add "up to 10 widgets in a Dashboard column.}}
Widgets are small windows available on a [[Home Page]] that let you view selected information. There are various types of widgets:
 
===About Widgets===
Widgets are small windows available on a [[Dashboard]] that let you view selected information. There are various types of widgets:
 
<blockquote>
<blockquote>
{{:Widget Types}}
{{:Widget Types}}
</blockquote>
</blockquote>


==Working with Widgets==
===Working with Widgets===
Widgets can be added and removed, reconfigured, minimized or maximized, and moved around on a home page.
Widgets can be added and removed, reconfigured, minimized or maximized, and moved around on a [[Dashboard]].


{{permissions|Manage Global Views/Reports|add/delete Widgets to a home page or modify its layout. In addition, any user who creates a home page can add, delete, and modify widgets on that page.}}
{{permissions|Manage Global Views/Reports|add/delete Widgets to a dashboard or modify its layout. In addition, any user who creates a dashboard can add, delete, and modify widgets on that page.}}


===Add Widget to your Home Page===
====Add Widget to a Dashboard====
The Add Widget option allows you to customize your [[Home Page]].
#Click '''[Add Widget]'''
To add a widget:
#Fill in the widget settings:
#Click the ''Add Widgets'' link.
#*'''Type -''' Select the Widget Type
#:[[File:HomePage-AddWidgetLink.jpg]]
#*'''Position -''' Specify the column it appears in
#The Add Widget page opens
#*'''Widget title -''' Give the Widget a title
#:[[Image:Addwidget.gif|none|thumb]]
#* Additional options - (Options vary, depending on the type of widget.)
#Select the Widget Type and complete the required fields. (Options will vary, depending on the type of widget selected.)


===Edit a Widget===
====Edit a Widget====
# In the [[Dashboard]], scroll to the widget of interest
# In the [[Dashboard]], scroll to the widget of interest
# Click the Wrench icon [[File:WrenchIcon.png|link=]] icon in the heading bar.  
# Click the wrench icon [[File:WrenchIcon.png|link=]] icon in the widget header.
# Specify your options. (The available options depend on the type of widget.)
# Specify your options. (The available options depend on the type of widget.)
# Click '''[Save]'''
# Click '''[Save]'''


===Move a Widget===
====Move a Widget====
Widgets can be moved from column to column, or moved up or down within a column. To move a widget, drag the header to a new position.
Widgets can be moved from column to column, or moved up or down within a column.
 
To move a widget, drag the header to a new position in the dashboard.
 
====Minimize a Widget====
To minimize a widget, click the Minimize icon in the widget header.
 
The widget remains minimized until you reopen it, or until your next login.
 
====Delete a Widget====
In the Widget header, click the "x" icon to delete the widget from the dashboard.<br>A confirmation dialog is displayed.
{{Important|<br>Deleted widgets are not stored in the Recycle bin, and cannot be recovered. Make sure you really want to delete the widget before confirming the action.}}
 
====Overview widget====
With the Overview widget, users can select an existing widget from the dashboard and display it on the overview page. This feature is particularly beneficial when users have access to multiple widgets, as it provides high-level metrics on the overview page for important or frequently accessed data. Currently, only one overview widget can be set, and it is displayed next to the Current application section.<br>
The Overview widget is user-specific and does not affect the overview page for other users. Additionally, this option is application-specific, enabling users to set overview widgets at the application level from their respective dashboards.
 
=====How to set the overview widget?=====
# Go to '''Dashboard'''.
# Navigate to the desired widget you wish to set as overview widget.
# Click on the widget header.
# Select '''View on Overview'''.
# The selected widget appears on the Overview page.
 
=====How to remove the overview widget?=====
User can remove the overview widget from Overview page and Dashboard page as well.<br>
Method 1:
# Go to '''Overview'''.
# Click '''⋮''' on the widget header.
# Select '''Remove from Overview'''.
# Click '''OK''' in the confirmation dialog.
# The overview widget will be removed.
<BR>
Method 2:<BR>
# Go to '''Dashboard'''.
# Navigate to the overview widget.
# Click '''⋮''' on the widget header.
# Select '''Remove from Overview'''.
# Click '''OK''' in the confirmation dialog.
# The overview widget will be removed.
{{Note| Removing the overview widget will not lead to the deletion of the report from the dashboard, only the widget on the Overview page will be removed.}}


===Minimize a Widget===
=====How to change the overview widget?=====
You can minimize selected widgets by clicking the Minimize button, located in the widget header bar. These widgets will remain minimized during the current session, but will open again at your next login.
# Go to '''Dashboard'''.
# Navigate to the desired widget you wish to set as overview widget.
# Click '''⋮''' on the widget header.  
# Select '''View on Overview'''.
# Click '''OK''' in the confirmation dialog.
# The selected widget appears on the Overview page.

Latest revision as of 12:25, 23 May 2024

Widgets enable you to quickly access and update information, including tasks, web sites, and custom objects.

Notepad.png

Note: A user can add "up to 10 widgets in a Dashboard column.

About Widgets

Widgets are small windows available on a Dashboard that let you view selected information. There are various types of widgets:

View

  • View-based widgets display data rows from the View you select
  • Choose the number of rows to display: 5, 10, 20, 50 or 100

Report

  • Report-based widgets display Charts, Table Data or both from the Report you select.
  • Choose the number of rows to display: 5, 10, 20, 50 or 100.
  • In the widget banner, click the document icon (DocumentIcon.png) to view the underlying report.

HTML

Add any HTML code for a fully custom widget.
Note: The one exception is a <form> tag.
Behind the scenes, the dashboard is one big form that submits a widget's new position to the server when you move it.
That way, the position is recorded for the next time you visit.
Since nested <form> tags do not work in HTML browsers, you can use any HTML except a <form> tag.
Enable HTML Sanitization

When this option is selected, it prevents XSS attacks by allowing you to use only the HTML tags and attributes listed in the table. When this option is not selected, all the HTML tags and attributes are allowed and XSS attacks are not prevented.

Allowed Tags

a, abbr, acronym, address, area, b, bdo, big,blockquote, br, button,body,caption, center, cite, code, col, colgroup, dl, dt, dd, del, dfn,dir, div, em, fieldset, font, form, h1, h2, h3, h4, h5, h6, hr, head, html, i, iframe,img, input, ins, kbd, label, legend, li, map, mark, menu, ol, optgroup, option, p,pre, q, s, samp, select, section, small, span, strike, strong, style, sub, sup, table, tbody,td, textarea, tfoot, th, thead, u, tr, tt, ul, var


Tags

Attributes Allowed
col, colgroup span, align, char, charoff, valign, width
abbr,acronym title
button type
p align
area alt,shape,coords,href
bdo bdl
dfn id, title
div style
img src,width,height,alt
label for, form
form accept, accept-charset, action, autocomplete, enctype, method ,name, novalidate, target
li type, value
input type, value, name
p title
optgroup label, disabled
textarea rows, columns
option label, disabled, selected, value
table border, bgcolor, style
font size, color, face
a class, id, href
tbody align
iframe width, height, src, frameborder
body bgcolor, link, text

Page

  • Display a JSP Page defined and stored on the platform.

Working with Widgets

Widgets can be added and removed, reconfigured, minimized or maximized, and moved around on a Dashboard.

Lock-tiny.gif

Users that have the Manage Global Views/Reports permission can add/delete Widgets to a dashboard or modify its layout. In addition, any user who creates a dashboard can add, delete, and modify widgets on that page. 

Add Widget to a Dashboard

  1. Click [Add Widget]
  2. Fill in the widget settings:
    • Type - Select the Widget Type
    • Position - Specify the column it appears in
    • Widget title - Give the Widget a title
    • Additional options - (Options vary, depending on the type of widget.)

Edit a Widget

  1. In the Dashboard, scroll to the widget of interest
  2. Click the wrench icon WrenchIcon.png icon in the widget header.
  3. Specify your options. (The available options depend on the type of widget.)
  4. Click [Save]

Move a Widget

Widgets can be moved from column to column, or moved up or down within a column.

To move a widget, drag the header to a new position in the dashboard.

Minimize a Widget

To minimize a widget, click the Minimize icon in the widget header.

The widget remains minimized until you reopen it, or until your next login.

Delete a Widget

In the Widget header, click the "x" icon to delete the widget from the dashboard.
A confirmation dialog is displayed.

Warn.png

Important:
Deleted widgets are not stored in the Recycle bin, and cannot be recovered. Make sure you really want to delete the widget before confirming the action.

Overview widget

With the Overview widget, users can select an existing widget from the dashboard and display it on the overview page. This feature is particularly beneficial when users have access to multiple widgets, as it provides high-level metrics on the overview page for important or frequently accessed data. Currently, only one overview widget can be set, and it is displayed next to the Current application section.
The Overview widget is user-specific and does not affect the overview page for other users. Additionally, this option is application-specific, enabling users to set overview widgets at the application level from their respective dashboards.

How to set the overview widget?
  1. Go to Dashboard.
  2. Navigate to the desired widget you wish to set as overview widget.
  3. Click on the widget header.
  4. Select View on Overview.
  5. The selected widget appears on the Overview page.
How to remove the overview widget?

User can remove the overview widget from Overview page and Dashboard page as well.
Method 1:

  1. Go to Overview.
  2. Click on the widget header.
  3. Select Remove from Overview.
  4. Click OK in the confirmation dialog.
  5. The overview widget will be removed.


Method 2:

  1. Go to Dashboard.
  2. Navigate to the overview widget.
  3. Click on the widget header.
  4. Select Remove from Overview.
  5. Click OK in the confirmation dialog.
  6. The overview widget will be removed.

Notepad.png

Note: Removing the overview widget will not lead to the deletion of the report from the dashboard, only the widget on the Overview page will be removed.

How to change the overview widget?
  1. Go to Dashboard.
  2. Navigate to the desired widget you wish to set as overview widget.
  3. Click on the widget header.
  4. Select View on Overview.
  5. Click OK in the confirmation dialog.
  6. The selected widget appears on the Overview page.