Application Customization Resource Bundles

(Does not apply to Hybrid App or Agentry SDK clients) For supported application types, customization resource bundles enable you to associate deployed client applications with different versions of customization resources.

A customization resource bundle is a JAR file that includes a manifest file of name and version properties. The customization resource bundle does not contain any information that binds or helps bind to applications; it can be uploaded or exported during the definition of an application with SAP Control Center. A deployed customization resource bundle is read-only.

Implementing a customization resource bundle requires the coordination of various roles:
  1. (Application developer) Invokes the SDK API that downloads the customization resource bundle. Use the onCustomizationBundleDownloadComplete (in the Application Callback API) and BeginDownloadCustomizationBundle (in the SUPApplication class) methods to pair the application with the device, and reach the client application. See Developer Guide: OData SDK or any of the Object API Developer Guides.
    For example, for an application called SAP.Mobile.Application, you might implement the customization resource bundle invocation as follows:
    /// <summary>
    /// start downloading default resource bundle associated with the application.The resource bundle would be saved into writer stream provided by user.
    ///an application only bundle an resource
    ///</summary>
    ///<param name="writer">a writer stream provided by user
    ///</param>
    public void BeginDownloadCustomizationBundle(System.IO.Stream writer) { }
    
    /// <summary>
    /// start downloading resource bundle named customizationBundleID. The resource bundle would be saved into writer stream provided by user.
    ///</summary>
    ///<param name="customizationBundleID">the resource bundle name
    ///</param>
    ///<param name="writer">a writer stream provided by user
    ///</param>
    public void BeginDownloadCustomizationBundle(string customizationBundleID, System.IO.Stream writer) { } Sybase.Mobile.IApplicationCallback
    
    /// <summary>
    /// Invoked when download resource bundle complete.
    /// </summary>
    /// <param name="customizationBundleID">! the resource bundle name. if null, application default resource bundle is downloaded
    /// </param>
    void OnCustomizationBundleDownloadComplete(string customizationBundleID, int errorCode, string errorMessage);
  2. (Developer) Generates the JAR with the MANIFEST.MF, which includes these required properties:
    • Customization-Resource-Bundle-Name
    • Customization-Resource-Bundle-Version
  3. (Administrator) Uses SAP Control Center to upload the customization resource bundle to SAP Mobile Server then assign it to an application connection.
  4. Once the application activation process completes, the application is directed to the appropriate version of the resource bundle.
Related concepts
Native Notification Properties
Related tasks
Creating Object API Application Definitions
Creating Hybrid App Definitions
Creating REST API Application Definitions
Creating OData Application Definitions
Creating Agentry Application Definitions