Skip Headers

Oracle9iAS Wireless Getting Started and System Guide
Release 2 (9.0.2)

Part Number A90486-02
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

10
Developing Services

This chapter describes how Content Developers use the Service Designer to create and manage objects of the Oracle9iAS Wireless repository. Each section of this document presents a different topic. These sections include:

10.1 Overview of the Service Designer

The Service Designer is a Web-based interface that enables Content Developers to create the following objects:

Master Services

Master services provide the actual implementation of the service. They specify the adapter used for the service and any service-specific parameters. By mapping an adapter to device transformers, master services link Wireless content sources to delivery platforms. Each master service is based on one adapter. A master service creates its own instance of the adapter it uses. Therefore, several services can use the same type of adapter, and each can pass its own service-specific argument values.

Content Managers create services based on master services and assign them to user groups.

Async Agent Services

The Service Designer enables you to augment master services by making them accessible by protocols other than HTTP. For example, you could assign an async agent service for services accessed by users whose devices do not have a Web browser, but support two-way messaging or email.

With async agent-enables services, users can access Web content. For example, async agent services enable end users who subscribe to OracleMobile to retrieve such Web content as stock quotes, traffic reports, or horoscopes by sending a message to Ask@OracleMobile.com. The Ask listener running on the iAS Wireless Server intercepts this message, which can be either an email or a short message, routes the request to the correct service or application, and then sends the requested information back to the user.

Master Alerts

A master alert is a template for an alert, a notification service delivered to users based on the trigger conditions they set when subscribing to an alert service. Master alerts designate the data feeders used for an alert service as well as the trigger parameter definition, trigger condition definition and optionally input parameter definition for an alert service. In addition, the master alert presents a simple result XML message template.

An alert service can deliver alert messages which are drawn from data feeds on a determined value, or at a scheduled time.

The default delivery mechanism of the alert message is through the transport module. The alert engine may provide hooks to invoke a customized message delivery mechanism to handle the alert delivery event.

Data Feeder

A data feeder is a repository object that retrieves content from both internal and external content sources and then converts that content into a standard XML format. The data feeder mechanism then publishes the content to the alert engine, which formats and sends alert messages that use the content that the data feeder retrieved and rendered from the content source.

Logical Devices

A logical device is a repository object that represents either a physical device, such as an Ericsson mobile phone, or an abstract device, such as an email server. Logical devices represent the interface between transformers and the target devices or applications

Preset Definitions

Presets enable users to personalize services by defining their own input parameters for an application. When a user requests a service, an adapter loads the user-defined input parameters, or presets. The service presents these presets as a list for the user, who must then select an item to execute the application. Wireless saves users presets on a table specific to each service.

Transformers

Transformers are Java programs or XSLT stylesheets that convert a document into either the target format or to another Wireless format. Transformers not only map source tags to target format tags, but they can also manipulate content. Because transformers can rearrange, filter, and add text, you can present content in the format, as well as the form factor that is best suited for the target device.

The Wireless initial repository includes transformers for several target formats, such as CHTML, HDML, HTML, MML, VoiceXML, VoxML, and WAP (WML). By modifying the provided transformers, or by creating new ones, you can target new device platforms and optimize content presentation for specific devices. Wireless publishes device transformation rule files so that anyone can create support for any type of device and markup language.

The transformer associated with a logical device is that device's default transformer. Default transformers are typically generalized for a markup format, but they can also be specific to a target device. Wireless uses the device's default transformer to convert any service targeted for that type of device, unless a custom device transformer overrides the default transformer. A custom device transformer enables you to control how a service appears on a specific device. While several devices can use a single default transformer, a custom transformer can be associated with only one master service and one device. The custom transformer optimizes the presentation of that service for a particular device and can only be used for that device.

When you create a transformer, you map the elements in the source content to the result format.

Adapters

An adapter is a Java application that retrieves data from an external source and renders it in Wireless XML. In the Oracle9iAS Wireless architecture, adapters constitute the interface between the Wireless server and the content source. When invoked by a master service, an adapter returns an XML object that contains the service content. This XML object is processed by the core of the Wireless and then delivered to the user's device as a the response to the user's service request.

Regions

Wireless uses regions to enable developers to assign a location to a service, making the service location-based, unique to a specified area.

10.2 Logging into the Service Designer

Before using the Service Designer, you must first log into the Webtool as follows:

  1. Access the login page through the following URL:

    http://hostname:7777/webtool/login.uix


Note:

7777 is the default port number for Oracle9iAS Wireless. The port number range is 7777 to 7877. To ensure that you are using the correct port number, check the port number for Oracle9iAS Wireless stored in [Oracle home]/install/portlist.ini. For more information on port usage, see Oracle9i Application Server Installation Guide and the Oracle9i Application Server Administrator's Guide


  1. Enter your user name and then enter your password. If you are an administrator, enter orcladmin as your user name. (The password is set during installation, but can be changed with the User Manager.)

After you successfully login, the Service screen of the Service Designer appears with the Service Designer Tab selected. The Service Designer Tab contains the following subtabs:

The Service Designer provides a tab for each of these repository objects. Each tab has a browsing screen, which enables you to search for an object, as well as access to functions for creating, editing and deleting, and testing objects.

Figure 10-1 The Browse Folder Screen of the Service Designer's Master Service Tab


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

10.3 Managing Master Services

Selecting the Master Services tab displays the Browse Folder screen, which enables you to create, edit, delete, debug, and move master services and folders. The screen also enables you to test master service and view it on a phone simulator.

The Browse Folder screen enables you to view the top-level folders in the hierarchy, which the Service Designer displays as hyperlinks. These hyperlinks allow you to "drill down" or traverse deeper into the hierarchy with each successive click. Wireless displays the structure of the hierarchy, enabling you to see level you currently access.

The Browse Folder screen displays Wireless objects as follows:

Table 10-1 Elements of the Browse Folder Screen of the Service Designer

Element  Description 

Type 

The type of objects  

Name 

The display name of the folder or service. The Service designer displays folders as hyperlinks, enabling you to "drill down" to view a folder's contents. 

Object ID 

The Object ID (OID) of the master service. 

Adapter 

The adapter used by the master service. 

Test 

Clicking the phone icon enables you to view the selected master service on a phone simulator.  

Valid 

If the column displays "Yes", the folder or service is enabled. If "No", then the folder or service is not enabled. 

Sequence  

The order in which services and folders appear on output devices. By default, these appear in order by sequence number, then name. 

Last Modified 

The last time the folder or service was modified. 

10.3.1 Searching for a Master Service

The Browse Folder screen of the Service Designer enables you to search for a master service using a search field in conjunction with drop-down lists of search options, which you can use to either narrow or broaden your searches. The search results display as a list on the Search Result screen.

To find an object, perform one or more of the following and then click Go.

  1. From the drop-down list, select one of the following options to narrow or broaden your search:

    • All Master Services

    • Async-Agent-Enabled Master Services

    • Modulable Master Services

    • Folders

  2. Enter a keyword.

  3. From the drop-down list, select one of the following sorting options for the search results:

    • Name. Select this option to sort results by the name of the master service or folder.

    • Last Modified Date. Select this option to sort results by the last time the object was modified.

  4. Click Go. The Search Result screen appears. The Search Result screen organizes objects as follows:

    Table 10-2 Elements of the Search Results Screen of the Service Designer

    Element  Description 

    Type 

    The type of object.  

    Name 

    The display name of the folder or service. The Service designer displays folders as hyperlinks, enabling you to "drill down" to view a folder's contents. 

    Object ID 

    The Object ID (OID) of the master service. 

    Full Path 

    The route to a repository object, with Master as the root. Each node on the route is displayed as a hyperlink. Clicking a hyperlink reveals a browse screen, showing the subfolders, services, and bookmarks organized under the folder. Using this browse screen, you can perform such functions as assigning objects to user groups, and creating and deleting services, bookmarks, and folders.  

    Adapter 

    The adapter used by the master service. 

    Test 

    Clicking the phone icon enables you to view the selected master service on a phone simulator.  

    Valid 

    If the column displays "Yes", then the folder or service is enabled. If "No", then the folder or service is not enabled. 

    Modulable 

    If "Yes", then the service can be deployed as a module; if "No", then the service cannot be deployed as a module. 

    Async-Agent Enabled 

    If the column displays "Yes", then the master service is accessed by protocols other than HTTP. 

    Last Modified Date 

    The last time the folder or service was modified. 

  5. To return to the Browse screen, click OK.

Figure 10-2 A Search Result Display


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

10.3.2 Creating a Folder

You can organize your repository objects by creating subfolders. These subfolders, which can represent topic areas, can be nested into other subfolders. When you create a subfolder, the Service Designer displays it as a hyperlink in the Browse screen. Clicking this hyperlink enables you to see the folder's contents.

To create a folder:

  1. From the Browse Folder screen, click the Add Sub-Folder button. The Create Folder Screen appears, displaying the following parameters:

    Table 10-3 Parameters of the Create Folder Screen

    Parameter  Value 

    Folder Name 

    The name of the folder. This is a required field. 

    Description 

    A description of the folder. 

    Valid 

    Selecting this option enables the folder. 

    Title Icon URI 

    The URI of an image used as the icon that appears on top of the screen when this folder becomes the current folder. You do not need to specify the format type in this URI, as Wireless selects the image format appropriate to the user's device. 

    Menu Icon URI 

    The URI of an image used as the icon that appears next to the folder in a menu listing. You do not need to specify the format type in this URI, as Wireless selects the image format appropriate to the user's device. 

    Title Audio URI 

    The URI of the audio file (for example, a .wav file) read aloud by voice-reader software when users access a folder. You do not need to specify the format type in this URI, as Wireless selects the audio file format appropriate to the user's device. 

    Menu Audio URI 

    The URI of the audio file (for example, a .wav file) read aloud by voice-reader software along with a folder in a menu listing. You do not need to specify the format type in this URI, as Wireless selects the audio file format appropriate to the user's device. 

  2. Complete the form as follows:

    1. Enter a name for the folder in the Name field. This is a required field.

    2. Enter a brief description of the folder in the Description field.

    3. Select the Valid check box to enable the folder.

    4. Enter the URI of an image used as the icon that appears on top of the screen when this folder becomes the current folder.

    5. Enter the URI of an image used as the icon that appears next to the folder in a menu listing.

    6. Enter the URI of the audio file read aloud by voice-reader software when users access a folder.

    7. Enter the URI of the audio file read aloud by voice-reader software along with the folder name in the menu listing.

  3. Click Create.

10.3.3 Creating a Master Service

The Service Designer enables you to create a master service using the Master Service Creation Wizard. This tool provides you with a separate screen for each step of the creation process.


Note:

