Skip to main content

Push changed rows to an Interactive Grid

By
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]]
Labels:

Comments

Post a Comment

Popular posts from this blog

How to create neatly formatted Excel documents using PL/SQL?

By
If there is a requirement to produce output from an application into Excel, you would probably create a CSV (Comma Separated File) with the data and start Excel to show the data - at least that's what I did...until now. The drawback of this solution is that you could only produce data and no nice layout. But Excel is also capable of opening HTML-files and using this you could create Excel files with data and magnificent layout! Let me give an example: 1. Create a procedure to show the data in formatted in an HTML table. CREATE OR REPLACE PROCEDURE display_emp_list IS v_emp_count NUMBER(5); v_empno NUMBER(8); v_ename VARCHAR2(50); v_job emp.job%TYPE; v_sal emp.sal%TYPE; v_bg_color VARCHAR2(10) := ''; CURSOR c_emp IS SELECT empno, initcap(ename), job, sal FROM emp ORDER BY ename; BEGIN SELECT COUNT(*) INTO v_emp_count FROM emp; owa_util.mime_header('application/ms-excel', FALSE); htp.p('Content...
21 comments
Read more

Refresh selected row(s) in an Interactive Grid

By
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 wors...
Post a Comment
Read more

Stop using validations for checking constraints !

By
 If you run your APEX application - like a Form based on the EMP table - and test if you can change the value of Department to something else then the standard values of 10, 20, 30 or 40, you'll get a nice error message like this: But it isn't really nice, is it? So what do a lot of developers do? They create a validation (just) in order to show a nicer, better worded, error message like "This is not a valid department".  And what you then just did is writing code twice : Once in the database as a (foreign key) check constraint and once as a sql statement in your validation. And we all know : writing code twice is usually not a good idea - and executing the same query twice is not enhancing your performance! So how can we transform that ugly error message into something nice? By combining two APEX features: the Error Handling Function and the Text Messages! Start with copying the example of an Error Handling Function from the APEX documentation. Create this function ...
Post a Comment
Read more