Prompt API - Auto refresh a report in the Browser / Web with a timed interval

Technote (FAQ)


Question

How can we autorefresh a report in IBM Cognos Prompt API with a time interval ?
It needs to work in the Browser / Web interfaces of Cognos Connection, the Portal Portlets and the Cognos Workspace.

Answer

NOTE : Any previous documentation using unsupported Javascript in the older versions before C10.2.x for refreshing a report in a timed manner, are obsolete for C10.2.x and higher.

This Javascript code is based on the Prompt API and is supported in IBM Cognos 10.2.x and later versions only.

Include the following JavaScript code in the HTML item in the report, it will automatically refresh the report for the defined interval.


<script>
(function(global){

var ocr = cognos.Report.getReport("_THIS_");
function sendPRMT_Request(eAction) {
ocr.sendRequest(eAction);
}
function sendFinishRequest() {
sendPRMT_Request(cognos.Report.Action.FINISH);
}
// This is the timeinterval
global.setInterval( function() { sendFinishRequest(); }, 5000 );
// for Auto Refresh 5000 is a value in milliseconds, ie 5 seconds here.
})(this);
</script>


Design comments :
Of course if your report is a large report and takes much longer than 5 seconds of run time , you need to take in account a much bigger value for Autorefresh in the Browser.

This sample of technology would not be recommended as best practice for use in long running reports , as these should be in effect Scheduled in IBM Cognos for user consumption.
Browser / Web operations are considered a more immediate operation , and users should not be put to wait for running reports , nor should portal or report "delay timers" be implemented.


Cross reference information
Segment Product Component Platform Version Edition
Business Analytics Cognos Analytics Report Authoring v11x AIX, HP-UX, Linux, Solaris, Windows 11.0 Edition Independent

Document information


More support for:

Cognos Business Intelligence
Software Development Kit

Software version:

10.2, 10.2.1, 10.2.2

Operating system(s):

AIX, HP-UX, Linux, Solaris, Windows

Software edition:

Edition Independent

Reference #:

1646893

Modified date:

2016-05-01

Translate my page

Content navigation