You must follow the sequence to its end to create a master service; if you exit the wizard at any point by selecting Cancel, you lose all the values you have entered.  


10.3.3.1 Step 1: Entering the Basic Information for the Master Service.

From the Browse Folder Screen, click Create Master Service. The Basic Information screen of the Master Service Creation Wizard appears. You use this screen to enter the configuration properties for the master service. The Screen contains the following fields:

Table 10-4 Basic Configuration Parameters for the Master Service

Parameter  Value 

Name 

The name of the master service. 

Description 

An optional description of the master service. 

Adapter 

A drop-down list of available adapters. 

Valid 

Select the Valid check box to enable the master service. 

Moduable 

Clicking this check box creates a service that can be deployed as a module component within another service. A module can be reused across services and, in the case of services which require input from end users, provide a consistent user interface. 

Location-Dependent 

Select this check box to make the service specific to a designated region. Use this option to enable location-acquisition at runtime.  

Region Name 

If you select the Location-Dependent option, then you must select a region by clicking this button.  

Language 

A drop-down list of display languages.  

Title Icon URI 

The URI of an image used as the icon that appears on top of the screen when this service becomes the current service. You do not need to specify the format type in this URI, as Wireless selects the image format appropriate to the user's device. 

Menu Icon URI 

The URI of an image used as the icon that appears next to the service in a menu listing. You do not need to specify the format type in this URI, as Wireless selects the image format appropriate to the user's device. 

Title Audio URI 

The URI of the audio file (for example, a .wav file) read aloud by voice-reader software when users access a service. You do not need to specify the format type in this URI, as Wireless selects the audio file format appropriate to the user's device. 

Menu Audio URI 

The URI of the audio file (for example, a .wav file) read aloud by voice-reader software along with the service in a menu listing. You do not need to specify the format type in this URI, as Wireless selects the audio file format appropriate to the user's device. 

Title Icon URI 

The URI of an image used as the icon that appears on top of the screen when this service becomes the current service. You do not need to specify the format type in this URI, as Wireless selects the image format appropriate to the user's device. 

Sequence 

The integer value that you enter in this field lets you alter the order in which services and folders appear on output devices. By default, these appear in order by sequence number, then by name. You can enter values in the sequence fields to rearrange the order in which the services and folders appear.  

Enter the following in the Basic Information screen:

  1. Enter the name for the master service in the Name field. This is a required field.

  2. Enter a description for the service in the Description field.

  3. Select an adapter from the drop-down list. This is a required field.


Note:

The SQL adapter and the Web Integration adapter are deprecated in this release. See the Oracle9iAS Developer's Guide for more information on adapters. 


  1. Select the Support Module check box if you wish to create a service that can be deployed as a module within other services.

  2. Select the Location-Based check box to create a service with content specific to a location.

    1. Click the flashlight icon to browse a list of region IDs.

    2. Click the appropriate region ID.

  3. Enter the URI of an image used as the icon that appears next to a service when this service becomes the current service.

  4. Enter the URI of an image used as the icon that appears next to the service in a menu listing.

  5. Enter the URI of the audio file read aloud by voice-reader software when users select the service from a menu.

  6. Enter the URI of the audio file read aloud by voice-reader software along with the service in a menu listing.

  7. Enter a sequence number.

  8. Click Next. The Caching screen appears.

Figure 10-3 The Basic Info. Screen of the Master Service Creation Wizard


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

10.3.3.2 Step 2: Entering Caching Information

You select the Cacheable check box for a service with changing content. Selecting the Cacheable option saves the adapter invocation and transformation. If you create a caching master service, then you must specify the frequency at which the Wireless server notifies the cache when a Web page has changed by issuing an invalidation report. If you do not wish to create a services that can be cached, leave the Cacheable check box clear, and click Next.

To create a service that can be stored in cache:

  1. Select the Cacheable check box. The Invalidation Frequency section of the screen appears.

  2. In the Cardinal field, enter the frequency, as a number value, of the unit selected from the Unit drop-down list.

  3. Using the Unit drop-down list, select from among the following time units:

    • Second

    • Minute

    • Hour

    • Day

    • Week

    • Month

  4. Using the drop-down lists, select the day and time (if applicable) for the invalidation frequency.

  5. Click Next. The Init Parameters screen appears.

Figure 10-4 The Caching Information Screen of the Master Service Creation Wizard


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

10.3.3.3 Step 3: Entering the Init Parameters of the Master Service

The Init Parameters screen contains the init parameters for the adapter you chose in Step 2. Not all adapters have init parameters. Enter the values for the init parameters and click Next. If the selected adapter does not contain init adapters, click Next.


Note:

The SQL adapter and the Web Integration adapter are deprecated in this release. See Section 10.10 for more information on setting the parameters for the AppsFramework adapter, the Mobile Applications Framework adapter, the SQL Adapter and the Web Integration adapter. 


If you want to plug in a listener for such purposes as debugging, specify the listener class in the HttpAdapterInvokerListener field. These listener methods are called at the following times:


Note:

You must specify the classpath in the OC4J config/application .XML file or you must copy the .jar file to wirless/lib. 


10.3.3.4 Step 4: Selecting the Input Parameters for the Master Service

The Input Parameters Screen displays the input parameters for the adapter you selected in Step 1. The Master Service Creation Wizard queries the adapter definition to determine the parameters that appear in this screen. The input parameters for master services using the HTTP Adapter and the OC4J Adapter include the following:

Table 10-5 Input Parameters for the HTTP Adapter and the OC4J Adapter

Parameter  Value 

Name 

The name of the input parameter. The Wireless Service Creation Wizard sets the name of the input parameter by querying the adapter definition.  

Comment 

In the case of master services based on the Web Integration adapter, Wireless automatically populates this cell with the name of the WIDL service that uses the parameter.

For services based on other adapters, you can use this column to document the parameter. The comment is only used internally.  

Mandatory 

Select this check box if this parameter must have a value. Remove the selection for optional parameters.  

Default Value 

For most parameters, this value represents the default value for the parameter. If you specify a default value, Wireless does not prompt the user for a value. Default values can be overridden by a value specified by a service created by the Content Manager, if the parameter is visible to the user, by the user with Wireless Customization.

The PAsection parameter is used by the Web Integration adapter. For PAsection, this value is the name of the WIDL service that the Web service should use. You can select the names from a drop-down selection list. If you do not specify a value for PAsection, Wireless service includes all WIDL services in the WIDL interface.  

The Input Parameters screen enables you to select an input parameter as well as add and delete input parameters to the adapter implementation for this master service.

Selecting an Input Parameter

To select an input parameter for the master service, Click on the Select radio button next to the input parameter you want to use and then click Next.

Adding a New Input Parameter to the Adapter

To add a new parameter to the adapter you selected in Step 1:

  1. Click Add Another Row.

  2. In the blank row, enter a name for the input parameter in the Name field.

  3. Enter a description for the input parameter in the Comment field. This can be the same information as both the Name and Caption.

  4. Select the Mandatory check box if this input parameter requires a value.

  5. Enter, if needed, a default value for the parameter. If you do not enter a default value, then Wireless prompts the user for a value.

  6. Click Next.

See Section 10.10 for information on the parameters for the SQL Adapter and WebIntegration Adapter.

Deleting an Input Parameter

To delete an input parameter,

  1. select the parameter you want to remove from the adapter implementation of this master service.

  2. Click Delete.

  3. Click Next.

Figure 10-5 The Input Parameters Screen of the Master Service Creation Wizard


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

Setting the Input Parameters for the HTTP Adapter

The HTTP adapter retrieves remote content and delivers it as mobile XML.The input paramters for the HTTP adapter include:

Table 10-6 The Input Parameters for the HTTP Adapter

Parameter  Description 

URL 

The URL to the data source. If there is a query in the URL, then its characters and URL must be encoded properly. For example: "http://my.host.com:80/Hello.jsp?fn=First+Name&ln=Last+Name" This is a mandatory parameter. 

REPLACE_URL 

Whether the adapter should replace the relative URLs inside the result with absolute ones. You should set this parameter to "false" only if you are sure that there will be no relative URLs inside the result. The default value if "true". 

FORM_METHOD 

The HTTP method used by the adapter to get the content of the url. Supported methods are GET and POST. The default method is GET. 

INPUT_ENCODING 

Encoding scheme of the remote web server. Use IANA character set names (for example: ISO-8859-1, UTF-8). 

10.3.3.5 Step 5: Selecting the Output Parameters for the Master Service

The Output Parameters screen enables you to select the output parameters for the adapter selected in Step 1, or optionally add output adapters for that adapter. The Master Service Creation Wizard queries the adapter definition to determine the parameters that appear in this screen.


Note:

You do not need to define output parameters for master services using the HTTP adapter and the OC4J adapter. 


The output parameters have the following attributes:

Table 10-7 Output Parameters for Adapters

Parameter  Value 

Name 

The name of the output parameter. The Master Service Creation Wizard sets the name of the output parameter by querying the adapter definition.  

Caption 

The caption is the label that Wireless uses for the parameter when prompting for user input.  

Comment 

In the case of master services based on the Web Integration adapter, Wireless automatically populates this field with the name of the WIDL service that uses the parameter.

For services based on other adapters, you can use this column to document the parameter. The comment is only used internally.  

User Customizable 

Specifies whether the end user can set a value for this parameter. You can make most input parameters customizable by the user. 

To select an output parameter, use the radio buttons to select the appropriate output parameter and then click Apply. To delete an output parameter, select the output parameter and click the Delete button.

Adding a New Output Parameter to the Adapter

Perform the following to add a new output parameter to the adapter selected in Step 1:

  1. Enter a name for the output parameter in the Name field.

  2. Enter a description that can be used as a label for the output parameter in the Caption field.

  3. In the Comment field, enter a description for the output parameter that can be used internally. You can enter the same description for the Name, Caption, and Comment field.

  4. Select the User Customizable check box to enable the end user to edit the output parameter.

After you have finished adding or deleting the output parameters for the adapter, click Next. The Confirmation screen appears if Wireless has not found a PASection in the master service you have created. Review the values listed on the Confirmation screen. If they are correct, click the Finish button. You have completed creating a master service.

If your master service contains a PASection, the Create Result Transformer screen appears.

10.3.3.6 Step 6: Creating an Async Agent Service -- Optional

By assigning Async Agent to a master service, you create a master service that can be accessed by protocols other than HTTP.

To set the values for an Async Agent service:

  1. Select the Async Agent check box.

  2. In the Async Command Line Syntax field, enter the text that is returned when a user issues an application help command to the Async Server.

  3. Enter the delimiter parameters for the Async Agent service.


    Note:

    The space (" ") is the default delimiter. 


  4. Complete the Async Service Argument List section as follows:

    1. Click Add Another Row.

    2. In the Name field, enter a name for the argument.

    3. Enter a number to represent the sequence in which the argument appears on the command line.

    4. Enter a default value for the argument. Leaving this field blank creates a service that requests a value from the user.

  5. Click Next.

