Skip Headers

Oracle Application Server Wireless Administrator's Guide
10g (9.0.4)

Part Number B10188-01
Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Go to previous page Go to next page

8
Configuring the Out-of-the-Box Applications

This document describes configuring the pre-built Wireless applications. Each section of this document presents a different topic. These sections include:

8.1 Configuring the Voice and Wireless Applications Using the Content Manager

Oracle Application Server Wireless includes pre-built Wireless applications, such as PIM (Personal Information Management), mail, location-based and messaging applications (through SMS, WAP-push, fax, e-mail and voice).

You use the edit functions of the Content Manager as illustrated in Figure 8-1, to configure the parameters of these wireless applications to make them ready for use. Some of the configuration parameters of a mobile application are read-only and therefore cannot be edited. For more information on editing application using the Content Manager, see Section 5.3.5 in Section 5, "Managing Content".

Figure 8-1 Editing the Configuration Parameters of a Wireless Application


Text description of mod_emsi.gif follows.
Text description of the illustration mod_emsi.gif

8.2 Wireless Application Configuration Parameters

This section details the configuration parameters and related software requirements for the following Wireless Applications:

In addition to the application-specific configuration parameters, this section also includes the following sections:

8.2.1 Applications Setup

Applications Setup defines how one application calls another. All of the Wireless and Voice applications can be uniquely identified by an attribute called the OracleMobile protocol (OMP) URL. Each application uses an OMP URL to call a different application. Application Setup acts as a repository where each of the OMP URLs are registered. In turn, each application has a configuration parameter which tells the application where to find Applications Setup.

You enter the OMP URLs when you create an application link using the Content Manager (Figure 8-2). For more information, see Section 5.3.4.

Figure 8-2 Entering the OMP URL


Text description of mod_eomp.gif follows.
Text description of the illustration mod_eomp.gif

8.2.1.1 Registered URLs

The Application Setup includes the following OMP URLs.

8.3 PIM and Mail

Oracle Application Server Personal Information Management (PIM) Service enables customers to integrate corporate email, directory, address book, calendaring and instant messaging applications into their mobile enterprise portals.

Each of these applications is built as a module that can be called either directly by mobile users from their devices, or by other applications. These mobile PIM and email applications are fully integrated within one another, enabling a user to access such features as an address book-based recipient selection or a directory when composing email messages.

Oracle Application Server customers can leverage the Personal Information Management Service applications (also known as Collaboration Applications) into their own or third-party applications to add communication features to these applications, to retrieve corporate directory information, or to add and manage appointments for users, such as travel or dining reservations.

8.3.1 Address Book

The Address Book enables users to manage their own address books and contacts as well as enabling call functions from wireless phones. The mobile address book integrates with the Mail application to allow users to compose a message's recipient list from their address book.

Once you find a contact, you can also edit the contact information or delete a contact. While deleting, nothing is returned to the caller.

8.3.1.1 Configuring the Address Book

The Address Book application integrates with various Address Book server, such as the Oracle Collaboration Suite, the Microsoft Exchange server, and the Oracle Calendar server. This application also has a preset mode where the address book contacts are stored in the Wireless schema. The preset mode requires no third-party software.

Required Software

Table 8-1 describes the third-party software required for the Address Book.

Table 8-1 Required Third-Party Software for the Address Book
Name  From Version(s) 

Oracle Collaboration Suite 

Microsoft Exchange Server 

5.5 

Oracle Calendar Server  

5.2 


Note:

For the Address Book application to connect to the Microsoft Exchange Server, see Section 8.3.10.1


8.3.1.2 Connecting the Address Book Application to the Oracle Collaboration Suite

To connect the Address Book to the Oracle Collaboration Suite:

Copy the following JAR files from the Oracle Collaboration Suite middle tier to $ORACLE_HOME/wireless/lib on the Wireless middle tier.

Include these JAR files in the OC4J classpath by adding the following lines to $ORACLE_HOME/j2ee/OC4J_Wireless/config/application.xml:

Configuration Parameters


Note:

The values set for Async Contact Separator, Async Query OID, Async Max Contacts Results, and Async Translate Commands parameters affect all of the Async-enabled mobile applications. These values do not affect the Address Book application alone, but any Async-enabled application. 


8.3.1.3 Linking to the Address Book Application

You can link to the address book using the following virtual URL:

omp://oracle/services/pim/addressbook

Table 8-2 describes the input call parameters of the Address Book.:

Table 8-2 Input Call Parameters of the Address Book
Parameter Name  Mandatory?  Description  Valid Value 

screen 

No 

The function performed by the Addressbook.  

0 (Displays the list of contacts);

51 (Makes the Addressbook service add the contact with the provided data to this database of contacts. This parameter requires SERIALIZED_CONTACT if the value is 51.) 

srchstr 

No 

Makes the Addressbook perform a search for the specified string among all of the contacts. 

The string which is the object of the search. Requires screen := {0 empty} 

SERIALIZED_CONTACT

The SERIALIZED_CONTACT group contains the parameters for each element of a contact, such as contact name, contact work phone, and contact work address. The elements described in this optional group are returned when the user clicks the Done button in a screen displaying a contact detail.

The SERIALIZED_CONTACT group includes the following parameters, described in Table 8-3.

Table 8-3 Parameters of the Serialized Contact Group for Addressbook
Parameter Name  Mandatory?  Description  Valid Value 

NAME 

Yes 

The name of this contact. 

For example, NAME=John Smith. 

WORKPH 

No 

The work phone number of this contact.

Restriction: white-spaces, special characters, are encoded. 

WORKPH=650-123-4567 

MOBILEPH 

No 

The mobile phone number of this contact. 

 

HOMEPH 

No 

The home phone of this contact.

Restriction: white-spaces, special characters, are encoded. 

 

WORKFAX 

No 

The business fax number of this contact.

Restriction: white-spaces, special characters, are encoded. 

 

EMAIL1 

No 

The email (or the first email) address of this contact.

Restriction: white-spaces, special characters, are encoded. 

An email address, for example, EMAIL1=scott.tiger@oralce.com 

EMAIL2 

No 

The second email address of this contact.

Restriction: white-spaces, special characters, are encoded. 

An email address, for example, EMAIL2=scott.tiger@homemail.com 

WADDRLINE1 

No 

The first (or only) line of the Work address of this contact.

Restriction: white-spaces, special characters, are encoded. 

The first line of a street address. For example:

WADDRLINE1=123 Main Street 

WADDRCITY 

No 

The city or Work address of this contact.

Restriction: white-spaces, special characters, are encoded. 

A city; for example, WADDRCITY = Boston 

WADDRSTATE 

No 

The state (or federal region) of the WORK address of this contact.

Restriction: white-spaces, special characters, are encoded.

 

A state (or federal region); for example, WADDRSTATE = CA

WADDRSTATE = Massa chusetts 

WADDRZIP 

No 

The ZIP or postal code of the work address of this contact. 

A ZIP or postal code. For example, WADDRZIP=02142

WADDRZIP=D-80333 

WADDRCOUNTRY 

No 

The country of the work address of this contact. 

The name of a country, for example:

WADDRCOUNTRY=U.S.A. 

HADDRLINE1 

No 

The first (or only) street line of the home address of this contact.

Restriction: white-spaces, special characters, are encoded. 

The first line of a street address, for example:

HADDRLINE1 = 2901 Armstrong Dr. 

HADDRCITY 

No 

The city of the home address of the person in the contact. 

The name of a city, for example:

HADDRCITY=Boston 

HADDRSTATE 

No 

The state (or federal region) of the home address of the person in this contact. 

The full name or abbreviation of the state. For example:

HADDRSTATE=Massachusetts

HADDRSTATE=CA 

HADDRZIP 

No 

The ZIP or postal code of this contact. 

The ZIP or postal code. For example:

HADDRZIP=90210

HADDRZIP=D-80333 

HADDRCOUNTRY 

No 

The country of the home address of this contact. 

A name of a country, for example:

HADDRCOUNTRY=U.S.A. 

NOTES 

Yes 

Text notes describing this contact.

Restriction: white-spaces, special characters, are encoded. 

A short description of the person in the contact, for example:

NOTES=This the chief-of-staff in CCC Co. 

Output Parameters

Table 8-4 describes the output parameters for the Address Book.

Table 8-4 Output Parameters of the Addressbook
Parameter Name  Mandatory?  Description 

mailto 

No. 

An email address of a contact. This must be an email address. For example: mailto=scott.tiger@orcale.com 

smPhone

smphone is a phone number of a contact, returned with additional parameters used by the Short Messaging application (usually when the user selects a phone number in the Address Book application).

Table 8-5 describes the smPhone parameters.

Table 8-5 Parameters of smPhone

Parameter Name  Mandatory?  Description  Valid Value 

type 

Yes 

The type of short messaging service desired. 

VOICE, FAX 

destinationAddress 

Yes 

The recipient number of address for the short message (usually a phone number). 

A phone number, for example:

destinationAddress=650-555-5000. 

faxNumber

faxNumber is the fax number of a contact, returned with additional parameters used by the FAX or Short-Messaging applications (usually when the user selects a fax number in the Address Book application). Table 8-6 describes the parameters of the faxNumber group.

Table 8-6 Parameters of faxnumber
Parameter Name  Mandatory?  Description  Valid Value 

type 

Yes 

The type of short messaging service needed. 

FAX 

destinationAddress 

Yes 

The fax number of the recipient used in the short messaging module. 

A fax number, for example, destinationAddress=650-123-4567. 

FAXTODO 

Yes 

The function that the fax module perform. 

NEWFAX 

RNAME 

Yes 

The name of the recipient of the fax. 

A name, for example: RNAME=Scott Tiger 

RPHONE 

Yes 

The phone number of the recipient of the fax. 

A phone number, for example: RPHONE=650-555-5000. 

RFAX 

Yes 

The fax number to which the fax is sent. 

A fax number, for example, RFAX=650-555-1234 

SERIALIZED_CONTACT

The SERIALIZED_CONTACT group contains the parameters for each element of a contact, such as contact name, contact work phone, and contact work address. The elements described in this optional group are returned when the user clicks the Done button done in a screen displaying a contact detail. Table 8-7 describes the parameters of the SERIALIZED CONTACT group.

Table 8-7 Parameters of the SERIALIZED_CONTACT Group
Parameter Name  Mandatory?  Description  Valid Value 

NAME 

Yes 

The name of this contact.

Restriction: the white-spaces, special characters, are encoded. 

A name. For example, NAME=John Smith. 

WORKPH 

No 

The work phone number of this contact.

Restriction: the white-spaces, special characters, are encoded. 

A phone number, for example:

WORKPH=650-123-4567 

HOMEPH 

No 

The home phone number of this contact.

Restriction: the white-spaces, special characters, are encoded. 

A phone number, for example: HOMEPH=650-555-5000 

MOBILEPH 

No 

The mobile phone number of this contact.

Restriction: the white-spaces, special characters, are encoded. 

