Show TOC

Adding the Settings PluginLocate this document in the navigation structure

To install the Settings plugin, use the Cordova command line interface.


  • Set up the development environment.
  • Create your Cordova project.
  • Add your OS platforms.


The Settings plugin has dependencies on the Logger plugin, so when you install the Settings plugin, the Logger plugin is added automatically.


  1. Add the Settings plugin by entering the following at the command prompt, or terminal:

    cordova plugin add kapsel-plugin-settings --searchpath KAPSEL_HOME/plugins

    Note KAPSEL_HOME=C:\SAP\MobileSDK3\KapselSDK.
  2. (Optional) To see a list of installed plugins in your Cordova project, open a command prompt or terminal window, navigate to your Cordova project folder, and enter:
    cordova plugins
    The Cordova command line interface returns a JSON array showing installed plugins, for example:
    [ 'cordova-plugin-camera',     
    'cordova-plugin-file' ] 

    This example shows that the Cordova project has the Cordova core Camera, Accelerator (device-motion), and File plugins installed.

  3. Modify the files in the Cordova project's www folder as appropriate for your project.
  4. Execute the following command to copy the files in the Cordova project's www folder to the platform directories:
    cordova prepare android
    cordova prepare ios
    cordova prepare windows 
  5. Use an integrated development environment to deploy and run the project.
    Note If you are using an iOS device, ensure to add the "clienthubEntitlements" to the Keychain Groups in the Entitlement section in Xcode.