Namespace: Logon

Members

(static) applicationId

Example

// After calling the init function
alert("The app ID for this app is: " + sap.Logon.applicationId);

(static) core

(static) fireEvent

(static) loadConfiguration

Methods

(static) changePassword(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(context){
    alert("Password successfully changed.");
}
sap.Logon.changePassword(successCallback,errorCallback);

(static) deletePasscodeManager(successCallback, errorCallback)

Parameters:

Example

var successCallback = function(){
    alert("successfully deleted all data");
}

var errorCallback = function(errorInfo){
    alert("error: " + JSON.stringify(errorInfo));
}
sap.Logon.deletePasscodeManager(successCallback, errorCallback);

(static) get(onsuccess, onerror, key)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var getSuccess = function(value){
    alert("value retrieved from the store: " + JSON.stringify(value));
}
var setSuccess = function(){
    sap.Logon.get(getSuccess,errorCallback,'someKey');
}
sap.Logon.set(setSuccess,errorCallback,'someKey', 'some string (could also be an object).');

(static) getConfiguration(onsuccess, onerror, key)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var getSuccess = function(value){
    alert("value retrieved from the store: " + JSON.stringify(value));
}
    sap.Logon.getConfiguration(getSuccess,errorCallback,'authentication');

(static) init(successCallback, errorCallback, applicationId, contextopt, logonViewopt, certificateProviderClassNameopt)

Parameters:

Example

// a custom UI can be loaded here
var logonView = sap.logon.LogonJsView;

// The app ID
var applicationId = "someAppID";

// You only need to specify the fields for which you want to set the default.   These values are optional because they will be 
// used to prefill the fields on Logon's UI screen.
// You can override UI defaults by setting the "custom" property.
var defaultContext = {
 "appName": "My App",
 "serverHost": "defaultServerHost.com",
 "https": false,
 "serverPort": "8080",
 "user": "user1",
 "password": "Zzzzzz123",
 "communicatorId": "REST",
 "securityConfig": "sec1",
 "farmId": "",
 "resourcePath": "",
 "passcode": "Aaaaaa123",
 "unlockPasscode": "Aaaaaa123",

 "custom": {
     // This is the Fiori Client background image
     "backgroundImage": "../../../background.jpg",

     // These fields will be hidden, but any default values specified above will still be sent
     "hiddenFields": ["resourcePath", "farmId", "securityConfig"],

     // This option hides the logo and copyright information
     "hideLogoCopyright": true,

     // This option specifies a custom logo image
     "copyrightLogo": "../../../sapLogo.png",

     // This option specifies both lines of the copyright message
     "copyrightMsg": ["Copyright 2016 SAP", "All rights reserved."],

     // This option skips the passcode screen
     "disablePasscode": false

     // This option specifies the css file used to customize the logon screen
     "styleSheet": "../../../custom.css"
 }
};

var app_context;

var successCallback = function(context){
    app_context = context;
}

var errorCallback = function(errorInfo){
    alert("error: " + JSON.stringify(errorInfo));
}
sap.Logon.init(successCallback, errorCallback, applicationId, defaultContext, logonView, "customCertProvider");

(static) initPasscodeManager(successCallback, errorCallback, applicationId, customViewopt, passcodePolicy, context, credentialProviderID)

Parameters:

Example

// a custom UI can be loaded here
var logonView = sap.logon.LogonJsView;

// The app ID
var applicationId = "someAppID";

var successCallback = function(state){
    alert("successfully initialzed, resulting state: " + JSON.stringify(state));
}

var errorCallback = function(errorInfo){
    alert("error: " + JSON.stringify(errorInfo));
}
sap.Logon.initPasscodeManager(successCallback, errorCallback, applicationId, customView, passcodePolicy, context, credentialProviderID);

(static) lock(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(){
    alert("Locked!");
}
sap.Logon.lock(successCallback,errorCallback);

(static) managePasscode(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(context){
    alert("Passcode successfully managed.");
}
sap.Logon.managePasscode(successCallback,errorCallback);

(static) performSAMLAuth(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(){
    alert("The saml authentication was successful.");
}
sap.Logon.performSAMLAuth(successCallback,errorCallback);

(static) refreshAccessToken(onsuccess, onerror)

Parameters:

Example

sap.Logon.refreshAccessToken(function (success) {
      utils.debug("Session has been refreshed.");
  }, function (error) {
      utils.log("Failed to refresh the session: " + error);
  }
);

(static) refreshCertificate(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(){
    alert("The certificate is refreshed.");
}
sap.Logon.refreshCertificate(successCallback,errorCallback);

(static) refreshSession(onsuccess, onerror)

Parameters:

Example

var successCallback = function(){
    alert("Refreshing the session was successful");
}
var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
sap.Logon.refreshSession(successCallback,errorCallback);

(static) set(onsuccess, onerror, key, value)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var getSuccess = function(value){
    alert("value retrieved from the store: " + JSON.stringify(value));
}
var setSuccess = function(){
    sap.Logon.get(getSuccess,errorCallback,'someKey');
}
sap.Logon.set(setSuccess,errorCallback,'someKey', 'some string (could also be an object).');

(static) showCertificateProviderScreen(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(context){
    alert("The showRegistrationData screenflow was successful.");
}
sap.Logon.showCertificateProviderScreen(successCallback,errorCallback);

(static) showRegistrationData(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(context){
    alert("The showRegistrationData screenflow was successful.");
}
sap.Logon.showRegistrationData(successCallback,errorCallback);

(static) startLogonInit()

Parameters:

Example

var context = {};
var appDelegate = {}; 
context.appConfig.appID = "com.mycompany.logon"; // Change this to app id on server
context.appConfig.isForSMP = true;
context.appConfig.certificate = "X509FileCertificateProvider"; //the value must match the key defined in the plist file
context.operation.logonView = sap.logon.LogonJsView;
appDelegate.logonSuccessCallback(result) {
     alert("Successfully Registered");
     applicationContext = result;
}
appDelegate.logonErrorCallback(error) {   //this method is called if the user cancels the registration.
     utils.log("An error occurred:  " + JSON.stringify(error));
     if (device.platform == "Android") {  //Not supported on iOS
         navigator.app.exitApp();
     }
}
 // Optional context for initial values and UI customization
context.smpConfig = {
  "appName": "My App",
  "serverHost": "torn00461340a.amer.global.corp.sap", //Place your SMP 3.0 server name here
  "https": "true",
  "serverPort": "8081",
  "communicatorId": "REST",
  "passcode": "password",  //note hardcoding passwords and unlock passcodes are strictly for ease of use during development
  //once set can be changed by calling sap.Logon.managePasscode()
  "unlockPasscode": "password",
  "passcode_CONFIRM":"password",

  // Use this to customize the Logon plugin UI
  "custom": {
     // This is the Fiori Client background image
     "backgroundImage": "../../../background.jpg",

     // These fields will be hidden, but any default values specified above will still be sent
     "hiddenFields": ["resourcePath", "farmId", "securityConfig"],

     // This option hides the logo and copyright information
     "hideLogoCopyright": true,

     // This option specifies a custom logo image
     "copyrightLogo": "../../../sapLogo.png",

     // This option specifies both lines of the copyright message
     "copyrightMsg": ["Copyright 2016 SAP", "All rights reserved."],

     // This option skips the passcode screen
     "disablePasscode": false

     // This option specifies the css file used to customize the logon screen
     "styleSheet": "../../../custom.css"
  }
};
sap.Logon.startLogonInit(appDelegate, context);

(static) unlock(onsuccess, onerror)

Parameters:

Example

var errorCallback = function(errorInfo){
    alert("Error: " + JSON.stringify(errorInfo));
}
var successCallback = function(context){
    alert("Registered and unlocked.  Context: " + JSON.stringify(context));
}
sap.Logon.unlock(successCallback,errorCallback);

Type Definitions

errorCallback(errorObject)

Parameters:

getSuccessCallback(value)

Parameters:

successCallback(context)

Parameters:

successCallbackNoParameters()