Building Hybrid mobile apps for Rollbase application using PDO

Transcription

1 Building Hybrid mobile apps for Rollbase application using PDO Authors: Anil Kumar Gaddalapati, QA Engineer Dr Ganesh Neelakanta Iyer, QA Architect 2016 Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.

2 Progress Data Object (PDO, Previously known as JSDO) is an open source standard by Progress that lets you build smooth integrations between many Progress products. For example, you can now build a hybrid mobile app for an existing Rollbase application with all business logic and data lying in Rollbase backend and just focus on building awesome mobile UI using Telerik AppBuilder with PDO integration. How to Expose Rollbase objects as Progress Data catalog The best way to learn something new is to learn it through an example. Hence we will understand these concepts by building a small sample application called Order Management. Create a new application in Rollbase called Order Management with an object Order and three fields Order ID (with integration name Order ), Country and Order Name. After creating a web Application in Rollbase, go to Setup Home, under Application setup navigate to Progress Data Catalog and create a New Progress Data Catalog. Choose the objects which you want to expose and save the catalog. (In the following sections of this document, we have created an Order Management application in Rollbase and the Order object has been used). Once saved you will get service URI and Catalog URI which needs to be noted somewhere for us to use when we create the mobile application. The catalog file is nothing but a JSON file which contains the schema for the objects which you have chosen and the operations (Create, Update, Read, Delete operations) which can be performed on those objects. Here is a sample of PDO we have created. 2

3 Getting started with Mobile development Login to your Telerik Platform Enterprise Edition and create a Hybrid application. In Views, go to Data Providers and Add a Progress Data Service 3

4 In Views, go to Data Providers and Add a Progress Data Service and provide the Service URI and Catalog URI from your first step. Set the Authentication mode to FORM. Optionally, you can add a Login View to the Mobile Application by clicking on Add an "Authentication" view to my app checkbox. Create and name a View. In Data Binding set the Content Type as the Rollbase Object Name ( Order in this example). In the List screen, you can bind the object fields by using the names under the properties of the object in catalog file. Lets see the Order ID which is exposed as Order which we have set in Heading Text 4

5 Under sub-heading text, choose country (which is a picklist in Rollbase) and the application looks like below: 5

6 If you notice, we got the Order Id and some id in place of country name. Rollbase currently exposes Picklist data as Id s and not the actual values. To overcome this PDO exposes a get operation to get the picklist data. If you look at the PDO catalog, in operations, there is an operation name getpicklist_country which can be used to get the country picklist data. Code to call the operation will look like this: Here is a snapshot of the response PDO.getPicklist_country().response.picklistData; 6

7 Now we know how to get the name of the country, how to map and show it on the mobile. This needs to be done for all the records we have. For this we can make use of PDO afterfill event. Go to Code and the navigate to components/<view Name>/index.js and at the end of the file there are few comments similar to what you see below: */ // START_CUSTOM_CODE_masterDetailViewModel // Add custom code here. For more information about custom code, see // you can handle the beforefill / afterfill events here. For example: /* app.masterdetailview.masterdetailviewmodel.get('_pdooptions').events = { ; 'beforefill' : [ { ] scope : app.masterdetailview.masterdetailviewmodel, fn : function (PDO, success, request) { // beforefill event handler statements... 7

8 Just uncomment the code and add a afterfill event as follows app.masterdetailview.masterdetailviewmodel.get('_pdooptions').events = { 'beforefill' : [ { scope : app.masterdetailview.masterdetailviewmodel, fn : function (PDO, success, request) { ], 'afterfill' : [ { scope : app.masterdetailview.masterdetailviewmodel, fn : function (PDO, success, request) { ] ; In the afterfill event 'afterfill' : [ { scope : app.masterdetailview.masterdetailviewmodel, fn : function (PDO, success, request) { if(success){ PDO.foreach(function(jsrecord) { var countrypicklistarray = PDO.getPicklist_country().response.picklistData; var countryid = jsrecord.data.country; //Country Id var object; for (var i = 0; i < countrypicklistarray.length; i++) { object = countrypicklistarray[i]; for (var property in object) { 8

9 if (property == "id") { a = object[property]; if (property == "name") { countrymap[a] = object[property]; //Store the values in a map for (var i in countrymap) { if (jsrecord.data.country == i) { jsrecord.data.country = countrymap[i]; //Map the Country Name ) ] Above code will get all the picklist values and store it in a map and then map the country with the name so that country name will be rendered in the UI. 9

10 Currently a PDO object can hold only a single object of Rollbase, so if there are any relationships with the objects and you need to access the related records you should be creating another PDO object and access it. Here is a sample code of creating a PDO object var productsdatasourceoptions = { type: 'PDO', transport: {, serverfiltering: true, serversorting: true, serverpaging: true, pagesize: 50, error: function(e) { if (e.xhr) { alert(json.stringify(e.xhr));, ; var productsobject = new progress.data.pdo({ name: 'Product' ); var productsdatasource1; productsdatasourceoptions.transport.pdo = productsobject; 10

11 productsdatasource1 = new kendo.data.datasource(productsdatasourceoptions); productsobject.fill().done(function(productspdo, success, request) { ); productspdo.foreach(function(productsjsrecord) { ); //You can get the data by using productsjsrecord.data Whenever a fill() function is called, it invokes a read operation and gets the data from Rollbase and stores it in PDO memory. Fill() will get all the data from the server and stores it in the memory. But at most of the times we want to fetch only related records and not all the records. Fetching all the records and mapping using code will cause lots of performance issues. Instead of that, we can make use of filters while doing fill() operation, so that PDO fetches only the required records. Read operation has the capabilities of sqlquery, top, skip, id, orderby options. Here is a sample code for sqlquery var productdetailsfilter = "{\"sqlquery\":\"select id,productname,r from Product < where condition if any>\""; productsobject.fill(productdetailsfilter).done(function(productspdo, success, request) { ) productspdo.foreach(function(productsjsrecord) { ); productsmap.set(productsjsrecord.data.id, productsjsrecord.data.productname); 11

12 If you have Pages/Views created in Rollbase and you want to access those you can make use of /getview**** operations. For example, if we have a view in Rollbase for Orders object and is exposed as below. In short, creating a mobile application for an existing Rollbase application is quite easy and straightforward. About Progress Progress (NASDAQ: PRGS) is a global leader in application development, empowering the digital transformation organizations need to create and sustain engaging user experiences in today s evolving marketplace. With offerings spanning web, mobile and data for on-premise and cloud environments, Progress powers startups and industry titans worldwide, promoting success one customer at a time. Learn about Progress at or Worldwide Headquarters Progress, 14 Oak Park, Bedford, MA USA Tel: Fax: On the Web at: Find us on facebook.com/progresssw twitter.com/progresssw youtube.com/progresssw For regional international office locations and contact information, please go to Progress, Progress Rollbase and Telerik are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. Any other trademarks contained herein are the property of their respective owners Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved. Rev 16/