10.3.3.7 Step 7: Selecting the Result Transformer -- Optional

After you have set the output parameters for the adapter, Wireless checks if the input parameters include PASection, the value used by the WIDL adapter to identify the service that is the entry point in the chained service sequence. If the Master Service Creation Wizard finds a PASection input adapter, it invokes the Result Transformer screen.

The transformer screen enables you to select a transformer for the adapter or add a new one by importing the XSLT stylesheet from your local file system.


Note:

You can skip this step if you selected an adapter that returns Mobile XML. 


To select a transformer for the adapter you selected in Step 1, use the radio buttons and then click Apply. To delete a transformer from the adapter, select the transformer using the Select radio button and click Delete.

Importing an XSLT Style Sheet

  1. Click the tab that represents the PASection you wish to edit. Each panel contains a text editor for entering the XSLT style sheet. You can also import an XSLT style sheet by clicking the import button.

  2. Click Next after you have completed editing the XSLT style sheet. The Device Transformer Screen appears. Leave this screen blank if you do not wish to create a result transformer and click Next until you reach the Confirmation screen.

  3. If the values appear correct, click Finish to complete the creation of the master service.

Adding a New Result Transformer

To add a new result transformer:

  1. Enter a name for the transformer in the Name field.

  2. Click the Import button to retrieve the XSLT stye sheet from your local file system. The style sheet then appears in the Content window.

  3. Make any needed changes to the style sheet.

  4. Click Add.

  5. Click Finish to complete the creation of the master service.

You have created a master service. This master service is not visible to users until the Content Manager publishes a service based based upon it to user groups.

10.3.4 Editing a Master Service

The Edit button in the Browse Folder screen enables you to edit the basic configuration, init parameters, input parameters, output parameters, Async Agent functions, and result transformer of a master alert.

10.3.4.1 Editing the Basic Configuration Parameters of a Master Alert

To edit a the basic configuration parameters of a master service:

  1. From the Browse Folder screen, select the master service you wish to edit.

  2. Click the Edit button. The Edit Master Service screen appears and defaults to the Basic Info. screen. The Basic Info. screen is populated with the basic configuration values set for the selected master service.

  3. Edit the values as needed. See Section 10.3.3.1 for information on the parameters of the Basic Info. screen.

  4. Click Ok to save your changes. Clicking Cancel resets the values to their original state and returns you to the Browse Folders screen.

Figure 10-6 The Basic Info. Screen for Editing Master Services


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

10.3.4.2 Editing the Caching of a Master Service

To edit the caching information for a the selected master service:

  1. Select Caching from the left menu.

  2. The Edit Cache screen appears.

  3. Edit the values as needed. See Section 10.3.3.2 for information on entering caching information.

  4. Click OK to save your changes. Clicking Cancel resets the values to their original state and returns you to the Browse Folders screen.

Figure 10-7 The Edit Cache Screen


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

10.3.4.3 Editing the Init Parameters of a Master Service

To edit the init parameters of a master service:

  1. Select Init Parameters from the left menu. The Edit Init Parameters screen appears, displaying the values set for the init parameters of the selected service.

  2. Edit the values for the init parameters as needed. See Section 10.3.3.3 for more information on the parameters of the init parameters.

  3. Click OK to save your changes and select. Clicking Cancel resets the values to their original state and returns you to the Browse Folders screen.

10.3.4.4 Editing the Input Parameters of a Master Service

To edit the input parameters of a master service:

  1. From the Edit Master Service screen, select Input Parameters from the left menu. The Edit Input Parameters screen appears, displaying the values set for the input parameters of the selected service.

  2. Edit the values for the input parameters as needed. See Section 10.3.3.4 for more information on the input parameters.

  3. Click Ok to save your changes. Clicking Cancel resets the values to their original state and returns you to the Browse Folders screen.

10.3.4.5 Editing the Output Parameters of a Master Service

To edit the output parameters of a master service:

  1. From the Edit Master Service screen, select Output Parameters from the left menu.

  2. The Edit Output Parameters screen appears, displaying the values set for the output parameters of the adapter used by selected service.

  3. Edit the values for the output parameters as needed. See Section 10.3.3.5 for more information on the output parameters.

  4. Click OK to save your changes. Clicking Cancel resets all values to their original state and returns you to the Browse Folders screen.

10.3.4.6 Editing an Async Agent Service

To edit an Async Agent service:

  1. Select Ask Service from the menu in the Edit Master Service screen. The Edit Ask Service screen appears, displaying the values set for the parameters of the selected master service.

  2. Edit the values for the Async Agent parameters as needed. See Section 10.3.3.6 for more information on the Async Agent parameters.

  3. Click OK to save your changes. Clicking Cancel sets all the values you have entered back to their original state and returns you to the Browse Folders screen.

10.3.4.7 Editing the Result Transformer for a Master Service

To edit the result transformer:

  1. From the Edit Master Service screen, select Result Transformer from the left menu. The Edit Result Transformer screen appears, displaying the result transformer's XSLT style sheet for the adapter used by selected service.

  2. Edit the entries as needed. See Section 10.3.3.7 for more information on setting the values for the result transformer and importing a XSLT stylesheet.

  3. Click OK to save your changes. Clicking Cancel sets all the values to their original state and returns you to the Browse Folder screen.

10.3.5 Deleting a Master Service

To delete a master service:

  1. From the Browse Folders screen, select the master service you wish to delete.

  2. Click Delete.

10.3.6 Debugging Master Services

The Service Designer enables you to simultaneously view a master service on a phone simulator and in Wireless XML or device markup languages.

Transformers, in the form of XSLT stylesheets or Java classes, convert the content returned by Wireless adapters into the format best suited to a particular platform.

To test a service:

  1. From the Browse Folders and Services screen, select a master service.

  2. Click Debug. The Debug Service screen appears.

  3. Select from among the following output formats:

    • Adapter XML Result

      Selecting this result type enables you to see Wireless source content in the AdapterResult format, the intermediary format between the source and the target output device. Source content in the AdapterResult format must be converted into SimpleResult format before it can be delivered to a target device. If no text displays in the The Result panel, then no AdapterResult has been produced.

    • Wireless XML Result

      Selecting Wireless XML Result displays the source content in Wireless' SimpleResult format of the output that is returned by an adapter.

    • Device Result

      The DeviceTransformer drop-down menu lists the logical devices in the repository. Selecting a logical device enables you to see the final markup language for that device.

  4. Click Set Parameters.

  5. Click Run Service. The service appears on a phone simulator. The selected result appears in the Service Result window.

Setting the Display Length of the Logging File

The System Log section enables you to set the number of lines from the end of the server's system log file that you want to see.

To set the number of lines from the server: displays from the end of the system log.

  1. Enter the number of lines from the end of the system log that you want to review:

  2. Click Refresh Log. The specified number of lines from the end of the system log appear.

  3. Click Done.

10.3.7 Moving Folders and Master Services

The Service Designers Move function enables you to organize your master services and folders.

To move a master service:

  1. From the Browse screen, select the folder or master service you wish to move. Click Move. The Move screen appears.

  2. Select a new location for the folder or master service from the list in the Move screen.

  3. Click Move Here.

10.4 Managing Master Alerts

The Alerts tab of the Service Designer enables you to create, edit and delete master alerts. When you select the Alerts tab, the Browse Alerts screen appears, displaying a list of the current master alerts. The Browse screen organizes the master alerts as follows:

Table 10-8 Element of the Browse Master Alerts Screen

Element  Description 

Name 

The name of the master alert. 

Object ID 

The id of the alert in the database. 

Data Feeder 

The data feeder, or content source, used for the master alert. 

Time-Based Enabled 

Denotes an alert that displays at predetermined times. 

Figure 10-8 The Browse Master Alerts Screen


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

10.4.1 Creating a Master Alert

The Master Alert Creation Wizard steps you through the creation of a master alert. This wizard, invoked by clicking the Create Master Alert button in the Browse Master Alerts screen, provides a separate screen for each step of the process.

Once you have created a master alert, a user with the System role this master alert to an alert engine process. The master alert becomes active once the Sytstem manager starts the both alert engine process and the data feeder engine process.

10.4.1.1 Step 1: Entering the Basic Configuration Parameters for the Master Alert

You enter the basic configuration parameters for the master alert in the Basic Info. screen, the first in the master alert creation sequence.

Figure 10-9 The Basic Info Screen of the Master Alert Creation Wizard


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

The Basic Info. screen includes the following parameters:

Table 10-9 Basic Configuration Parameters for a Master Alert

Parameter  Value 

Name 

The name of the alert. This is a required parameter. 

Description 

A description of the alert. 

Data Feeder 

A drop-down list of available data feeders. 

Subscriber Filtering Hook 

A Java class name. This hook enables you to filter out some subscribers to the qualified alerts before these alerts are sent to the messaging server.  

Data Feeder 

A drop-down list of data feed sources. This is a required parameter. 

Time-Enabled 

Specifies whether this alert triggers at predetermined times. The frequency options are daily, week day, and weekend. The user profile provides the time zone information. 

To enter the basic configuration parameters for the master alert:

  1. Enter the name for the master alert in the Name field.

  2. Enter a short description for the master alert in the Description field.

  3. Using the drop-down list in the Data Feed field, select a data feed source for the master alert.

  4. Select the Time-Enabled check box to designate the master alert as displaying at a predetermined time.

  5. Click Next. The Trigger Conditions screen appears.

Figure 10-10 The Trigger Conditions Screen of the Master Alert Creation Wizard


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

10.4.1.2 Step 2: Setting the Trigger Conditions for the Master Alert

You use the Trigger Condition screen to enable end users to set the conditions that invoke an alert on end users' devices. For example, if you create an alert notifying users of a stock price, you can to set the alert conditions that allow an end user to request a notification when the stock has risen above, or fallen below, a certain price.

The Trigger Condition screen includes the following parameters:

Table 10-10 Trigger Conditions for Master Alerts

Parameter  Value 

Condition Name 

The name of the alert trigger for the master alert. The Trigger name must contain only alphanumeric characters and underscore and must be within 30 characters. In addition, the trigger name cannot start with a numeric character and cannot use SQL reserved words. End users seel this label when they subscribe to an alert service. 

Trigger Parameter 

The trigger parameter is an element in a data feeder that you define a trigger condition against. For example, if a data feeder for a stock alert service inlcudes an output parameter of stock price, you could select stock price as the trigger parameters for a condition name. For information on setting the output parameters of a data feeder, see Section 10.5.2.4

