Installing the IBM Tn3270 Mainframe Emulator Portlet

OracleAS Portal Developer Kit (PDK)
Oracle Application Server Emulator Portlet for IBM Tn3270 Server - Installation Instructions

Last Updated: May 2005
Status: Beta

Contents

Introduction
User Interface

Deploying the Provider
Updating provider.xml
Publishing the Portlet
Registering the Provider
Adding the Portlet to a Page

Introduction

This document describes how to install the Oracle Application Server (OracleAS) Emulator Portlet for IBM Tn3270 Server.  This portlet emulates a web interface to the IBM Tn3270 mainframe.  This portlet is a Java based portlet and is designed to work as an applet.

User Interface

When added to an OracleAS Portal page, this portlet provides the following user interface components: 

Show Mode Screen

IBM TN3270 Emulator Portlet Show Mode Screenshot.

Edit Mode Screen

IBM TN3270 Emulator Portlet Edit Mode Screenshot.

Deploying the Provider

Please follow the instructions in the Installing Integration Portlet document to deploy the OracleAS Emulator Portlet for IBM Tn3270 Server.

Updating provider.xml

Once you have successfully deployed the OracleAS emulator provider for IBM Tn3270 Mainframe, the provider.xml file needs to be modified.
  • Using any Text Editor, open the provider.xml located at: $IAS_HOME(MID_TIER)/j2ee/OC4J_PORTAL/applications/tn3270/tn3270/WEB-INF/providers/tn3270/provider.xml.
  • The seeded portlet contains dummy information, which may be modified.  Following are the tags which may be changed/configured:
    •  
      The renderer contains the following set of tags :
            <renderer class="oracle.portal.provider.v2.render.RenderManager">
               <showPage class="oracle.portal.provider.v2.sample.AppletRenderer">
                   <useQuickLoader>true</useQuickLoader>
                   <showStatus>true</showStatus>
                   <splashImage>/htdocs/applet/logo9i.gif</splashImage>
                   <message>Loading....</message>
               </showPage>
         </renderer>

      showPage
      The class attribute of the showPage tag should map to oracle.portal.provider.v2.sample.AppletRenderer class.

      useQuickLoader
      This tag is used to indicate if a splash screen is required while the applet download is in progress.  This tag can only accept values true or false:  

      - True indicates that the splash screen with images and/or messages should be shown while downloading the actual applet.  

      - False value indicates that the splash screen is not required.

      showStatus
      This tag is only effective if <useQuickLoader> is set to true. Quick Loader brings a status bar while showing the splash screen, where the status of the download is visible.

      splashImage
      This tag is only effective if <useQuickLoader> is set to true.  This contains the absolute/relative location of the image which needs to be shown while the download is in progress. If an absolute path is specified, the path is mapped from the current mid-tier's context path.

      message
      This tag is only effective if <useQuickLoader> is set to true.  This contains the message which needs to be shown while the download is in progress.

      The portlet also contains another tag called <appletDescriptor> which describes the Tn3270 applet details, it contains the following set of tags:

            <appletDescriptor class="oracle.portal.provider.v2.sample.AppletDescriptor">
                <name>Tn3270 Client</name>
                <description>This is the Tn3270 Mainframe's Client.</description>
                <code>oracle.portal.integration.tn3270.Tn3270Applet.class</code>
                <codebase>/WEB-INF/lib</codebase>
                <archive>tn3270.jar,appletviewer.jar</archive>
                <usePlugin>false</usePlugin>
                <width>650</width>
                <height>400</height>
                <paramDescriptor class="oracle.portal.provider.v2.sample.ParamDescriptor"> 
                    <name>hostmane</name>
                    <value>some Hostname</value>
                </paramDescriptor>
            <appletDescriptor>

      appletDescriptor
      The class attribute of this tag should map to the oracle.portal.provider.v2.sample.AppletDescriptor class

      name
      This tag gives a name to the applet while it is rendered in the browser. This name can be used by the javascript for communication with the applet. The browser will interpret this name, just as it interprets as any other component name.

      description
      This tag gives provides a description of the applet. The description text will be shown if the applet could not be interpreted by the browser.

      code
      This is a mandatory tag, this specifies the full qualified name of the applet class. The Tn3270 Applet's class is oracle.portal.integration.tn3270.Tn3270Applet

      codebase
      This is an optional tag, that specifies the location from where the applet code (jar) can be downloaded. You can specify the relative URL, from the current context path. For example /htdocs/jars specifies physical path will be relative to the current context path, which will resolve to the following directory structure:
      $IAS_HOME(MID_TIER)/j2ee/OC4J_PORTAL/applications/tn3270/tn3270/htdocs/jars.

      archive
      This is another mandatory tag, that specifies the download jar file to run the applet.  You can specify more than one jar/zip files separated by commas (,).  The Tn3270's jar file name is tn3270.jar.  If you have set the <quickLoader> to true, then you should also make an entry for appletviewer.jar in the archive tag.  Subsequently you should make sure the jar file is available through the codebase for a successful download.  The appletviewer.jar file in available in the /WEB-INF/lib directory of the context path.
      NOTE: The appletviewer.jar file is present at the following location when the Tn3270 Application is deployed on OC4J. $IAS_HOME(MID_TIER)/j2ee/OC4J_PORTAL/applications/tn3270/tn3270/htdocs/jars. The appletviewer.jar renders the applet as a portlet.

      usePlugin
      This is an optional tag.  This Boolean tag indicates whether the Appletviewer should use the plugin or use the browser based JVM to render the portlet in the browser:

      - True indicates that the portlet should be rendered using an applet plugin.  

      - False indicates that the portlet can run using the browser based JVM.  The default is False.

      width
      This is a mandatory tag, that indicates the width to be occupied by the portlet on the browser window.

      height
      This is a mandatory tag.  This tag specifies the height to be occupied by the portlet on the browser window.

      paramDescriptor
      This is an optional tag.  This tag is used to supply some initial parameters/arguments to the applet (running in the portlet) for its initialization.  Every parameter has to be specified in a separate <paramDescriptor> tag.  The class attribute of this tag must map to the oracle.portal.provider.v2.sample.ParamDescriptor class.  The name & value parameters can be supplied in the child tags <name> & <value> respectively.
      The Tn3270 Applet requires the hostname parameter. This parameter is Mandatory. This tag takes in the name or IP address of the Tn3270 Mainframe machine to which the user wants to connect to.
       

  • Save the provider.xml file
  • If you have stopped the OC4J Instance, then start it again.
  • Test your provider if its configured properly by using the URL:  http://your_server_address:port/tn3270/providers/tn3270. Here replace the "your_server_address" and "port" with the appropriate values.
  • Now your Tn3270 provider is ready to run within a OracleAS Portal page. Register the Tn3270 provider and add the Tn3270 portlet to the portal page.