A phone number, for example: MOBILEPH=650-555-5000 

WORKFAX 

No 

The business fax number of this contact.

Restriction: the white-spaces, special characters, are encoded. 

Example: WORKFAX= 

EMAIL1 

No 

The e-mail (or the first email) address of this contact. Restriction: the white-spaces, special characters, are encoded. 

An email address, for example, EMAIL1=scott.tiger@oracle.com 

EMAIL2 

No 

The second email address of this contact.

Restriction: the white-spaces, special characters, are encoded.  

An email address, for example, EMAIL2=scott.tiger@homemail.com 

WADDRLINE1 

No 

The first (or only) line of the Work address of this contact.

Restriction: the white-spaces, special characters, are encoded.  

The first line of a street address. For example:

WADDRLINE1=123 Main Street 

WADDRCITY 

No 

The city or work address of this contact.

Restriction: the white-spaces, special characters, are encoded.  

A city; for example, WADDRCITY = Boston 

WADDRSTATE 

No 

The state (or federal region) of the WORK address of this contact.

Restriction: the white-spaces, special characters, are encoded.

 

A state (or federal region); for example, WADDRSTATE = CA

WADDRSTATE = Massachusetts 

WADDRZIP 

No 

The ZIP or postal code of the work address for this contact. 

A ZIP or postal code. For example, WADDRZIP=02142

WADDRZIP=D-80333 

WADDRCOUNTRY 

No 

The country of the work address of this contact. 

The name of a country, for example:

WADDRCOUNTRY=U.S.A. 

HADDRLINE1 

No 

The first (or only) street line of the home address of this contact.

Restriction: the white-spaces, special characters, are encoded.  

The first line of a street address, for example:

HADDRLINE1 = 2901 Armstrong Dr. 

HADDRCITY 

No 

The city of the home address of the person in the contact. 

The name of a city, for example:

HADDRCITY=San Francisco 

HADDRSTATE 

No 

The state (or federal region) of the home address of the person in this contact. 

The full name or abbreviation of the state. For example:

HADDRSTATE=California HADDRSTATE=CA 

HADDRZIP 

No 

The ZIP or postal code of this contact. 

The ZIP or postal code. For example:

HADDRZIP=90210

HADDRZIP=D-80333 

HADDRCOUNTRY 

No 

The country of the home address of this contact. 

A name of a country, for example:

HADDRCOUNTRY=U.S.A. 

NOTES 

Yes 

Text notes describing the person this contact.

Restriction: the white-spaces and special characters are encoded.  

A short description of the person in the contact, for example:

NOTES=This the chief-of-staff in CCC Co. 

8.3.2 Calendar

The Calendar application enables users to manage their schedule using mobile access to calendaring servers, such as Oracle Collaboration Suite, Oracle Calendar Server, Microsoft Exchange, and Lotus Domino.

Required Software

Table 8-8 lists the required third-party software for the calendar application.

Table 8-8 Software Requirements for the Calendar Application
Name  From Version 

Oracle Collaboration Suite 

Oracle Calendar Server 

5.2 

MS Exchange 

5.5 

Lotus Domino Server 

R5 


Note:

To connect applications to Microsoft Exchange and the Lotus Domino server, see Section 8.3.10.1


Connecting to the Oracle Collaboration Suite

To connect to the Oracle Collaboration Suite, copy all of the native libraries from $ORACLE_HOME/ocal/sdk/lib on the middle tier of the Oracle Collaboration Suite to $ORACLE_HOME/wireless/lib on the Oracle Application Server Wireless middle tier.

Configuration Parameters

The Calendar application's configuration parameters include the following:

8.3.2.1 Linking to the Calendar Application

You can link to the calendar application using the following virtual URL:

omp://oracle/services/pim/calendar

Input Call Parameters for the Calendar Application

The input call parameters of the calendar application include the getApptDetails group. This optional group includes the following input call parameter, which is described in Table 8-9.

Table 8-9 The ID Parameter
Parameter Name  Mandatory?  Description  Valid Value 

ID 

Yes 

The input ID required to retrieve appointment details. 

A string. For example, ID=1324. 

Table 8-10 describes the parameters of addAppt group.

Table 8-10 Parameters of addAppt
Parameter Name  Mandatory?  Description  Valid Value 

TITLE 

Yes 

The title of the appointment. 

A string. For example, TITLE=Dinner at Joe's. 

DATE 

Yes 

The date of the appointment. 

A string. For example, DATE=December 31, 2001 

TIME 

Yes 

The time of the appointment. 

A string. For example, TIME= 8:00 p.m. 

DURATION 

Yes 

The duration of the appointment. 

A string. For example, DURATION=1 hour. 

NOTES 

Yes 

The notes for the appointment. 

A string. For example, NOTES=Remember the brief. 

TYPE 

Yes 

The type of appointment, either personal or business. 

A string. For example, TYPE=Business. 

LOCATION 

Yes 

The location of an appointment. 

A string. For example, LOCATION=Home. 

REMIND 

Yes 

The time interval before the event reminder occurs. 

A string. For example, REMIND=1 hour. 

SHARING 

Yes 

A flag that enables or disables the sharing of an appointment. If True, the appointment is shared; if FALSE, then the appointment is not shared. 

For example, SHARING=TRUE. 

The Calendar application also includes the deleteAppt group. Table 8-11 describes the deleteAppt parameter.

Table 8-11 The deleteAppt Parameter
Parameter Name  Mandatory?  Description  Valid Value 

ID 

Yes 

The input ID required to select an appointment. 

A string. For example, ID=1324. 

Output Parameters of the Calendar Application

The Calendar application includes the following output parameters:

The output parameters of the calendar application include the getApptDetailsRresponse group. This optional group includes the following parameters, which are described in Table 8-12.

Table 8-12 The Output Parameters of the getApptDetailsResponse Group

Parameter Name  Mandatory?  Description  Valid Value 

TITLE 

Yes 

The title of the appointment. 

A string. For example, TITLE=Dinner at Joe's. 

DATE 

Yes 

The date of the appointment. 

A string. For example, DATE=December 31, 2001 

TIME 

Yes 

The time of the appointment. 

A string. For example, TIME= 8:00 p.m. 

DURATION 

Yes 

The duration of the appointment. 

A string. For example, DURATION=1 hour. 

NOTES 

Yes 

The notes for the appointment. 

A string. For example, NOTES=Remember the brief. 

TYPE 

Yes 

The type of appointment, either personal or business. 

A string. For example, TYPE=Business. 

LOCATION 

Yes 

The location of an appointment. 

A string. For example, LOCATION=Home. 

REMIND 

Yes 

The time interval before the event reminder occurs. 

A string. For example, REMIND=1 hour. 

SHARING 

Yes 

A flag that enables or disables the sharing of an appointment. If True, the appointment is shared; if FALSE, then the appointment is not shared. 

For example, SHARING=TRUE. 

apptResponse

Table 8-13 describes the parameters of the apptResponse group (an optional group).

Table 8-13 The Output Parameters of the addApptResponse Group
Parameter Name  Mandatory  Description  Valid Value 

TITLE 

Yes 

The title of the appointment. 

A string. For example, TITLE=Dinner at Joe's. 

DATE 

Yes 

The date of the appointment. 

A string. For example, DATE=December 31, 2001 

TIME 

Yes 

The time of the appointment. 

A string. For example, TIME= 8:00 p.m. 

DURATION 

Yes 

The duration of the appointment. 

A string. For example, DURATION=1 hour. 

NOTES 

Yes 

The notes for the appointment. 

A string. For example, NOTES=Remember the brief! 

TYPE 

Yes 

The type of appointment, either personal or business. 

A string. For example, TYPE=Business. 

LOCATION 

Yes 

The location of an appointment. 

A string. For example, LOCATION=Home. 

REMIND 

Yes 

The time interval before the event reminder occurs. 

A string. For example, REMIND=1 hour. 

SHARING 

Yes 

A flag that enables or disables the sharing of an appointment. If True, the appointment is shared; if FALSE, then the appointment is not shared. 

For example, SHARING=TRUE. 

deleteApptResponse

Table 8-14 describes the parameters of the deleteApptResponse group (an optional group).

Table 8-14 Parameters of the deleteApptResponse group
Parameter Name  Mandatory?  Description  Valid Value 

TITLE 

Yes 

The title of the appointment. 

A string. For example, TITLE=Dinner at Joe's. 

DATE 

Yes 

The date of the appointment. 

A string. For example, DATE=December 31, 2001 

TIME 

Yes 

The time of the appointment. 

A string. For example, TIME= 8:00 p.m. 

DURATION 

Yes 

The duration of the appointment. 

A string. For example, DURATION=1 hour. 

NOTES 

Yes 

The notes for the appointment. 

A string. For example, NOTES=Remember the brief. 

TYPE 

Yes 

The type of appointment, either personal or business. 

A string. For example, TYPE=Business. 

LOCATION 

Yes 

The location of an appointment. 

A string. For example, LOCATION=Home. 

REMIND 

Yes 

The time interval before the event reminder occurs. 

A string. For example, REMIND=1 hour. 

SHARING 

Yes 

A flag that enables or disables the sharing of an appointment. If True, the the appointment is shared; if FALSE, then the appointment is not shared. 

For example, SHARING=TRUE. 

8.3.3 Directory

The Directory application enables users to access LDAP directory servers from any mobile device. This application is integrated with the Email application, enabling users to browse their corporate directory and then send an email to a particular contact, or to compose a recipient list from the directory.

8.3.3.1 Configuring the Directory

Wireless includes all of the required JAR files. This application requires no scripts.

The Mobile directory application includes the following configuration parameters:

8.3.3.2 Configuration Parameters

8.3.3.3 Linking to the Directory Application

You can link to the directory application through the following virtual URL:

omp://oracle/services/pim/directory

You can configure each element of this application; clicking any field after getting the details of a result returns the field value to the caller as the parameter mailto.

Output Parameters

The output parameters for the directory application include the following:

mailto

The value of the field that the user selects. For example:

There are no restrictions for this parameter.

Examples

To return a first name, configure the mailto parameter as follows:

mailto=john

To return an email address, configure the mailto parameter as follows:

mailto=john.smith@mycompany.com

8.3.4 Fax

The Fax application enables users to send documents, text, and Web pages to any fax machine.

Required Software

Table 8-15 describes the required third-party software for the Fax application.

Table 8-15 Required Software for the Fax Application
Name  Instructions  From Version(s)  

RightFax Server (available from RightFax) 

Install the RightFax server. 

7.2  

RightFax Integration Module (available from RightFax) 

Install the Integration module on fax server. 

7.2  

RightFax PFD module (available from RightFax)  

Install the PFD module on the fax server. 

7.2  

RightFax Java API (available from RightFax) 

