OpenEdge Development: Mobile Applications - Product ...

More documents

Recommendations

Info

Chapter 4: Creating Mobile Apps using JSDOs For a non-built-in invoke operation that completes successfully, the response property references an object that contains properties with the values of any output parameters and return value returned by the ABL routine. A property for an ABL output parameter has the same name (and letter case) as the corresponding output parameter, and has a JavaScript data type that maps to the ABL data type of the output parameter (see Appendix A, “ABL to JavaScript Data Type Mapping”). Any return value from the routine is returned as the OpenEdge-defined property, _retVal, also with a ABL-mapped JavaScript data type. For a Mobile operation that completes with one or more ABL errors, the response property references an object that contains two OpenEdge-defined properties: • _retVal — A String with the value of any ABL RETURN ERROR string or ReturnValue property for a thrown AppError object • _errors — An array of JavaScript objects, each of which contains properties with the ABL error message string and error number for one of possibly many ABL-returned errors. Note: In the current OpenEdge release, this array always returns one object only for the first ABL error (the equivalent of ERROR-STATUS:GET-MESSAGE(1) in ABL). For more information on the request object and its available properties, see its reference entry in Appendix B, “OpenEdge JavaScript Class and Object Reference”. General error handling for Mobile operations For any Mobile operation that completes with an error of any kind (ABL, Mobile Web application, or network), the success property of the returned request object (and the success parameter of the event handler) is set to false. As noted in the previous section, any ABL errors can be found in the object returned by the response property. All other Web application and network errors can be inspected using the xhr property of the request object. For more information on the XMLHttpRequest object that this property references, see the software development documentation for your Web browser or mobile device. Note that for a Mobile create, update, or delete operation, if any error, at any point causes the operation to complete unsuccessfully, the record in JSDO local storage is reverted prior to any change that caused the operation to be executed. So, for example, a failed create operation causes the added record to be removed from local storage. The record object that was originally added for the operation is then available for your re-use as the jsrecord property of the request object (or the record parameter if the event handler). A similar reversion occurs for the update and delete operations, with the field values of any updated record reverted to their original values, and any deleted record added back to local storage. Properties of a JSDO Every JSDO has several properties to manage its state. We have already introduced the table reference properties that provide access to temp-table data loaded into JSDO local storage, and the record property, which provides access to individual record objects on a given table reference (see the “How JSDO local storage works” section on page 93). 102 OpenEdge ® Development: Mobile Applications
Two additional properties are available for access on a JSDO: JSDO overview • name — A String property that returns the name of the Mobile resource for which the JSDO is created. You must set this value either directly or indirectly using the progress.data.JSDO class constructor when you instantiate a JSDO. You can read the property on the JSDO after it is created. • useRelationships — A Boolean property that when set to true makes all data-relations active in JSDO local storage so that searches on a child temp-table reference involve only records related to a its parent. In addition, record objects created for a child temp-table have their key fields automatically set in relation to their parent. When set to false, searches on a child temp-table reference involve all record objects stored for the temp-table, regardless of data-relations, and any record objects created for a child temp-table have no automatic settings for their key fields. This property can be set and reset at any time during the life of the JSDO to change the effect of data-relations on local storage. In addition to these JSDO properties, you can set additional initialization properties in the class constructor, along with the name property itself. These initialization properties, which you cannot access after the JSDO is created, allow you to specify that certain JSDO methods are called during instantiation, including: • Automatically calling the fill( ) method to initialize JSDO local storage as the object is created • Subscribing event handlers for JSDO events, especially the 'beforeFill' and 'afterFill' events to handle the automatic execution of the fill( ) method For more information on setting the name and initialization properties in the JSDO class constructor, see the “Creating a JSDO for a Mobile resource” section on page 105. Requirements for using a JSDO The basic requirements for using a JSDO include having access to the Mobile resource it needs to access and set up a user login session to access that Mobile resource. To use a JSDO in a Mobile App, you need to ensure that the following actions have been completed: 1. Deploy a Mobile Web application that contains a Mobile service with the Mobile resource, or resources, you need to an Apache Tomcat Web server (such as the OpenEdge-installed OE Web Server), whether for testing or production. For more information on deployment for testing, see the sections on publishing Mobile services for testing in Chapter 3, “Creating Mobile Services.” For more information on deployment for production, see the sections on deploying Mobile Web applications in Chapter 5, “Deploying Mobile Applications.” 2. Instantiate the progress.data.Session class to create a user login session between the Mobile App and the Mobile Web application and ensure that you initialize it to use the same Web server authentication model as the Mobile Web application. For more information on coding for security considerations like the Web server authentication model, see the “Managing user login sessions” section on page 117. OpenEdge ® Development: Mobile Applications 103
Page 1 and 2:
® ® PROGRESS® OPENEDGE® OpenEdg
Page 3 and 4:
Contents Preface . . . . . . . . .
Page 5 and 6:
Contents Packaging and Deploying An
Page 7 and 8:
Figures Contents Figure 1: OpenEdge
Page 9 and 10:
Preface This Preface contains the f
Page 11 and 12:
Using this manual Chapter 4, “Cre
Page 13 and 14:
SMALL, BOLD CAPITAL LETTERS Preface
Page 15 and 16:
Preface In this example, you must s
Page 17 and 18:
On UNIX platforms, use the OpenEdge
Page 19 and 20:
Preface end-user documentation incl
Page 21 and 22:
Preface in all copies of the suppor
Page 23 and 24:
Preface not be used in advertising
Page 25 and 26:
Preface pertaining to distribution
Page 27 and 28:
Preface LIABILITY, WHETHER IN CONTR
Page 29 and 30:
Preface CONSEQUENTIAL DAMAGES (INCL
Page 31 and 32:
Preface Except as contained in this
Page 33 and 34:
OpenEdge Mobile Overview OpenEdge
Page 35 and 36:
Run-time architecture As shown in F
Page 37 and 38:
Run-time architecture An OpenEdge R
Page 39 and 40:
Run-time architecture As shown in F
Page 41 and 42:
Run-time architecture For informati
Page 43 and 44:
Building Mobile services Developmen
Page 45 and 46:
Development architecture and tools
Page 47 and 48:
Example: A Simple Mobile App This c
Page 49 and 50:
Creating a new Mobile OpenEdge proj
Page 51 and 52: Creating an include file Creating a
Page 53 and 54: Creating a new Business Entity 5. I
Page 55 and 56: 3. In the Event menu, select Load.
Page 57 and 58: Adding the JSDO service to the clie
Page 59 and 60: Building and testing the Mobile App
Page 61 and 62: 2. Check the JavaScript associated
Page 63 and 64: Creating Mobile Services OpenEdge
Page 65 and 66: Getting started with OpenEdge Mobil
Page 67 and 68: Getting started with OpenEdge Mobil
Page 69 and 70: Coding AppServer services for OpenE
Page 77 and 78: Creating Mobile resources Creating
Page 79 and 80: Creating Mobile services Creating M
Page 81 and 82: URIs for accessing Mobile Web appli
Page 83 and 84: URIs for accessing Mobile Web appli
Page 85 and 86: est URIs for accessing Mobile Web a
Page 87 and 88: Creating Mobile Apps using JSDOs Op
Page 89 and 90: Creating a Mobile App from Develope
Page 91 and 92: JSDO overview JSDO overview A JSDO
Page 93 and 94: JSDO overview A Mobile resource can
Page 95 and 96: JSDO overview If a method leaves a
Page 97 and 98: JSDO overview - assign( ) — Calle
Page 99 and 100: Comparing asynchronous and synchron
Page 101: Managing JSDO event subscriptions J
Page 105 and 106: Creating a JSDO for a Mobile resour
Page 107 and 108: Accessing built-in CRUD operations
Page 109 and 110: Client JavaScript code: Create Acce
Page 111 and 112: Client JavaScript code: Update Acce
Page 113 and 114: Notice that the sample code: Access
Page 115 and 116: Accessing non-built-in invoke opera
Page 117 and 118: Managing user login sessions Managi
Page 119 and 120: Managing user login sessions • Th
Page 121 and 122: Managing user login sessions If the
Page 123 and 124: Getting started with other HTML cod
Page 125 and 126: Using a custom template Getting sta
Page 127 and 128: Publishing Mobile Apps for testing
Page 129 and 130: Deploying Mobile Applications OpenE
Page 131 and 132: Packaging and deploying Mobile serv
Page 133 and 134: 9. To upload the certificate: a. Cl
Page 135 and 136: Devices Packaging and Deploying iOS
Page 137 and 138: Packaging and Deploying Android App
Page 139 and 140: Packaging and Deploying Mobile Web
Page 141 and 142: Security considerations Security co
Page 143 and 144: Security considerations In order to
Page 145 and 146: SSL connections Security considerat
Page 147 and 148: ABL to JavaScript Data Type Mapping
Page 149 and 150: JavaScript data type overview JavaS
Page 151 and 152: ROWID String (Base64 encoded) Data
Page 153 and 154:
OpenEdge JavaScript Class and Objec
Page 155 and 156:
progress.data.JSDO class progress.d
Page 157 and 158:
object-ref progress.data.JSDO class
Page 159 and 160:
Table 12: progress.data.JSDO table-
Page 161 and 162:
progress.data.JSDO class The JSDO c
Page 163 and 164:
progress.data.JSDO class Note: If a
Page 165 and 166:
Properties Table 15: progress.data.
Page 167 and 168:
progress.ui.UIHelper class Construc
Page 169 and 170:
Table 20: Example — index.html pr
Page 171 and 172:
equest object Properties request ob
Page 173 and 174:
OpenEdge JavaScript Class Propertie
Page 175 and 176:
• onOpenRequest property • para
Page 177 and 178:
addCatalog( ) method addCatalog( )
Page 179 and 180:
addItem( ) method addItem( ) method
Page 181 and 182:
In Release 11.2, the following form
Page 183 and 184:
afterCreate event afterCreate event
Page 185 and 186:
afterDelete event afterDelete event
Page 187 and 188:
afterFill event afterFill event Fir
Page 189 and 190:
afterSaveChanges event afterSaveCha
Page 191 and 192:
afterUpdate event afterUpdate event
Page 193 and 194:
assign( ) method (JSDO class) assig
Page 195 and 196:
async property async property A Boo
Page 197 and 198:
atch property A reference to an obj
Page 199 and 200:
eforeDelete event beforeDelete even
Page 201 and 202:
eforeInvoke event beforeInvoke even
Page 203 and 204:
eforeUpdate event beforeUpdate even
Page 205 and 206:
clearItems( ) method Clears the ite
Page 207 and 208:
display( ) method display( ) method
Page 209 and 210:
fill( ) method After this method co
Page 211 and 212:
In following code fragment, jsdo re
Page 213 and 214:
findById( ) method The following co
Page 215 and 216:
foreach( ) method foreach( ) method
Page 217 and 218:
getData( ) method getData( ) method
Page 219 and 220:
getFormRecord( ) method getFormReco
Page 221 and 222:
getListViewRecord( ) method Returns
Page 223 and 224:
invocation method invocation method
Page 225 and 226:
jsdo property jsdo property An obje
Page 227 and 228:
login( ) method login( ) method Sta
Page 229 and 230:
OpenEdge Mobile supports the follow
Page 231 and 232:
loginResult property loginResult pr
Page 233 and 234:
logout( ) method logout( ) method T
Page 235 and 236:
onOpenRequest property onOpenReques
Page 237 and 238:
paramObj property paramObj property
Page 239 and 240:
emove( ) method remove( ) method De
Page 241 and 242:
saveChanges( ) method saveChanges(
Page 243 and 244:
services property services property
Page 245 and 246:
serviceURI property serviceURI prop
Page 247 and 248:
setFieldTemplate( ) method setField
Page 249 and 250:
setListView( ) method Defines a lis
Page 251 and 252:
subscribe( ) method subscribe( ) me
Page 253 and 254:
success property success property A
Page 255 and 256:
table reference property (JSDO) Bot
Page 257 and 258:
unsubscribe( ) method unsubscribe(
Page 259 and 260:
useRelationships property useRelati
Page 261 and 262:
xhr property xhr property A referen
show all

OpenEdge Development: Mobile Applications - Product ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?