Publishing the Portlet

Registering the Provider

After deploying OracleAS Emulator Provider for IBM Tn3270 Server, you must register the provider with OracleAS Portal before adding the provider's portlet to a page.
  1. Login to OracleAS Portal using an account that has build privileges. If your home page is not the Build/Administer page, click on the Builder link in the top right corner of the screen.  Click on the Build tab if that is not the active tab.
  2. Under the Build tab (on Oracle Portal Home Page), click on Register Portlet Provider within the portlet called Providers.
  3. Fill out provider information for the Provider.
    • Name: Tn3270Provider
    • Display Name: Tn3270 Provider
    • Timeout: 100
    • Timeout Message: Tn3270 Portlet timed out.
    • Implementation Style: Web
  4. Click on the Next button to enter the Web Provider specific information
  5. Enter the Web Provider location

  6. URL: http://your_oc4j_hostname:port/tn3270/providers/tn3270
  7. Scroll down to the User/Session Information section and specify the login frequency
  8. Login Frequency: Once Per User Session
  9. Click on the Finish button to complete the registration
Note: When registering a new provider with OracleAS Portal, only the user who registered the provider has privileges to see the provider/portlets. If necessary, go to the Folder with the name of the provider within the Portlet Repository content area and update the provider privileges as required.

Adding the Portlet to a Page

You are now ready to add the Portlet to an OracleAS Portal page.
 


Trademarks

Oracle and the Oracle logo are trademarks or registered trademarks of Oracle Corporation in the United States and other countries.

All other names are trademarks and/or registered trademarks of their respective owners.


Oracle Corporation
World Headquarters
500 Oracle Parkway
Redwood Shores, CA 94065, USA
http://www.oracle.com/
Worldwide Inquiries:
1-800-ORACLE1
Fax 650.506.7200
Copyright and Corporate Info

E-mail this page
Printer View Printer View
Oracle Is The Information Company About Oracle | Oracle RSS Feeds | Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Privacy