Documentation Issues and Updates for Mobile SDK

The following note was omitted from the prerequisites in the 2.1.2 Tutorials:

Do not try to compile and run the tutorial example projects posted in http://scn.sap.com/docs/DOC-8803#section2. They are meant only as code examples.

In the topic Logging In, the second paragraph incorrectly lists the startConnection method as an appropriate method for user authentication. The paragraph should read:

Authenticate the user for data synchronization by calling the generated database API beginOnlineLogin method.

In the topic REST Web Services in Sybase Unwired WorkSpace - Mobile Business Object Development the statement:

"Supports resources with multiple representations (Transfer XML, JavaScript Object notation(JSON), or both)"

is not correct. The REST Service endpoint does not support JSON, so resources with multiple representations are not supported.

The topic Retrieving Information About Synchronization Groups in Developer Guide: iOS Object API Applications is not relevant to iOS.

Result checkers are now implemented through the OperationHandlerBase class, which replaces the ResultChecker class.

These topics have been added to Result Checkers in the Mobile Data Models: Using Mobile Business Objects 2.1 ESD #2.

You must set and save both the personalization and synchronization parameters.

• Add this information to Specifying Personalization Parameters and Specifying Synchronization Parameters.
  Note: If a synchronization parameter is mapped to a personalization parameter, no data is downloaded to the device until that mapped personalization parameter is set and saved."
• In Nonblocking Synchronization, add this step 2, or modify the existing step 2 to include:

  If there are personalization parameters and synchronization parameters, set and save them before making the first full synchronize call.

  PersonalizationParameters pp = SUP101DB.getPersonalizationParameters(); pp.setPKCity( "New York" ); pp.save();

  CustomerSynchronizationParameters sp = Customer.getSynchronizationParameters(); sp.setCityname("Kansas City"); sp.save();

Best practices and security audits require you to know how passwords are stored on a device. The Sybase Unwired Platform environment using native object APIs does not automatically store passwords on a device. It does support you using a secure DataVault to store passwords or using an offlineLogin feature.

The DataVault API is the recommended feature to use a password to access the application's sensitive data on the device. To use DataVault, you first create the application, an encryption key, the database, and a DataVault. You then create the log-in screen and display it during application startup. It calls the DataVault API to validate the one password entry. You must enter the password to unlock the application and provide access to any on-device data.

DataVault stores sensitive data securely such as the encryption key used to encrypt/decrypt the on-device database and the user's password. With that one valid password, the Unwired Platform application retrieves the database encryption key from the DataVault and uses that to open the encrypted on-device database.

Create a DataVault using the Security APIs section of the Developer Guide for the device you are using.

The offlineLogin feature uses a username and password to access the on-device data. To use the feature, you first create the application, an encryption key, and the database. A hashcode of your password is computed and applied automatically the first time you synchronize the application. It is stored in the offlineLogin table. You then create the log-in screen and display it during application startup. It calls the offlineLogin API to validate the username and password entries. You must enter the credentials to unlock the application and provide access to any on-device data.

You can access the data locally without Unwired Server communications. You must know the Unwired Platform username and password to log in. If successful the process authenticates the current credentials against the last successfully authenticated credentials and provides access to the on-device data.

This affects Testing Applications in the Developer Guide: iOS Object API Applications.

On a device, multiple applications are supported as expected (App1 uses App1 PIN and App2 uses App2 PIN after multiple launches); however, this multiple application support is not possible with the iOS simulator.

Incorrect path for Workflow Client files in tutorials.

In Tutorial: Mobile Workflow Package Development > Developing the Mobile Workflow Package > Installing the Mobile Workflow Package > Configuring the BlackBerry Simulator > Configuring the Mobile Workflow in the BlackBerry Simulator, step 4 gives the incorrect path for the Workflow client files.

The document states that they are located in C: Sybase\UnwiredPlatform\MobileSDK\ClientAPI\Workflow\BB; however, they are located in UnwiredPlatform_InstallDir\UnwiredPlatform\MobileSDK\HybridWeb\BB.

In Tutorial: Mobile Workflow Package Development > Developing the Mobile Workflow Package > Installing the Mobile Workflow Package > Configuring the Windows Mobile Emulator > Installing Sybase Messaging Runtime, step 5 gives the incorrect path for the SybaseMobileWorkflow.cab file.

The document states that the CAB file is located in: UnwiredPlatform_InstallDir\ClientAPI\Workflow\WM; however, the CAB file is located in UnwiredPlatform_InstallDir\UnwiredPlatform\MobileSDK\HybridWeb\WM.

Referencing custom resources in HTML elements requires the use of relative URLs. The parent directory may be the HTML directory, the root, or something else. There is no guarantee that the URL structure is always http://hostname/html/workflow.html. It is possible to copy the resources into each localization directory or reference the resources from one directory (paying attention to localization paths).

An example of a useful helper function to get the relative path to the HTML directory is:

/**
 * Returns relative URL to the html directory
 */
function getRelativeRoot()
{
   return ((resources != null) ? "../" : ""
}

// Helper function usage
var imageElement = document.getElementById("ImageElement");
imageElement.src = getRelativeRoot() + "images/myImage.gif";

This affects Mobile Workflow Development in the Developer Guide: Mobile Workflow Packages.

Use a custom Java class to implement custom error checking.

See the topic Writing a Custom Result Checker.

Use OHLog to trap warnings but not halt execution of the result checker.

See the topic Result Checker Logging.