Skip to main content

Push changed rows to an Interactive Grid

For pushing changes from the database to the end user, the regular solution is using websockets. A change in a record is detected - using a trigger or using the CQN (Change Query Notification) feature - and a notification is send to a websocket server. That websocket server broadcasts the notification over a channel to all browsers that are tuned in to that websocket channel. Then the browser reacts to that notification, usually showing an alert or refreshing a report. This trick is described on multiple sites, just Google for "oracle apex websockets" or similar.

So back in the old days, we used that notification in the browser to refresh the (interactive) report. But along comes the Interactive Grid (IG). While he full-refresh mechanism still works for IG, an IG has also the option to refresh just one row. 
So wouldn't it be awesome that just the changed row(s) get refreshed upon a change in the database, instead of the whole report? Can we do it ... yes we can!

First in our "Execute when Page Loads" property we start listening to the websocket server when the page is loaded using:

window.addEventListener("load", init, false);

In the "Function and Global Variable Declaration" we add the actual code and the init function:

//The websocket server is set using an Application Item 
var wsUri = "&WSSERVER.";

function init() {
  websocket = new WebSocket(wsUri); 
  websocket.onopen = function(evt) { onOpen(evt) };
  websocket.onclose = function(evt) { onClose(evt) };
  websocket.onmessage = function(evt) { onMessage(evt) };
  websocket.onerror = function(evt) { onError(evt) };
}

// This is where the real magic happens
// onMessage is called when a message is received from the websocket server 
function onMessage(msg) {
  // msg is in JSON format, containing the ROWID of the changed record
  var rowid, 
      record, 
      records = [],
      json = JSON.parse( msg.data ),
      l = json.changes.length;  
  // "myGrid" is the Static ID of the IG region
  var myGrid = apex.region("myGrid").widget().interactiveGrid("getViews").grid;
  for ( var i = 0; i < l; i++){   
    rowid = json.changes[i].rowid ;
    // loop through all the rows, check if the rowid is present
    // forEach callback params : record, index, key
    myGrid.model.forEach( function(r, i, k){
      if ( $.inArray( rowid, r ) > -1 ) {
        record = myGrid.model.getRecord(k);
        if ( myGrid.model.getRecordMetadata(k).updated ){
          apex.message.alert("Record " + (i+1) + " is changed by another user and is requeried");
        }
        records.push( record );
      }
    });
  }
  // fetch the changed records
  if ( records.length > 0 ) {
    myGrid.model.fetchRecords(records);  
  }
}

// Addtional helper functions below
$(window).on("beforeunload", function(){
  websocket.close();
});  

function onOpen(evt) {
 apex.debug("Websocket opened on &WSSERVER.");
}

function onClose(evt) {
  apex.debug("Websocket closed");
}

function onError(evt) {
  apex.debug("Websocket Error");
  apex.debug(evt);
}

The key of the code above is that the records that are changed and are found on the current page are added to an array of records. And that array us used to fetch the records. If you inspect the network traffic that is going on, you can verify that only the changed records (in the screen shot below, three changed records) are fetched and shown on the screen.

The whole process works seamless for the user. If he made a change to a record that didn't get updated by someone else (or another process) than he can keep working on that, if he did make a change - and thus there is a conflict - he will get a notification. In our example the process didn't even show a progress spinner, but maybe that's because our queries are fast (it is not on EMP, but based on a view that references several tables and returns over 40,000 rows).

[Edit Jul 4 : I changed the code in a way that it is dependent on the DOM anymore, but only uses the model to determine whether there is a record to update]]
Post a Comment

Popular posts from this blog

Showing a success message after closing a modal dialog

APEX 5 comes with Modal Dialogs out of the box. Very neat. Especially for adding and changing data. And to minimise the number of time a user has to click, it could be useful to add a "Close Dialog" process after the actual data processing. When the data processing fails, the Dialog stays on top showing the error. When data processing runs fine, the Dialog is closed ... without any confirmation. And this might be scary for a shaky user.

So how can we provide the user some feedback? On Page 4 of the Sample Dialog Application you can see one solution: up on a Dialog Closed Event on the parent page it does a redirect to refresh the parent page appending the success message of the "Close Dialog" process. This has two drawbacks. First, it probably refreshes more than necessary. And second, if you're using multiple layers of dialogs (dialogs that open other dialogs) the message appears in the "parent dialog".
As an alternative you could follow these steps: 1…

A review of APEX World 2017 - Day 1

Last week the SS Rotterdam was the beautiful location of the largest gathering of APEX Developers worldwide. With around 380 (!) attendees a new high was set. And they came from all over the world : I spotted people from The Netherlands, Belgium, Switzerland, Austria, Croatia, Germany, Denmark, Norway, UK, Ireland and the USA. And I even might have missed one or two ….

The event started with a presentation by the “father of APEX”, Mike Hichwa, talking about "Oracle APEX Past, Present and Future”. Of course everyone is curious what the APEX future might bring: Friendly URL’s, automated testing, more JSON, concurrent APEX versions, third party Oauth 2 authentication (think Facebook, Google), APEX app diff and more, a lot more, REST capabilities. And now we have to wait for APEX 5.2 … and that might take a while! 
After this keynote, the conference split up in three tracks. After the coffee break I returned to to big theatre where Geertjan Wielenga talked about "Finally Javas…

It's happening again ... running for the ODTUG Board of Directors 😉

For the third time in a row I'll be running for ODTUG's Board of Directors. But after ending as a runner up twice, I am sure I'm going to make it this time! But not without your help!

My campaign statement this year is:
I have been attending and presenting at Kscope conferences since 2007. This not only resulted in a vast amount of knowledge, but also - and even more important - a huge number of friends from all over the globe.  I want to see ODTUG grow and spread this community feeling even more! 
My experience as an attendee, presenter and content lead has provided the basic foundation to be a director. Next to that, my personality and (global) network will be beneficial to the whole board and organization. 
Since March I have served on the Board of Directors in a limited term for a Director who stepped down due to a career change. This has allowed me to have unique insight of all the things that are going on in and around the ODTUG organization. As the train was already ro…