Web Applications

Identifier:

com.ibm.eswe.workbench.WctWebApplication

Since:

WCTME Enterprise Offering 5.8.0 NOTE: Location, Local, Description, and Version elements from 5.8.0 are deprecated for the WebSphere Everyplace Deployment 6.0.0 and Expeditor 6.1.0 release. For web applications intended to run on devices, only the 6.1.0 schema is supported.

Description:

This extension point provides the definition of a web application to be launched.

Configuration Markup:

<!ELEMENT extension (WEBApplication)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #REQUIRED

name CDATA #IMPLIED>

point - Fully qualified identifier of the extension point
id - ID identifying this instance of the extension point. If the web application is using an IUrlProvider implementation to generate the url, ID should not contain any '.'s.
name - Name associated with the extension point.

<!ELEMENT BrowserConfiguration EMPTY>

<!ATTLIST BrowserConfiguration

browser (Mozilla|MSIE)

showAddressbar (true | false)

showToolbar (true | false)

showHistory (true | false)

showPageCtrl (true | false)

showHome (true | false)

showPrint (true | false)

showBookmark (true | false)

userid CDATA #IMPLIED

password CDATA #IMPLIED>

Browser configuration settings Note: The Lotus Expeditor Client for Devices will correctly read, but does not support, BrowserConfiguration options in the eSWT browser.

browser - Type of browser to be used. Supported values are platform (default), Mozilla and MSIE. MSIE is the supported value on Windows. Mozilla is the supported value on Linux.
showAddressbar - Used to specify whether or not the browser address bar should be displayed or not. Supported values are true or false. Default value is true.
showToolbar - Used to specify whether or not the browser tool bar should be displayed or not. Supported values are true or false. Default value is true.
showHistory - Used to specify whether or not the browser history button should be displayed or not. Supported values are true or false. Default value is true.
showPageCtrl - Used to specify whether or not the browser print button should be displayed or not. Supported values are true or false. Default value is true.
showHome - Used to specify whether or not the browser home button should be displayed or not. Supported values are true or false. Default value is true.
showPrint - Used to specify whether or not the browser print button should be displayed or not. Supported values are true or false. Default value is true.
showBookmark - Use to specify whether or not the browser bookmark should be displayed or not. Supported values are true or false. Default value is true.
userid - Use to specify the user id to login to a website. Substituted for any %USERID% token in the url string.
password - Use to specify the password to login to a website. Substituted for any %PASSWORD% token in the url string.

<!ELEMENT WebApplicationUrl EMPTY>

<!ATTLIST WebApplicationUrl

local (true | false)

secured (true | false)

provider CDATA #IMPLIED

url CDATA #IMPLIED>

Specify the URL to access the web application. ("url" and "local") or "provider" is required to provide the correct url the Web Browser connect to. The Lotus Expeditor Client for Devices does not support ssl/https

local - Used to specify whether the given application is local to the runtime or not. If the local attribute is set to true then specify only the portion of the url following the server address and port number. If the local attribute is set to false then specify the full-qualified url of the web application including the protocol, server address, port number and path to access web application.
secured - Used to specify whether or not the web application should be run securely or not - the workbench will attempt to run the web application on a secure port using HTTPS. Used only if the local attribute is set to true. NOTE: If the Web Container is not configured to use ssl then the workbench will run the web applicaiton using HTTP on a non-secured port.
provider - Used to specify the name of the class that will generate the web application url. If the provider attribute is present the values of the local and secured attributes and element will be ignored. All url provider classes must implement the IUrlProvider interface.
url - The URL to access the web application.

<!ELEMENT WEBApplication (BrowserConfiguration , WebApplicationUrl)>

<!ATTLIST WEBApplication

DisplayName CDATA #REQUIRED

Icon CDATA #IMPLIED>

Specifies an instance of an application that will be created in the Launcher list.

DisplayName - Display Name to use for the web application in the Launcher list.
Icon - Relative path of icon to be used in the Launcher list. Web application developers should provide both a 16x16 and a 32x32 pixel color image. If the image size is not 16x16 or 32x32 or if the element is not specified, then the default web application images will be used. Image name should contain either '16x16' or '32x32' to denote the size of the image. E.g., DemoWebApp_16x16.jpg

Examples:


(1) This example shows a web application that is local to Expeditor runtime.     
     
 <extension id="LocalExample" point="com.ibm.eswe.workbench.WctWebApplication">
   <WEBApplication DisplayName="Order Entry Web Application">
    <WebApplicationUrl local="true"
           url="OrderEntry"/>
   </WEBApplication> 
 </extension>
  
(2) This example shows a web application that is running on a remote server.
  
 <extension id="RemoteApp" point="com.ibm.eswe.workbench.WctWebApplication">
    <WEBApplication DisplayName="IBM">
    <WebApplicationUrl local="false"
           url="http://www.ibm.com"/>
   </WEBApplication>
 </extension>
 
(3)This example shows how a local web application can be configured to use the browser address bar but not the home button
  
 <extension id="MyExample" point="com.ibm.eswe.workbench.WctWebApplication">
    <WEBApplication DisplayName="%webapp.name"
        Icon="icons/OEwctwebapp_32x32.gif">
    <WebApplicationUrl local="true"
           url="/OrderEntry"/>
    <BrowserConfiguration browser="platform" 
                       showAddressBar="true" 
              showToolbar="true" 
            showHistory="true" 
            showPageCtrl="true"
            showHome="false"
            showPrint="true"/>
    
   </WEBApplication>
 </extension>
 
(4) This example shows how a local web application can be configured to not use the address bar and tool bar

 <extension id="LocalApplication" point="com.ibm.eswe.workbench.WctWebApplication">
     <WEBApplication DisplayName="%webapp.name"
         Icon="icons/OEwctwebapp_32x32.gif">
    <WebApplicationUrl local="true"
           secured="true"
           url="/OrderEntry"/>
    <BrowserConfiguration browser="platform" 
                       showAddressBar="false" 
              showToolbar="false"/>
    
   </WEBApplication>
 </extension>

(5) This example shows how a local web application can be configured to use the Mozilla browser and remove the print button from the toolbar
  
 <extension id="TestApplication" point="com.ibm.eswe.workbench.WctWebApplication">
     <WEBApplication DisplayName="%webapp.name"
         Icon="icons/OEwctwebapp_32x32.gif">
    <WebApplicationUrl local="true"
           url="/OrderEntry"/>
    <BrowserConfiguration browser="Mozilla" 
            showPrint="false"/>
    
   </WEBApplication>
 </extension>
 
(6) This example shows how to configure a web application to use the urlprovider capability
  
 <extension id="MyApplication" point="com.ibm.eswe.workbench.WctWebApplication">
     <WEBApplication DisplayName="%webapp.name"
        Icon="icons/OEwctwebapp_32x32.gif">
    <WebApplicationUrl provider="myApplication.myProvider"/>
    <BrowserConfiguration browser="platform" 
                       showAddressBar="true" 
              showToolbar="true" 
            showHistory="true" 
            showPageCtrl="true"
            showHome="false"
            showPrint="true"/>
    
   </WEBApplication> 
 </extension>

Supplied Implementation:

Expeditor runtime will use this extension point to register the web application. These web applications will be displayed in the Launcher list. Please note that the BrowserConfiguration attributes are read correctly but the configurations are not supported by the eSWT browser, this may be implemented in future releases.