60 mobiandr sdk en

60 mobiandr sdk en
Android Developer's Guide
Table of Contents
1
About this Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1
Target Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2
Building the Application with Your Certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3
Customizing the Visual Features of the Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.1
Customizing the Name of the Installed Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2
Customizing the Launch Icon and the Launch Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3
Customizing the Application Password Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.4
Customizing the Appearance of Home and Browse Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.5
Customizing the Appearance of the Left Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.6
Customizing Icons Within the Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4
Customizing the Default Behavior of the Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
4.1
Customizing the Onboarding Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.2
Customizing the Application Functionality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.3
Customizing the Protocols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5
Integrating with Third Party Security Solutions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
6
Customizing SAP BusinessObjects Dashboards for Mobile App. . . . . . . . . . . . . . . . . . . . . . . . . . 28
7
Configuring Application's Behavior Using the SAP BusinessObjects Mobile Server. . . . . . . . . . . .29
7.1
Configuring Application's Behaviour by Setting Properties on the Server. . . . . . . . . . . . . . . . . . . . . . . 29
7.2
Configuring the Session Timeout Duration of the Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
7.3
Configuring the Thumbnail Background Image of BI Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
8
Mobile Server and Property File Locations Matrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
9
Using the CMC to Define Properties on BI Platform 4.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
2
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Table of Contents
1
About this Document
This guide provides information on how to customize the visual features, behavior and functionality of the SAP
BusinessObjects Mobile app for Android devices; such as smartphones and tablets.
By performing the step-by-step instructions in this document, you can customize the SAP BusinessObjects
mobile app (for android) in the following two aspects:
●
Customize using the Android SDK project available at the SAP Service and Market place (SMP)
●
Configure the properties files available on the Mobile BI platform server
1.1
Target Audience
This document is intended for developers and administrators of the SAP BusinessObjects Mobile (SAP BI)
application (for Android), who
●
host the application in their enterprise app store
●
customize the behavior of the mobile application features, behavior and functionality
Android Developer's Guide
About this Document
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
3
2
Building the Application with Your
Certificate
Pre-requisite
●
Install Android SDK Eclipse: To download and install the Android SDK Eclipse, refer:https://
developer.android.com/sdk/index.html
Note
We recommend you to use the latest available version of Android SDK.
●
Install 4.0 (API 14) API or higher version to open and compile the project.
To install an API, perform the following steps:
1.
Launch the Android SDK Eclipse application.
2.
Select
(Android SDK Manager) in toolbar.
Note
If the loading of packages in the Android SDK manager fails, set the proxy host and port in the SDK
Manager menu. To set the proxy host and port, choose one of the following:
3.
●
○
If Eclipse is running on Windows: Select Tools > Options.
○
If Eclipse is running on Mac: Select Android SDK Manager > Preferences.
Download the desired API package.
Download the SAPBusinessObjectsMobileAndroidLib-6.0.7.zip from the SAP services and market
place (SMP link).
Note
The <app_version_number> is of the format 6.x.x (such as 6.0.0).
●
4
Install Android support library
Ensure to install android support library to work with the SAP BusinessObjects Mobile (for Android)
application functionalities efficiently on your android device.
To install the android support library in your current project, perform the following steps:
1.
Launch the Android SDK Eclipse application.
2.
Select Project > Android Tools.
3.
Under Extras, select Android Support Library.
4.
Select Install.
The android-support.jar file is available in libs folder.
5.
Include the file in Build Path.
To include the build path, perform the following sub-steps:
1.
Right click on Project > Properties > Java Build Path > Libraries > Add Jars.
2.
Browse and select android-support.jar
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Building the Application with Your Certificate
3.
Go to Order > Export tab and check the android-support.jar .
Note
We recommend you to install android library in following scenarios:
●
○
Device operating system version below 3.0
○
Mobile application operating system version from 3.2
Include Geo Maps SDK
Ensure to install Google Play services in your project SDK to support Geo Maps capabilities in the SAP
BusinessObjects Mobile (for Android) application.
To install the Google Play services in your current project, perform the following steps:
1.
Select
(Android SDK Manager) in toolbar.
2.
Under Extras, select Google Play services.
3.
Select Install.
4.
Import Google Play services into Android SDK Eclipse.
5.
Select SAPBIAndroidSDK > Properties > Android > Library > Add Google Play services
library. GeoMaps should open within the application without issues.
●
Specify Google API Key to view Geo Maps
Ensure to specify a Google API key in your project SDK to view Geo-maps in the SAP BusinessObjects Mobile
(for Android) application.
To install the Google API key in your current project, perform the following steps:
1.
Browse to
Mobi
AndroidManifest.xml .
2.
Select Application tab.
3.
Go to Application Nodes.
4.
Select com.google.android.maps.v2.API_KEY.
5.
Specify the Google API Key.
Procedure to build the application
To customize the SAP BusinessObjects Mobile (for Android) SDK project, perform the following steps:
1.
Download SAPBusinessObjectsMobileAndroidLib-6.0.7.zip from SAP Service MartketPlace (SMP).
2.
Unzip the application project file to open the SAP BusinessObjects Mobile project.
A folder named SAPBusinessObjectsMobileAndroidLib-6.0.7 appears.
3.
Rename the folder SAPBusinessObjectsMobileAndroidLib-6.0.7 to a shorter name and ensure that
there are no spaces or special characters in the name.
Note
For convenience, let us call the above folder MOBISDK
4.
Access MOBISDK and choose SAPBI_SDK to start the project.
5.
(Optional) Customize the application by making the required changes to the files contained in MOBISDK
folder, as described in subsequent chapters.
Android Developer's Guide
Building the Application with Your Certificate
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
5
6.
6
Build and run the project using your certificate.
Users can now use the generated application on Android devices.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Building the Application with Your Certificate
3
Customizing the Visual Features of the
Application
The following section provides information on how to customize the SAP BusinessObjects Application features
such as :
●
Name of the application
●
Launch icon an Launch screen
●
Application Password screen
●
Browse screen (Left Panel)
●
Application icons
3.1
Customizing the Name of the Installed Application
Once installed the SAP BusinessObjects Mobile application appears on your device screen with the name SAP BI.
To change the application name based on your requirements, perform the below steps:
1.
Open the AndroidManifest.xml file.
2.
Under Application tab > Select Application Attibutes and Edit the parameter: Label.
3.
Save the file, run the project and validate your changes.
Note
Make sure that you do not change the Version name value in the AndroidManifest.xml file as changing the
application version here may lead to issues while during future upgrades of the application.
3.2
Customizing the Launch Icon and the Launch Screen
The application launch icon appears at the following places on an Android device:
1.
On the device menu as shown below:
Android Developer's Guide
Customizing the Visual Features of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
7
2.
8
On the device Application Settings screen as shown below:
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Visual Features of the Application
The application launch screen appears when the application is launched on the device:
To view or edit the Resources for launch icons in the SAP BI app, access Mobi
(corresponding to the user's Android device screen resolution) and select:
●
res
drawable folder
appicon and appicon_tablet for customizing the application icon.
Note
Ensure to replace both icons to customize the application icon for phone as well as tablet
●
splashscreen_landscape /splashscreen_portrait for customizing the launch screens.
Android Developer's Guide
Customizing the Visual Features of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
9
3.3
Customizing the Application Password Screen
If the user has enabled the application password, the password screen appears every time the application is
launched or foregrounded:
To customize the application password screen image, perform the below procedure:
1.
Access
Mobi
res
drawable-hdpi .
2.
Choose the image and replace it with your custom image.
Note
○
The name and dimensions of your custom image should be the same as that of the default image.
○
You can customize the following images for the application password screen:
○
3.
○
splashscreen_landscape.png
○
splashscreen_portrait.png
Ensure to customize the drawable folder corresponding to the Android device resolution.
Run the project and validate your changes in the application.
3.4
Customizing the Appearance of Home and Browse Tab
To customize the Home and Browse tabs, perform the following steps:
1.
10
Open the colors.xml file available at the following location in your project:
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Mobi
res
values
Android Developer's Guide
Customizing the Visual Features of the Application
An example snapshot of the file is shown in the below figure:
2.
Update the value of features with color codes (in 6 digit hexadecimal value format) based on your custom
requirements.
3.
Save your changes, run the project and validate your changes in the simulator.
Android Developer's Guide
Customizing the Visual Features of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
11
3.5
Customizing the Appearance of the Left Panel
You can customize the appearance of the left navigation panel of the application including the background color
and the font color.
Customizing the Background color of the Left Panel
1.
Open the colors.xml file available at the following location in your project:
Mobi
res
values
2.
Update the value of the left_panel_bg property with the required color code (in 6 digit hexadecimal value
format).
3.
Save your changes, run the project and validate your changes in the simulator.
Customizing the Font Color of Labels in the Left Panel
1.
Open the colors.xml file available at the following location in your project:
Mobi
res
values
2.
Update the value of the left_panel_text property with the required color code (in 6 digit hexadecimal value
format).
3.
Save your changes, run the project and validate your changes in the simulator.
Customizing the Font Color of the Header Text in the Left Panel
1.
Open the colors.xml file available at the following location in your project:
2.
Update the value of the left_panel_header_text property with the required color code (in 6 digit hexadecimal
value format).
3.
Save your changes, run the project and validate your changes in the simulator.
12
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Mobi
res
values
Android Developer's Guide
Customizing the Visual Features of the Application
3.6
Customizing Icons Within the Application
This chapter explains how to customize the various icons used within the application (including the tool-bars on
Home screen, Browse panel and open reports).
Customizing the Icons of Home Screen (used in tool-bar, body, BI document
tiles) and The Browse Panel
To customize an icon, perform the below steps:
1.
Access Mobi>res>drawable folder (corresponding to the user's Android device screen resolution).
2.
Select the image that you want to replace, and replace it with your custom image.
Note
3.
○
The name and dimensions of your custom image should be the same as that of the default image.
○
You can identify the purpose of each image icon with the name of the image. For example,
download_list_normal.png is the image name for a normal Download icon that appears next to a listed
BI document in the List View of Home screen. Similarly, download_thumb_normal.png is the
unselected download icon appearing over a thumbnail of BI document in Grid View of screen,
download_thumb_progress.png is the name of image that should appear over the tile once the
download is in progress, and download_thumb_completed.png is the name of image that should
appear once the document is completely downloaded.
Save the file, run the project and validate your changes.
Customizing the Icons of BI Reports (used in primary and secondary tool-bars
and the report body)
To customize an icon, perform the below steps:
1.
Access Mobi>res>drawable folder (corresponding to the user's Android device screen resolution).
2.
Select the image that you want to replace, and replace it with your custom image.
Note
○
The name and dimensions of your custom image should be the same as that of the default image.
○
You can identify the purpose of each image icon with the name of the image. For example,
download_list_normal.png is the image name for a normal Download icon that appears next to a listed
BI document in the List View of Home screen. Similarly, download_thumb_normal.png is the
unselected download icon appearing over a thumbnail of BI document in Grid View of screen,
download_thumb_progress.png is the name of image that should appear over the tile once the
download is in progress, and download_thumb_completed.png is the name of image that should
appear once the document is completely downloaded.
Android Developer's Guide
Customizing the Visual Features of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
13
3.
14
Save the file, run the project and validate your changes.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Visual Features of the Application
4 Customizing the Default Behavior of the
Application
The default behavior of the application is defined by various features in the defaultsettings.xml file available
at the following location:
Mobi
res
xml
An example snapshot of the file is displayed in the figure below:
Each feature in the above file impacts the behavior of the application on device and you can change it's default
value based on your requirements.
The sub-sections of this chapter explain how you can specify values for these features to customize various
aspects of the application.
4.1
Customizing the Onboarding Features
You can customize the following on-boarding features of the application through a metadata driven approach:
Android Developer's Guide
Customizing the Default Behavior of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
15
Predefining Connections
●
●
Pre-define the following types of connections in the application, so that they appear as available connections
immediately after the application is launched on device:
○
Enterprise/ BI Platform
○
Sybase Unwired Platform
Pre-define multiple connections for the application.
Disable Connection Creation
●
Disable the creation of any connection in the application.
●
Disable creation of specific connection types in the application:
○
Enterprise/ BI Platform
○
Sybase Unwired Platform
To customize any feature from the above list, follow the below procedure:
1.
Open the defaultsettings.xml file from the following location:
Mobi
res
xml
2.
Navigate to the Customizations section of the defaultsettings.xml file and modify the value of the required
feature based on it's description provided in the table below this procedure.
3.
Save your changes, run the project and validate your customization in the simulator.
Feature
Description
Default value
feature.predefinedconnections.enabled.
default
●
If the value is "true", the
connections listed in
feature.predefinedconnections.list.
default are created.
true
●
If the value is "false", you cannot
have pre-defined connections for
the application.
*feature.predefinedconnections.list.defa You can define a single predefined
ult
connection or multiple predefined
connections by specifying values within
this parameter. It is of the type "Array"
and each Item in the array is of the type
"String". Value of each item
corresponds to a connection URL.
1 item (connection URL) of type
<String> in the array: sapbi://
addconnection?
ConnectionType=BOEConnection&con
nection_name=SAP%20Analytics
%20Gallery&server_url=&cms=
Note
16
1.
See the bottom of this chapter
for more information on creating
pre-defined connections.
2.
This property is meant only for
the first installation of the
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Default Behavior of the Application
Feature
Description
Default value
application. Hence if you change
the value of any parameter in
the URL, you need to remove
and install the application again
to see the changes reflected in
the application.
feature.addconnection.enabled.default
feature.addconnection.BOE.enabled.def
ault
●
If the value is 'true', users can add
connections in the application
using the following ways:
○
Importing from the server
(using Application Settings)
○
Creating manually (using
Application Settings)
○
Using the sapbi:// URL
provided by the administrator
●
If the value is 'false', the users
cannot add connections in the
application in any way.
●
If the value is 'true', users can add
BI platform/ Enterprise
connections in the application
using the following ways:
●
○
Importing from the
Configuration server (using
Application Settings)
○
Manually creating connections
of the typeSAP
BusinessObjects BI
Platform(using Application
Settings)
○
Using the sapbi:// URL
provided by the administrator
true
true
If the value is 'false', the users
cannot add BI platform
connections in the application in
any way.
Note
Android Developer's Guide
Customizing the Default Behavior of the Application
1.
This feature does not impact the
application if
feature.addconnection.enabled.
default is set to 'false'.
2.
This feature does not impact the
list of connections provided in
feature.predefinedconnections.li
st.default
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
17
Feature
Description
Default value
feature.addconnection.SUP.enabled.def
ault
●
true
If the value is 'true', users can add
SUP server connections in the
application using the following
ways:
●
○
Manually creating connections
of the typeSybase Unwired
Platform(using Application
Settings)
○
Importing from the Sybase
Afaria server
○
Using the sapbi:// URL
provided by the administrator
If the value is 'false', the users
cannot add SUP connections in the
application in any way.
Note
feature.application.pwd.minlen.default
1.
This feature does not impact the
application if
feature.addconnection.enabled.
default is set to 'false'.
2.
This feature does not impact the
list of connections provided in
feature.predefinedconnections.li
st.default
This property defines the minimum
length of the application password
string for the user.
8
Note
●
In the current release, this
property is used only when the
user creates or modifies the
application password.
●
If an application is previously
installed with a certain value for
this property, and you reduce
the value in the SDK, it does not
have any impact on the
password’s minimum length.
Note
To avoid unpredictable results, ensure accuracy of the value that you specify for each feature in the
defaultsettings.xml file.
18
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Default Behavior of the Application
Description of common parameters used across all pre-defined connection
types
Parameter name
Description
connection_name
The name of connection.
connectionType
The type of connection.
Note
Below is the list of valid <ConnectionType> names
corresponding to each connection type:
●
BOEConnection for a BI platform connection
●
SUPConnection for an SUP connection
usr
User name for the connection.
pwd
Password for the connection.
savePwd
Boolean parameter ( with 'true'/'false' value) that determines
if the option to Save Password appears in the application on
device.
Note
This property is ignored if pwd has not been supplied and
editable=false
editable
Boolean parameter ( with 'true'/'false' value) that determines
whether the pre-defined connection is editable on device.
Note
The following constraints apply if editable=false
●
Users cannot view the details of the connection in the
application.
●
When users share a document from the connection,
the email draft that the application creates does not
contain any links.
●
Users cannot assign documents to personal
categories on the Home screen of the application.
●
The connection password is retained even when data
is wiped off using the Application Settings.
To create a pre-defined BI platform/ BusinessObjects Enterprise connection
Syntax:
sapbi://addconnection?<query string parameters>
Mandatory Parameters:
Android Developer's Guide
Customizing the Default Behavior of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
19
●
Connection name
●
Connection type
●
Server URL
●
CMS
●
Authentication type
Optional Parameters
●
editable
●
default
●
user credentials
Description and example
●
server_url- mobile server address
●
CMS- CMS address
●
authType- one of secEnterprise|secWinAD|secLDAP|secSAPR3
sapbi://addconnection?
ConnectionType=BOEConnection&connection_name=myBOEConnection&server_url=11.22.33.44%3A
8080&cms=11.22.33.44&authType=secEnterprise&usr=myuser&pwd=mypassword&savePwd=true&edi
table=true
To create a pre-defined Sybase Unwired platform connection
Syntax:
sapbi://addconnection?<query string parameters>
Mandatory Parameters:
●
Connection name
●
Connection type
●
Server
●
Port
●
Farm ID
●
Sec Config
Optional Parameters
●
editable
●
default
●
user credentials
Description and example
●
server_url- SUP server address/ Relay server address
●
SUP_port- SUP port/ relay server port
●
Sec_Config- Security Configuration name
●
SUP_Farm_ID- Specify if relay server is not used
20
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Default Behavior of the Application
sapbi://addconnection?ConnectionType=SUPConnection&connection_name=SUP
%20Connection&server_url=55.66.77.88&SUP_Port=5001&SUP_Farm_ID=0&Sec_Config=MobiTest&A
pplication_ID=MobiApp&usr=myuser&pwd=mypassword&savePwd=true&editable=true
4.2
Customizing the Application Functionality
You can customize the following aspects of application functionality through a metadata driven approach:
Customize Usability and Security Features
●
●
Enable or disable the appearance of the BI document's author name on the following screens of the
application:
○
Home screen (where BI documents are listed)
○
BI document Information screen
○
Sort pop up (invoked from app tool-bar)
Customize the minimum length of application password that users are required to observe
Customize Collaboration
●
Disable all collaboration options
●
Specify a Web based collaboration tool (SAP JAM)
●
Disable Email and Annotation
Customize the Application feature
1.
Open the defaultsettings.xml file from the following location:
2.
Navigate to the Customizations section of the file and modify the value of the required feature based on it's
description provided in the table below this procedure.
3.
Save your changes, run the project and validate your changes in the simulator.
Mobi
res
xml
Feature
Description
Default value
feature.email.enabled.default
●
If the value is 'true', the Email option appears for the BI
documents opened in the application.
true
●
If the value is 'false', the Email option does not appear for
the BI documents opened in the app.
Android Developer's Guide
Customizing the Default Behavior of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
21
Feature
Description
Default value
feature.annotation.enabled.default
●
If the value is 'true', the Annotate option appears for the BI
documents opened in the application.
true
●
If the value is 'false', the Annotate option does not appear
for the BI documents opened in the app.
Note
If you disable both feature.email.enabled.default and
feature.collaboration.enabled.default, the application
ignores the feature.annotation.enabled.default property.
feature.collaboration.enabled.default
●
If the value is 'true', the Collaborate option appears in the
secondary report tool-bar of a BI report opened on device.
●
If the value is 'false', the Collaborate option does not
appear in the secondary report tool-bar of a BI report
opened on device.
true
Note
If you set both the below listed properties as 'false', the
application ignores the collaboration property:
feature.jam.enabled.default
●
feature.streamwork.enabled.default
●
feature.jam.enabled.default
●
If the value is 'true', SAP JAM popup appears asking for
user credentials when users choose Collaborate in the
secondary report tool-bar of a BI report opened on device
●
If the value is 'false', SAP JAM does not appear as the Web
based collaboration tool when users choose Collaborate in
the secondary report tool-bar of a BI report opened on
device. Based on the configuration, SAP StreamWork may
instead appear as the collaboration tool in the application.
false
Note
If feature.collaboration.enabled.default is set to 'false',
feature.jam.enabled.default is not considered in the
application.
feature.jam.url.default
JAM URL
<none specified>
Note
The value of this feature must be compulsorily specified for
SAP JAM to work in the application.
feature.jam.consumer.key.default
22
JAM consumer key
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
<none specified>
Android Developer's Guide
Customizing the Default Behavior of the Application
Feature
Description
Default value
Note
The value of this feature must be compulsorily specified for
SAP JAM to work in the application.
feature.jam.consumer.secret.default
JAM consumer secret
<none specified>
Note
The value of this feature must be compulsorily specified for
SAP JAM to work in the application.
feature.jam.callback.urlverb.default
JAM Callback URL Verb
jamcallback
Note
The value of this feature must be compulsorily specified for
SAP JAM to work in the application.
feature.home.view.default
The value of this feature determines the first home screen view list
that the users see after installing the application on device.
Thereafter, the view-type which you use last is persisted in the
application.
list and grid are the two valid values for this feature.
feature.application.pwd.minlen.defaul This property defines the minimum character length of
t
application password that users should ensure while creating
the password in the application.
8
Feature.home.sort.option.default
date
Use this property to define the sort parameter according to
which the BI documents appear on the application's "Home"
screen. Following are the valid values for this property:
●
author
●
date
●
title
●
type
feature.home.doc.person.enabled.def ●
ault
●
Android Developer's Guide
Customizing the Default Behavior of the Application
true
If the value of this property is 'true', the application
displays the Author name next to the BI documents on the
list view of the Home screen, and also displays the Sort by:
Author option in the Sort pop up (invoked from tool-bar).
If the value of this property is 'false', the application
neither displays the Author name next to the BI
documents on the list view of the Home screen, nor does it
display the Sort by: Author option in the Sort pop up
(invoked from tool-bar).
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
23
Feature
Description
Default value
Note
Disabling this property also infers that the Sender for BI
Inbox documents, and the Owner for Lumira
documents does not appear in the application.
feature.info.doc.person.enabled.defa
ult
●
true
If the value of this property is 'true', the application
displays the Author name on the Information screen of the
BI document .
●
If the value of this property is 'false', the application does
not display the Author name on the Information screen of
the BI document .
Customizing the Web Intelligence Features in the Application
You can customize the following Web Intelligence features of the application:
●
Disable Refresh for Web Intelligence documents and personal views of Web Intelligence reports.
●
Customize the default color theme of Web Intelligence documents on device.
To customize any feature from the above list, follow the below procedure:
1.
Open the defaultsettings.xml file from the following location in your Eclipse project bundle:
2.
Navigate to the Web Intelligence section of the file and modify the value of the required features based on
their description provided in the table below this procedure.
3.
Save the changes in the file, run the project and validate your changes in the application build on simulator.
Mobi
res
xml
Feature
Description
Default
value
feature.webi.refresh.enabled
You can enable or disable Refresh in Web Intelligence
reports on the device using this parameter.
true
feature.webi.theme.default
This property defines the default color theme (Ivory/
Graphite) for viewing Web Intelligence documents on
device. Valid values are WhiteTheme and
WhiteThem
e
BlackTheme. These correspond to the Ivory and
Graphite themes respectively.
Note
User can use the Application Settings to override
the color theme.
Note
1.
If the following features have a value defined in the client settings on the Mobile server, it overrides
the default value which you specify in defaultsettings.xml:
24
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Default Behavior of the Application
○
feature.email.enabled
○
feature.collaboration.enabled
○
feature.annotation.enabled
○
feature.jam.enabled
○
feature.jam.url
○
feature.jam.consumer.key
○
feature.jam.consumer.secret
○
feature.jam.callback.urlverb
○
feature.webi.refresh.enabled
○
feature.home.doc.person.enabled
○
feature.info.doc.person.enabled
See the related topic of this chapter for more information.
2.
To avoid unpredictable results, ensure accuracy of the value that you specify for each feature in
thedefaultsettings.xml file.
4.3
Customizing the Protocols
You can customize Change SUP application ID application protocols using a metadata driven approach:
To customize the first two features in the above list, open the DefaultSettings.plist file from the following location
in your Eclipse project:
Mobi
res
xml
Then modify the value of the relevant feature from the list shown in below table. After modifying values, save your
changes and run the project.
Feature
Description
Default value
Customizations/
feature.SUPconnection.application.id
This feature is meant to over-ride the
MobiApp
SUP application name. (If you use SUP
connections, the application name
always used for SUP is "MobiApp". )
Note
If the application specifying a new
application id is installed before the
user deregisters from a connection
containing old application id; the
users must kill the application after
deregistering, and before registering
in the new application.
Android Developer's Guide
Customizing the Default Behavior of the Application
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
25
Note
To avoid unpredictable results, ensure accuracy of the value that you specify for each feature in the
defaultsettings.xml file.
26
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing the Default Behavior of the Application
5
Integrating with Third Party Security
Solutions
Although SAP BusinessObjects Mobile is a secure solution, you may have an organizational need to integrate with
a 3rd party mobile security solution.
For mobile security solutions that take the approach of wrapping mobile apps, use the technique described in
chapter 3 of this guide ("Building the Application With Your Certificate") to generate an unsigned SAP
BusinessObjects Mobile IPA file. The IPA file can then be fed into the security wrapping tool as per the 3rd party
vendor's instructions. For mobile security solutions that require further integration, contact your SAP account
representative for additional information.
Android Developer's Guide
Integrating with Third Party Security Solutions
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
27
6 Customizing SAP BusinessObjects
Dashboards for Mobile App
You can customize the Dashboards for SAP BusinessObjects Mobile application by using the Dashboards SDK.
For more information, refer to the Dashboards Component SDK documentation, available on the SAP Help Portal
(http://help.sap.com/bodash41).
28
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Customizing SAP BusinessObjects Dashboards for Mobile App
7
Configuring Application's Behavior Using
the SAP BusinessObjects Mobile Server
7.1
Configuring Application's Behaviour by Setting
Properties on the Server
Pre-requisites
1.
You have the SAP BusinessObjects Mobile server and the SAP BusinessObjects BI platform server in your
network.
2.
You have the SAP BusinessObjects Mobile (SAP BI) application for Android installed on your Android device.
You can configure some chief behavioral aspects of the application by configuring the client settings on the SAP
BusinessObjects Mobile server.You configure client settings using the clientsettings.properties file on the Mobile
server. If you are using the BI platform 4.1, you can also use the Central Management Console (CMC) interface
for configuring client settings.
Note
●
The location of clientsettings.properties file on the SAP BusinessObjects Mobile server is based on
the server version you are using. To find the file-path for your specific server version, refer to the related
topic of this chapter.
●
For information on how to configure client settings using the CMC, see the related topic of this chapter.
Following is a typical default configuration of the clientsettings.properties file:
savePassword=false
offlineStorage=false
offlineStorage.ttl=365
offlineStorage.appPwd=true
You can add the following features to the file, if you need to customize some of these based on your requirements:
●
feature.email.enabled
●
feature.collaboration.enabled
●
feature.annotation.enabled
●
feature.jam.enabled
●
feature.jam.url
●
feature.jam.consumer.key
●
feature.jam.consumer.secret
●
feature.jam.callback.urlverb
Android Developer's Guide
Configuring Application's Behavior Using the SAP BusinessObjects Mobile Server
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
29
●
feature.webi.refresh.enabled
●
feature.home.doc.person.enabled
●
feature.info.doc.person.enabled
7.2 Configuring the Session Timeout Duration of the
Application
The number of concurrent sessions running on the SAP BusinessObjects Mobile server can impact its
performance.
If you want a session of an SAP BI mobile application to be aborted after a defined period of inactivity, perform the
following configuration on the Mobile server:
1.
Open the web.xml file at the following location:
<Webapp-server-root>\webapps\MobileBIService\WEB-INF
Note
The <WebApp-server- root> is the root folder location specific to your deployed application server, for
example: C:\Program Files (x86)\SAP BusinessObjects\Tomcat6
2.
Set the value of the session-timeout parameter found within the tags shown below:
<session-config>
<session-timeout>60</session-timeout>
</session-config>
Note
○
The session-timeout element defines the default session timeout interval for all sessions created in
MobileBIService (Mobile server).
○
The timeout duration begins when either the device is locked, or the application goes in the
background (user switches to other apps on device).
○
When a session times out the user is logged off from the BI platform.
○
The specified timeout must be expressed in a whole number of minutes. In above example, the timeout
is 60 minutes.
If the timeout is zero ('0') or less, the default behavior of sessions is never to time out.
7.3 Configuring the Thumbnail Background Image of BI
Documents
Based on your requirements, you can customize the thumbnail image for BI documents that appear as tiles on the
Home screen of the application.
If you do not configure a thumbnail image for BI documents on the server, the documents displays a default image
(based on document type) on the Home screen. Once you open the document and return to the Home screen, the
30
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Configuring Application's Behavior Using the SAP BusinessObjects Mobile Server
default background image of thumbnail is replaced by snapshot of the first report of the document. The below
figure illustrates this behavior for a Web Intelligence document: However, one configured on the server (BI
LaunchPad), the thumbnail background image remains constant on the Home screen. It does not change even
after you open the BI document and return to the Home screen
To configure the thumbnail background image for a BI document, perform the following steps:
1.
Access the Properties of the document on the BI platform (BI LaunchPad/ Web Intelligence Rich client).
2.
Enter the URL of your image in the Keywords field and choose Save.
Note
●
The recommended thumbnail image size for best results on the device screen is 208 pixels*208 pixels.
●
The background image size should not be greater than hundred KiloBytes (100 KB).
●
The valid image formats include .jpeg, .jpg and .png.
●
If multiple image URLs are specified in the BI document's Keywords on the BI platform, the app only
considers the last valid image URL for the thumbnail background image.
●
If there are multiple strings specified in the Keywords, and if the image URL is not the last keyword string
(that is, it appears in between) then it must end with a space. For example: keyword1, http://
www.xyz.com/myImage.png , keyword2, keyword3.
Android Developer's Guide
Configuring Application's Behavior Using the SAP BusinessObjects Mobile Server
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
31
8 Mobile Server and Property File Locations
Matrix
SAP BusinessObjects Mobile server version
File location of clientsettings.properties and
mobi.properties
XI 3.1 SP3, SP4, SP5, SP6
<WebApp root>\webapps\MobileBIService\WEBINF\
BI 4.0, SP5 and below versions
<WebApp root>\webapps\MobileBIService\WEBINF\
BI 4.0, SP6
<WebApp root>\webapps\MobileBIService\WEBINF\config\default
BI 4.1
<WebApp root>\webapps\MobileBIService\WEBINF\config\default
Note
The <WebApp root> is the root folder location specific to your deployed application server, for example: C:
\Program Files (x86)\SAP BusinessObjects\Tomcat6
32
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Mobile Server and Property File Locations Matrix
9 Using the CMC to Define Properties on BI
Platform 4.1
If you have deployed SAP BusinessObjects mobile server 4.1 or 4.1 SP1 in your set-up, you can use the Central
Management Console (CMC) to configure client settings and mobile properties. These parameters are otherwise
configured through the clientsettings.properties and mobi.properties files on the Mobile server
respectively.
So that the application can identify whether the Mobile configuration is defined on the CMC (BI platform) or in the
properties files on the Mobile server, you need to explicitly define the following parameter in the
MobileBIService\WebContent\WEB-INF\web.xml file :
<context-param>
<description>local-if configuration on server, boe-if configuration in CMC</
description>
<param-name>mobile.server.configuration.location</param-name>
<param-value>boe</param-value>
</context-param>
If you specify the context-param value as boe in the above file, your mobile server configuration on the CMC is
considered.
To access mobile properties on the CMC, perform the following steps:
1.
Open the Central Management Console on the BI platform server and access Applications.
You'll find the SAP BusinessObjects Mobile application listed on the page.
2.
Right click SAP BusinessObjects Mobile and choose Properties.
You'll see the following window:
3.
Edit the category values in Properties as required.
Android Developer's Guide
Using the CMC to Define Properties on BI Platform 4.1
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
33
Note
○
For information on the various categories, see the Configuring Categories on the Mobile Server topic of
the Administrator and Report Designer's guide available at http://help.sap.com/bomobileandroid .
○
For understanding the overall mobile properties and their impact on the app in general, refer to the
Mobile server Installation and Blackberry Configuration guide available at http://help.sap.com/
bomobile40
4.
To edit client settings, choose Client Settings:
5.
Save your property settings and exit from the CMC.
Note
The negative mobile application rights that are granted via the CMC take precedence over the values specified
for client settings via the CMC. For example, if the right To save documents to the local store of a device is not
granted to the user in the CMC, users cannot download BI documents to their device even if the
offlineStorage property is set to true in the client settings.
Also note that if the right to save documents is granted in the CMC, but offlineStorage=false in client
settings, users cannot download BI documents to the mobile device. Only when the right is granted and
offlineStorage=true that users can download/save BI documents to the device.
34
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Android Developer's Guide
Using the CMC to Define Properties on BI Platform 4.1
Android Developer's Guide
Using the CMC to Define Properties on BI Platform 4.1
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
35
www.sap.com/contactsap
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any
form or for any purpose without the express permission of SAP AG.
The information contained herein may be changed without prior
notice.
Some software products marketed by SAP AG and its distributors
contain proprietary software components of other software
vendors. National product specifications may vary.
These materials are provided by SAP AG and its affiliated
companies ("SAP Group") for informational purposes only, without
representation or warranty of any kind, and SAP Group shall not be
liable for errors or omissions with respect to the materials. The only
warranties for SAP Group products and services are those that are
set forth in the express warranty statements accompanying such
products and services, if any. Nothing herein should be construed as
constituting an additional warranty.
SAP and other SAP products and services mentioned herein as well
as their respective logos are trademarks or registered trademarks
of SAP AG in Germany and other countries.
Please see http://www.sap.com/corporate-en/legal/copyright/
index.epx for additional trademark information and notices.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement