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

Refresh selected row(s) in an Interactive Grid

In my previous post I blogged about pushing changed rows from the dabatase into an Interactive Grid. The use case I'll cover right here is probably more common - and therefore more useful!

Until we had the IG, we showed the data in a report (Interactive or Classic). Changes to the data where made by popping up a form page, making changes, saving and refreshing the report upon closing the dialog. Or by clicking an icon / button / link in your report that makes some changes to the data (like changing a status) and ... refresh the report.  That all works fine, but the downsides are: The whole dataset is returned from the server to the client - again and again. And if your pagination size is large, that does lead to more and more network traffic, more interpretation by the browser and more waiting time for the end user.The "current record" might be out of focus after the refresh, especially by larger pagination sizes, as the first rows will be shown. Or (even worse) while you…

Dockerize your APEX development environment

Nowadays Docker is everywhere. It is one of the main components of Continuous Integration / Continuous Development environments. That alone indicates Docker has to be seen more as a Software Delivery Platform than as a replacement of a virtual machine.

However ...

If you are running an Oracle database using Docker on your local machine to develop some APEX application, you will probably not move that container is a whole to test and production environments. Because in that case you would not only deliver a new APEX application to the production environment - which is a good thing - but also overwrite the data in production with the data from your development environment. And that won't make your users very excited.
So in this set up you will be using Docker as a replacement of a Virtual Machine and not as a Delivery Platform.
And that's exactly the way Martin is using it as he described in this recent blog post. It is an ideal way to get up and running with an Oracle database …

Using multiple Authentication Schemes for your APEX application

Recently someone asked me how he could implement multiple authentication schemes for his APEX application. He would like to use (some kind of) Single Sign-on authentication and - as an alternative - an Application Express Authentication. The problem is ... you can only define one Authentication Scheme being "Current" for an application! So how can we solve this issue?

First, we need te be aware that multiple applications can share their authentication by using the same cookie. Thus if you specify "MYCOOKIE" as the Cookie Name in Application A as well as in Application B, you can switch from A to B and back without the need of logging in again. It doesn't matter what Authentication Scheme Type you are using!

Knowing this, we are halfway our solution. We need two Applications. One - the "real" application - using the Application Express Authentication, let's name this one "LAUNCHPAD". And another one using the Single Sign-on Authentication…