Condition Type 

The condition, in relation to the value set by the end user, which triggers the alert.  

Default Value 

The default value for the parameter. If you specify a default value, Wireless does not prompt the user for a value. Default values can be overridden by a value specified by a service created by the Content Manager or, if the parameter is visible to the user, by the user through Wireless Customization. 

Selecting a Trigger Condition

To select a trigger condition:

  1. From the list of trigger conditions, select the trigger condition.

  2. Edit the Condition Type, Trigger Parameter, or Default Value fields as needed.

  3. Click Apply.

Adding a New Trigger Condition

To add a new Trigger Condition

  1. Enter the name for the trigger condition in the Condition field.

  2. Enter text used for prompting input from end users in the Caption field.

  3. Select a trigger parameter from the drop-down list in the Trigger Parameter field.

  4. Select a Condition Type from the drop-down list in the Condition Type field. Condition types depend on the data type of the trigger parameter.

If the data type is a number, then the conditions include:

If the data type is text, then the condition types include:

  1. Enter a default value for the trigger condition in the Default Value field.

  2. Click Add.

  3. Click Next. The Message Template screen appears.

10.4.1.3 Step 3: Creating the Message Template for the Master Alert

The Message Template screen allows you to either import a message template or provide a hook.

The data feeder output values are the dynamic values in the SimpleText stylesheet. The following stylesheet represents these values as &price and &change.

<SimpleText> Stock Alert for [&sym;]: Price: &price; Change: &change;</SimpleText>

Figure 10-11 The Message Template Screen of the Master Alert Creation Wizard


Text description of cdv_tmal.gif follows.
Text description of the illustration cdv_tmal.gif
Importing a Message Template

To import a message template:

  1. Select the Message Template radio button.

  2. Click Import to retrieve a message template from your local file system.

  3. Click Next to complete the creation of the master alert.


Note:

Wireless will not commit any of the values you have entered until you have completed the entire wizard.  


Providing a Hook

To create a message template by providing a programming hook:

  1. Select Java Template Class Name.

  2. Enter the name of the hook.

  3. Click Next to complete the creation of the master alert.

10.4.2 Editing a Master Alert

The Edit button in the Browse Master Alerts screen enables you to edit the basic configuration parameters, trigger conditions, and message template for a master alert.

10.4.2.1 Editing the Basic Configuration Parameters of a Master Alert

To edit the basic configuration parameters of a master alert:

  1. From the Browse Master Alerts screen, select the master alert you wish to edit.

  2. Click Edit. The Basic Info. screen for editing a master alert appears, with its fields populated by the values set for the selected master alert.

  3. Edit the basic configuration values as needed. See Section 10.4.1.1 for more information on the basic configuration parameters of a master alert.

  4. Click OK to save your changes. Click Cancel to set the values back to their original state and return to the Browse Master Alerts screen.

Figure 10-12 The Basic Info. Screen for Editing a Master Alert


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

10.4.2.2 Editing the Trigger Conditions of a Master Alert

To edit the trigger conditions of a master alert:

  1. From the left menu, select Trigger Conditions. The Edit Trigger Conditions screen appears with its fields populated by the values set for the selected master alert.

  2. Edit the values as needed. See Section 10.4.1.2 for information on the parameters for the trigger conditions.

  3. Click OK to save your changes. Clicking Cancel sets all the values back to their original state and returns you to the Browse Folders screen.

10.4.2.3 Editing the Message Template of a Master Alert

To edit the message template of a master alert:

  1. From the left menu, select Message Template. The Edit Message Template screen appears with the XML template, or the Java class name set for the selected master alert.

  2. Perform any of the following operations:

    • Edit the XML template, or import a template.

    • Enter a Java template class name.

    See Section 10.4.1.3 for information on the message template for a master alert.

10.5 Managing Data Feeders

The Service Designer's Data Feeder tab enables you to create, edit, and delete data feeders, Wireless object that download data from an internal or external content source and converts that data into a common format for Wireless mobile alerts.

Figure 10-13 The Browse Data Feeders Screen


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

Clicking the Data Feeders tab displays the browse data feeders screen, which lists the current data feeders. The Browse Data Feeders screen displays the data feeders as follows:

Table 10-11 Elements of the Browse Data Feeders Screen

Element  Description 

Name 

The Name of the data feeder. 

Object ID 

The Object ID (OID) of the data feeder.  

Protocol Type 

The protocol used by the data feeder to access the content provider and retrieve data. 

Format Type 

The data format type for the retrieved content. Format include delimited text (such as comma-separated values), XML, and fixed-column text. 

Data Filter Hook 

The Java class name that implements the DataFeedFilterHook, which enables post-processing before storing the data. 

Download Hook 

A Java class name that implements the FeedDownloadHook.Implementing this Java interface implemented enables you to construct the download URL or POST page during download.  

10.5.1 Creating a Data Feeder

You create data feeders with the Data Feeder Creation Wizard. This wizard, invoked by clicking the Create Data Feeder button in the Browse Data Feeders screen, steps you through the creation of a data feeder by providing a separate screen for each phase of the process.

Once you create a data feeder, you can assign it to a master alert. A data feeder (and consequently the alert that derives its content using the data feeder) cannot become active until a user with the System role assigns it to a configured data feeder process and then starts the process.

10.5.1.1 Step 1: Entering the Basic Information for the Data Feeder

The Basic Info screen of the Data Feeder Creation Wizard enables you enter the basic properties for the data feeder.

Figure 10-14 The Basic Info. Screen of the Data Feeder Creation Wizard


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

The Basic Info. screen of the Data Feeder Creation Wizard includes the following parameters.

Table 10-12 Parameters of the Basic Info. Screen of the Data Feeder Creation Wizard

Parameter  Value 

The General Section of the Basic Info Screen includes the following parameters 

Name 

The Name of the content provider. This is a required parameter. 

Type 

Select Regular if you use the built-in data retrieval framework to pull the data. Select Pass-Through for a push application using a Java class to retrieve the data. If you select Pass-Through, you must specify a Java class. This is a required parameter. 

Protocol Type 

The protocol used by the data feeder to access the content provider and retrieve data. The drop-down menu includes the following options:

  • sql -- SQL Database. Runs a sql query against the specified data feed and reads the output.

  • app -- Local Application. Runs an application as a subprocess and then reads the .stdout file.

  • http -- HTTP. Construct the URL, performs the GET/POST on the remote Web site and authenticates if necessary

  • ftp -- FTP. Connects to the remote Web server, and then authenticates and downloads files. Requires a username and password.

  • file -- Local File. Reads from an arbitrary file in the file system.

 

Format Type 

The data format type for the retrieved content. The drop-down menu includes the following options:

  • delimited -- Parses delimited text. The default delimiter is the comma (,).

  • fixed -- Fixed Column Text. Parses text delimited by fixed column positions.

  • xml -- The preferred input format.

 

Data Filter Hook 

A Java class name. This option enables you to customize a data feeder for additional logic, such as splitting a single column from a provider into two columns or filtering out content data before feeding the data to the content cache table. 

Download Hook 

A Java class name. This option enables you to customize a data feeder by generating a new URL to download data. 

Null Value 

A string used to mark non-applicable data, such as N/A. Different providers use different strings.  

The Update Policy section includes the following parameters: 

Start Time 

The time to start downloading data. 

End Time 

The time to stop downloading data. 

Update Interval 

The interval (in seconds) between downloads. Set this value to 0 if you want only one download interval per day. 

Batch Size 

The batch size for the download. If you set the size to one, Wireless downloads one parameter at a time; if you set the size to ten, Wireless downloads ten parameters at one time.  

Update Days 

The days designated for updating data. 

Complete the Basic Info. screen as follows:

  1. Enter the Name of the data feeder

  2. Select from between the following types:

    • Regular (Select if you use the built in data retrieval framework.)

    • Pass-Through (Select if you use a push application to deliver data.) You must provide a Java class if you select this option.

  3. Using the drop-down list, select one of the following protocol types:

    • http -- HTTP. The data feeder constructs the URL, performs the GET/POST on the remote Web site and authenticates if necessary

    • file -- Local File. The data feeder reads a file in the file system.

    • ftp -- FTP. The data feeder connects to the remote Web server, and then authenticates and downloads files. Requires a username and password.

    • sql -- SQL Database. The data feeder runs a SQL query against the specified data feed and reads the output.

    • app -- Local Application. The data feeder runs an application as a subprocess and then reads the .stdout file

  4. From the drop-down list, select on of the following format types for the retrieved content:

    • delimited -- Parses delimited text. The default delimiter is the comma (,).

    • fixed -- Fixed Column Text. Parses text delimited by fixed column positions.

    • XML -- The preferred input format.

  5. Enter a data filter. For example, enter a Java class name.

  6. Enter a download hook. For example, enter a Java class name.

  7. Enter a null value to represent inapplicable data. For example, enter n/a or N/A.

  8. Using the drop-down menus, enter a start time for data update.

  9. Using the drop-down menus, enter an end time for the data update.

  10. Enter the number of seconds between downloads. Set this value to 0 If you want only one download interval per day.

  11. Enter the batch size for the download. If you set the size to one, Wireless downloads one parameter at for each HTTP request; if you set the size to ten, Wireless downloads ten parameters for each HTTP request.

  12. Select the day or days for the download.

  13. Click Next. The Init Parameters screen appears, displaying init parameters for the protocol type you selected.

10.5.1.2 Step 2: Entering the Init Parameters for the Data Feeder

The Init Parameters screen displays the init parameters specific to the protocol and format type you selected in Section 10.5.1.1.

Table 10-13 Init Parameters for Data Feeder Protocols

Parameters  Description 

The http protocol includes the following init parameters: 

HTTP URI 

The full path for the HTTP address of the content source. 

Username 

The user name. Enter this value if you retrieve data from a protected site. 

Password 

The password. Enter this value if you retrieve data from a protected site. 

HTTP Method 

Select either the GET or POST methods. 

The file protocol includes the following init parameters: 

File Path 

A file path, such as c:\temp\file.txt 

The FTP protocol includes the following init parameters:  

FTP URI 

The path for the FTP request. 

Username 

The user name 

Password 

The password. 

FTP Mode 

Select either the Text or Binary mode. 

The SQL protocol has the following init parameters: 

Connect String 

The database connect string. 

Query 

The SQL query. 

The File protocol has the following init parameters: 

File Path 

The file path of a content source. 

10.5.1.3 Entering the Init Parameters for the HTTP Protocol

To enter the init parameters for a data feeder using the HTTP protocol and the XML format type:

  1. Enter the HTTP URI of the content source.

  2. Enter a user name.

  3. Enter a password.

  4. Select either the GET or POST HTTP methods.

  5. If the feed ingests XML, then you must import an XSL stylesheet that converts the XML to standard feed XML format.

  6. Click Next. The Input Parameters screen appears.

