The following instructions are for SP08. If you are using a newer version of the SDK, please see Getting Started with Kapsel in SP13+
The Kapsel Offline OData plugin enables an OData version 2.0 based application that has its data proxied through an SMP server to be used when a device or emulator is offline by creating a store on the device.
store = sap.OData.createOfflineStore(properties);
store.open(openStoreSuccessCallback, errorCallback);
Once the store is open and the custom OData client is applied with the following call, all calls made using the datajs library that match the service root (connection name for the endpoint such as com.mycompany.offline) are routed to the offline store.
sap.OData.applyHttpClient();
//sap.OData.removeHttpClient();
A set of defining requests specify the data that will populate the offline store.
definingRequests : {
contacts : "/ContactSet?$expand=ToContactDetails",
customers : "/CustomerSet",
regions : "/RegionSet",
departments : "/DepartmentSet",
countries : "/CountrySet",
jobfunctions : "/JobFunctionSet"
}
The data that will be updated when a device is offline should ideally be data that multiple offline users are not simultaneously updating. If possible, partition the data to the subset required by each user. The offline store has a 16 GB limit. The initial download time, database size and refresh times can be affected by the amount of data being stored on the device. Adding OData filters to the defining requests to limit the data on the device to the subset of data required is one technique to do this.
An offline store can only be used with one OData service. For example, one offline store could be associated with one service such as http://services.odata.org/V2/OData/OData.svc/ or http://services.odata.org/V2/Northwind/Northwind.svc/ but not both.
Once the offline store has been created, local changes made to it can be sent out via a call to store.flush(). The offline store can update its copy of the data by calling store.refresh().
The offline store files can be seen at \data\data\com.mycompany.offline2\files when running in an Android emulator as shown below.
OData function imports are not supported as the service metadata document does not describe what changes occur as a result of calling them. See also Offline OData Version Support for further details on supported features. For additional details on the Offline OData plugin see the JavaScript file in a project that includes this plugin at
project_name\plugins\com.sap.mp.cordova.plugins.odata\www\OData.js and OfflineStore.js
or the JS Documentation at Kapsel Offline OData Plugin API Reference.
Note, that SP07 of the Kapsel OData SDK is not compatible with versions of the SMP 3.0 server prior to SP06.
When an offline store is opened, the following message may appear in the SMP server's log due to this incompatibility.
Stack trace: '[-100067] "6" is an invalid system property ID from the client
Note, if an SP06 PL02 SDK is used with the examples in this section, the offline store will open but when making a read request, the following error will appear in the device log such as the Android logcat due to BCP Issue 1580003258.
An error occurred executing SQL statement: SELECT LO_1 ...
The workaround for this is to use SP07 of the SDK or modify the read request to not use an orderby.
The following samples will help demonstrate the Kapsel Offline OData plugin.
OData Based App
This is a simple OData based app that demonstrates how it cannot read data while the device is offline.
OData Based App with the Kapsel Offline OData Plugin
The Offline OData plugin is added to the project to enable the accessing of OData when device is offline.
Offline enabled App with Create, Update, Delete, Access to the Error Archive
Adds CUD operations (create, update, delete) and how to view failed updates in the ErrorArchive.
Offline and Online in One App
Demonstrates an app where a portion of the data is made available when offline.
Using More than one Offline Store
Demonstrates an app where multiple offline stores are opened.
Sample that Switches to Offline Usage once the Network is Unavailable
This sample shows how an application may switch to using an offline store automatically when network connectivity is lost.
Sample that Defines Relationships using $expand
How to use $expand to define relationships between entities when the OData service does not make use of referentialconstraint.
Additional Settings
Demonstrates encryption of the offline store, refreshing a subset of data and use of refresh interval.
Batch Operation
This example shows how to add a new product that references an existing category and supplier in one operation.
Deep Insert
This example shows how to add a category and a new product in one operation. This feature was added in SP08 of the SDK.
Binary Data/Attachments
This section discusses offlining attachments.
The following steps will create a simple OData based app that does not use the Kapsel Offline OData plugin.
cordova -d create C:\Kapsel_Projects\OfflineDemo com.mycompany.offline OfflineDemo "{\"plugin_search_path\":\"C:/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd C:\Kapsel_Projects\OfflineDemo
cordova -d platform add android
cordova -d create ~/Documents/Kapsel_Projects/OfflineDemo com.mycompany.offline OfflineDemo "{\"plugin_search_path\":\"/Users/i826567/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd ~/Documents/Kapsel_Projects/OfflineDemo
cordova -d platform add ios
cordova -d prepare
The following steps will enable the app to be used when the device or simulator is online or offline.
Note, the techniques used in this sample are for learning purposes only. In a non-demo app, it is recommended that the offline store be used all the time to maintain consistency of the data.
cordova -d plugin add com.sap.mp.cordova.plugins.odata
cordova -d plugin add com.sap.mp.cordova.plugins.logon
cordova plugin add org.apache.cordova.network-information
com.mycompany.offline
Set the endpoint to be the following URLhttp://services.odata.org/V2/OData/OData.svc
Check Allow anonymous access since this backend does not require a user name or password.cordova -d prepare
Note, there is a known issue with this example and the SP06 SMP server due to a problem with redirects. BCP Issue 1580013675. The read request will fail. This problem is not present in the SP05 server and is addressed in SP06 PL02 and SP07 server versions.
The following steps will extend the app to enable create, update and delete operations and will also display the contents of the ErrorArchive which contains any error that occurred during a flush which attempts to send locally made changes on the device to the OData producer.
Note, there is an incompatibility around escaping backslashes in a JSON payload that causes the flush operation against services.odata.org to fail. This issue was fixed in SMP 3.0 SDK SP05 PL03 and SP06.
Note, the techniques used in this sample are for learning purposes only. In a non-demo app, it is recommended that the offline store be used all the time to maintain consistency of the data.
Note, that this example uses a partial service endpoint in the management cockpit. The endpoint specified is
http://services.odata.org
instead of
http://services.odata.org/V2/(S(readwrite))/OData/OData.svc/
The full URL causes a redirect to a new URL that contains the URL with a session id in it.
Note, that the temporary OData session ID can be reset in this example by clicking on Clear Offline Store, Unregister, Register, and then Read or Open Store.
com.mycompany.offline2
and an endpoint ofhttp://services.odata.org
Check Allow anonymous access since this backend does not require a user name or password.cordova -d create C:\Kapsel_Projects\OfflineDemo2 com.mycompany.offline2 OfflineDemo2 "{\"plugin_search_path\":\"C:/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd C:\Kapsel_Projects\OfflineDemo2
cordova -d platform add android
cordova -d create ~/Documents/Kapsel_Projects/OfflineDemo2 com.mycompany.offline2 OfflineDemo2 "{\"plugin_search_path\":\"/Users/i826567/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd ~/Documents/Kapsel_Projects/OfflineDemo2
cordova -d platform add ios
cordova -d plugin add com.sap.mp.cordova.plugins.odata
cordova -d plugin add com.sap.mp.cordova.plugins.logon
cordova plugin add org.apache.cordova.network-information
cordova -d prepare
The service root for the offline and always online requests must be different. In this sample requests that are made to
http://10.7.171.223:8080/com.mycompany.offline/Products?$orderby=Name%20desc
are redirected to the Offline Store when it is open and requests to
http://10.7.171.223:8080/com.mycompany.online/Products?$orderby=Name%20desc
are not redirected to the offline store. The service root is specified when the store is initially opened.
function openStore() {
...
var properties = {
"name": "ProductsOfflineStore",
"host": applicationContext.registrationContext.serverHost,
"port": applicationContext.registrationContext.serverPort,
"https": applicationContext.registrationContext.https,
"serviceRoot" : appId,
"definingRequests" : {
"ProductsDR" : "/Products"
}
};
store = sap.OData.createOfflineStore(properties);
//var options = {};
store.open(openStoreSuccessCallback, errorCallback/*, options*/);
}
The following steps demonstrate this using the previous Offline project.
Note, the techniques used in this sample are for learning purposes only. In a non-demo app, it is recommended that the offline store be used all the time to maintain consistency of the data.
<button id="read2" onclick="read2()">Read2</button><br>
var sURL = applicationContext.applicationEndpointURL + "/Products?$orderby=Name desc";
tovar sURL = applicationContext.applicationEndpointURL.replace("offline", "online") + "/Products?$orderby=Name desc";
cordova -d prepare
If the data being used in the app changes perhaps due to having the device being shared by multiple users or perhaps depending on the sales region the sales person is visiting on a particular day, it may make sense to have more than one offline store. Each store will need to have a unique service root.
The following steps demonstrate this using the previous Offline project.
Note, the techniques used in this sample are for learning purposes only. In a non-demo app, it is recommended that the offline store be used all the time to maintain consistency of the data.
The following sample listens to online and offline notifications and sets a timer to call refresh after a set interval. When the app starts the offline store is opened, and if the device is online the store is refreshed. While the device is online, the offline store is not used. When the device is offline, the OData requests are redirected to the open online store as the sap.OData.applyHttpClient() method is called when the device switches to offline. When the device regains network connectivity, the method sap.OData.removeHttpClient() is called.
Note, the techniques used in this sample are for learning purposes only. In a non-demo app, it is recommended that the offline store be used all the time to maintain consistency of the data.
Follow the below steps to try it out.
cordova -d create C:\Kapsel_Projects\OfflineDemo3 com.mycompany.offline3 OfflineDemo3 "{\"plugin_search_path\":\"C:/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd C:\Kapsel_Projects\OfflineDemo3
cordova -d platform add android
cordova -d create ~/Documents/Kapsel_Projects/OfflineDemo3 com.mycompany.offline3 OfflineDemo3 "{\"plugin_search_path\":\"/Users/i826567/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd ~/Documents/Kapsel_Projects/OfflineDemo3
cordova -d platform add ios
cordova -d plugin add com.sap.mp.cordova.plugins.odata
cordova -d plugin add com.sap.mp.cordova.plugins.logon
cordova plugin add org.apache.cordova.network-information
cordova prepare
The definition of a service can be examined by opening the service URL such as http://services.odata.org/V2/OData/OData.svc/.
This shows that there are three collections available named Products, Categories and Suppliers. For further details see the following URL. http://services.odata.org/V2/OData/OData.svc/$metadata
Notice that Products is defined as an EntityType of OData.Product and it has a set of NavigationProperties. Specifically it defines that a Product has a Supplier and a Product has a Category. When the offline store is created it needs to know about these relationships to correctly create the tables and relationships between the tables. If the metadata does not specify a referentialconstraint as this service does not, the defining requests will need to use the $expand format to specify how the tables are related. This is explained in more detail at Using Defining Requests to Build Entity Relationships.
The following sample displays a table of categories as links that when clicked on shows the products in the clicked on category and the supplier of the product. To make this data available when the device is offline, we need all three entities. The following defining requests were used initially when creating this sample.
"definingRequests" : { //the below requests will be used to populate the offline store
"CategoriesDR" : "/Categories",
"ProductsDR" : "/Products",
"SuppliersDR" : "/Suppliers"
}
Then the following query could be used to retrieve the Categories.
/Categories?$orderby=Name desc
When a category is clicked on a second query can be performed to return the products and supplier information for a given category. Here are a couple of queries that could be used.
/Products?$expand=Supplier,Category&$filter=Category/ID eq 0&$orderby=Name desc
or
/Categories(1)/Products?$expand=Supplier&$orderby=Name desc
Unfortunately, the above queries returns 0 results when the offline store is open since the relationships between the entities are not defined with ReferentialConstraint. See also ReferentialConstraint Element.
Since we are not able to change the OData service, the relationships can be specified by using expand in the defining requests as shown below.
"definingRequests" : { //the below requests will be used to populate the offline store
"CategoriesDR" : "/Categories?$expand=Products/Supplier"
//"ProductsDR" : "/Products?$expand=Category,Supplier" //this also works
}
Note, the techniques used in this sample are for learning purposes only. In a non-demo app, it is recommended that the offline store be used all the time to maintain consistency of the data.
Try out the complete example by following the below steps.
cordova -d create C:\Kapsel_Projects\OfflineDemo4 com.mycompany.offline4 OfflineDemo4 "{\"plugin_search_path\":\"C:/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd C:\Kapsel_Projects\OfflineDemo4
cordova -d platform add android
cordova -d create ~/Documents/Kapsel_Projects/OfflineDemo4 com.mycompany.offline4 OfflineDemo4 "{\"plugin_search_path\":\"/Users/i826567/SAP/MobileSDK3/KapselSDK/plugins/\"}"
cd ~/Documents/Kapsel_Projects/OfflineDemo4
cordova -d platform add ios
cordova -d plugin add com.sap.mp.cordova.plugins.odata
cordova -d plugin add com.sap.mp.cordova.plugins.logon
cordova plugin add org.apache.cordova.network-information
cordova -d prepare
The following section provides examples of some additional settings that can be set.
Encrypting the Offline Database
Delta Queries
Refreshing a Subset of the Offline Data
Prepopulate Offline Database and Refresh Interval of Shared Data
To encrypt the data in the offline stores, specify an encryption key. Without this, it is possible on an Android or iOS simulator to access the UltraLite database files and view the data as shown below.
The following option can be provided when opening the store to encrypt the stores using AES-256.
var options = {
"storeEncryptionKey" : "myVerySecretKey123!"
//"storeEncryptionKey" : applicationContext.registrationContext.password //if using the Logon plugin, the user entered password for the registration can be used if it never changes
};
store.open(openStoreSuccessCallback, errorCallback, options);
A better solution than hardcoding the password would be to generate a random password and then to store it in the datavault provided by the Logon plugin. Here is an example of how that might look.
var otp = null; //one time password. Must be set once the first time the app starts
function logonSuccessCallback() {
getOneTimePassword();
...
}
function getOneTimePassword() {
sap.Logon.get(getSuccess, errorCallback, "key");
}
function getSuccess(val) {
if (val == null) {
val = Math.random().toString(36).substring(16);
sap.Logon.set(val);
return;
}
otp = val;
}
function openStore() {
...
var options = {
"storeEncryptionKey" : otp
};
store.open(openStoreSuccessCallback, errorCallback, options);
}
The Offline OData plugin can work with delta query enabled backends to minimize the communication between the SMP server and the OData producer. The following links provide additional details.
Delta Queries (Part 1)
Performance Improvement with Caching and Delta Tracking
Delta Query Support
When performing a refresh, if it is only a subset of the data that changes often, in the refresh call it is possible to specify which defining requests should be refreshed. Assume the application has the following defining requests.
"definingRequests" : { //the below requests will be used to populate the offline store
"CategoriesDR" : "/Categories",
"ProductsDR" : "/Products",
"SuppliersDR" : "/Suppliers"
}
To only refresh the Products and Suppliers, the following call could be made.
store.refresh(refreshStoreCallback, errorCallback, ["SuppliersDR", "ProductsDR"]);
The database used on the device to store the offline data is created and optionally initially populated on the SMP server before it is sent to the device the first time the store is opened. This can speed up the time taken when the offline store opens for the first time. As well if the data is cached in the SMP server, calls to refresh the data from the device will use the cached data in the SMP server rather than making requests to the OData producer.
Assume the application has the following defining requests.
"definingRequests" : { //the below requests will be used to populate the offline store
"CategoriesDR" : "/Categories",
"ProductsDR" : "/Products",
"SuppliersDR" : "/Suppliers"
}
Also assume that the following application configuration file is specified in the management cockpit under Applications > com.mycompany.offline > Import Settings
[endpoint]
Name=com.mycompany.offline
prepopulate_offline_db=Y
prepopulate_offline_db_interval=1440
[defining_request]
name=CategoriesDR
is_shared_data=Y
refresh_interval=1440
track_deltas=NEVER
delta_token_lifetime=0
[defining_request]
name=ProductsDR
is_shared_data=Y
refresh_interval=1440
track_deltas=NEVER
delta_token_lifetime=0
[defining_request]
name=SuppliersDR
is_shared_data=Y
refresh_interval=1440
track_deltas=NEVER
delta_token_lifetime=0
The above configuration file specifies that the offline database is prepopulated and filled with data that is at most less than one day old (1440 minutes = 60 minutes * 24 hours).
It also indicates that if the mobile device requests a refresh operation and the data on the server is less than one day old, the SMP server uses the cached data rather than contacting the OData producer.
Note, these options are further explained at Defining an Application Configuration File with Defining Requests.
If multiple requests need to be made, it is more efficient to send them as one HTTP(S) request than in multiple requests.
The following steps demonstrate how to perform create and an update operation in one request using the create, update, delete app.
See also Batch Operations, Addressing Links between Entries, Referencing Requests in a Change Set (Content-ID Referencing) and $batch Processing. Note that Content-ID referencing is not supported in SAP NetWeaver Gateway as mentioned under the Constraints section of the last link.
<button id="deepinsert" onclick="batchCreateAndUpdate()">Batch Create and Update</button>
function batchCreateAndUpdate() {
var oHeaders = {
};
var params = {
__batchRequests: [ {
__changeRequests: [ {
requestUri: getEndPointURL() + "/Products",
method: "POST",
data : {
"ID" : 199,
"Name" : "Cheese",
"Description" : "Orange, aged 1 year",
"Price" : "4.99",
"Rating" : 1,
"ReleaseDate" : "2014-01-01T00:00:00"
}
},
{
requestUri: getEndPointURL() + "/Products(0)",
method: "PUT",
data: {
"ID" : 1,
"Name" : "Bread",
"Description" : "Whole grain bread",
"Price" : "2.99",
"ReleaseDate" : "2014-01-01T00:00:00"
}
}
]
}
]
};
oHeaders['Authorization'] = authStr;
//oHeaders['X-SMP-APPCID'] = applicationContext.applicationConnectionId; //this header is provided by the logon plugin
var request = {
headers : oHeaders,
requestUri : getEndPointURL() + "/$batch",
method : "POST",
data : params
};
OData.request(request, read, errorCallback, OData.batchHandler);
}
Note, this feature was added in SP08 of the SDK. A deep insert allows creating a related entity. With the Kapsel OData Offline plugin the related entity must not be in a one to many relationship.
See also
Create Related Entities When Creating an Entity
This example will add a button that when pressed will add a new category named Toys and a new product named RC Helicopter. The following steps demonstrate this using the create, update, delete app.
<button id="deepinsert" onclick="deepInsert()">Deep Insert</button>
//Example of an insert that also creates a related item (Category). function deepInsert() { var oHeaders = {}; var params = { "ID" : 99, "Name" : "RC Helicopter", "Description" : "Flight time 5 minutes", "Price" : "29.99", "Rating" : 1, "ReleaseDate" : "2014-01-01T00:00:00", "Category" : { //Adding a new category entity "ID" : 3, "Name" : "Toys" }, //adding navigation properties using entity bindings while offline is not currently supported SP08. //https://msdn.microsoft.com/en-us/library/dd541294(prot.20).aspx /*"Supplier" : { "__metadata": {"uri": "/Suppliers(1)"} }*/ }; oHeaders['Authorization'] = authStr; var request = { headers : oHeaders, requestUri : getEndPointURL() + "/Products", method : "POST", data : params }; OData.request(request, read, errorCallback); }
<th align="left">Category</th>
var cell7 = row.insertCell(6);
...
cell7.innerHTML = data.results[i].Category.Name;
var sURL = getEndPointURL() + "/Products?$expand=Supplier,Category&$orderby=Name desc";
"definingRequests" : {
"ProductsDR2" : "/Products?$expand=Category,Supplier"
}
There are multiple ways to access binary data in OData. The following demonstrates a few examples.
http://services.odata.org/V2/Northwind/Northwind.svc/$metadata
contains
<Property Name="Picture" Type="Edm.Binary" Nullable="true" MaxLength="Max" FixedLength="false"/>
The following URL will return the image data.
http://services.odata.org/V2/Northwind/Northwind.svc/Categories(1)/Picture/$value
The following doesn't appear to show the image. I am not sure how to make use of the stream returned as the image does not show.
<img src="http://services.odata.org/V2/Northwind/Northwind.svc/Categories(1)/Picture/$value">
Perhaps it is because the Content-Type is application/octet-stream rather than image/jpeg; charset=UTF-8
Support for this was added in SP08 of the SDK. It is also possible to enable the end user to decide on an attachment by attachment basis which attachments should be made available while offline by calling
store.registerStreamRequest("stream",
For additional details see Offline Media Stream Setup.
https://sapes1.sapdevcenter.com:443/sap/opu/odata/IWFND/RMTSAMPLEFLIGHT/$metadata
contains
<EntityType Name="Carrier" m:HasStream="true" sap:content-version="1">
https://sapes1.sapdevcenter.com:443/sap/opu/odata/IWFND/RMTSAMPLEFLIGHT/CarrierCollection('SR')
returns
<link href="CarrierCollection('SR')/$value" rel="edit-media" type="image/gif"/>
<content type="image/gif" src="CarrierCollection('SR')/$value"/>
<m:properties>
<d:mimeType>image/gif<d:mimeType>
</m:properties>
It is not clear to me how to access the binary data as the following link does not appear to return the binary data.
https://sapes1.sapdevcenter.com/sap/opu/odata/IWFND/RMTSAMPLEFLIGHT/CarrierCollection('SR')/$value
See also
Representing Media Link Entries.
This is something introduced in OData v 3.0 and hence is not currently supported in the Kapsel Offline OData plugin with SDK SP08.
http://services.odata.org/V3/OData/OData.svc/$metadata
contains
<Property Name="Photo" Type="Edm.Stream" Nullable="false"/>
http://services.odata.org/V3/OData/OData.svc/PersonDetails(0)?$format=json
returns
{
"odata.metadata":"http://services.odata.org/V3/OData/OData.svc/$metadata#PersonDetails/@Element",
"PersonID":0,
"Age":21,
"Gender":false,
"Phone":"(505) 555-5939",
"Address":{
"Street":"2817 Milton Dr.",
"City":"Albuquerque",
"State":"NM",
"ZipCode":"87110",
"Country":"USA"
},
"Photo@odata.mediaETag":"\"nCP1Tf4Uax96eYIWjvoC/6ZflG8=\""
}
When accessed via datajs it appears as below.
It is not clear to me how to access the binary data. I would have expected a media_src entry to describe the URL to be used to retrieve the binary data. The following URLs do not appear to return anything.
http://services.odata.org/V3/OData/OData.svc/PersonDetails(0)/Photo
http://services.odata.org/V3/OData/OData.svc/PersonDetails(0)/Photo/$value
When the store fails to open or fails during a flush or refresh, additional details regarding the error can often be seen in one of three log files; the SMP server log file, the JavaScript console or the device log.
The Offline component of the SMP server should have its log level increased when debugging.
The SMP server's log file is located at
C:\SAP\MobilePlatform3\Server\log\YKFN00528072A-smp-server.log
The JavaScript console log can also be useful to monitor. To do so, Open Chrome and press Ctrl Shift I when using an Android 4.4 emulator or device or use Safari on a Mac and choose Develop iPhone Simulator or device. See also Debugging Appendix.
Finally the Android or iOS log can also be useful.
The following are some examples of error conditions and the associated logged messages for these problems.
The endpoint in the management cockpit was modified from
http://services.odata.org/V2/OData/OData.svc
to
http://services.odata.org/V3/OData/OData.svc
JavaScript console from debugging an Android device.
store.open called at 14:20.20 index.html:270
An error occurred "Unknown network error occured" index.html:69
Device is ONLINE
Android LogCat Output
10-29 14:20:20.538: I/chromium(16869): [INFO:CONSOLE(270)] "store.open called at 14:20.20", source: file:///android_asset/www/index.html (270)
10-29 14:20:25.653: E/SMP_ODATA(16869): Failed to open store
10-29 14:20:25.653: E/SMP_ODATA(16869): com.sap.smp.client.odata.exception.ODataNetworkException: Unknown network error occured
10-29 14:20:25.653: E/SMP_ODATA(16869): at com.sap.smp.client.odata.offline.ODataOfflineStore.openStoreSync(ODataOfflineStore.java:500)
10-29 14:20:25.653: E/SMP_ODATA(16869): at com.sap.smp.client.odata.offline.ODataOfflineStore$OpenStoreWithOptionsThread.run(ODataOfflineStore.java:406)
10-29 14:20:25.653: E/SMP_ODATA(16869): Caused by: com.sap.smp.client.odata.offline.ODataOfflineException: [-10210] The operation failed due to an error on the server.
10-29 14:20:25.653: E/SMP_ODATA(16869): ... 2 more
Here are some snippets from the SMP server log file.
2014 10 29 14:20:37#0-400#ERROR#com.sap.mobile.platform.server.mobilink.SessionLogger##anonymous#Thread-213###[-100099] An error occurred while parsing the metadata document for service "https://10.7.171.223:8080/com.mycompany.offline" com.sap.odata.offline.util.MODataException: [-100099] An error occurred while parsing the metadata document for service "https://10.7.171.223:8080/com.mycompany.offline"
...
Caused by: org.apache.olingo.odata2.api.ep.EntityProviderException: Invalid or missing namespace for 'Schema'.
Notice that the serviceRoot is incorrect. It has an x added to the end of value. The service root should be a connection name such as com.mycompany.offline.
var properties = {
"name": "ProductsOfflineStore",
"host": smpServerHost,
"port": smpServerPort,
"https": smpServerProtocol == "https",
"serviceRoot" : "com.mycompany.offlinex",
"streamParams" : "custom_header=Authorization:" + authStr + ";",
"definingRequests" : {
"ProductsDR" : "/Products"
}
};
store = sap.OData.createOfflineStore(properties);
JavaScript console from debugging an iOS simulator.
[Log] store.open called at 11:10.06 (index.html, line 270)
[Log] An error occurred "[-10210] The operation failed due to an error on the server." (index.html, line 69)
[Log] Device is ONLINE (index.html, line 264)
Here are some snippets from the SMP server log file.
2014 10 29 11:09:38#0-400#INFO#com.sap.mobile.platform.server.mobilink.SessionLogger##anonymous#Thread-229####null#null#null#info#Offline#null#null#18730952-12fa-4f42-b611-21b1468c5051#null#1414609778664#null#com.sap.mobile.platform.server.mobilink.SessionLogger:info#Service root: https://10.7.171.223:8080/com.mycompany.offlinex#null#385#null#28#null |
...
2014 10 29 11:09:38#0-400#INFO#com.sap.mobile.platform.server.mobilink.SessionLogger##anonymous#Thread-229####null#null#null#info#Offline#null#null#18730952-12fa-4f42-b611-21b1468c5051#null#1414609778745#null#com.sap.mobile.platform.server.mobilink.SessionLogger:info#Sending HTTP GET "https://10.7.171.223:8080/com.mycompany.offlinex/$metadata"#null#385#null#89#null |
2014 10 29 11:09:38#0-400#ERROR#com.sap.mobile.platform.server.mobilink.SessionLogger##anonymous#Thread-229###[-100025] An error occurred while communicating with the OData server to retrieve the result of request "https://10.7.171.223:8080/com.mycompany.offlinex/$metadata" com.sap.odata.offline.util.MODataException: [-100025] An error occurred while communicating with the OData server to retrieve the result of request "https://10.7.171.223:8080/com.mycompany.offlinex/$metadata"
...
Caused by: com.sap.odata.offline.util.MODataException: [-100010] Retrieve metadata failed because the OData server returned HTTP code, 404, with message: null
Notice the addition of 123456 to the authorization header
var properties = {
"name": "ProductsOfflineStore",
"host": smpServerHost,
"port": smpServerPort,
"https": smpServerProtocol == "https",
"serviceRoot" : appID,
//There is a cookie store for JavaScript which is different from the Java one used by the Offline plugin
"streamParams" : "custom_header=Authorization:123456" + authStr + ";custom_header=X-SMP-APPCID:" + appCID + ";",
"definingRequests" : {
"ProductsDR" : "/Products"
}
};
store = sap.OData.createOfflineStore(properties);
JavaScript Console from debugging an Android device.
store.open called at 13:53.33 index.html:270
An error occurred "Unknown network error occured" index.html:69
Device is ONLINE
Android LogCat Output
10-29 13:53:33.651: I/chromium(754): [INFO:CONSOLE(270)] "store.open called at 13:53.33", source: file:///android_asset/www/index.html (270)
10-29 13:53:56.713: E/SMP_ODATA(754): Failed to open store
10-29 13:53:56.713: E/SMP_ODATA(754): com.sap.smp.client.odata.exception.ODataNetworkException: Unknown network error occured
10-29 13:53:56.713: E/SMP_ODATA(754): at com.sap.smp.client.odata.offline.ODataOfflineStore.openStoreSync(ODataOfflineStore.java:500)
10-29 13:53:56.713: E/SMP_ODATA(754): at com.sap.smp.client.odata.offline.ODataOfflineStore$OpenStoreWithOptionsThread.run(ODataOfflineStore.java:406)
10-29 13:53:56.713: E/SMP_ODATA(754): Caused by: com.sap.smp.client.odata.offline.ODataOfflineException: [-10207] Communication with the server failed due to invalid authentication
10-29 13:53:56.713: E/SMP_ODATA(754): ... 2 more
Here are some snippets from the SMP server log file.
2014 10 29 13:53:59#0-400#ERROR#com.sap.mobile.platform.server.coreservices.configuration.service.ApplicationConnectionServiceImpl##anonymous#http-bio-8080-exec-10####null#null#null#error#Registration#null#null#ddafa3cc1fa24acab78726e30bd48967#null#1414619639774#null#com.sap.mobile.platform.server.coreservices.configuration.service.ApplicationConnectionServiceImpl:isAppConnInputValid#Invalid application connection#null#644#null#0#null |
2014 10 29 13:53:59#0-400#ERROR#com.sap.mobile.platform.server.online.filter.application.SMPApplicationSecurityFilter##anonymous#http-bio-8080-exec-10####null#null#null#error#Other#null#null#ddafa3cc1fa24acab78726e30bd48967#null#1414619639774#null#com.sap.mobile.platform.server.online.filter.application.SMPApplicationSecurityFilter:doFilter#Application connection is not found::null#null#644#null#1#null |
JavaScript Console output from debugging an iOS simulator.
[Log] store.flush called at 10:58.56 (index.html, line 537)
[Log] An error occurred "[-10060] An error occurred while performing a synchronization. Reason: -1305 (MOBILINK_COMMUNICATIONS_ERROR) %1:220 %2:The operation couldn't be completed. Connection refused %3:61" (index.html, line 95)
[Log] Device is ONLINE (index.html, line 531)
JavaScript Console output from debugging an iOS simulator.
[Log] store.open called at 10:12.04 (index.html, line 537)
[Log] Store opened in 0.694 seconds at 10:12.04 (index.html, line 537)
[Log] Store is OPEN. Device is ONLINE (index.html, line 531)
[Log] store.refresh called at 10:12.10 (index.html, line 537)
[Log] Device is OFFLINE (index.html, line 531)
[Log] An error occurred "[-10060] An error occurred while performing a synchronization. Reason: -1305 (MOBILINK_COMMUNICATIONS_ERROR) %1:220 %2:The operation couldn't be completed. Network is unreachable %3:51" (index.html, line 95)
[Log] Device is OFFLINE (index.html, line 531)
Note, that the flush or refresh operation continues with a short network disconnect.
JavaScript Console output
[Log] store.flush called at 10:56.06 (index.html, line 537)
[Log] Device is OFFLINE (index.html, line 531)
[Log] Device is ONLINE (index.html, line 531)
[Log] Store flushed in 15.39 seconds at 10:56.22 (index.html, line 537)
When the offline store is open, URLs that match the defining request are handled by the offline store rather than being sent out over the network. For this to work correctly the option Rewrite URL in SMP much be selected for the rewrite mode in the Back End tab of the management cockpit. There is a known issue with the SMP SP07 server in that if the endpoint specified does not include a default port such as 443 or 80 but the URL's returned from a request do or vice versa, the URL's are not rewritten. This has been reported as BCP issue 1570293744.
Is there any way to add additional "defining Requests" after an OData offline db got created?
There is a product collection with 1 million entries. I do not want to download this complete collection, so I am setting my definingrequest to an OData collection with filter to city eq Berlin. This is working and will create the database for me with a few thousand products. Now I am in another city and want to add the products of that other city, e.g. Hamburg into my already existing offlineDB. Is this somehow possible?
There is no way to add additional defining requests to an already existing database. Once a database is created, the defining requests become fixed.
One potential way to work around this is to create multiple stores on your device. By using different storeName values in the store options, you can have multiple stores existing at the same time. So you can have a store_Hamburg and a store_Berlin and open either depending on where you are.
Is there any way to perform a free text search on the offline database?
I know that in OData V4 a new $search query parameter got introduced, but I guess this one is not yet available in the offline store.
The offline store does not yet support the $search query parameter.
However, it does support the $filter indexof operation. With this, you can do searches such as:
/Products?$filter=indexof(Name, 'wrench') ge 0
to search for entities containing a string
I know that function imports are not supported in offline. But if there are entities with function imports and without function imports, can we use entities without function imports offline?
Also, what about in the case of variables with size more than 512? If any of the collection having variable size more than 512 can it be used when offline?
We essentially ignore function imports. So as long as you don’t try to use them, you can offline other entity sets fine.
We currently don’t support KEY properties or REFERENTIAL CONSTRAINT properties with a greater size. However, all other properties can have a greater size.
I am getting an error when opening my offline store such as
Provided value for the property 'Price' is not compatible with the property
The V2 spec requires that Edm.Double be represented as a JSON string, but this service is returning them as a JSON floating point number. The parser in the offline server is strict and expects a string so it is failing when it is parsing the Edm.Double properties.
A work around to this issue is to force the offline server to use ATOM when retrieving the defining requests. That can be done by configuring the offline application using an INI file and using that under Applications > com.mycompany.offline > Import Settings.
Name=com.mycompany.offline5
request_format=atom
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
User | Count |
---|---|
38 | |
19 | |
13 | |
13 | |
11 | |
10 | |
10 | |
10 | |
8 | |
8 |