Initialize the MobileFirst web
SDK before using its APIs to develop your web application.
About this task
Add the initialization code that is described in the
following procedure to your application's JavaScript code (for example, in index.js).
Procedure
- Define an initialization-properties JSON object that sets
the following mandatory SDK initialization properties:
- mfpContextRoot - the context root of your
application's MobileFirst Server runtime.
- applicationId - a unique identifier for your
application.
For example, the following code defines an mfpInitProperties variable
that sets the context root of MobileFirst Server (mfpContextRoot)
to /mfp (the default context root of the MobileFirst Development Server),
and sets the application ID (applicationId) to com.example.myapplication:var mfpInitProperties = {
'mfpContextRoot' : '/mfp' ,
'applicationId' : 'com.example.myapplication'
};
- Call the WL.Client.init method of the core web-SDK module
(ibmmfpf.js) to initialize the SDK. Pass the
initialization-properties JSON object that you defined in the previous step
(mfpInitProperties) as the parameter of this method. Use a JavaScript promise to
implement the initialization-completion logic of the asynchronous
init method, as demonstrated in the following
example:
WL.Client.init(mfpInitProperties).then
(function(){
console.log('MobileFirst web SDK initialized');
// Application initialization logic
});
Note: For
backwards compatibility with Cordova applications that use the same MobileFirst client JavaScript API, you can
select to implement the initialization-completion logic in a
wlCommonInit function instead of using a JavaScript promise.
What to do next
You can now use the JavaScript client-side
API to develop your application and add MobileFirst capabilities.
If you selected to add the web-analytics module of the SDK (ibmmfpfanalytics.js),
as outlined in Adding the MobileFirst SDK to web applications, use the JavaScript web
analytics client-side API to add MobileFirst Analytics features
to your application (see Analytics and Logger).
To
use server-side features, such as adapters and security,
first register your application to a running instance of MobileFirst Server.
See Registering web applications to MobileFirst Server.