Oracle9iAS Wireless Developer's Guide Release 2 (9.0.2) Part Number A90485-02 |
|
Each section of the chapter describes a module and its configuration. The sections of this chapter include:
Oracle9i 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.
Oracle9i Application Server customers can leverage the Personal Information Management Service modules into their own or third-party applications to add communication features to these services, to retrieve corporate directory information, or to add and manage appointments for users such as travel or dining reservations.
The email module enables users to access their email messages from any mobile device. Mobile Email integrates with any IMAP or POP3 server (including Microsoft Exchange and Lotus Domino servers).
All the necessary .jar files are shipped with Oracle9iAS Wireless. The are no scripts.
You can link to an email service using the following virtual URL:
omp://oracle/services/pim/mail
The input call parameters of the email module include the following:
The action the email module should perform. This is a mandatory input parameter.
Table 18-2 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. |
The email address to which the message is sent. This is an optional input parameter. The value must be a string. For example:
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:
To send an email to Scott Tiger, you configure the action and mailto parameters as follows:
To send the picture (a .jpeg)of your new home, you configure the action and attach parameters as follows:
The Mobile Directory module enables users to access LDAP directory servers from any mobile device. The directory module is integrated with the mobile email module, 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.
All of the required .jar files are included with Oracle9iAS Wireless. This module requires no scripts.
The Mobile directory includes the following configuration parameters:
Table 18-3 Configuration Parameters for the Mobile Directory
You can link to the directory module through the following virtual URL:
omp://oracle/services/pim/directory
You can configure each element of this service; clicking any field after getting the details of a result returns the field value to the caller as the parameter mailto
.
The output parameters for the mobile directory service include the following:
The value of the field that the user clicks. For example:
There are no restrictions for this parameter.
To return a first name, configure the mailto parameter as follows:
mailto=john
To return an email address, cofeature the mailto parameter as follows:
mailto=john.smith@mycompany.com
The Mobile 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 Mobile Email Module to allow users to compose a messages' 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.
This service implements two distinct modes, both with the same user experience but different back-ends. In its Oracle9iAS Wireless 2.0 mode, it does not require any third-party software and uses Oracle9iAS Wireless 2.0 storage. In its Microsoft Exchange Mode, it fully integrates with a Microsoft Exchange server to mobile enable Exchange users
The mobile address book requires the following third-party software:
Required Third-Party Software for the Mobile Address Book
The mobile address book includes the following parameters:
You can link to the mobile address book using the following virtual URL:
omp://oracle/services/pim/addressbook
The mobile address book includes the following call parameters:
Table 18-4 Input Call Parameters of the Mobile Address Book
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 done in the screen with a contact detail.
The SERIALIZED_CONTACT group includes the following parameters:
Table 18-5 Parameters of the Serialized Contact Group for Addressbook
The output parameters for the Addressbook include the following:
Table 18-6 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 is a phone number of a contact, returned with additional parameters used by the Short Messaging module (usually when the user clicks on a phone number in the Addressbook).
This group includes the following parameters:
Table 18-7 Parameters of smPhone
faxNumber is the fax number of a contact, returned with additional parameters used by the FAX or Short-Messaging modules (usually when the user clicks on a fax number in the Addressbook). The faxNumber group includes the following parameters:
Table 18-8 Parameters of faxnumber
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 done in the screen with a contact detail.
The parameters of the SERIALIZED CONTACT group are as follows:
Table 18-9 Parameters of the SERIALIZED_CONTACT Group
The calendar enables users to manage their schedule and tasks via mobile access to calendaring servers, such as Microsoft Exchange and Lotus Domino.
This service 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 mobile enable Domino users. In its Microsoft Exchange Mode, it fully integrates with a Microsoft Exchange server to mobile enable Exchange users.
The calendar module requires the following third-party software:
Table 18-10 Software Requirements for the Calendar Module
The Calendar module includes the following configuration parameters:
You can link to the calendar module using the following virtual URL:
omp://oracle/services/pim/calendar
The input call parameters of the calendar module include the getApptDetails
group. This optional group includes the following input call parameters:
Parameter Name | Mandatory | Description | Valid Value |
---|---|---|---|
ID |
Yes |
The input ID required to retrieve appointment details. |
A string. For example, ID=1324. |
Table 18-12 Parameters of addAppt
The Calendar module also includes the deleteAppt
group. The deleteAppt
group includes the following parameter:
Parameter Name | Mandatory | Description | Valid Value |
---|---|---|---|
ID |
Yes |
The input ID required to select an appointment. |
A string. For example, ID=1324. |
The calendar module includes the following output parameters:
The output parameters of the calendar module include the getApptDetailsRresponse group. This optional group contains the following parameters:
Table 18-14 The Output Parameters of the getApptDetailsResponse Group
The apptResponse group (an optional group) includes the following parameters:
Table 18-15 The Output Parameters of the addApptResponse Group
The deleteApptResponse group (an optional group) includes the following parameters:
Table 18-16 Parameters of the deleteApptResponse group
The instant messaging module provides presence management, enabling employees to exchange instant messages from their mobile devices. Integrated with Jabber Instant Messaging server and the MSN and Yahoo networks.
The instant messaging module, which uses the Jabberbeans classes to connect to a Jabber Instant Messaging Server, requires the following third-party software.
Table 18-17 Third-Party Software for the Instant Messaging Module
This module does not require scripts.
The instant messaging module includes the following configuration parameters:
You can link to the instant messaging module using the following virtual URL:
omp://oracle/services/pim/instantmessaging
The input call parameters of the instant messaging module includes the IMMessage parameter.
Table 18-19 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: |
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?
The short messaging module 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.
This service does not require any third-party software components. It relies on Oracle9iAS Wireless transports to be configured. The short messaging modules does not require scripts.
The short messaging service includes the following configuration parameters:
You can link to a short messaging module using the following virtual URL:
omp://oracle/services/pim/sm
The short messaging module includes the following input call parameters:
Table 18-20 Input Call Parameters of the Short Messaging Module
An example of the short message output parameters is sending a simple message. For example:
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
To send a voice message, configure the input parameters as follows:
type=Voice
destinationAddress=9095551234
The Oracle Internet File System (iFS) module enables users to both upload files to, or download files from, an Oracle IFS server. The iFs module is integrated with other modules, such as the email module and the fax module.
The Oracle iFS module enables users to both attach and save files in their native formats. The Oracle iFS module is also integrated with RightFax to enable document printing through faxes. Users can remotely select an attachment and send it by email to another mobile user, who can then view the document (Microsoft Office files) and print it to a nearby fax. This modules does not require scripts.
This iFS Module requires the Java development kit for Oracle Internet File System.
The iFS module includes the following configuration parameters:
You can link to the iFS Module using the following virtual URL:
omp://oracle/services/pim/ifs
The iFS module includes the following call parameters and parameter groups:
Table 18-22 The IFSAction Input Parameter
This optional group includes the following parameters:
Table 18-23 Parameters of the uploadIfsRequest Group
The Oracle iFS module includes the following output parameters:
This optional group specifies such information about the downloaded file as the size of the downloaded file, its location, and its original name.
The downloadIFsInfo group includes the following parameters:
Table 18-24 Parameters of the IFsInfo Group
To upload, files.doc, from the directory/private/joe/docs and save it as newfile.doc, you must configure the parameters as follows:
To download files.doc from the Oracle iFS 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
The fax module enables users to send a fax, check the status of a fax, forward or delete a fax from any wireless device. By combining email or iFS services, it also supports faxing documents through mobile devices.
This service requires third-party software components: it uses the RightFax Java API to connect to a RightFax server.
Table 18-25 Required Software for the Fax Module
This module does not require scripts.
Since the fax module uses customized cover sheet file, it is highly recommended that you 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:
On Windows NT installations, this cover page is located at:
To use the provided fax cover page:
The fax module includes the following configuration parameters:
You can link to the fax module using the following virtual URL:
omp://oracle/services/pim/fax
The fax module has one input call parameter, FAXTODO. This parameter describes the type of actions to be performed. This mandatory input parameter includes the following values:
Table 18-26 Values of the FAXTODO Input Parameter
Value | Requirement | Triggers Output |
---|---|---|
NEWFAX |
SendNewFax |
SendNewFaxResult. |
STATUS |
faxID |
CheckFaxStatusResult |
DELETE |
faxID |
deleteFaxResult |
FWD |
forwardFax |
forwardFaxResult |
The FAXTODO parameter includes sendNewFax group. This mandatory group of parameters specify the information about the fax to be sent.
Table 18-27 Parameters of the sendNewFax Group
The FAXTODO parameter includes the forwardFax group. This mandatory group includes the following parameters:
Table 18-28 Parameters of the forwardFax Group
The Fax module includes the following output parameters:
Table 18-29 Output Parameters of the Fax Module
To send a fax, you configure the FAXTODO parameters as follows:
FAXTODO = NEWFAX
RECIPIENT_FAX = 1(650)987-6543
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:
The tasks module enables users and applications to schedule and manage tasks. This module integrates with Lotus and Exchange servers.
This service 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 module requires the following third-party software:
Table 18-30 Software Required for the Tasks Module
This module does not require scripts.
The Task Module includes the following configuration parameters:
You can link to the task module using the following virtual URL:
omp://oracle/services/pim/tasks
|
Copyright © 2002 Oracle Corporation. All Rights Reserved. |
|