How to configure server-side filtering with JSDO and Kendo UI

How to specify server-side filtering through the JavaScript Data Object (JSDO) when a Data Object Service (in OpenEdge 11.6) or Mobile Service (OE 11.5.1) is used as a Kendo UI DataSource.

In a Kendo UI DataSource, filtering is done on the client unless server-side filtering is explicitly configured. Server-side filtering must be configured in both the OpenEdge service that is the data source (a Data Object service in OpenEdge 11.6 or an OpenEdge Mobile service in OE 11.5.1) and in the Kendo UI DataSource object.

To configure server-side filtering in an OpenEdge Mobile Service: 

Add the following annotations to the Read method of the Business Entity:

    @openapi.openedge.method.property (name="mappingType", value="JFP").
    @openapi.openedge.method.property (name="capabilities", value="ablFilter,top,skip,id,orderBy").

Note that all five properties of the Json Filter Pattern must be included in the value list, even if only one property (in this case, server filtering) is being used.

Re-generate the JSDO Catalog following the steps below :
After adding the above annotations to the Business Entity it is necessary to regenerate the JSDO Catalog in order for the client code to be able to pass a filter to the server.

• Double click on the Service
• Click Next button and select the Resource(s)
• Click finish. This will refresh and publish the JSDO Catalog on the server.

To configure server-side filtering in a Kendo UI DataSource:

Use the standard Kendo UI Javascript syntax for configuring server filtering in the DataSource. For example:

            ...
            dataSource: {
              type: "jsdo",
              serverFiltering: true,
              filter: { field: "CustNum", operator: "le", value: "3" },
              transport: {
                jsdo: "Customer"
              },
              error: function(e) {
                console.log('Error: ', e);
              }
            },
            ...

"serverFiltering: true" specifies that filtering should be done on the server. If this property is not specified, or if serverFiltering is set to "false", filtering will be done on the client,

The "filter" property is specified according to jQuery parameter conventions. The JSDO dialect of the Kendo UI DataSource translates this format into a JSON Filter Pattern (JFP) for the equivalent ABL filter, which is a WHERE clause without the WHERE keyword.

The attached sample code displays the first three records returned by a service similar to the OE Mobile Demo Customer service. It is based on the example in the Progress Community white paper referenced below.

References to Other Documentation:

OpenEdge Development: Web Services, Chapter 6, "Data Object Services > Coding Business Entities to implement Data Objects > Coding ABL routines to implement a Data Object resource > Updating Business Entities for access by Telerik DataSources and Rollbase external objects"

Progress Data Objects Guide and Reference, "Overview of Progress Data Objects, Services and Catalogs > Using the JSDO dialect of the Kendo UI DataSource"
https://documentation.progress.com/output/pdo/#page/pdo/using-the-jsdo-dialect-of-the-kendo-ui-datasourc.html#

Telerik Kendo UI: kendo.data.DataSource
http://docs.telerik.com/kendo-ui/api/javascript/data/datasource

Progress Community: Using the JSDO with Kendo UI (Updated) - Whitepaper
https://community.progress.com/community_groups/openedge_development/m/documents/2135.aspx

Progress Community: Examples using the JSDO v4.0 with Kendo UI
https://community.progress.com/community_groups/openedge_development/m/documents/2020.aspx

Progress Articles:

 Performance of Kendo UI grid with a filter same as grid with no filter