VSERV J2ME AppWrapper

VSERV J2ME AppWrapper
Version 1.3
Vserv Digital Services Pvt Ltd
605,Eco House,Vishweshwar Nagar,
Off. Aarey Road, Goregaon(E),
Mumbai – 400063.
Tel No: +91 22 29275746/82
www.vserv.mobi
CONFIDENTIAL DOCUMENT
No part of this document may be disclosed verbally or in writing, including by
reproduction, to any third party without the prior written consent of Vserv Digital
Services Pvt Ltd. This document, its associated appendices and attachments remain
the property of Vserv Digital Services Pvt Ltd and shall be returned upon request.
VSERV J2ME App Wrapper
1
Introduction
Vserv AppWrapper enables you to wrap your J2ME MIDP 2 Applications and Games with key
Online Services listed below, in One Click without any coding.
Online Services:
1. Vserv Premium Ads
2. App Analytics from Google Analytics
Prerequisites
1. Ensure that Java Development Kit (JDK) 1.6 or higher is installed on the PC and
the PATH environment variable is properly set for JDK. You can find more details on
Java path setup from below download link.
http://vserv.mobi/JavaPathSetup.pdf
2. Link for download of AppWrapper.
http://www.vserv.mobi/AppWrapper/J2ME/VservJ2MEAppWrapper.zip
VSERV J2ME App Wrapper
2
Steps to wrap your J2ME MIDP 2 Applications and Games
1. Register and download the AppWrapper. Unzip the AppWrapper.
2. Place all the application Jar and optionally Jad files to be wrapped in the RawApps
folder
3. Modify config.txt in conf folder as required. Below are the details of the various
parameters & default values.
Option
Explanation
Values
Default
Vserv Premium Ads – configuration parameters
Important
1
zoneId
(Mandatory For Launch
Ad)
zoneId_end
(Mandatory For Exit Ad)
2
showAt
A zone defines the type of ads,
targeting etc that will be used to
shown Ads in your app. A default
zoneId is generated at time of
registration. This is available in the
registration email, as well as in the
Vserv.mobi
online
interface.
(Inventory > Zones) Values for both
should be same, unless you need
different targeting for start & end In
most cases the value for both is
same
<string>
Specifies at what stage the ad is to
be shown
<string>
both
start/end/both
3
4
viewMandatory
cache
Specifies if the user can or can not
proceed with the application in case
of non availability of data connection
to fetch the ad
<string>
Enables
caching
advertisement
<string>
for
post
app
true
true [can not]
false[can]
VSERV J2ME App Wrapper
true
3
Static Ads
5
staticAdPosition_start
Specifies position at which static ads
should appear
staticAdPosition_end
<string>
0
0/1/2
0[should not appear]
1[should
ads]
appear
before
dynamic
2[should appear after dynamic ads]
6
staticAdOnlyOnFailure_start
staticAdOnlyOnFailure_end
7
staticAdTemplate_start
Specifies whether static ads are to
be shown only on dynamic ad
failures
<string>
Specifies the Template name for
static Ad.
<string>
false
true/false
staticAdTemplate_end
(Mandatory For Static Ad)
You should save the markup
received from Online interface in
some text file and pass on name of
that file in this parameter
VSERV J2ME App Wrapper
4
8
supportedScreens
Specifies static ad image resolutions
in a below format.
352x288|176
x144|128x96
<string>
[SW]X[SH]
[IW]X[IH]
IW=Image Width
IH=Image Height
Resolution
values
for
multiple
images should be pipe(|) separated.
You must keep resources for each
pipe
separated
value
inside
Resources folder with following
naming conventions.
*resourceName_IWXIH
*Refer parameter no 12
Note:
If this parameter is not specified ,
you must keep resources for
following MMA recommended image
sizes.
352x288 pixels
176x144 pixels
128x96 pixels
9
staticAdResource_start
Specifies the resource name with
extention
<string>
staticAdResource_end
(Mandatory For Static AdType Banners)
VSERV J2ME App Wrapper
5
Advanced
10
startAfterCount
Specifies if ad is to be shown only
after specified counts of session
<string>
startAfterCount_end*
11
timeout
Specifies maximum seconds the
application would try to fetch the ad
then in case of viewMandatory=true
show viewMandatoryMessage, else
enable RSK with cancelLabel for
proceeding
<string>
12
proceedTime
When viewMandatory=false Specifies
number of seconds(after cancel
button appears) the application would
try to fetch the ad before moving into
the app or exiting
<string>
13
vservJarParam
Specifies any extra parameter that is
to be sent along with jar
<string>
14
wrapAd
Specifies if Vserv premium ads are
needed and should be wrapped
<string>
20 Seconds
true
true/false
15
geoData
Specifies if geo data like cell-site id,
location area code to be pulled from
device for better targeting. Note that
some devices may ask for explicit
user acceptance in order to pull these
data.
<string>
false
true/false
VSERV J2ME App Wrapper
6
Analytics related parameters
16
wrapAnalytics
Specifies if google analytics
needed and should be wrapped.
are
<string>
false
true/false
17
analyticsKey
(Mandatory)
18
analyticsName
This will be your Web Property Id
<string>
from google analytics account.
Specifies the display name under
which you can find your analytics
data.
<string>
Midlet Name
Code Signing related parameters
19
codeSigningRequired
Specifies if code signing is required
after wrapping.
<string>
false
true / false
20
keyStoreName
Specifies your key store name
<string>
Specifies your alias name
<string>
Specifies your store password
<string>
Specifies your key password
<string>
(Mandatory for Code
Signing)
21
aliasName
(Mandatory for Code
Signing)
22
storePassword
(Mandatory for Code
Signing)
23
keyPassword
(Mandatory for Code
Signing)
VSERV J2ME App Wrapper
7
Other parameters
24
deleteRawAppsOnSuccess
Specifies if raw apps to be deleted
after successful wrapping
<string>
false
true / false
25
4.
moveNonJarResources
Specifies if non jar/jad resources
such as screenshots, game material if
present inside RawApps folder to be
moved to output folder WrappedApps
<string>
false
true / false
On Windows Run VservAppWrapper.exe
On Mac Run VservAppWrapper.app
This will wrap the jar/jad files and place processed jar/jad files in the WrappedApps
folder. Deploy the files from WrappedApps on AppStores.
Logs generated are in the logs folder.
5.
Ad statistics can be viewed from the online interface at www.vserv.mobi.
VSERV J2ME App Wrapper
8