Auto Refresh Widget |

Home » Support » Dashboard Widgets » Auto Refresh Widget

Purpose

The Auto Refresh Widget allows you to specify a period of time after which ALL widgets on the dashboard (including all portals on the dashboard) you use it on will be refreshed. You may specify any number of minutes and/or seconds. This portlet may help those who wish to configure a portal and then project that or use a large monitor where team members can easily see it. The portlet will keep the information up-to-date without further intervention.

Screenshots

You may specify any number of minutes and seconds for the refresh period.

Refresh set to: 2:29 - 1 minutes and 11 seconds left until page refreshes

The countdown is displayed in the status bar.

Installation

Note: This version will only work with Bugs Dashboard v3.2 and up due to the use of the parameter to restrict this portlet to a loginName.

To use the AutoRefresh Widget do the following:

Copy the AutoRefresh.class file at com/wmpnj/bugz/portlets into the deployed web application directory; i.e. /webapps/bugs/WEB-INF/classes/com/wmpnj/bugz/portlets. This may require that you also copy the directory “portlets” if this is the first portlet you are deploying.
Copy the refresh.js file to the deployed web application javascript directory; i.e. /webapps/bugs/javascript.
Update the dwr.xml file in the deployed web application WEB-INF directory; i.e. /webapps/bugs/WEB-INF. Edit the file with a text editor and add the following after the last </create> statement:
```
<create creator="new" javascript="Auto_Refresh">
  <param name="class" value="com.wmpnj.bugz.portlets.AutoRefresh" />
</create>
```
Update the portlets.properties file in the deployed web application classes directory; i.e. /webapps/bugs/WEB-INF/classes:
- Update the first line by incrementing the count of portlets by 1
- Add the following in the position that you want the portlet to appear within your desired column. For example, if you want the AutoRefresh to appear at the top of the right-most column, you must insert this ahead of any other portlet whose column is “2″ on a 3-column portal. After adding the following block, you MUST then renumber the portlets appropriately, beginning with 0, i.e. “portlet0″, “portlet1″.
```
portlet5.title=Auto Refresh
portlet5.column=2
portlet5.package=com.wmpnj.bugz.portlets.AutoRefresh
portlet5.className=Refresh
portlet5.method=getText portlet5.stylesheet=
portlet5.javascript=refresh.js
portlet5.desc=This portlet allows you to set the number of minutes and/or seconds after which ALL portlets on the page will be refreshed.
portlet5.call=
portlet5.restrictTo=
```

You may change the title and column, but do NOT change the package, className, or method!

NOTES:

A refresh call may have an effect you don’t expect. For example, if you use the SVNLog portlet, and you have not yet searched the log, a refresh call to it will read an empty search string and return all rows from the log in the repository appearing in the dropdown list.
If you lose your connection to the server, the countdown will continue as it occurs at the browser. At the time the countdown reaches zero, it will fire the refresh event for each portlet. When the portlets fire again, they may well raise an alert because the server is unavailable. This can result in multiple alert dialogs which must be dismissed.

Download

AutoRefresh.zip