Show TOC

Hybrid SDK (Kapsel) PluginsLocate this document in the navigation structure

Developers use one or more Hybrid SDK (Kapsel) plugins in Cordova applications to add SAP Mobile Platform awareness and capabilities to the application. The plugins that you use vary depending on your application’s requirements. Manage these Cordova plugins in a Cordova project using the standard Cordova CLI plugin commands.

Note

The Hybrid SDK (Kapsel) plugin IDs have been changed to follow the naming change made by the Cordova plugins. For example, com.sap.mp.cordova.plugins.logon is now kapsel-plugin-logon. For more information, see the API references for the Kapsel plugins.

You can add and use the Cordova Crosswalk plugin with any Kapsel plugins.

Table 1: Hybrid SDK (Kapsel) Plugins
Plugin Use
AppUpdate Plugin (Required) As the lifecycle management plugin, AppUpdate manages application update downloads and installs updates to the Kapsel application. The AppUpdate plugin initiates the check for an update when the application starts, and when it resumes after being suspended. You can also start an app update manually, if required.

AppUpdate requires the Logon plugin; the two plugins are installed together.
Attachment Viewer Plugin Handles how the application views an attachment.
AuthProxy Plugin Provides capabilities that are used in certain security scenarios such as mutual authentication and in token-based SSO environments.
Barcode Scanner Plugin Enables Hybrid SDK (Kapsel) applications to scan and decode a barcode using the device camera.
Calendar Plugin Enables Hybrid SDK (Kapsel) applications to use the default calendar of Android and iOS devices.
Certificate Delivery Services Provider Plugin Contacts the SAP Mobile Secure server to provide client side certificate. You can use this certificate to authenticate with SAP backend systems.
Encrypted Storage Plugin Adds an encrypted persistent store (key/value pair) to a Cordova application, which allows you to build an application that securely stores application data while offline, or while the application is not running. Unlike the built-in local storage, EncryptedStorage is nonblocking.
End-to-End Trace Plugin Allows you to perform an end to end trace within a Hybrid SDK (Kapsel) application to capture trace data, and upload the data to the server for analysis with SAP Solution Manager.
FederationProvider Plugin Allows credential sharing across multiple applications, provided the user certificate is signed by the same developer certificate.
Logger Plugin Lets you have an application write entries to a local log, which can be uploaded to the SAP Mobile Platform Server for analysis. The SAP Mobile Platform administrator can manage setting the application log remotely from the server and upload device logs to the server without user intervention.
Logon Plugin

Manages user onboarding and the authentication process for SAP Mobile Platform applications. Most other Hybrid SDK (Kapsel) plugins use capabilities that this plugin exposes. The plugin interfaces with the SAP Afaria client as well as the Client Hub application to help manage authentication and single sign-on.

You can install this plugin standalone, or it is automatically installed with AppUpdate.
Offline OData Plugin Provides offline OData support to Cordova applications. The plugin uses the SAP Mobile platform client SDK OData component.
Printer Plugin Enables Hybrid SDK (Kapsel) applications to print HTML documents.
Push Notification Plugin Manages the process of registering for push requests as well as exposes events that help you code an application to respond to push notifications. Once the push registration is completed, the plugin uses the Settings plugin to exchange application settings information with SAP Mobile Platform Server so it knows how to manage delivery of push notifications to the application.
Settings Plugin Required if you are using the Push plugin. Manages the exchange of settings information between the app and the SAP Mobile Platform server. Used by the Push plugin.
Usage Plugin Handles usage tracking, and allows developers to collect usage data for analytics and charts through timing and log APIs.

You can also use some Hybrid SDK (Kapsel) plugins for developing custom Fiori Client applications. For more information, see SAP Fiori Client.


In this section:
    Logon Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Manage application registration and authentication processes either through SAP Mobile Platform Server, SAP HANA Cloud Platform mobile services or through SAP Gateway server.
    AppUpdate Plugin
    (Android and iOS) Remotely update contents in the www folder and the config.xml of a deployed Hybrid SDK (Kapsel) application.
    InAppBrowser Plugin
    (Android, iOS, Windows 8.1, and Windows 10) The InAppBrowser plugin provides Kapsel applications with an in-app web browser view.
    AuthProxy Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Automate accepting SSL certificates returned by a call to a Web resource. AuthProxy makes an HTTPS request with mutual authentication, and optionally intercepts all Web requests to handle basic authentication and X509 certificate challenges.
    Attachment Viewer Plugin
    (Android, iOS, Windows 8.1, and Windows 10) The Attachment Viewer plugin handles how the application allows you to view an attachment.
    Barcode Scanner Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Enables Hybrid SDK (Kapsel) applications to scan and decode a barcode using the device camera.
    Calendar Plugin
    (Android and iOS) Enables Hybrid SDK (Kapsel) applications to use the default calendar.
    Certificate Delivery Services Provider Plugin
    (Android and iOS) The Certificate Delivery Services (CDS) provider is a Hybrid SDK (Kapsel) plugin that contacts the SAP Mobile Secure server to provide a clientside certificate. You can use this certificate to authenticate with SAP back-end systems.
    End-to-End Trace Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Handles end-to-end tracing in Hybrid SDK (Kapsel) applications.
    Encrypted Storage Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Provides an encrypted local storage mechanism to that allows a Hybrid SDK (Kapsel) application's private data to be stored on the user's device. The plugin adds an encrypted key/value pair storage option to Cordova, which uses the same API method signature as the browser’s local storage option and is nonblocking.
    Logger Plugin
    (Includes client-side APIs that are supported on Android, iOS, Windows 8.1, and Windows 10). Allows you to log information to trace bugs or other issues in your Hybrid SDK (Kapsel) application for analysis.
    Offline OData Plugin
    (Supports OData V2 for Android, iOS, Windows 8.1, and Windows 10). Provides offline OData support to Hybrid SDK (Kapsel) applications.
    Printer Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Enables Hybrid SDK (Kapsel) applications to print documents.
    Push Notification Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Push plugin APIs allow you to send push data from the back-end data source to Hybrid SDK (Kapsel) applications, Fiori Client applications, or packaged Fiori applications.
    Settings Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Invokes the settings exchange API on the SAP Mobile Platform Server, which sends the Hybrid SDK (Kapsel) application connection settings to the server and downloads application settings from the server.
    Usage Plugin
    (Android, iOS, Windows 8.1, and Windows 10) Collects information about how mobile end users interact with your mobile apps, details of the operating systems, and device platforms on which the apps are running.
    FederationProvider Plugin
    (Android and iOS) The FederationProvider plugin is a CertificateProvider implementation that enables sharing of X509 client certificates for authentication across multiple applications.
    Removing Hybrid SDK (Kapsel) Plugins
    Remove Hybrid SDK (Kapsel) plugins from the application.

Parent topic: Hybrid (Kapsel) App Development