Documentation Issues and Updates for SAP Mobile SDK

Read about updates, corrections, and clarifications to the documentation released with SAP Mobile Platform Mobile SDK.

Issue #Description
SMPONP-11797
Incorrect version numbers in tutorials
The topics in these tutorials should show version number 2.3, not 2.2 SP02:
  • Tutorial: Hybrid App Package Development > Developing a Hybrid App Package
  • Tutorial: BlackBerry Object API Application Development > Developing a BlackBerry Application > Creating the BlackBerry Project
  • Tutorial: Windows Mobile Object API Application Development > Developing a Windows Mobile Device Application
  • Tutorial: Windows Mobile Object API Application Development > Developing a Windows Mobile Device Application > Creating the User Interface for the Windows Mobile Device Application
  • Tutorial: Windows Object API Application Development > Developing a Windows Application
  • Tutorial: iOS Object API Application Development > Developing an iOS Application
SMPONP-11296
Code correction
The Technical Details for Developer Guide: OData SDK > Developing iOS Applications > OData SDK Components and APIs > SDMSupportability > SDMLogger shows the wrong code for retrieving all log messages. The correct code is:
[[SDMLogger instance] displayLogsWithLevel:DebugLoggingLevel forQueryOperation:GreaterEqual];
SMPONP-11276
Native IDEs support custom development for hybrids apps

The note in Supported Hardware and Software > SAP Mobile SDK Requirements > Supported Platforms and Development Environments > HTML5/JS Hybrid Apps should read:

Note: Custom development using native IDEs is supported. The Hybrid Web Container application is available in the form of a template project with static libraries for easy extensibility and branding. See Developer Guide: Hybrid Apps > Hybrid Web Container Customization.
SMPONP-8653
HTTP requests are recommended for all purposes

The topic SDMConnectivity Public APIs, in Developer Guide: OData SDK, contains a sentence in the last paragraph before the protocols that states "However, for development and testing purposes you can use HTTP requests." Disregard that statement.

HTTP requests can be used for all purposes, not only development and testing. You can develop productive OData applications using HTTP requests.

NA
The topic Composite Operation Requirements and Limitations located in SAP Mobile WorkSpace: Mobile Business Object Development describes functionality that is not implemented.

The topic includes this item: "SAP Mobile Server checks the graph version in the cache and compares it to the graph version in the operation replay message to be sure they agree prior to invoking the EIS. If the versions do not match, a conflict is detected and an error is generated in the SAP Mobile Server log file".

Workaround: Ignore the description. This functionality is not implemented.

NA
BES Requirements topic in Mobile Application Life Cycle omits requirement for BlackBerry Enterprise Server to have access to the internal network.

BES (hosted or not)

Workaround: When referring to the "BlackBerry Enterprise Server Requirements" table in BES Requirements topic in Mobile Application Life Cycle, include this row as the last row in that table:

Prerequisite Where to Find Information
Ensure BES, hosted or unhosted, has access to your internal network. Contact the system administrator for your internal network.
NA
Topic includes obsolete BlackBerry 5 example

Enabling Hybrid Web Container Message Notification in the Developer Guide: Hybrid Apps includes an example of a BlackBerry 9700 device running BlackBerry 5, which is not currently supported.

Workaround: Ignore the example.

RTC-269

The Developer Guide: iOS Object API Applications incorrectly documents the Metadata API class names.

The Developer Guide: iOS Object API Applications documents incorrect class names for the Metadata API. In code examples, the guide describes the SUPDatabaseMetaData and SUPClassMetaData classes. The correct classes are SUPDatabaseMetaDataRBS and SUPClassMetaDataRBS

Workaround: See the generated API reference information provided with the Mobile SDK for more information on these classes.

CR-710930

Start-up of an application always gets HTTP callback errors.

During initialization, the client may try several URLs in an attempt to discover the correct path to the SAP Mobile Platform server. During these attempts, 404 errors Page Not Found may occur and are reported to the OnHttpCommunicationError callback. This is expected behavior and you can safely ignore these initial 404 errors.

Workaround: If the 404 errors continue to occur after successful registration of the application or if registration never completes, verify the UrlSuffix setting of the application's ConnectionProperties object.

CR-710608

onHttpCommunicationError returns an unexpected code.

In an environment configured for SiteMinder authentication, the expectation is that onHttpCommunicationError is called back for error condition 302. This condition is not currently fulfilled by the Windows and Windows Mobile platforms; instead, they return 404 errors.

Workaround: None.

CR-708259
The developer guides do not document all the methods in the ConnectionPropertyType class.

Workaround: See the generated API reference information provided with the Mobile SDK for a complete list of methods in the ConnectionPropertyType class.