To Enter Init Parameters for a data feeder using the HTTP Protocol and the delimited format:

  1. Enter the HTTP URI of the content source.

  2. Enter a user name.

  3. Enter a password.

  4. Enter the delimiter for the format type. For example, enter a comma (,).

  5. Enter a quote character for the format type you selected. For example, enter quotation marks (").

  6. Click Next. The Input Parameters screen appears.

To Enter the Init Parameters for a data feeder using the HTTP protocol and the fixed column format:

  1. Enter the HTTP URI of the content source.

  2. Enter a user name.

  3. Enter a password.

  4. Select either the GET or POST HTTP methods.

  5. Click Next. The Input Parameters screen appears.

10.5.1.4 Entering the Init Parameters for the File Protocol

To enter the init parameters for a data feeder using the file protocol and the XML format:

  1. Enter the file path. For example, enter c:\temp\file.txt.

  2. If the feed ingests XML, then you must import an XSL stylesheet that converts the XML to standard XML.

  3. Click Next. The Input Parameters screen appears.

To enter the init parameters for a data feeder using the file protocol with the delimited format:

  1. Enter the file path.

  2. Enter the delimiter for the format type. For example, enter a comma (,).

  3. Enter a quote character for the format type you selected. For example, enter quotation marks (").

  4. Click Next. The Input Parameters screen appears.

To enter the init parameters for a data feeder using the file protocol and the fixed column format:

  1. Enter the file path.

  2. Click Next. The Input Parameters screen appears.

10.5.1.5 Entering the Init Parameters for the FTP Protocol

To enter the init parameters for a data feeder using the FTP protocol and the XML format:

  1. Enter the FTP URI.

  2. Enter the username.

  3. Enter the password.

  4. Select either the Text or Binary FTP mode.

  5. If the feed ingests XML, then you must import an XSL stylesheet that converts the XML to standard XML.

  6. Click Next. The Input Parameters screen appears.

To enter the init parameters for a data feeder using the FTP protocol and the delimited format:

  1. Enter the FTP URI.

  2. Enter the username.

  3. Enter the password.

  4. Select either the Text or Binary mode.

  5. Enter the delimiter for the format type. For example, enter a comma (,).

  6. Enter a quote character for the format type you selected. For example, enter quotation marks (").

  7. Click Next. The Input Parameters screen appears.

To enter init parameters for a data feeder using the FTP protocol and the fixed column format:

  1. Enter the FTP URI.

  2. Enter the username.

  3. Enter the password.

  4. Select either the Text or Binary FTP mode.

  5. Click Next. The Input Parameters screen appears.

10.5.1.6 Entering the Init Parameters for the SQL Protocol

To enter the init parameters for a data feeder using the SQL protocol and the XML format:

  1. Enter the connect string.

  2. Enter a SQL query.

  3. If the feed ingests XML, then you must import an XSL stylesheet that converts the XML to standard XML.

  4. Click Next. The Input Parameters screen appears.

To enter the init parameters for a data feeder using the SQL protocol and the delimited format:

  1. Enter the connect string.

  2. Enter a query.

  3. Enter the delimiter for the format type. For example, enter a comma (,).

  4. Enter a quote character for the format type you selected. For example, enter quotation marks (").

  5. Click Next. The Input Parameters screen appears.

To enter the init parameters for a data feeder using the SQL protocol and the fixed column format:

  1. Enter the connect string.

  2. Enter a query.

  3. Click Next. The Input Parameters screen appears.

10.5.1.7 Entering the Init Parameters for the Application Protocol

To enter the init parameters for a data feeder using the application protocol and the XML format:

  1. Enter the command line.

  2. If the feed ingests XML, then you must import an XSL stylesheet that converts the XML to standard XML.

  3. Click Next. The Input Parameters screen appears.

To enter the init parameters for a data feeder using the application protocol and the delimited format:

  1. Enter the command line.

  2. Enter the delimiter for the format type. For example, enter a comma (,).

  3. Enter a quote character for the format type you selected. For example, enter quotation marks (").

  4. Click Next. The Input Parameters screen appears.

To enter init parameters for a data feeder using the application protocol with the fixed column format:

  1. Enter the command line.

  2. Click Next. The Input Parameters screen appears.

10.5.1.8 Step 3: Entering the Input Parameters for the Data Feeder

The Input Parameters enables you to enter the input parameters for the data feeder. The input parameters screen displays the input parameters specific to the format type you selected in Section 10.5.1.1.

The data feeder input parameters include the following:

Table 10-14 Data Feeder Input Parameters

Input Parameter  Description 

Internal Name 

The name used for this parameter internally for the column the caching table and also for setting conditions in the alert framework. 

Data Type 

A drop down list that includes the following:

  • Number: For numeric input.

  • TEXT_30: Text with a maximum of 30 characters.

  • TEXT_80: Text with a maximum of 80 characters.

  • TEXT_150: Text with a maximum of 150 characters.

  • TEXT_800: Text with a maximum of 800 characters.

  • TEXT_1200: Text with a maximum of 1200 characters.

 

External Name 

A mapping to the external provider. 

Column Number 

The column number for a delimited value. This input parameter is specific to the delimited format. 

Starting Position 

The starting column for a value. This input parameter is specific to the fixed-column parameter. 

Ending Position 

The ending column for a value. This input parameter is specific to the fixed-column parameter. 

Caption 

A caption seen by end-users when they subscribe to alerts. For example, Stock Symbol

Default Value 

The default value for the parameter.  

To enter the input parameters:

  1. Click Add Another Row. A row appears.

  2. Complete the row as follows:

    1. Enter the internal name.

    2. Enter the data type.

    3. Enter the external name.

    4. Enter the column number. This parameter is specific to the delimited format.

    5. Enter the starting position. This parameter is specific to the fixed-column format.

    6. Enter the ending position. This parameter is specific to the fixed-column format.

    7. Enter a caption.

    8. Enter a default value.

  3. Click Next. The Output Parameters screen appears.

10.5.1.9 Step 4: Entering the Output Parameters for the Data Feeder

The Output Parameters screen enables you to enter the output parameters for the data feeder. The output parameters screen displays parameters specific to the format type you selected in Section 10.5.1.1.

The output parameters are the retrieved data from the content provider; you set alerts on the output parameters of a data feeder.

The data feeder output parameters include the following:

Table 10-15 Data Feeder Output Parameters

Output Parameter  Description 

Internal Name 

The name used for this parameter internally for the column in the caching table and also for setting conditions in the alert framework. 

Data Type 

A drop down list that includes the following:

  • Number: For numeric input.

  • TEXT_30: Text with a maximum of 30 characters.

  • TEXT_80: Text with a maximum of 80 characters.

  • TEXT_150: Text with a maximum of 150 characters.

  • TEXT_800: Text with a maximum of 800 characters.

  • TEXT_1200: Text with a maximum of 1200 characters.

 

External Name 

A mapping to the external provider. 

Column Number 

The column number for a delimited value. This output parameter is specific to the delimited format. 

Starting Position 

The starting column for a value. This output parameter is specific to the fixed-column parameter. 

Ending Position 

The ending column for a value. This output parameter is specific to the fixed-column parameter. 

Caption 

The label that Wireless uses for the parameter. End users see this label when they subscribe to an alert service. 

To enter the input parameters:

  1. Click Add Another Row. A row appears.

  2. Complete the row as follows:

    1. Enter the internal name.

    2. Select the data type.

    3. Enter the external name.

    4. Enter the column number. This parameter is specific to the delimited format.

    5. Enter the starting position. This parameter is specific to the fixed-column format.

    6. Enter the ending position. This parameter is specific to the fixed-column format.

    7. Enter a caption.

  3. Click Finish to complete the data feeder. The Browse Data Feeder screen reappears, displaying the new data feeder.

10.5.2 Editing a Data Feeder

The Edit button in the Browse Data Feeder screen enables you to edit the basic configuration, init parameters, input parameters, and output parameters of a data feeder.

10.5.2.1 Editing the Basic Configuration of a Data Feeder

To edit the basic configuration of a data feeder:

  1. From the Browse Data Feeders screen, select the data feeder that you wish to edit.

  2. Click Edit.

  3. The screen for editing the basic configuration of the data feeder appears, with its fields populated by the values set for the selected data feeder.

  4. Edit the values as needed. See Section 10.5.1.1.for more information on the basic configuration parameters of a data feeder.

  5. Click OK to save your changes. Clicking Cancel resets the basic configuration values back to their original state and returns you to the Browse Data Feeders screen.

10.5.2.2 Editing the Init Parameters of a Data Feeder

To edit the init parameters of a data feeder:

  1. From the menu, select Init Parameters. The screen for editing init parameters appears, populated with the init parameters set for the selected data feeder.

  2. Edit the init parameters as needed. See Section 10.5.1.2 for more information on the init parameters of a data feeder.

  3. Click OK to save your changes. Clicking Cancel resets the values for the init parameters back to their original state and returns you to the Browse Data Feeders screen

10.5.2.3 Editing the Input Parameters of a Data Feeder

To edit the output parameters of a data feeder:

  1. From the menu, select Input Parameters. The screen for editing the input parameters appears, populated with the values set for the selected data feeder.

  2. Edit the values as needed. See Section 10.5.1.8 for more information on the input parameters of a data feeder.

  3. Click OK to save your changes. Clicking Cancel sets the input parameters to their original state and returns you to the Browse Data Feeders screen.

10.5.2.4 Editing the Output Parameters of a Data Feeder

To edit the output parameters of a data feeder:

  1. From the menu, select Output parameters. The screen for editing the output parameters appears, populated with the values set for the selected data feeder.

  2. Edit the values as needed. See Section 10.5.1.9 for more information on the output parameters of a data feeder.

  3. Click OK to save your changes. Clicking Cancel sets the output parameters back to their original state and returns you to the Browse Data Feeder screen.

10.6 Managing Logical Devices

A logical device is an object in the Wireless repository that represents either a physical device, such as a Nokia mobile phone, or an abstract device, such as email. Logical devices represent the interface between Wireless transformers and the target devices or applications.

Wireless determines the type of device that is requesting a service from the HTTP header. A device agent identifies the user's device address, such as an email address or telephone number and device type. This information enables Wireless to deliver notifications to the user.

You use the Logical Devices tab to create a logical device in the repository. When you click the Logical Device tab, the Browse Logical Devices screen appears, displaying a list of logical devices in the repository. Using the Browse Logical Device screen, you can search for, create, delete, and edit the user agents of a logical device.

Figure 10-15 The Browse Logical Devices Screen


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

10.6.1 Searching for a Logical Device

From the Browse screen, you can search for logical devices using the Keyword field. You can sort your search results by name, user agents, or transformers. .

To search for a logical device:

  1. Select, if needed, one of the following search result sorting options:

    • Name

    • Transformers

    • User Agents

  2. Enter the keyword for your search.

  3. Click Go. The Search Results screen appears. To return to the Browse screen, click OK.

Figure 10-16 The Search Results Screen (for Logical Devices)


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

10.6.2 Creating a Logical Device

You create a logical device using the logical device creation wizard. The logical device creation wizard guides you through each step of creating a logical device. When you complete a screen, you move to the next screen in the sequence by clicking the Next button. Clicking the Back button takes you to the preceding screen in the sequence, allowing you to perform edits.

10.6.2.1 Step 1: Entering the Basic Information for the Logical Device

  1. From the Browse Logical Devices screen, click Create Logical Device. The Basic Info. screen appears displaying the following parameters:

    Table 10-16 Parameters of the Logical Device Creation Wizard Basic Information Screen

    Parameter  Value 

    Name 

    The name of the logical device. 

    Description 

    An optional description of the logical device 

    Encoding 

    The logical device's content encoding, which is used to transport the result of the device type.  

    Preferred MIME Type 

    The MIME-type of the logical device. At runtime, if Wireless cannot detect a user agent HTTP header, the Wireless fails over to another device in the database that has the same MIME type. 

    Device Class 

    A Drop-down list of device types. The menu includes the following:

    • VOICE

    • MICRO_BROWSER

    • PDA_BROWSER

    • PC_BROWSER

    • MICRO_MESSENGER

    • MESSENGER

     

    Prolog 

    Specifies the format of the prolog required by the device. The prolog frequently includes processing instructions and meta tags. 

  2. Enter the name of the logical device into the Name field. This name must be unique. For example, enter Email.

  3. Enter, if needed, a desciption of the device.

  4. Enter the content encoding parameters for the logical device. For example, enter UTF-8.

  5. Enter the MIME type in the MIME field. For example, enter text/html.

  6. From the Device Class drop-down list, select the appropriate display size of the user's device.

  7. Enter the prolog required by the device.

  8. Click Next. The Transformers screen appears.

10.6.2.2 Step 2: Selecting the Appropriate Transformers

  1. From the Transformer screen, select transformers appropriate to the MIME type of the logical device from Eligible Transformers to Selected Transformers using the Move functions (>>or >>). Use the Remove functions (<< or <<) to remove the transformers you do not wish to use from Selected Transformers.

  2. Click Next.

10.6.2.3 Step 3: Adding User Agents

The User Agent screen enables you to assign a user agent to the logical device by selecting from a list of user agents, mechanisms that identify device type and address.

To add a user agent.

  1. Enter the user agent name. For example, enter WIG Browser/1.1*

  2. If needed, click Add Another Row to add another user agent.

  3. Click Next. The Device Attributes screen appears, displaying the following parameters:

Table 10-17 Parameters of the Device Attributes Screen

Parameter  Value 

Maximum Native Document Size 

The maximum number of bytes that can be sent to the device. This is a guideline for caption lengths. 

Display Properties 

Screen Width 

Use this option to describe the width of the screen of the physical device in points.  

Screen Height 

Use this option to describe the height of the screen of the physical device in points.  

Screen Columns 

The screen size in characters. Use this option if you want to break text into pages. 

Screen Rows 

The screen size in characters. Use this option if you want to break text into pages. 

Number of Softkeys 

Allows users to map a hot link to a phone soft key. 

Supports Cookie 

 

Color Capable 

Select this check box to create a device that supports color. 

Bits per Pixel 

The number of bits of color or grayscale information per pixel. 

Voice Capable 

Select this check box to create a device that supports voice. 

Image Capable 

Select this check box for a device that supports images. Use the Move functions (> or >>) to select the preferred image formats from Available Formats. Use the Remove functions (< or <<) to remove the image formats you do not wish to use from Preferred Formats. 

Video Capable 

Select this check box for a device that supports video. Use the Move functions (> or >>) to select the preferred video formats from Available Formats. Use the Remove functions (< or <<) to remove the video formats you do not wish to use from Preferred Formats. 

Streaming  

Select this radio button for real-time video. You can only select this option if you have selected Video Capable. 

Buffered 

This option essentially acts as a time-delay, storing bits of incoming video data before playing them. Using this option ensures a smooth presentation, one in which users see all frames. You can only select this option if you have selected Video Capable. 

10.6.2.4 Step 4: Setting the Device Attributes for the Logical Device

Complete the Device Attributes screen as follows:

  1. Enter the Maximum Native Document Size.

  2. Set the display properties as follows:

    1. Enter the points for the screen width.

    2. Enter the points for the screen height.

    3. Enter the number of screen columns.

    4. Enter the number of rows.

    5. Enter the number of softkeys that the end user can use to create short-cuts.

  3. Select the Color Capable check box if the device supports color.

  4. Enter the number of bits per pixel.

  5. Select the Voice Capable check box if the device supports audio.

  6. Select the Image Capable box if the device supports images.

  7. Use the Move functions (> or >>) to select the preferred image formats from Available Formats. Use the Remove functions (< or <<) to remove the image formats you do not wish to use from Preferred Formats.

  8. Select the Video Capable check box if the device supports video.

  9. Select this check box for a device that supports video. Use the Move functions (>or >>) to select the preferred video formats from Available Formats. Use the Remove functions (< or <<) to remove the video formats you do not wish to use from Preferred Formats.

  10. Select the Streaming option for real-time video. You can only select this option if you have selected Video Capable.

  11. Select the Buffered option for storing bits of incoming video data before playing them. Using this option ensures a smooth presentation, one in which users see all frames. You can only select this option if you have selected Video Capable.

  12. Click Next. The User Agents screen appears.

10.6.2.5 Step 5: Creating the Login Page

The Login Page screen enables you to create the XSLT stylesheet that generates the login page on the device.

  1. Provide a stylesheet using one of the following methods:

    1. Enter the XSLT stylesheet manually into the Login Page field.

    2. Copy the XSLT stylesheet from a text editor into the Login Page field.

    3. Import the XSLT stylesheet by clicking Import. In the Import screen, enter the name of the file in the Import File field and then click Import, or retrieve the file using the Browse function and the Upload window. After you select the file, Click Open. From the Import Screen, click Import.

  2. Click Next. The Error Page screen appears.

10.6.2.6 Step 6: Creating the Error Page

The Error Page screen enables you to create an XSLT stylesheet that generates the error page for the device.

  1. Provide a stylesheet using one of the following methods:

    1. Enter an XSLT stylesheet manually into the Login Page field.

    2. Copy an XSLT stylesheet from a text editor into the Login Page field.

    3. Import the XSLT stylesheet by clicking Import. In the Import screen, enter the name of the file in the Import File field and then click Import, or retrieve the file using the Browse function and the Upload window. After you select the file, Click Open. From the Import Screen, click Import.

  2. Click Finish to complete the logical device.

10.6.3 Modifying a Logical Device

The Wireless Service Designer enables you to modify a logical device in the repository. To modify a logical device:

  1. From the Browse Logical Device screen, select the logical device you wish to edit.

  2. Click Edit. The Edit Logical Device screen appears. From the left menu, select the component of the logical device you wish to edit. For information on setting the values for the basic information of a logical device, see Section 10.6.2.1. See Section 10.6.2.2 for information on selecting transformers. See Section 10.6.2.4 for setting the device attributes. See Section 10.6.2.3 for selecting or adding user agents. For information on creating a login page, see Section 10.6.2.5. See Section 10.6.2.6 for information on creating the error page.

  3. Click OK to commit your changes.

10.6.4 Deleting a Logical Device

To delete a logical device from the repository:

  1. From the Browse Logical Device screen, select the logical device.

  2. Click Delete.

10.7 Managing Preset Definitions

Preset definitions enable users to personalize services by entering their own input parameters to an application. When a user requests a service, a service loads the user-defined input parameters, (or presets). Typically, the service may list these presets for the user, who must select an item to execute the application.

.


Note:

Preset definitions are accessible to all users in a user group.  


Figure 10-17 The Browse Preset Definitions Screen


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

When selected, the Preset Definitions tab defaults to the Browse Preset Definitions Screen, which displays a list of the current preset definitions. From this screen, you can create, edit, and delete a preset definition.

The Browse Preset Definitions screen includes the following parameters.

Table 10-18 Parameters of the Browse Preset Definitions Screen

Parameter  Description 

Preset Definition Name 

The name of the Preset Definition. 

Object ID 

The Object ID stored in the database. 

10.7.1 Creating a Preset Definition

The Service Designer enables you to create a preset definition, a template which enables users to add values to each pre-defined preset definition. When users invoke a service, they select a value from any of the preset definitions as an input parameter.

To create a new preset definition:

  1. From the Browse Preset Definitions screen, click Create Preset Definition. The Create Preset Definition screen appears.

  2. In the General section of the Create Preset Screen, enter a name for the preset definition in the Preset Definition Name field. This is a required field.


Note:

The Preset Definition Name must be unique. 


  1. Click Finish. The Browse Preset Definitions screen reappears, displaying the new preset definition.

10.7.1.1 Adding Preset Attributes

Preset attributes enable you to define the relation of input parameters that an end user can enter and save on the Wireless server.

To add Preset Attributes to your preset definition:

  1. In the Preset Attributes section of the Create Preset Definition screen, click Add Another Row. A blank row appears which includes the following parameters.

    Table 10-19 Preset Description Parameters

    Parameters  Value 

    Attribute Name 

    A Name for the preset attribute.  

    Description 

    An optional description of the preset attribute.  

    Value Format 

    For text, enter anything that meets the regular expression org.apache.regexp.RE. For example, enter [:digit:] for numeric values.

    For numbers, enter anything that meets the formats for java.text.DecimalFormat. For example, enter #,##0.0 for currency. 

    Column Type 

    A drop down list that includes the following:

    • Number: For numeric input.

    • TEXT_30: Text with a maximum of 30 characters.

    • TEXT_80: Text with a maximum of 80 characters.

    • TEXT_150: Text with a maximum of 150 characters.

    • TEXT_250: Text with a maximum of 250 characters.

    • TEXT_500: Text with a maximum of 500 characters.

    • TEXT_800: Text with a maximum of 800 characters.

    • TEXT_1200: Text with a maximum of 1200 characters.

     

    Input Field Type 

    Select from among the following preset types:

    • Single Line -- Select for a single line entry, such as name.

    • Multiline -- Select for a multiple line entry, such as a street address.

    • Enum -- Select to assign conditions for an entry, such as show and hide.

     

  2. Enter the name of the preset attribute.

  3. Enter the value format.

  4. Select a column type.

  5. Select from among the following entry types:

    • SingleLine

    • MultiLine

    • Enum -- If you select this option, use must define the enumeration conditions. See Section 10.7.2.1. for information on enumeration options.

  6. Click Finish. Clicking Cancel clears all values and returns you to the Browse Preset Definitions screen.

You can add several rows of preset attributes to define relationships, such as Name, Street Address, Phone Number.

Figure 10-18 The Create Preset Definition Screen


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

10.7.2 Editing a Preset Definition

To edit a preset definition:

  1. From the Browse Screen, select the preset definition that you wish to edit. Click Edit. The Edit Preset Definition screen appears.

  2. Edit the preset definition as needed. See Section 10.7.1.1 for information on Preset Descriptors.

  3. Click OK to commit your changes. The Browse Preset Definitions screen reappears.

10.7.2.1 Adding, Editing, and Deleting Preset Attribute Enumeration Options

You can edit, add, or delete a preset attribute enumeration option by using the Edit Preset Descriptor Enumeration Options screen.

To edit a preset descriptor enumeration option:

  1. In the Preset Descriptors section of either the Create Preset Definitions screen or the Edit Preset Definitions screen, select Enum.

  2. Click Edit. The Edit Preset Descriptor Enumeration Options screen appears.

  3. In the Description Enumeration Options screen, perform the following operations as needed:

    • From the drop-down list, select the option you wish to edit or delete.

    • Click add to add a new enumeration option.

  4. Click Done. The Create Preset Definition screen or the Edit Preset Definition screen reappears.

10.7.3 Deleting a Preset Definition

To delete a preset definition:

  1. From the Browse Preset Definitions screen, select the preset definition you wish to delete.

  2. Click Delete.

10.8 Managing Transformers

You use the Browse Transformer screen of the Transformer tab to create, edit, and delete transformers in the repository.

Figure 10-19 The Browse Transformers Screen (Partial View)


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

10.8.1 Creating a New Transformer

To create a new transformer:

  1. From the Browse Transformer page, click Create Transformer. The Create Transformer screen appears and displays the following parameters:

    Table 10-20 Transformer Parameters

    Parameter  Value 

    Name 

    The transformer name. This must be a unique name. 

    MIME Type 

    The MIME type that the transformer supports. 

    SimpleResult DTD Version 

    The SimpleResult DTD version such as 1.0.0 (the default version). 

    Java Transformer 

    Specifies a Java class transformer implementation.  

    Class Name 

    The name of the class that implements the transformer.  

    XSL Transformer 

    Specifies an XSLT stylesheet transformer implementation.  

    XSL Stylesheet 

    The actual XSLT stylesheet that implements the transformer. You can cut and paste a transformer from another editing environment into this field.  

    Java Transformer 

    Specifies a Java class transformer implementation.  

    Java Class  

    The name of the class that implements the transformer.  

  2. Enter the name of the transformer in the Name field.

  3. Select the MIME type that you want to use.

  4. If you select an XSL transformer, you can do one of the following:

    1. Type the code for the XSL stylesheet in the field next to the Stylesheet parameter, then click Finish.

    2. Using a text editor, open an existing XSL stylesheet, copy and past the lines that you want to use and then click Finish.

    3. Click the Import button to import an existing XSL stylesheet. The Import Transformer XSL Stylesheet appears.

      Click Browse to find the XSL file that you want to use. Import the file by clicking Import. In the Import screen, enter the name of the file in the Import File field and then click Import, or retrieve the file using the Browse function and the Upload window. After you select the file, Click Open. From the Import Screen, click Import.

  5. If you select Java Transformer, then enter the class name of the transformer, then click Finish.

Figure 10-20 The Create Transformer Screen


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

10.8.2 Editing a Transformer

To edit a transformer:

  1. From the Browse Transformer screen, select the transformer you wish to edit.

  2. Click Edit. The Edit Transformer Screen appears, displaying the values set for the selected Transformer. The Edit Transformer screen includes the following parameters:

  3. Edit the parameters as needed. See Section 10.8.1 for information on entering values and preparing style sheets.

  4. Click Done to commit your changes.

10.8.3 Deleting a Transformer

To delete a transformer:

  1. From the Browse Transformer screen, select the transformer you wish to delete.

  2. Click Delete.

10.9 Managing Adapters

Selecting the Adapters tab invokes the Browse Adapters screen. You use this screen to create, edit, delete adapters.

Figure 10-21 Partial View of the Browse Adapters Screen


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

10.9.1 Creating an Adapter

To create an adapter:

  1. From the Browse Adapters screen, click Create Adapter. The Create Adapter screen appears displaying the following parameters:

    Table 10-21 Adapter Parameters

    Parameter  Value 

    Name 

    The name of the adapter. The name should be unique.  

    Object ID 

    The OID of the adapter in the repository. 

    Valid 

    Specifies whether the adapter is available to services. If selected, the adapter is available to services. If an adapter is invalid, the adapter is unavailable, and all master services that use the adapter are invalid.  

    Java Class  

    The Java class that either implements the adapter or serves as the entry point for the classes that implement the adapter.  

  2. Enter a unique name for the adapter in the Name field.

  3. Select the Valid check box to make the adapter available to services. Leaving the Valid check box clear makes the adapter unavailable and renders all services using it invalid.

  4. Enter the name of the Java class, or click Import to browse and retrieve the archived class or classes that implement the adapter.

  5. Click Create. The Browse Adapters screen reappears, displaying the new adapter. Clicking Cancel clears any values entered and returns you to the Browse Adapters screen.

10.9.2 Editing an Adapter

To edit an adapter:

  1. From the Browse Adapters screen, select the adapter you wish to edit.

  2. Click Edit. The Edit Adapters screen appears, displaying the values for the selected adapter.

    1. Edit the values for the selected adapter as needed. See Section 10.9.1 for information on the adapter parameters.

    2. Click Done to Commit your changes. The Browse Adapters screen reappears. Clicking Cancel clears any values entered and returns you to the Browse Adapters screen.

10.9.3 Deleting an Adapter

To delete an adapter:

  1. From the Browse Adapters screen, select the adapter you want to delete.

  2. Click Delete.

10.10 Setting Adapter Parameters

The following sections describe the uses and parameters of the Wireless adapters.

10.10.1 Setting Init Parameters for Adapters

The Init Parameters screen of the Master Service Creation Wizard shows the initialization parameters for the selected adapter. These parameters vary depending on the adapter implementation. When Wireless first invokes the adapter, it passes the values you set in the Init Parameters screen to the adapter.

10.10.1.1 Setting Init Parameters for the SQL Adapter

The SQL adapter retrieves and adapts content from any JDBC-enabled data source for a master service based on the SQL adapter, the Init Parameters panel includes the following parameters:

Table 10-22 Init Parameters for the SQL Adapter

Parameter  Description 

JDBC Connect String 

The JDBC connect string for the database on which to query, as follows:

jdbc:oracle:thin:@host_name:port:SID

Note: Insert all colons (for example, thin:@host). 

JDBC Driver 

Java DriverClass name (for example, Oracle thin driver, Oracle.jdbc.driver.oracle.driver

User Name 

The name of the database user. 

Password 

The password of the database user 

Type of Statement 

The type of SQL statement used by the master service. Allowable values:

QUERY: for a select statement. This type of statement returns a Simple Result document. You can use output filtering with QUERY statements. For information on filtering output, see the Oracle9iAS Developer's Guide.

PLSQL: to use a PL/SQL procedure. This type of statement returns results to a database buffer.

CALL: to run a stored procedure (SQL92 syntax only). This returns either a Simple Result or an Adapter Result element.  

The Statement 

The actual SQL statement that invokes the query, PL/SQL procedure, or stored procedure.

Note: The SQL statement should be entered without a semicolon.

You can use input variables in the SQL statement. You must indicate a variable in the statement by prefixing the variable with a colon. For example, you can specify an input variable in a PL/SQL statement as follows:

begin mypackage.foo(:expr); end;

Where :expr is the name of the variable. You must define the parameter manually in the input panel.  

Minimum DB Connection Pool Size 

The minimum number of database connections. 

Maximum DB Connection Pool Size 

The maximum number of database connections. 

Increment Size for the Connection Pool 

The increment by which the database connection pool increases.  

Idle Timeout (In Minutes) 

The time (in minutes) of inactivity that Wireless allows before automatically logging the user off the system. 

10.10.1.2 Setting Init Parameters for the Web Integration Adapter

The Web Integration adapter retrieves and adapts Web content. The Web Integration adapter works with Web Interface Definition Language (WIDL) files to map source content to Wireless XML. Typically, the source format for the Web Integration adapter is HTML, but developers can also use the adapter to retrieve content in other formats, such as XML.

For a master service based on the Web Integration adapter, the Init Parameters panel appears as follows:

Table 10-23 Init Parameters of the Web Integration Adapter

Parameter  Value 

WebIntegrationServer 

The machine name and listening port of the Web Integration Server. If the Web Integration Server and the Wireless server reside on the same machine, use localhost:port.

This field is required. The server you specify in this field must be running for the Service Designer to return the adapter parameters.  

Interface 

The WIDL interface name. This interface must be published to the Web Integration Server. You can publish the interface using the Web Integration Developer. You cannot currently use the WIDL_FILE parameter to identify a WIDL service.  

WIDL_FILE 

Do not enter a value for this parameter.  

10.10.1.3 Setting Input Parameters for the Web Integration Adapter

The master service determines the parameters to display in the panel by querying the adapter. Every input parameter defined in the WIDL interface appears in the Inputs panel, including parameters for other WIDL services within the WIDL interface.

In addition to the custom input parameters that you create, Web Integration services provide these parameters:

The OutputType specifies the type of XML output that the adapter should return. You can specify RawResult, to return content in Adapter Result format, or SimpleResult, to return content in Simple Result format. If returning raw result format, you must create a result transformer that converts the result into Simple Result for the device transformer. The result transformer should have the same name as the value you use for the PAsection parameter; that is, it should have the same name as the WIDL service. You use RawResult for chained services.

PAsection is the name of the WIDL service that you want the master service to invoke. A WIDL interface can include more than one WIDL service. Wireless lists the WIDL service names in a selection list in the value field.

InputEncoding specifies the encoding used to encode the source document. The source document is the URL that was used to create the WIDL file for this service. The default value of this parameter is UTF-8. If the language of the source document is an Asian language, you can change the default encoding to the appropriate multi-byte encoding according to the IANA standards for the particular Asian language that is used in the source document. The InputEncoding parameter enables you to specify or change the encoding. It is part of the multi-byte character support. The Oracle9iAS Developer's Guide provides more information about multi-byte character support.

10.10.2 Setting the Input Parameters for Adapters

The Input Parameters screen displays the input parameters for the adapter. The Content Developer Tool queries the adapter definition to determine the parameters that appear in this panel. The master service passes the input parameter values to the adapter's invoke method every time the adapter executes.

Some parameters rely on user input for values. The values for other parameters, such as name of the WIDL service in the WIDL interface (PAsection), are set by the master service or service. PAsection is an internal parameter, not exposed to the end user. In addition to PAsection, Wireless provides these input parameters:

Table 10-24 Input Parameters for a Master Service e

Variable  Value 

PAservicepath 

The relative path to a Wireless service, /UsersFolders/joe/myChain, for example.  

PAdebug 

The debugging option. If true (set to 1), Wireless produces verbose output to the log files. In this case, in addition to notifications and warnings, Wireless writes the results of adapter invocations to the log file. This enables you to examine service content in its internal, XML format, which can help you to create result transformers and solve service and transformer problems. 

PAsection 

The WIDL adapter uses this value to identify the service that serves as the entry point in the chained service sequence.  

PAuserid 

The user name. 

PApassword 

The user password. 

PAsid 

The Wireless session identifier. 

Wireless input parameters includes the following:

Table 10-25 Input Parameters Attributes

Parameter  Value 

Name 

The name of the input parameter. The Content Developer sets the name of the input parameter by querying the adapter definition.  

Caption 

The caption is the label that Wireless uses for the parameter when prompting for user input.  

Comment 

In the case of master services based on the Web Integration adapter, Wireless automatically populates this cell with the name of the WIDL service that uses the parameter.

For services based on other adapters, you can use this column to document the parameter. The comment is only used internally.  

User Customizable 

Specifies whether the end user can set a value for this parameter using Wireless Customization. You can make most input parameters customizable by the user. In particular, you should set this option for parameters that may be difficult for a user to enter from a mobile device. This includes email addresses and personal identification numbers.  

Format 

This mask sets the expected data entry mode for the user device. For example, if you expect the user to enter numbers for the parameter, you use the format code N. This works only with WML 1.1-compliant devices.

The default format is *M. Other formats include:

  • A, for entry of uppercase letters or punctuation

  • a, for entry of lowercase letters or punctuation

  • N, for entry of numbers.

  • X, for entry of uppercase letters.

  • x, for entry of lowercase letters.

For a complete list of formats, see the Wireless Application Protocol Wireless Markup Language Specification, Version 1.1.  

Mandatory 

Select this check box if this parameter must have a value. Remove the selection for optional parameters.  

Default Value 

For most parameters, this value represents the default value for the parameter. If you specify a default value, Wireless does not prompt the user for a value. Default values can be overridden by a value specified by a service created by the Content Manager or, if the parameter is visible to the user, by the user with the Wireless Customization.

The PAsection parameter is used by the Web Integration adapter. For PAsection, this value is the name of the WIDL service that the Web service should use. You can select the names from a drop-down selection list. If you do not specify a value for PAsection, the Wireless service includes all WIDL services in the WIDL interface.  

10.10.2.1 Adding a New Input Parameter to the Adapter

To add a new input parameter to the adapter.

  1. From the Input Screen of the Master Service Creation Wizard, click Add Another Row.

  2. In the blank row, enter a name for the input parameter in the Name field.

  3. Enter a description for the input parameter in the Caption field.

  4. Enter a description for the input parameter in the Comment field. This can be the same information as both the Name and Caption.

  5. Enter the data entry mode for the user's device in the Format field. The default is *M.

  6. Select the User Customizable check box to enable the end user to edit the input parameter.

  7. Select the Mandatory check box if this input parameter requires a value.

  8. Enter, if needed, a default value. If you do not enter a default value, then Wireless prompts the user for a value.

  9. Click Next.

10.10.2.1.1 Setting Input Parameters for the AppsFramework Adapter

The AppsFramework adapter allows for the development of enterprise applications on top of Wireless. It provides system-wide standard application look and feel, enhanced application widgets support and data binding to enterprise data.

The AppsFramework adapter includes the input parameter classname which must be the package and class of the implementation of the MobileApplicationHandler interface. Refer to the Oracle9iAS Developer's Guide , Section 12.5.6 MobileApplicationHandler Interface, for more information.

10.10.2.2 Modifying the Style/Color/SDU Information for the Mobile Application Framework Adapter

The Mobile Application Framework adapter uses style and color mappings to provide a uniform look and feel that can be customized across all applications running on the server. In addition, carrier specific information can be specified to the Mobile Application Framework adapter to optimize the content delivered by the adapter. The StyleColorLoader command-line utility is used to modify the style, color, and SDU size information used by the Mobile Applications Framework adapter.

10.10.2.2.1 Downloading the Style/Color/SDU Repository.
  1. Change directory to ${ORACLE_HOME}/wireless/sample

  2. Type updateStyleColor.bat -D <filename>, where <filename> is the target file the xml repository should be downloaded into. Note that on a UNIX system, you should use updateStyleColor.sh -D <filename>.

10.10.2.2.2 Uploading the Style/Color/SDU Repository.
  1. Change directory to ${ORACLE_HOME}/wireless/sample

  2. Type updateStyleColor.bat -U <filename>, where <filename> is the file containing the Style/Color/SDU information in the specified XML format that should be uploaded into the database. Note that on a UNIX system, you should use updateStyleColor.sh -U <filename>.

10.10.2.2.3 Modifying the Style/Color/SDU XML Repository File.
  1. Download the file

  2. To modify this file, open it in any text editor of your choice. The XML file contains 3 top-level elements: <StyleSet>, <ColorSet>, <SDUSize>. Follow the guide in Section 10.10.2.2.4 to modify these elements correctly. Then upload the file back into the repository

10.10.2.2.4 Defining a StyleSet

The <StyleSet> elements help the renderers for a given logical device render application styles into markup language, as described above. For example when a developer wants to create a prompt style "Prompt" and bind the style to the text of the prompt, he/she will create a "Prompt" style in the style repository.

Each <StyleSet> element contains a number of <Style> elements. Each <Style> element contains a name, a font face, font size, font style and font color. The property names are described below.

Table 10-26 Style Element Properties
Property Name  Required  Multiple  Description 

Name 

The name of the Style. 

FontFace 

The name of the font face of the given style. 

FontSize 

The font size of the given style. 

FontColor 

the name of the font color of the given style. 

FontStyle 

The name of the font style of the given style, in other words, Bold, Italc, Plain. 

In addition to the <Style> element, the StyleSet contains the following elements.

Table 10-27 StyleSet Element Properties
PropertyName  Required  Multiple  Description 

Name 

The name of the StyleSet. If a StyleSet isn't associated with the logical device, the StyleSet with the name "Default" gets assigned to the device. 

Inherits 

What StyleSet it inherits from. Often the administrator simply wants to change a single style between two logical devices. In this case he would define a single style set which has all of the style definitions for the first logical device, and then would inherit this first style set in the second style set and only overwrite the styles that are different between the StyleSets. 

Style 

This element defines a style.  

Device 

Describes the type of logical device this style set is associated with. The two types of logical devices supported are "Phone" and "PDA". 

By modifying application style definitions in a given <StyleSet>, the system administrator can control how the given application style is rendered on the logical device to which the style set is bound, across the whole system. For example, if the logical device PDA is bound to the StyleSet "Default", then if the system administrator changes the prompt style in the default StyleSet so that it is bold rather than simply plain, all prompts will appear bold rather than plain when rendered on client devices in the PDA Logical Device grouping.

10.10.2.2.5 Defining a ColorSet

The <ColorSet> element helps the renderers for a given logical device render application colors into markup language. For a given logical device this application color is mapped to a color code, which can be modified by the system administrator to produce the optimal rendering. For example, if the logical device PDA is bound to the ColorSet "Default", then if the system administrator changes the background color in the default ColorSet so that it is grey rather than simply white, the background color for all applications on client devices in the PDA Logical Device grouping will be grey instead of white.

A <ColorSet> element consists of multiple <Color> elements. Each <ColorSet> has the following properties:

Table 10-28 ColorSet Elements Properties
PropertyName  Required  Multiple  Description 

Name 

The name of the ColorSet. 

Inherits 

What ColorSet it inherits from. Often the administrator simply wants to change a single application color between two logical devices. In this case he would define a single color set which has all of the color definitions for the first logical device, and then would inherit this first color set in the second color set and only overwrite the colors that are different between the ColorSets. 

Color 

This element defines a color.  

Device 

Describes the type of logical device this style set is associated with. The two types of logical devices supported are "Phone" and "PDA". 

A <ColorSet> element consists of multiple <Color> elements, each <Color> element has the following properties

Table 10-29 ColorSet Color Element Properties
PropertyName  Required  Multiple  Description 

Name 

The name of the Style. 

ColorDesc 

The 24 bit color code of the given color, for example White = #FFFFFF. 

10.10.2.2.6 Defining SDUSize Information for a Device

The <SDUSize> element helps the renderers for a given logical device render an optimized amount of information on pages. For a given logical device, the SDUSize is the upper limit on the amount of information (in bytes) that the network can carry to this device.

A <SDUSize> element consists of two child elements. They have the following properties:

Table 10-30 SDUSize Element Properties
PropertyName  Required  Multiple  Description 

Name 

The name of the type of device. The two types of logical devices supported are "Phone" and "PDA". 

Value 

The 24 bit color code of the given color, for example White = #FFFFFF. 

Table 10-31 SDUSize Element Properties
PropertyName  Required  Multiple  Description 

Name 

The name of the type of device. The two types of logical devices supported are "Phone" and "PDA". 

Value 

The 24 bit color code of the given color, for example White = #FFFFFF. 

10.10.2.3 Setting Input Parameters for the SQL Adapter

You can configure SQL input parameters just as you can Web service parameters. You specify input parameters in the SQL statement you use to implement the service.

10.11 Managing Regions

When you click the Regions tab in the Service Designer, the main displayof the region modeling tool appears.

Figure 10-22 The Main Display of the Region Modeling Tool


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

The region modeling tool lets administrators of a wireless portal service create custom regions that can be associated with location-based services. When you create a service, if you specify that it is location dependent, you specify a region: either an Oracle-supplied system-defined region or a custom region previously created with the region modeling tool.

A region is simply a geographic entity, or location. A region can be small (such as a street address) or large (such as a country). A region can be represented by a point, as is often done for addresses and locations of interest (such as airports and museums), or by a polygon, as is usually done for states and countries. For detailed information about using the region modeling tool, click the Help button on modeling tool in the chapter on Location Services in the Oracle9iAS Developer's Guide.


Go to previous page Go to next page
Oracle
Copyright © 2002 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