Copy RFJava_api.zip(Fax server's RightFax/Production/xml/java directory) to $ORACLE_HOME/wireless/lib on Solaris, to %ORACLE_HOME%\wireless\lib on NT. Include this zip file in the OC4J classpath by adding the following line to %ORACLE_HOME%\j2ee\OC4J_Wireless\config\application.xml.

<libarary path="../../../wireless/lib/RFJava_api.zip"/> 

7.2  

Sample Cover Page

Because the Fax application uses a customized cover sheet file, you should use the provided sample cover page. To use this cover page, you must have Microsoft Word 2000 installed on your RightFax server for server-side application conversion.

On Solaris installations, this cover page is located at:

$ORACLE_HOME/iaswv20/wireless/j2ee/applications/modules/modules-web/images/pim/fax/FCS.doc

On Windows NT installations, this cover page is located at:

%ORACLE_HOME%\iaswv20\wireless\j2ee\applications\modules\modules-web\images\pim\fax\FCS.doc

To use the provided fax cover page:

  1. Copy the FCS.doc to the directory RightFax\FCS on the machine in which you installed your RightFax server.

  2. Specify which cover sheet to use:

    1. Run Enterprise Fax Manager

    2. Highlight Users under the appropriate server and double-click the user, ID Administrator.

  3. Click the Default Cover Sheets tab.

  4. In the Cover Sheet Defaults group box, check Send Cover Sheets and select the cover sheet file (FCS.doc) in the Cover Sheet Model field.

  5. Highlight Groups under the appropriate server and double-click the group, ID Everyone.

  6. Click the Basic Information tab.

  7. Select the cover sheet file (FCS.doc) in the Cover Sheet Model field.


Note:

See the RightFax Administrator's Guide for detailed instructions on fax cover sheets.  


Configuration Parameters

The Fax application includes the following configuration parameters:

8.3.4.1 Linking to the Fax Application

You can link to the Fax application using the following virtual URL:

omp://oracle/services/pim/fax

The Fax application has one input call parameter, FAXTODO. This parameter describes the type of actions to be performed. Table 8-16 describes this mandatory input parameter.

Table 8-16 Values of the FAXTODO input Parameter
Value  Requirement  Triggers Output 

NEWFAX 

SendNewFax 

SendNewFaxResult. 

STATUS 

faxID 

CheckFaxStatusResult 

DELETE 

faxID 

deleteFaxResult 

FWD 

forwardFax 

forwardFaxResult 

sendNewFax

The FAXTODO parameter includes sendNewFax group. This mandatory group of parameters specify the information about the fax to be sent. Table 8-17 describes the parameters of the sendNewFax group.

Table 8-17 Parameters of the sendNewFax Group
Parameter Name  Mandatory  Description  Valid Value 

SENDER_NAME 

No  

Sender name.  

A string. For example: SENDER_NAME=Joe Smith  

SENDER_CORP 

No  

Sender company.  

A string. For example: SENDER_CORP=Oracle Corp.  

SENDER_PHONE 

No  

Sender phone number.  

A string. For example: SENDER_PHONE=1(650)123-4567  

SENDER_FAX 

No  

Sender fax number.  

A string. For example: SENDER_FAX=1(650)123-4567  

SENDER_ADDRESS 

No  

Sender address.  

A string. For example: SENDER_ADDRESS=Home address  

SENDER_NOTES 

No  

Other sender information not listed above.  

A string. For example: SENDER_NOTES=email: joe.smith@oracle.com  

RECIPIENT_NAME 

No  

Recipient name.  

A string. For example: RECIPIENT_NAME=John White  

RECIPIENT_CORP 

Yes  

Recipient company.  

A string. For example: RECIPIENT_CORP=1(650)123-4567  

RECIPIENT_PHONE 

No  

Recipient phone number.  

A string. For example: RECIPIENT_PHONE=1(650)987-6543  

RECIPIENT_FAX  

Yes  

Recipient fax number.  

A string. For example: RECIPIENT_FAX=1(650)123-4567  

RECIPIENT_ADDRESS 

No  

Recipient address.  

A string. For example: RECIPIENT_ADDRESS=Work address  

MESSAGE 

No  

Short message to be written on cover page.  

A string. For example: MESSAGE=An awesome resume!  

ATTACHMENT 

No  

Attachment to be faxed.  

A string. For example: ATTACHMENT=mydoc/resume.pdf  

forwardFax

The FAXTODO parameter includes the forwardFax group. Table 8-18 describes the parameters of this mandatory group.

Table 8-18 Parameters of the forwardFax Group
Parameter Name  Mandatory  Description  Valid Value 

FAXID 

Yes  

The unique id of the fax to be forwarded.  

A string. For example: FAXID=12345  

RECIPIENT_FAX 

Yes  

The destination fax number.  

A string. For example: Example: RECIPIENT_FAX=1(650)555-4576  

Output Parameters

Table 8-19 describes the output parameters of the Fax application.

Table 8-19 Output Parameters of the Fax Module
Parameter  Mandatory  Description  Valid Value 

sendNewFaxResult 

Yes  

Whether the fax was successfully sent or not.  

A string. For example: sendNewFaxResult=Fax has been successfully submitted for sending.  

checkFaxStatusResult 

Yes  

The fax status.  

A string. For example: checkFaxStatusResult=Sending(50%)  

deleteFaxResult 

Yes  

Whether the fax was successfully deleted or not.  

A string. For example: deleteFaxResult=Fax successfully deleted.  

forwardFaxResult 

Yes  

Whether the fax was successfully forwarded or not.  

A string. For example: forwardFaxResult=Fax has been successfully submitted for forwarding.  

Examples

To send a fax, you configure the FAXTODO parameters as follows:

FAXTODO = NEWFAX

RECIPIENT_FAX = 1(650)555-5000 

MESSAGE = Hello world! 

sendNewFaxResult = Fax has been successfully submitted for sending. 

To check the status of a fax you configure the FAXTODO parameters as follows:

FAXTODO = STATUS 

faxID = 16543 

checkFaxStatusResult = OK 

8.3.5 Oracle Internet File System

The Oracle Internet File System application enables you to browse online files and select files for faxing or sent with email. Table 8-20 lists the required third-party software for this application.

Table 8-20 Required Software for the Oracle Internet File System Application
Name  Instructions  From Version 

Any WEBDAV-compliant server, such as Oracle Files. 

Install the server. 

2.0 

Configuration Parameters

The Oracle Internet File System application includes the following configuration parameters:

8.3.5.1 Linking to the Oracle Internet File System Application

You can link to the Oracle Internet File System application using the following virtual URL:

omp://oracle/services/pim/ifs

Input Call Parameters

The Oracle Internet File System application includes the following call parameters and parameter groups, which are described in Table 8-21.

Table 8-21 The IFSAction Input Parameter
Parameter Name  Mandatory  Description  Valid Value 

IFSAction 

Yes 

The type of action to be performed. 

UPLOAD (for uploading a file to the Oracle Internet File System server.)

DOWNLOAD (for downloading a file to the Oracle Internet File System server.)

If the value is UPLOAD, then IFSAction requires uploadIfsRequest. If the value is DOWNLOAD, then the downloadIfsRequest output is triggered.  

uploadIfsRequest

Table 8-22 describes the parameters of the uploadifsRequest group. This is an optional group.

Table 8-22 Parameters of the uploadIfsRequest Group
Parameter Name  Mandatory  Description  Valid Value 

LOCALPATH 

Yes 

The absolute local path of the file to be uploaded to the Oracle Internet File System Server. 

A string. For example:

  • LOCALPATH=/private/joe docs/file.doc

  • LOCALPATH=c:\TEMP\RESUME.PDF

 

OBJNAME 

No 

Enables the user to rename the uploaded file rather than keeping the file name given in LOCALPATH.

Note: This name must conform to the UNIX file system convention. For example, it cannot contain the back-slash (\). 

A string. For example, OBJNAME=Renamed File.doc 

Output Parameters

The Oracle Internet File System application includes the following output parameters:

downloadIfsInfo

This optional group specifies such information about the downloaded file as the size of the downloaded file, its location, and its original name.

Table 8-23 describes the parameters of the downloadIFsInfo group.

Table 8-23 Parameters of the IFsInfo Group
Parameter Name  Mandatory  Description  Valid Value 

IFSPATH 

Yes 

The absolute path of the downloaded file. 

A string, for example:

  • IFSPATH=/private/joe/download/file.doc

  • IFSPATH=C:\TEMP\RESUME.PDF

 

IFSORIGPATH 

Yes 

The original IFS path of the downloaded file. 

A string, for example:

IFSORIGPATH=/ifshome/joe/file.doc 

IFSNAME 

Yes 

The original name of the downloaded filed. This name is provided for display in the user interface. 

A string, for example:

  • IFSNAME=file.doc

  • IFSNAME=RESUME.PDF

 

IFSSIZE 

Yes 

The size (in kilobytes) of the downloaded file. 

Double. For example:

IFSSIZE=12.4 

Examples

To upload files.doc from the directory/private/joe/docs and save it as newfile.doc, you must configure the parameters as follows:

IFSACTION=UPLOAD

LOCALPATH=/private/joe/docs/file.doc

OBJNAME=newfile.doc

To download files.doc from the Oracle Internet Files System server, configure the parameters as follows:

IFSACTION=DOWNLOAD

IFSPATH=/private/joe/download/file.doc

IFSNAME=file.doc

Output Parameter: IFSORIGPATH=ifshome/joe/file.doc

Output Parameter: IFSSIZE=15.0

8.3.6 Instant Messaging

The Instant Messaging application provides presence management, enabling employees to exchange instant messages from their mobile devices. This application is integrated with Jabber Instant Messaging server and the MSN and Yahoo networks.

8.3.6.1 Configuring the Instant Messaging Application

The Instant Messaging application, which uses the Jabberbeans classes to connect to a Jabber Instant Messaging Server, requires the installation of third-party software. Table 8-24 describes the required third-party software.

Table 8-24 Software Required for the Instant Messaging Application
Name  From Version   Instructions 

Jabber Server 

1.4.1  

Follow the Jabber server installation guide. 

Yahoo Transport Gateway 

0.8.0 

Optional. Follow the Jabber server installation guide. 

MSN Transport Gateway 

1.1.0 

Optional. Follow the Jabber server installation guide. 

Configuration Parameters

The Instant Messaging application includes the following configuration parameters:

8.3.6.2 Linking to the Instant Messaging Application

You can link to the Instant Messaging application using the following virtual URL:

omp://oracle/services/pim/instantmessaging

Input Call Parameters of the Instant Messaging Application

The input call parameters of the Instant Messaging application includes the IMMessage parameter, which is described in Table 8-25.

Table 8-25 The IMMessage Parameter
Parameter Name  Mandatory?  Description  Valid Value 

IMMessage 

No 

The text of a message that is sent through the service. 

A string. For example:

  • IMMESSAGE=How are you doing today?

  • IMMESSAGE=I am sending you this message through IM.

 

Output Parameters

An example of the IMMessage output parameter is calling the module to send a simple message. For example:

Input Parameter: IMMessage=Do you want to go see a movie?

8.3.7 Mail

The Mail application enables users to access their email messages from any mobile device. The Mail application integrates with any IMAP or POP3 server (including Microsoft Exchange and Lotus Domino servers).

8.3.7.1 Configuration Parameters

The Mail application includes the following parameters:


Note:

For the inbox filters for the Mail application, enter the Oracle Internet Directory (OID) server and the port as Mail Server and Mail Server Port instead of the IMAP server and port. Also select esmail as the Mail protocol. For more information about Inbox Filters, see the documentation for Oracle Unified Messaging which ships with the Oracle Collaboration Suite.

Copy the following JARS from the Oracle Collaboration Suite middle tier to the $ORACLE_HOME/wireless/lib on the Oracle Application Server Wireless middle tier:

  • $ORACLE_HOME/jlib/esmail_sdk.jar

  • $ORACLE_HOME/jlib/escommon.jar

  • $ORACLE_HOME/jlib/esldap.jar

Include the JAR files in the OC4J classpath on the Oracle Application Server Wireless middle tier by adding the following lines to $ORACLE_HOME/j2ee/OC4J_Wireless/config/application.xml:

  • <library path="../../../wireless/lib/esmail_sdk.jar"/>

  • <library path="../../../wireless/lib/escommon.jar"/>

  • <library path="../../../wireless/lib/esldap.jar"/>

 

8.3.7.2 Linking to the Mail Application

You can link to an email application using the following virtual URL:

omp://oracle/services/pim/mail

Input Call Parameters

The input call parameters of the Mail application include the following:

action

The action that the Mail application should perform. This is a mandatory input parameter. Table 8-26 describes the input parameters of the action input call parameter.

Table 8-26 Input Parameters for Action
Valid Value  Description  Requirement 

messageto 

Send an email message. 

Requires mailto.  

messagecc 

CC an email message. 

Requires mailto. 

sendasattachment  

Send an attachment 

Requires attach. 

mailto

The email address to which the message is sent. This is an optional input parameter. The value must be a string. For example:

attach

The fully-qualified path of the local file that is sent as an attachment to the email. the value must be a string. For example:

Output Parameters (Examples)

To send an email to Scott Tiger, you configure the action and mailto parameters as follows:

To send the picture (that is, a .JPEG) of your new home, configure the action and attach parameters as follows:

8.3.8 Short Messaging

The Short Messaging application enables users to send messages through such mediums as voice, email, fax or SMS messaging. To send a short message, a user sends the service four parameters: the type of message to be sent (email, SMS, Voice, or Fax), the destination address of the message, the subject text, and the body text of the email. The subject and body text are translated into the medium appropriate to the message type and then sent to the destination.

8.3.8.1 Configuring the Short Messaging Application

This application does not require any third-party software components; it instead relies upon the Oracle Application Server Wireless transport to be configured. The short messaging application does not require scripts.

Configuration Parameters

The Short Messaging application includes the followoing configuration parameters:

8.3.8.2 Linking to the Short Messaging Application

You can link to a Short Messaging application using the following virtual URL:

omp://oracle/services/pim/sm

Input Call Parameters

The short messaging application includes the following input call parameters, which are described in Table 8-27.

Table 8-27 Input Call Parameters of the Short Messaging Module
Parameter Name  Mandatory  Description  Valid Value 

type 

No 

The type of medium through which the message is sent. 

The values include:

  • EMAIL (for sending email messages)

  • SMS (for sending a SMS message)

  • VOICE (for sending a message through a phone).

  • FAX (for sending a message through a facsimile)

 

destinationAddress 

No 

The address to which the message is sent. 

A string. For example:

  • destinationAddress=6505555000

  • destinationAddress=oraclemobile@oracle.com

 

subjectText 

No 

The subject of a message to be sent. 

A String. For example:

  • subjectText=Hi There!

  • subjectText=Tomorrow Night?

 

bodyText 

No 

The body text of a message to be sent. 

A String. For example:

bodyText=Do not forget to pick up the children on the way home. And buy dinner, too

sendMessage 

No 

Specifies whether the service should attempt to send the message with the given information. The service does not send the message unless it has been instructed to do so. 

Specify Yes if the service should send the message. Specify No if the service should not send the message. 

Output Parameters (Examples)

An example of the short message output parameters is sending a simple message. For example:

Sending an Email

To send an email configure the input parameters as follows:

type=EMAIL
destinationAddress=friend@oracle.com
subjectText=Hey there!
bodyText=How's it going?
sendMessage=yes
Sending a Voice Message

To send a voice message, configure the input parameters as follows:

type=Voice
destinationAddress=6505555000

8.3.9 Tasks

The Tasks application enables users to schedule and manage tasks.

Required Software

This application implements two distinct modes, both with the same user experience but with different back-ends. In its Lotus Domino mode, it fully integrates with a Lotus Domino server to enable mobile Domino users. In its Microsoft Exchange Mode, it fully integrates with a Microsoft Exchange server to mobile-enable Exchange users.

The Tasks application requires third-party software. For more information, refer to Section 8.3.10.1 and Section 8.3.10.1.1.

Configuring the Task Module

The Tasks application includes the following configuration parameters:

8.3.9.1 Linking to the Tasks Application

You can link to the Tasks application using the following virtual URL:

omp://oracle/services/pim/tasks

8.3.10 Connecting PIM Applications to Non-Oracle Servers

The Collaboration Applications (that is, the PIM applications Address Book, Calendar and Tasks applications) can connect to non-Oracle collaboration servers, such as the Microsoft Exchange and Lotus Domino server. To enable these PIM applications to run against the Exchange and Domino severs, you must configure these servers in addition to configuring the application-specific parameters.


Note:

The Mail application does not require additional software. 


8.3.10.1 Configuring the Microsoft Exchange Server for PIM Applications

Configuring the Microsoft Exchange Server for Voice and Wireless PIM applications requires the following software, described in Table 8-28.

Table 8-28 Required Software

Name 

From Version 

Microsoft Exchange 

5.5 

Microsoft Internet Information Services (IIS)  

4.0 

Microsoft Collaboration Data Objects (MS CDO)

(Available with the Microsoft Exchange SDK). 

1.2.1 

You must install the Microsoft Exchange Server and the Microsoft Internet Information Services (IIS) server.


Note:

You must install cdo.dll on the IIS server. This library is included with MS CDO.  


8.3.10.1.1 Configuring the PIM Active Server Pages (ASPs)

To configure the ASPs for the PIM applications:

  1. Create a directory named oracle on the IIS server. For example, create C:\inetpub\oracle.

  2. Copy the following files from Oracle Application Server Wireless middle-tier server to the oracle folder on the IIS server:

8.3.10.2 Configuring the Lotus Domino for PIM Applications

Configuring Lotus Domino for the Collaboration Applications (that is, the PIM applications) requires the software described in Table 8-29.

Table 8-29 Required Software for Configuring Lotus Domino for PIM Applications
Name  From Version  Instructions 

Lotus Domino Server 

5.5 

Install the Lotus Domino Server, 

Lotus Java Toolkit for Java/COBRA 

5.0.5 

Install the Lotus Java Toolkit for Java/COBRA. 

Installing the Lotus Domino Toolkit for Java/COBRA from www.lotus.com creates a directory in the file system called DTJava.

To configure the Lotus Domino Server:

  1. Copy DTJava/lib/NCSO.jar to

    $ORACLE_HOME/wireless/lib on Solaris

    or

    %ORACLE_HOME%\wireless\lib on NT

    Examples of Solaris and NT values for ORACLE_HOME are as follows:

    • For Solaris: ORACLE_HOME=/u01/iaswv904

    • For Windows NT: ORACLE_HOME=d:\oracle\iaswv904

  2. Include DTJava/lib/NCSO.jar in the OC4J classpath by adding the following line to $ORACLE_HOME/j2ee/OC4J_Wireless/config/application.xml:

    <library path="../../../wireless/lib/NCSO.jar"/>


Note:

You must download Lotus Domino Toolkit for Java/CORBA Release 5.0.8 Update or Lotus Domino Toolkit for Java/CORBA Release 5.0.5 Update Shipping.

Do not use the Version 2.x toolkit. 


  1. Server tasks HTTP and DIIOP must both be running on the Domino server. Ensure that the Domino server's notes.ini file contains the following line:

    ServerTasks=<other tasks>,http,diiop 5.0.5

8.4 Location

There are four Location Based applications: Location Picker, Driving Directions, Maps, and Biz Directory (business directory).

The Location Picker application enables users to pick and manage their frequently-accessed locations. Using this application, a user can specify a location that can be used by another application, such as the Diving Directions application. This location can be the user's default location, the current location (if mobile positioning is enabled), a Location Mark selected by the user, a recent location used by the user, or a new location to be entered by the user

The Location Picker application is used by other applications to acquire a location from the user. When used directly by the user, Location Picker provides management of the user's Location Marks and allows the user to set a preferred location, which is either the user's current location (when the mobile positioning is available and enabled) or the user's default Location Marks.

Other location applications include Driving Directions, Maps, and Biz Directory. These applications use the Location Picker to acquire locations from the user if the user does not have a preferred location or if the user specifically wants to change the location used for those applications.

8.4.1 Biz Directory

The Biz Directory application provides users with a complete business directory. This application is built on the Wireless Location Application Component API.

This application provides a yellow pages-type interface to search for the addresses and phone numbers of registered businesses within a given radius. The application enables searches for business names or categories and enables users to browse categories. If no location parameters are passed to this application, then the Location application is invoked to obtain location data for the search.

8.4.1.1 Configuring the Biz Directory Input Parameters

This application requires a Wireless business directory provider (as described in Table 8-30)

Table 8-30 Requirements for the Biz Directory Application
Name  External Provider(s)  Instructions  From  

Business Directory Provider 

otn.oracle.com 

See application providers 

2.0  

.

8.4.1.2 Configuring the Input Parameters

The Biz Directory includes the following input parameters:

8.4.1.3 Linking to the Biz Directory

You link to the Biz Directory application using the following virtual URL:

omp://oracle/services/location/bizdir

Table 8-31 describes the input call parameters of the Biz Directory application.

Table 8-31 The Input Call Parameters of the Biz Directory Application
Parameter Name  Mandatory  Description  Valid Value 

PH  

No  

Phrase (keywords) to search for.  

A string. For example: PH=Pizza

PH=Restaurants PH=Oracle  

FC  

No  

Full category of the business. This category is defined in the YP mapping XML file, which is specified using the Oracle Application Server Wireless Tools.  

A string. For example: FC=/Business/Restaurant/Italian For example: FC=/Business/Automotive/Dealer/New/BMW  

CN  

No  

Company Name  

A string. For example: CN=Oracle Corp.  

FL  

No  

Address First Line  

A string. For example: FL=500 Oracle Parkway  

SL  

No  

Address Second Line  

A string. For example: SL=Redwood City, CA  

LL  

No  

Address Last Line  

A string. For example: LL=US  

BL  

No  

Block  

A string. For example: BL=Block 400  

CI  

No  

City  

A string. For example: CI=Redwood City  

CT  

No  

County  

A string. For example: CT=San Mateo  

ST  

No  

State  

A string. For example: ST=CA  

PC  

No  

Postal Code  

A string.For example: PC=94065  

PCE  

No  

Postal Code Extension  

A string. For example: PCE=5423  

CO  

No  

Country  

A string. For example: CO=US  

LT  

No  

Latitude 

(Double) For example: LT=37.2433  

LN  

No  

Longitude  

(Double) For example: LN=-122.3452  

N  

No  

Name  

A string. For example: N=Golden Gate Park 

Output Parameter

Table 8-32 describes the output parameter of the Biz Directory application.

Table 8-32 Output Parameter of the Biz Directory Application
Parameter Name  Mandatory  Description  Valid Value 

STATUS 

No 

The status of a mobile call. 

(OK)

CANCEL (Cancelled) 

8.4.2 Driving Directions

The Driving Directions application provides users with turn-by-turn driving directions between an originating address and a destination address.

This application requires aWireless routing provider (as described in Table 8-33).

Table 8-33 Required Software for the Driving Direcation Application
Name  External Provider(s)  Instructions  From  

Routing Provider 

otn.oracle.com 

See application providers. 

2.0  

8.4.2.1 Configuration Parameters

The Driving Directions application includes the following input parameters:

8.4.2.2 Linking to the Driving Directions Application

You link to the Driving Directions application through the following virtual URL:

omp://oracle/services/location/directions

Input Call Parameters

The Driving Directions application includes the following input call parameters, which are described in Table 8-34.

Table 8-34 Input Call Parameters of the Driving Directions Application
Parameter Name  Mandatory  Description  Valid Value 

OCOMPANYNAME 

No 

The company name of the starting location. 

A string. For example: OCOMPANYNAME=Oracle Corp.  

OADDRESS 

No  

The first line of the address for the starting location. 

A string. For example: OADDRESS=500 Oracle Parkway  

OADDRESS2 

No 

The second line for the address of the starting location.  

A string. For example: OADDRESS2=Redwood City, CA  

OADDRESSLL 

No  

The last line for the address of the starting location. 

A string. For example: OADDRESSLL=US  

OBLOCK  

No  

The block of the starting location.  

A string. For example: OBLOCK=Block 400  

OCITY  

No  

The city of the starting location.  

A string. For example: OCITY=Redwood City  

OCOUNTY  

No  

The county of the starting location.  

A string. For example: OCOUNTY=San Mateo  

OSTATE  

No  

The state of the starting location. 

A string. For example: OSTATE=CA  

OZIP  

No  

The postal code of the starting location. 

A string. For example: OZIP=94065  

OZIPEXT  

No  

The postal code extension of the starting location.  

A string. For example: OZIPEXT=5423  

OCOUNTRY  

No  

The country of the starting location.  

A string. For example: OCOUNTRY=US  

OLAT  

No 

The latitude of the starting location. 

(Double) For example: OLAT=37.2433  

OLNG  

No  

The longitude of the starting location  

(Double) For example: OLNG=-122.3452  

ONAME  

No  

The name of the starting location.  

A string. For example: ONAME=Golden Gate Park  

DCOMPANYNAME  

No  

The company name of the destination location  

A string. For example: DCOMPANYNAME=Oracle Corp.  

DADDRESS  

No  

The address first line of the destination location. 

A string. For example: DADDRESS=500 Oracle Parkway  

DADDRESS2  

No  

The address second line of the destination location.  

A string. For example: DADDRESS2=Redwood City, CA  

DADDRESSLL  

No  

The address last line of the destination location.  

A string. For example: DADDRESSLL=US  

DBLOCK  

No  

The block of the destination location. 

A string. For example: DBLOCK=Block 400  

DCITY  

No 

The city of the destination location. 

A string. For example: DCITY=Redwood City  

DCOUNTY  

No  

The county of the destination location 

A string. For example: DCOUNTY=San Mateo  

DSTATE  

No  

The state of the destination location.  

A string. For example: DSTATE=CA  

DZIP  

No  

The postal code of the destination location. 

A string. For example: DZIP=94065  

DZIPEXT  

No  

The postal code extension of the destination location.  

A string. For example: DZIPEXT=5423  

DCOUNTRY  

No  

The country of the destination location.  

A string. For example: DCOUNTRY=US  

DLAT 

No  

The latitude of the destination location. 

(Double) For example: DLAT=37.2433  

DLNG  

No  

The longitude of the destination location. 

(Double) For example: DLNG=-122.3452  

DNAME  

No 

The name of the destination location. 

A string. For example: DNAME=Golden Gate Park  

Output Parameters

The Driving Directions application includes the following output parameters (described in Table 8-35).

Table 8-35 Output Parameter of the Driving Directions Application
Parameter Name  Mandatory  Description  Valid Value 

STATUS 

No 

The status of a mobile call. 

(OK)

CANCEL (Cancelled) 

8.4.3 Location Picker

The Location Picker application enables users to pick and manage their frequently-accessed locations. Using this application, a user can specify a location that can be used by another application, such as the Driving Directions application. This location can be the user's default location, the current location (if mobile positioning is enabled), a Location Mark selected by the user, a recent location used by the user, or a new location to be entered by the user

The Location Picker application is used by other applications to acquire a location from the user. When used directly by the user, Location Picker provides management of the user's Location Marks and allows the user to set a preferred location, which is either the user's current location (when mobile positioning is available and enabled) or the user's default Location Marks.

The Driving Directions, Maps, and Biz Directory applications use the Location Picker to acquire a location (or locations) from the user if the user does not have a preferred location, or if the user wants to change the location used for those applications.

This application integrates with positioning servers when available and is built upon the Oracle Application Server Wireless Location Application Component API.

8.4.3.1 Configuring the Location Picker Application

This application requires aWireless geocoding provider only when the geocoding of addresses is needed and requires the Wireless mobile positioning provider only when the positioning feature is needed. The geocoding and mobile positioning are optional features. Table 8-36 describes the software requirements for the Location Picker application.

Table 8-36 Software Requirements for the Location Picker Application
Name  External Providers  From   Instructions 

Geocoding Provider 

otn.oracle.com 

2.0  

See application providers. 

Mobile Positioning Provider  

otn.oracle.com 

2.0 

See application providers. 

8.4.3.2 Configuring the Input Parameters of the Location Picker Application

The Location Picker application includes the following input parameters:

8.4.3.3 Linking to the Location Picker Application

You link to the Location Picker application using the following virtual URL:

omp://oracle/services/location/picker (Invocation Interface)

Input Parameters

The Location Picker application includes the following input call parameters:

Output Parameters

Table 8-37 describes the output parameters for the Location Picker application.

Table 8-37 Output Parameters of the Location Picker
Parameter Name  Mandatory?  Description  Valid Value 

CN 

No  

The company name 

A string. For example: CN=Oracle Corp. 

FL 

No 

The first line of the address. 

A string. For example: FL=500 Oracle Parkway  

SL 

No 

The second line of the address. 

A string. For example: SL=Redwood City, CA  

LL 

No 

The last line of the address. 

A string. For example: LL=US  

BL 

No 

The block. 

A string. For example: BL=Block 400  

CI 

No 

The city. 

A string. For example: CI=Redwood City  

CT 

No 

The county. 

A string. For example: CT=San Mateo  

ST 

No 

The state. 

A string. For example: ST=CA  

PC 

No 

A postal code. 

A string. For example: PC=94065 

PCE 

No 

A postal code extension. 

A string. For example: PCE=5423  

CO 

No 

the country. 

A string. For example: CO=US  

LT 

No 

latitude. 

Double. For example: LT=37.2433  

LN 

No 

longitude. 

Double. For example: LN=-122.3452  

No 

The name. 

A string. For example: N=Golden Gate Park  

LMN 

No 

The name of the Location Mark.  

A string. For example: LMN=Office  

STATUS 

No 

The status of the application call. 

(OK)

CANCEL (Cancelled) 

8.4.4 Maps

The Maps application provides broad and detailed maps for a given location, supports map tiling and image map transformation for different devices. This application integrates with the Driving Directions application and is built upon the Wireless Location Application Component API.

8.4.4.1 Configuring the Maps Input Parameters

This application requires aWireless mapping provider (as described in Table 8-38).

Table 8-38 Requirements for the Maps Application
Name  External Providers  Instructions  From  

Mapping Provider 

otn.oracle.com 

See the application providers. 

2.0  

8.4.4.2 Configuration Parameters

The Maps application includes the following input parameter:

8.4.4.3 Linking to the Maps Application

You link to the Maps application using the following virtual URL:

omp://oracle/services/location/maps

Input Call Parameters

Table 8-39 describes the input call parameters of the Maps application.

Table 8-39 Input Call Parameters of the Maps Application
Parameter Name  Mandatory  Description  Valid Value 

CN 

No 

The company name. 

A string. For example: CN=Oracle Corp. 

FL 

No 

The first line of the address. 

A string. For example: FL=500 Oracle Parkway  

SL 

No 

The second line of the address. 

A string. For example: SL=Redwood City, CA  

LL 

No 

The last line of the address. 

A string. For example: LL=US  

BL 

No 

The block. 

A string. For example: BL=Block 400  

CI 

No 

The city. 

A string. For example: CI=Redwood City  

CT 

No 

The county. 

A string. For example: CT=San Mateo  

ST 

No 

The state. 

A string. For example: ST=CA  

PC 

No 

The postal code. 

Postal Code A string. For example: PC=94065 

PCE 

No 

The postal code extension. 

A string. For example: PCE=5423  

CO 

No 

The country. 

A string. For example: CO=US  

LT 

No 

The latitude. 

Double. For example: LT=37.2433  

LN 

No 

The longitude. 

Double. For example: LN=-122.3452  

No 

The name. 

A string. For example: N=Golden Gate Park  

LMN 

No 

The name of the Location Mark. 

A string. For e xample: LMN=Office  

STATUS 

No 

The status of the application call. 

(OK) CANCEL (Cancelled) 

Output Parameter for the Maps Application

Table 8-40 describes the output parameter for the Maps application.

Table 8-40 Output Parameter of the Map Module
Parameter Name  Mandatory  Description  Valid Value 

STATUS 

No 

The status of a mobile call. 

(OK)

CANCEL (Cancelled) 

8.5 m-Commerce Applications

Oracle m-Commerce applications are a set of Wireless and Voice Applications that securely store user profiles, supply information authorized by users of third-party applications, and interface with on-line payment mechanisms to complete transactions. The m-Commerce applications also translate existing WML applications into Mobile-XML, and uses Form Filler to map forms, which spares users from entering information from a mobile device. The m-Commerce applications are automatically installed along with Oracle Application Server Wireless.

m-Commerce APIs

You can build an m-Commerce application using Wireless XML. To incorporate any m-Commerce component into an application, you can add URL links to the moduable application that comply with its APIs.

If you have already developed an m-Commerce application in WML, you can run it through the Translator Application by calling its API, and by providing the URL of the application. The URL adds links from your application to all of the m-Commerce modulable applications.

8.5.1 Form Filler

The Form Filler application is a self-teaching form filler, one that maintains mappings between application form fields and wallet elements. The Form Filler accepts a URL and a list of label and variable names as input parameters, and checks if there is a stored mapping from the given labels and variables to wallet fields. If there is no such mapping, then it enables users to create a new mapping into wallet fields. Once a mapping is retrieved or created, it calls the wallet, asking it for the given mapped information. Upon successful completion, the application returns a status of Success along with the wallet values corresponding to the label-variable name list. Otherwise, a status code of Failure will be returned

8.5.1.1 Configuring the Form Filler Application

While you can use the out-of-the-box configuration for Form Filler application, you can enhance the application's functionality by configuring the guessing heuristics and by approving or rejecting the mappings.

8.5.1.2 Configuring the Guessing Heuristics

If an existing mapping is not available, then Form Filler enables authorized users to select given fields from the m-Wallet to populate the values for a given input field in a wireless form.

When constructing a new mapping, the Form Filler uses name guessing heuristics to automatically suggest default values to the user. As a result, the mapping creation process is minimized, making it a user-approved mapping process.

Name-guessing can be accomplished in two ways: you can enter rules for explicit mapping suggestions, (such as mapping Credit Card number to CreditCard:Number) or you can implement a dynamic heuristic that determines the similarities between the values in an input field and those in the fields in the m-Wallet. For example, Deluxe user home address maps automatically to Profile:Address.

8.5.1.2.1 Configuring the Mappings as Input Parameters

The fixed mapping suggestions are placed as input parameters for the Form Filler application. The input parameter consists of the name ORACLE_SERVICES_COMMERCE_FORMFILLER_SUGGESTIONS_ and the suggested key to use. For example, for ORACLE_SERVICES_COMMERCE_FORMFILLER_SUGGESTIONS_Credit Card, Credit Card is the suggested key. The default value must contain a valid Wallet compartment and field name. (The administrator for the Form Filler knows the compartment and the field name.) For example:

The dynamic mapping suggestions are controlled by a class that implements the GuessingHeuristic interface. The factory method inside the FormFillerManager to retrieve the implementation of the guessing heuristic takes the class name from the Form Filler application parameters. The key of the property is ORACLE_SERVICES_COMMERCE_FORMFILLER_HEURISTIC.

8.5.1.3 Setting Up the Guessing Heuristics

The guessing heuristics uses keys that are defined in the parameters for Form Filler application. The parameter, ORACLE_SERVICES_COMMERCE_FORMFILLER_HEURISTIC, defines the property used by the GuessingHeuristic implementor of the Form Filler application. This value must be the fully qualified class name of the class implementing the GuessingHeuristic interface. This is an optional field, as the default dynamic heuristic provider is set to

oracle.panama.app.services.modules.formfiller.WalletGuessingHeuristic.

The following are input service parameters are examples of the configuration file:

8.5.1.4 Using the Form Filler Administration

The Form Filler Administration enables you to manage settings, manipulate stored mappings, and approve pending mappings.

To access the Form Filler Administration:

  1. Select the Content Manager. The Content Manger defaults to the Publish tab, displaying the folders and applications at root level. The Root Folders and Services screen appears.

  2. Select the Commerce folder.

  3. Select Form Filler.

  4. Click Edit. The Edit Application screen appears.

  5. From the left menu, click Configure Parameters. The Form Filler Administration appears and defaults to the Config tab (Figure 8-3).

The Config tab enables you to set the submission mode for the Form Filler mappings by selecting between the following options:

The Config tab also includes the Auto-Approve Mode. Selecting this option approves all submitted mappings immediately. (These mappings do not need approval as they become effective immediately.)

Figure 8-3 The Config Tab of the Form Filler Administration


Text description of int_ffcn.gif follows.
Text description of the illustration int_ffcn.gif

The Existing Mappings tab (Figure 8-4) enables you to search for, edit, and delete existing Form Filler mappings.

To retrieve a stored mapping, either search for the mapping by URL, or select Get All. The mapping appears in the pane in the Stored Maps section of the screen. To edit a mapping, click on the mapping. The mapping's form label, variable name (Varname) and matching wallet parameters appear in the right frame. You can then modify the mapping by using the drop-down lists to select different matching wallet parameters. Click Done after you have completed your changes. Clicking Delete removes the mapping.

Figure 8-4 The Existing Mappings Tab of the Form Filler Administration


Text description of int_ffem.gif follows.
Text description of the illustration int_ffem.gif

The Pending Mappings tab (Figure 8-5) enables you to search for, edit, delete, and approve any pending (unapproved) mappings.

You can retrieve a pending mapping either by searching by URL, or by user. To retrieve all the pending mappings, select Get All. The mappings appear in the pane in the Stored Maps section of the screen. To select a mapping, click on the mapping. The mapping's form label, variable name (Varname) and matching wallet parameters appear in the right frame. You can then approve the mapping or delete it.

Figure 8-5 The Pending Mappings Tab of the Form Filler Administration


Text description of int_ffpm.gif follows.
Text description of the illustration int_ffpm.gif


Note:

For performance reasons, (such as a database connection cache with a five-minute expiration period) it can take up to five minutes for changes made using the Form Filler Administration to be reflected in the system.  


8.5.1.5 Configuring the Input Parameters for the Form Filler Module

To configure the input parameters for this application:

The Form Filler application includes the following optional input parameters, which do not require configuration.

8.5.1.6 Linking to the Form Filler Application

You link to the Form Filler application using the following virtual URL:

omp://oracle/services/commerce/formfiller

Table 8-41 describes the input call parameters of the Form Filler application.

Table 8-41 Input Call Parameters of the Form Filler Application
Parameter Name  Mandatory?  Description  Valid Value  Triggers Output 

FORMFILLURL 

Yes 

The URL of the form to be filled. Restriction: URL encoded 

A string. For example: FORMFILLURL=http://www.formfillerdemo.com 

ReturnGroup 

FORMFILLPARAMS 

Yes 

The parameters inside the form. Restriction: It should be a comma-separated, ordered list of [%label%:%variable name%] pairs.Where %label% is the label used in the form that is used for the %variable name% variable. The parameters must be URL encoded 

A string. For example: FORMFILLPARAMS=First+Name:fname,Last+Name:lname,Credit+Card:CC_NUMBER,Email:EMAIL,Address:Address 

ReturnGroup  

APPLICATION 

No 

Specifies the application name to identify the request to the Form Filler (which in turn passes it to the m-Wallet). When it is not specified, the URL will be treated as the application name. This must be URL encoded. 

A string. For example: APPLICATION=Form Filler Demo 

ReturnGroup 

8.5.1.7 Output Parameters

The Form Filler's output parameters include the following:

ReturnGroup

This group includes the following parameters, which return the values for the Form Filler. Table 8-42 describes the parameters of the ReturnGroup.

Table 8-42 Parameters of the Return Group
Parameter   Mandatory  Description  Valid Values 

FORMFILLURL 

Yes 

The URL of the form to be filled. Restriction: URL encoded 

A string. For example: FORMFILLURL=http://www.formfillerdemo.com  

FORMFILLPARAMS 

Yes 

The parameters inside the form.

Restrictions:

  • The parameters must be URL encoded.

  • For successful retrievals, the parameters should be a comma-separated ordered list of [%label%:%variable name%:%value%] pairs. Where %label% is the label used in the form that is used for the %variable name% variable. %value% contains the result from the m-Wallet applicaiton.

  • For unsuccessful retrievals, the parameters return nothing.

 

A string. For example: FORMFILLPARAMS=First Name:fname:Bob,Last Name:lname:Smith,Credit Card:CC_NUMBER:123456789,Email:EMAIL:bob.smith@company.com,Address:Address:SomeWhereOnEarth Example: FORMFILLPARAMS=First Name:fname:,Last Name:lname:,Credit Card:CC_NUMBER:,Email:EMAIL:,Address:Address:  

SUCCESSCODE 

Yes 

The success code indicates whether there was a successful request of information from the m-Wallet for the given labels and variable names. 

The valid values are:

TRUE -- For successful data retrieval

FALSE --For Unsuccessful retrieval of data from user-issued cancellations or from the inability to retrieve dynamic mapping. For example:

  • SUCCESSCODE=TRUE

  • SUCCESSCODE=FALSE

 

8.5.1.8 Examples

To retrieve data from the Form Filler Demo application, configure the parameters as follows:

An example of the unsuccessful retrieval of data for the Form Filler Demo application is as follows:

8.5.2 Payment Application

The Payment Application, which integrates with Oracle iPayment, processes credit card and bank account transactions through wireless devices.

Payment processing enables integration with payment mechanisms, such as Oracle's CRM iPayment. As a result, credit card processing and bank account transactions are carried out through direct connections to financial networks. You can add other drivers that integrate payment solution providers per customer requests.

Through integration with Oracle CRM's iPayment component, which implements transaction settlement support for credit cards and bank accounts, transactions are processed directly through the platform rather than through a merchant-deployed processing infrastructure.

8.5.2.1 Configuring the Payment Application

You must correctly install and configure the Oracle iPayment before you use the Payment application. To do this, you must follow the instructions from Oracle Applications 11i to install Oracle iPayment.

Required Software

The Payment application requires the following software (as described in Table 8-43).

Table 8-43 Required Software for the Payment Application
Name  Instructions  From Versions 

Oracle iPayment 

Follow the instructions from Oracle Applications 11i to successfully install Oracle iPayment. 

Oracle Application 11i 

8.5.2.2 Configuration Parameters

8.5.2.3 Linking to the Payment Application

You link to the Payment application using the following virtual URL:

omp://oracle/services/commerce/payment

Table 8-44 describes the input call parameters of the Payment application.

Table 8-44 Input Call Parameters for the Payment Application
Parameter Name  Mandatory?  Description  Valid Value  Triggers Output 

AMOUNT 

Yes 

Amount value for this transaction. 

A valid float number. For example: 100.00 

TRXID 

MERCHANTID  

Yes  

A valid ID within Cybercash, Verisign or other valid Payment Partner, and a valid, registered user of Wireless. 

A valid Cybercash, CheckFree, or Verisign ID Restriction: the merchant should be a registered Wireless user. 

TRXID

 

MODE 

Yes 

The transaction mode, which can be ONLINE/OFFLINE for Credit Card transaction and OFFLINE only for Bank Account transactions. 

ONLINE - online transaction for Credit Cards OFFLINE - offline transaction for both Credit Card and Bank Accounts. Offlline transactions will be processed by a batch job in CRM IPayment 

TRXID  

TYPE 

Yes 

The transaction type. This could be an authorization-only, capture-only, or authorization-and-capture transaction. 

AUTH - Authorization only

CAPTURE - Capture previously authorized transactions

AUTH_CAPTURE -Authorize and Capture transaction at the same time 

TRXID 

INSTRTYPE 

Yes 

This parameter informs the Wallet Application of the types of instrument allowed by the merchant: credit cards only, bank accounts only, or both. 

CC - When the merchant accepts only Credit Card transactions.

BA - When the merchant accepts only Bank Accounts transactions.

CC,BA - When the merchant accepts both Credit Cards and Bank Accounts transactions 

TRXID 

DESCR 

No 

The description of this transaction (if the merchant wants to save a personalized message for the particular transaction.) If the transaction receives no information, then the Payment Application generates a default description. 

Any string with description information. Example: DESCR=Book Shop Transaction Example: DESCR=Mobile Transaction - the default message. 

TRXID 

CURRENCY 

No 

The currency for this transaction. The default currency is defined as a application input parameter - Default Currency - and this value is used as default. If the merchant wants to use a different currency, then provide it in this request parameter. 

The three-letter string currency codes per ISO 4217 (1995). For example: USD, EUR, BRL. 

TRXID 

APPLICATION 

No 

Name of the application calling the Payment Application. This name is stored in the user's transaction history. If this is not present, then the Payment Application stores the default value as '3rd Party App

Any string with the application name. For example: APPLICATION=Book Shop Application or APPLICATION=Mobile Transaction (This is the - default message) 

TRXID 

8.5.2.4 Output Parameters

The Payment application's output parameters include the following:

TRXID

This group includes the following parameters, which return the values for the Payment application. Table 8-45 describes the parameters of TRXID.

Table 8-45 Parameters of TRXID
Parameter  Mandatory  Description  Valid Values 

TRXID 

Yes 

The transaction ID for a successful transaction. If the transaction failed this return -1 

An integer representing the transaction ID. Example: TRXID=1234 for a successful transaction or TRXID=-1 for a failed transaction 

FAILCODE 

Yes, if TRXID=-1 

The fail code for this transaction. A transaction can be cancelled by the end-user or because of an error occurring during processing. 

1 - If an ERROR occurred

2 - If the end-user cancelled the transaction.  

FAILREASON 

Yes, if TRXID=-1 

The backend payment system (for example, Oracle CRM payment) which generates error messages which are useful for the end-user when an error occurs. For example, these messages can alert users to invalid, or declined credit cards.  

A string with the describing the reason for the failure. Example: FAILREASON=Invalid Credit Card  

8.5.2.5 Capturing Transactions

Merchants can use a URL whenever they want to capture previously authorized transactions. This URL can be used in both secure and non-secure modes. The difference between the two modes is the HTTP and HTTPS protocols.

Non-Secure Capture

The http URL for the non-secure capture of a previously authorized transaction is as follows:

http://myserver.com:9080/modules/commerce/payment/jsp/IPaymentProcess.jsp?

MERCHANTID=<merchantID>&
MERCHANTPW=<merchantPWD>&
TRXID=<transactionID>&
CURRENCY=<currency>&
AMOUNT=<amount> 

For a merchant called BookStore to capture transaction #1234 in the amount of US$100.00, you call the URL and then enter the parameters as follows:

http://myserver.com:9080/modules/commerce/payment/jsp/IPaymentProcess.jsp?

MERCHANTID=bookstore&MERCHANTPW=welcome&TRXID=1234&CURRENCY=USD&AMOUNT=100

Secure Capture

In order to use the secure mode for the capture URL, you must first ensure that there is HTTPS access to the server.

The HTTPS URL for the secure capture of a previously authorized transaction is as follows:

https://myserver.com:443/modules/commerce/payment/jsp/IPaymentProcess.jsp?

MERCHANTID=<merchantID>&
MERCHANTPW=<merchantPWD>&
TRXID=<transactionID>&
CURRENCY=<currency>&
AMOUNT=<amount> 


Note:

Merchants must have an Oracle Application Server Wireless account to use the capture URL. 


8.5.3 Wallet Application

The Wallet application enables users to manage their profile from mobile devices as well as participate in commerce transactions and track their activity.

The Wallet application securely stores user's payment instrument information, such as credit cards, bank accounts, and shipping addresses. Upon user approval, other m-Commerce applications can retrieve this information to process payments.

The Oracle Application Server Wireless administrator can configure the Credit Cards, Bank Accounts and Extended Information compartments at any time, even if they contain values that users have entered previously. The fixed compartments are profiles, shipping addresses and Internet accounts.

A wallet is divided into compartments that can hold one or more instruments. For example the Credit Cards compartment holds as many credit cards as a user sees fit to enter. The Extended Information compartment, however, holds only one information set.

8.5.3.1 Configuring the Wallet Application

The Wallet application provides a convenient single-click commerce payment mechanism. It is a server side, encrypted entity that contains payment instrument, identification and address information for registered users. It enables users to store all the information required to fill out commerce-related forms from any application. That information is used to complete transactions, and through APIs (built and maintained by authorized third-party application providers), can be made available to authorized partners and e-merchants. It processes requests (using proxies) for personal and payment instrument information issued through HTML or WML forms by third-parties, and presents them to users, who decide explicitly what information gets sent back to the third-party. The wallet stores this information securely for users, providing them with an easy, secure shopping experience, and freeing them from repeatedly entering information.

The information is encrypted in the Repository using a three-part key comprised of a combination of the following:

Each portion of the three-layer key can be changed independently, but each one is required to decrypt information stored in the wallet. This combination is never stored; only an encrypted alias, assigned to each entry during its creation or modification, is sent over the wireless network.

Because security is central to the Wallet application, you must configure HTTPs to access the Wireless server.

8.5.3.2 Configuration Parameters

The Wallet application includes the following configuration parameters:

Show Wallet Confirmation Page

Whenever a third-party application requests user information from the Wallet, the user must agree to share this information. This parameter is set regardless of whether this confirmation card is presented to user.

The valid values for this input parameter include:

Wallet Security Mode

Defines whether the Wallet application runs in HTTP or HTTPS. If true, the application runs in secure HTTPS. If false, then the wallet runs in non-secure HTTP.

The valid values for this input parameter include the following:

The default value is true.


Note:

The Wallet application can only function in secured mode (HTTPS) if Oracle Application Server Wireless is configured in secured mode. For more information on configuring Wireless in secured mode, see Section 3.6.1.1


Application Setup OMP URL

This is the OMP URL reference for the URL group. This parameter includes the following values:

8.5.3.3 Linking to the Wallet Application

You can link to the Wallet application using the following virtual URL:

omp://oracle/services/commerce/wallet

The wallet application includes the following input call parameters:

Wallet_Action

Wallet_Action is used to determine the type of overall action that service requests. Table 8-46 describes this mandatory parameter.

Table 8-46 Input Parameters for Wallet_Action
Valid Value  Description  Requirement 

GETSTRUCTURE 

Used to retrieve the Wallet structure definition. Triggers WALLET_STRUCTURE. 

GET_FORM_DATA 

Used when a third -party application wants to request information from the user's mobile wallet.Triggers generateUserResponse as output. 

getWalletInfoRequest

GET_INET_ACCT  

Used to add Internet account information in the user's wallet. 

createInternetAccountRequest

GEN_USER_PASS 

Used to automatically generate the username and password information. Triggers generateUserResponse as output. 

 

getWalletInfoRequest

Table 8-47 describes the parameters of this optional group.

Table 8-47 Parameters of the getWalletInfoRequest Group
Parameter Name  Mandatory  Description  Valid Value 

FORM_TITLE 

Yes 

This parameter is displayed as part of the Wallet application for the duration of the call. 

A string. For example:

FORM_TITLE=Movie Ticket Purchase. 

GET_DATA 

Yes 

A comma-separated string of tokens which specify which values to retrieve from the wallet. 

Valid values in this string are:

  • CC (triggers creditCardData as output)

  • BA (triggers bankAccountData as output)

  • FN (triggers FIRSTNAME as output)

  • LN (triggers LASTNAME as output)

  • EMAIL (triggers output EMAIL as output)

  • PHONE (triggers phoneData as output)

  • INT_ACC (triggers internetAccountData as output)

  • SHIP (triggers shippingData as output)

For example:

  • GET_DATA=FN,LN,SHIP

  • GET_DATA=CC, PHONE, INT_ACC

 

APPICATION 

No 

The application name displayed to the user and stored in the History file, so that the user always knows which applications are requesting the user's wallet information. 

A string. For example: APPLICATION=Bookshop Application. 

ISEXCLUSIVE 

No 

If set to True, then the user can chose either Credit Card or Bank Account. This parameter is used only by the Payment application. 

A boolean. 

DOMAIN 

Yes 

 

A string. For example: DOMAIN=http:/wwww.oraclemobile.com 

ACCOUNT_ID 

Yes 

 

A string. For example: ACCOUNT_ID=smurgle. 

PASSWORD 

Yes 

 

A string. For example: PASSWORD=237894. 

8.5.3.4 Output Parameters of the Wallet Application

Table 8-48 describes the output parameters of the Wallet application.

Table 8-48 Output Parameters for the Wallet Application
Parameter Name  Mandatory  Description  Valid Value 

WALLET_SELECT 

Yes 

Indicates that the operation completed correctly. If the user cancels the wallet operation, this variable contains False

Valid values are True and False. 

WALLET_STRUCTURE 

No 

This string specifies the wallet's internal structure. The wallet structure is based on fixed- and user- defined compartments. The fixed compartments include the User Profile, Internet Accounts, and Shipping Addresses. The user-defined compartments include Credit Card, Bank Account, and Extended Info.

Restriction: The return string is formatted as COMPARTMENT_NAME:FIELD_NAME90FIELD_DESCRIPTION

A string. For example: WALLET_STRUCTURE=If the wallet has compartments CC and BA for credit card and bank account respectively, then the return string can be CC:CCNUM()CreditCard Number, CC:CCEXP()Credit Card Expiration Date, BA:BNUM() Bank Account Number... 

FIRSTNAME 

No 

This variable holds its value of the user's first name when the calling application requests the user's name. This variable cannot be changed, as it is part of the fixed Profile compartment. 

A string. For example: FIRSTNAME=John 

LASTNAME  

No 

This variable holds the value of the user's last name when the calling application requests the user's last name. It cannot be changed as it is part of the fixed Profile compartment.  

A string. For example: LASTNAME=John  

EMAIL  

No 

This variable holds the value of the user's email address when the calling application requests the user's email. This cannot be changed, as it is part of the fixed Profile compartment.  

A string. For example: EMAIL=John.Doe@company.com 

CreditCardData

The Credit Cards structure held in wallet.properties. The fields are returned as request parameters. The following parameters, described in Table 8-49, are the default parameters of the CreditCardData group. CreditCardData is an optional group.

Table 8-49 Parameters of the CreditCardData Group
Parameter Name  Mandatory  Description  Valid Value 

CC 

Yes 

A short name for the credit card. 

A string. For example: CC=My Bank Visa Card.  

CC_HOLDER_NAME 

Yes 

The name of the holder of the credit card. 

A string. For example: CC_HOLDER_NAME=John Doe 

CC_HOLDER_ADDRESS_LANDMARK 

Yes 

The billing address of the holder of the credit card. This is a link to the user's Location Marks.

Restriction: this landmark must be defined in the location application. 

A string. For Example: CC_HOLDER_ADDRESS_LANDMARK=Office at Oracle  

CC_EXPIRATION_DATE 

Yes 

The expiration date of the credit card.

Restriction: this should be in the MM/YYYY form. This also must be defined in wallet.properties

A string. For example: CC_EXPIRATION_DATE=04/2003  

CC_LANDMARK_NAME 

Yes 

The Location Mark of the credit card.

Restriction: the parameters for the street address (such as CC_ADDRESS_LINE1)are built on-the-fly as Wallet Module 'knows' that Billing Address is a reference to a location mark. 

A string. For example: CC_LANDMARK_NAME=Office at Oracle

 

CC_ADDRESS_LINE1 

No 

 

A string. For example: CC_ADDRESS_LINE1=500 Oracle Pkwy

 

CC_ADDRESS_LINE2 

No 

 

A string. For example: CC_ADDRESS_LINE2=  

CC_CITY 

No 

 

A string. For example: CC_CITY=Redwood Shores 

CC_STATE 

No 

 

A string. For example:CC_STATE=CA  

CC_COUNTRY 

No 

 

A string. For example: CC_COUNTRY=USA 

CC_ZIPCODE 

No 

 

A string. For example: CC_ZIPCODE=94065 

bankAccountData

The Bank Account structure defined in wallet.properties. All of the fields are returned as request parameters.

Table 8-50 describes the parameters of this optional group.

Table 8-50 Parameters of the bankAccountData Group
Parameter Name  Mandatory  Description  Valid Value 

BA 

Yes 

The short name for the bank account 

A string. For example: BA=Checking ****-2438  

BA_HOLDER_NAME 

Yes 

The name of the holder of the bank account. 

A string. For example: BA_HOLDER_NAME=John Doe  

BA_HOLDER_ADDRESS_LANDMARK 

Yes 

Statement Address - this is a link to the user's Location Marks

Restriction: This landmark must be defined in the location application. 

A string. For example: BA_HOLDER_ADDRESS_LANDMARK=Palo Alto branch of Western Union  

BA_ACCT_NUMBER 

Yes 

The number of the bank account.

Restriction: this can only be numbers; all other characters are ignored. 

A string. For example: BA_ACCT_NUMBER=23894592  

BA_ACCT_TYPE 

Yes 

The type of account, such as checking or savings.  

Checking, Savings,Market-Rate. For example: BA_ACCT_TYPE=Checking  

BA_FI_ROUTING_NUMBER 

Yes 

The routing number of the bank.

Restriction: this must only be numbers; all other characters are ignored. 

A string. For example: BA_FI_ROUTING_NUMBER=23985002394  

BA_FI_NAME 

Yes 

The name of the bank. 

A string. For example: BA_FI_NAME=Bank of America 

BA_LANDMARK_NAME 

Yes 

The parameters for the bank's street address (such as BA_ADDRESS_LINE1) are built "on-the-fly", as the Wallet application knows that Billing Address is a reference to a Location Mark.

Restriction: This landmark must be defined in the location application. 

A string. For example: BA_LANDMARK_NAME=Palo Alto branch of Western Union  

BA_ADDRESS_LINE1 

No 

 

A string. For example: BA_ADDRESS_LINE1=2035 Island Parkway 

BA_ADDRESS_LINE2 

No 

 

A string. For example: BA_ADDRESS_LINE2=Apt. #P-24  

BA_CITY 

No 

 

A string. For example: BA_CITY=Menlo Park 

BA_STATE 

No 

 

A string. For example: BA_STATE=CA  

BA_COUNTRY 

No 

 

A string. For example: BA_COUNTRY=USA  

BA_ZIPCODE 

No 

 

A string. For example: BA_ZIPCODE=91750  

idData

The Extended Information structure defined in wallet.properties. All of the fields are returned as request parameters.

The idData group contains the following parameters, described in Table 8-51. This is an optional group:

Table 8-51 Parameters of the idData Group

Parameter Name  Mandatory  Description  Valid Value 

ID_SSN 

No 

The Social Security Number 

A string. For example: ID_SSN=298459825 

ID_DL 

No 

A driver's licence number 

A string. For example: ID_DL=B239922023  

ID_DL_STATE 

No 

The state in which the driver's license has been issued. 

A string. For example: ID_DL_STATE=CA  

ID_DL_EXP_DATE 

No 

The expiration date of the driver's license.

Restriction: The format (MM/DD/YYYY,) is defined in the wallet.properties

A string. For example: ID_DL_EXP_DATE=04/27/2007 

ID_PASSPORT 

No 

A passport number 

A string. For example: ID_PASSPORT=B293A923CK 

ID_PASSPORT_EXP_DATE 

No 

The expiration date of the passport.

Restriction: The format (MM/DD/YYYY) is defined in the wallet.properties

A string. For example: ID_PASSPORT_EXP_DATE=04/08/1997  

8.5.3.5 Extending the Wallet Structure

You can configure the structure of the Wallet so that its contents can be personalized according to usage.

The Wallet structure is defined in the wallet.properties file located under the following directory:

$ORACLE_HOME\wireless\j2ee\applications\modules

This file contains the definitions for credit cards, bank accounts and extended information. In addition, this file contains the definition of the formats used for each field. The format definitions are used for internationalization purposes of the dates.

Defining a Compartment

To define a compartment, When defining a compartment:

  1. Add a reference to this compartment in the compartments key:

    compartments=CREDIT_CARD,BANK_ACCOUNT,ID 
    
    
  2. Add the total number of fields in this new compartment:

    CREDIT_CARD.fieldnumber=6 
    

  1. Add all the fields for this compartment and add attributes for each field. You can add up to six attributes (0 - 5)

    The variable is built as follows:

    <comparment_name>.fieldNN.itemNN=<value>, where: 
    compartment_name = current compartment name, i.e. CREDIT_CARD 
    fieldNN = represents the current field, starting in 1, i.e. CREDIT_
    CARD.field1 
    itemNN = represents each attribute of this field, starting in 0, i.e. 
    CREDIT_CARD.field1.item0 
    
    

    The attributes are defined as follows:

    • The application reads variables from the request to retrieve a value for an specific field from the wallet. This variable name is defined in the attribute #0

      CREDIT_CARD.field1.item0=<request_variable_name, i.e. CC_HOLDER_NAME>

    • The label that appears to the end user is defined in the attribute #1. It is a key to a value defined in portal.properties (for internationalization purposes).

      CREDIT_CARD.field1.item1=<key.in.portal.properties, i.e. modules.commerce.wallet.creditcard.holdername

    • Each field can be either optional or mandatory, depending on the compartment rules. This is defined in attribute #2.

      CREDIT_CARD.field1.item2=<MANDATORY|OPTIONAL>

    • The format of this field (for display on WML and HDML WAP devices) is defined in attribute #3 and is a reference of a format previously defined in wallet.properties

      CREDIT_CARD.field1.item3=<format, i.e. MIXED_FORMAT, NUMBER_FORMAT, DATE_FORMAT>

    • If the field contains a list of possible values, such as credit card types, then they are listed in attribute #4. Use a comma (,) to separate these values.

      CREDIT_CARD.field1.item4=<comma-separated list of values, i.e. Visa, Master, AmEx, Discover, Diners>

    • Attribute #5 is used if the current field stores an address by having a reference to an existing location mark.

      CREDIT_CARD.field1.item5=<LINK_LOC>

8.5.4 Transcoder

The Transcoder application (also called WML translator) reformats WML documents and resources on the Web, making them available on any devices by translating the remote WML resource into Oracle Application Server Wireless XML. The Wireless XML is then transformed into the appropriate device-specific markup language.

8.5.4.1 Required Software

The Transcoder application does not require any third-party software.

8.5.4.2 Configuration Parameters

The Transcoder application includes the following configuration parameters.

The sample Navigation XML file is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<Navigation>
  <NavigationItems>
    <Item target="%value home.url%" 
      label="Home"
      showAs="Link" 
      preferredLocation="Header" />
    <Item target="%value service.parent.url%" 
      label_prefix="Back"
      showAs="Link" />
    <Item target="http://www.oraclemobile.com" 
      label="OracleMobile" 
      showAs="Button" 
      preferredLocation="Footer" />
  </NavigationItems>
</Navigation>

Each navigation item has the following six attributes, which are described in Table 8-52.

Table 8-52 Navigation Item Attributes
Attribute Name  Meaning  Mandatory   Accepted Values   Default Values 

target 

The location of the resource. 

Yes 

Either a fully-qualified URL, or a placeholder for mobile context, such as portal home, service home. 

N/A 

label 

The label displayed for the end user. 

No. This is an optional attribute. 

A string value.

 

N/A

 

label_prefix 

The prefix to the label. 

No. This is an optional attribute.  

This attribute is meaningful only for a mobile context, such as portal home.

 

 

label_suffix 

The suffix of the label. 

No. This is an optional attribute. 

This attribute is meaningful only for a mobile context, such as portal home.

 

 

showAs 

How to display the label. 

No. This is an optional attribute. 

A menu item, link, or button. 

A button  

preferredLocation 

Where to display the label. 

No. This is an optional attribute. 

A header, or footer. 

A header  

The schema for the navigation XML is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" 
  elementFormDefault="qualified" attributeFormDefault="unqualified">
  <xs:element name="Navigation">
    <xs:complexType>
      <xs:all>
        <xs:element ref="NavigationItems" minOccurs="0"/>
      </xs:all>
    </xs:complexType>
  </xs:element>
  <xs:element name="NavigationItems">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="Item" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="Item">
    <xs:complexType>
      <xs:attribute name="target" type="xs:string" use="required"/>
      <xs:attribute name="label" type="xs:string" use="optional"/>
      <xs:attribute name="label_prefix" type="xs:string" use="optional"/>
      <xs:attribute name="label_suffix" type="xs:string" use="optional"/>
      <xs:attribute name="showAs" type="xs:string" use="optional"/>
      <xs:attribute name="preferredLocation" type="xs:string" use="optional"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Show MyHome Link

While the Show MyHome Link parameter is supported, it is ignored when the Navigation XML file is valid.

The following three configuration parameters are deprecated:

8.5.4.3 Linking to the Transcoder Application

You can link to the Translator application using the following virtual URL:

omp://oracle/services/commerce/translator

The application can be invoked by passing the WML source URL in the request parameter, XLTORSITE. For example, to invoke www.oraclemobile.com, you can use the following URL in your Wireless XML

omp://oracle/services/commerce/translator?XLTORSITE=http%3A%2F%2Fwww.oraclemobile.com


Go to previous page Go to next page
Oracle
Copyright © 2003 Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index