Real-time data dashboard refreshes regularly

1.1 Expected effect

Users who use FineBI real-time data directly connected to the database often use FineBI dashboards as large screen displays, so they often need to refresh the dashboards on a regular basis. FineBI provides the ability to implement the dashboard refresh on a regular basis, enabling automatic refreshing of single dashboards, multiple dashboard panels and individual components.

• The dashboard is refreshed at regular intervals, as shown in the following figure.

• The single component timed refresh effect, as shown below.

1.2 Implementation idea

1）Creating JS files.

2）Place the created refresh.js file in the FineBI installation directory %FineBI%/webapps/webroot.

3）Call the JS file.

1.3 Other Programs

If this article does not meet the needs, you can contact technical support to get BI Preview Auto Refresh Template Plugin (QQ: 800049425).

2.1 Create JS file

1）The timed refresh of the dashboard is implemented with custom JS, copy the following code to create the  refresh.js  file.

setTimeout(function () {
 var b =document.title;
 var a =BI.designConfigure.reportId;//get dashboard id
 //Determine the dashboard id to achieve the specified dashboard refresh
 if (a=="7193a5c87fbb4915b8893e07a0c6759c") {
  setInterval(function () {
   BI.SharingPool.put("controlFilters", BI.Utils.getControlCalculations());
   //Data.SharingPool.put("controlFilters", BI.Utils.getControlCalculations());
   BI.Utils.broadcastAllWidgets2Refresh(true);
  }, 5000000);//5000000is the frequency of regular refresh, unitms
 }
}, 2000)

In the judgment of the dashboard ID, you need to modify the judgment condition to the dashboard ID you need to refresh; and 5000000 is the interval time of regular refresh, in milliseconds, modified according to your needs, usually should be greater than 300000.

2）Modify the interval between scheduled JS file refreshes.

• If the data is not updated every second. It is recommended that JS set the refresh time higher than 5 minutes, i.e. the interval between scheduled refreshes should be greater than 300000.

Otherwise, it will cause problems such as downtime and a spike in memory usage, and since the project has a 5-minute cache time, the cache is read all the time during these 5 minutes, so when the refresh interval is less than 5 minutes, the data may not change.

• If you want to set the refresh time in seconds. You need to turn off caching to circumvent the 5-minute cache time while turning on live data.

Administrators can close the corresponding button in "Manage > System > BI Parameters > Cache Setting" and "Save" to take effect, the setting path is shown below.

3）Get the dashboard ID and modify the JS file dashboard ID.

The dashboard ID can be obtained directly from the link address when editing the dashboard, for example, the link address when creating a new dashboard is 

http://localhost:37799/webroot/decision/v5/design/report/7193a5c87fbb4915b8893e07a0c6759c/edit. The dashboard ID is ID 7193a5c87fbb4915b8893e07a0c6759c, as shown in the following figure.

After getting it, change a=="dashboard ID" in the Judgment ID.

4）Close FineBI.

5）Place the created refresh.js  file in the FineBI installation directory %FineBI%/webapps/webroot as shown below.

2.2 Call JS files

1）Under the %FineBI%/webapps/webroot/WEB_INF/lib,  you can find show.html  in fine-bi-adapter-5.1.jar （ 5.1 version is fine-bi-adapter-5.1.jar ）

2）Insert the following code into that HTML file to call the previously created refresh.js  file, as shown in the following image.

<!-- Add refresh function --> 
<script type="text/javascript" src="/webroot/refresh.js"></script>

Insert the code location as shown below.

Save the changes to this JAR package when you are done.

2.3 Effect view

After the configuration is complete, launch FineBI and press F12 on this dashboard preview page to view the page source code to determine if the JS was loaded successfully. The dashboard successfully loads the JS for the timed refresh. As shown in the figure below.

Note: If you change the frequency in JS, you can clear the browser cache after you save the modified file, you don't need to restart FineBI. 

setTimeout(function () {
 var b =document.title; 
 var a =BI.designConfigure.reportId;//Get the dashboard id //Judgment on dashboard id to achieve specified template refresh
 if (a=="d5405b13bfeb454081be9627a9cfc97f" || a=="e1dcb1a61d6947e1adedced59bde9533") {  
 setInterval(function () { 
   BI.SharingPool.put("controlFilters", BI.Utils.getControlCalculations());   
   //Data.SharingPool.put("controlFilters", BI.Utils.getControlCalculations());  
    BI.Utils.broadcastAllWidgets2Refresh(true);  
    }, 5000000);//5000000 is the frequency of timer refresh, unit ms 
    }
    }, 2000);

If you look at the web source code of the dashboard, each dashboard adds JS for regular refreshing. See Section 2.3 of this chapter for details.