Home / Middleware / Oracle Fusion Middleware Online Documentation Library, 11g Release 1 (11.1.1.3.0) / Developer Guides
Fusion Middleware Developer's Guide for Oracle Help
ContentsOpens a new window
Opens a new window
Page 33 of 40

21 Deploying OHW-UIX Demo File

This chapter describes how to deploy OHW-UIX demo file on Oracle WebLogic Server.

The OHW-UIX demo EAR file contains the class libraries that you need to view the demo and try out the release. It includes sample helpsets, OHW-UIX servlet file, and XML configuration files. You can deploy the demo file to experience the OHW-UIX interface, or replace the existing helpsets and add your own.

The following sections help you understand the demo file, deploy and test the sample helpset in your environment, and optionally add your own helpset for testing and deployment:

21.1 Understanding the OHW-UIX Demo File

The OHW-UIX demo file, ohw-uix-demo.ear, contains three OHW-UIX sample helpsets along with their help topics, helpset file, and control files. It also contains ohwconfig.xml which is needed to configure OHW-UIX.

The OHW demo EAR file extracts files into the ohw-uix-demo directory. The EAR file, when extracted, contains an ohw-uix-demo.war file and creates the META-INF directory, which contains the application.xml file. The ohw-uix-demo.war when extracted into ohw-uix-demo directory contains the helpsets directories along with their help topics, helpset file, and control files.

Table 21-1Opens a new window describes the files and directories in OHW-UIX demo file.

Table 21-1 OHW-UIX Demo Files

Directory Location Description

application.xml

Java EE application: a simple OHW-UIX application.

The file is available in META-INF directory.

helpsets

A web module containing three helpsets: blafdoc, ohguide, and the sample shakespeare, in their respective directories.

The helpsets directory exists in the ohw-uix-demo.war file.

cabo

The UIX installable resource files.

The cabo directory exists in the ohw-uix-demo.war file.

web.xml

Contains configuration and deployment information that affects OHW-UIX.

The file ise available in WEB-INF directory of ohw-uix-demo.war file.

ohwconfig.xml

OHW-UIX configuration file.

The file is available in helpsets directory.

21.2 Installing the OHW-UIX Demo EAR File on Oracle WebLogic Server

Installing the demo EAR file is a very simple process:

  1. Download the OHW-UIX demo EAR file from OTNOpens a new window. The name of the demo file is ohw-uix-demo.ear. This file includes OHW-UIX and sample helpsets.

  2. Start the Oracle WebLogic Administration Console and navigate to Deployments page.

  3. In the Deployments page, click Install to start the deployment wizard.

  4. In the Path field, enter the location where you saved the ohw-uix-demo.ear file, and click Next.

  5. In the Choose targeting style page, select Install this deployment as an application, and click Next.

  6. In the Optional Settings page, verify the settings. It is recommended that you leave the settings as default. Click Next to continue, or click Finish to complete the deployment.

  7. In the Additional Configuration page, select Yes, take me to the deployment's configuration screen and click Finish to complete the deployment.

    The deployment wizard, after successful deployment, returns you to the Settings page of ohw-uix-demo.ear. If there are errors while deploying the file, you are navigated to Deployment home page where the errors are listed in red text.

21.3 Installing the OHW-UIX Demo EAR File using Oracle JDeveloper

To install the demo file on Oracle JDeveloper, follow these steps:

  1. Download the OHW-UIX demo EAR file from OTNOpens a new window. The name of the demo file is ohw-uix-demo.ear. This file includes OHW-UIX and sample helpsets.

  2. Start JDeveloper.

  3. Create a new application from the ohw-uix-demo.ear file. From the File menu, select New. In the New Gallery dialog, select Applications under General category, and then select Application from EAR File from the Items list.

  4. In the Location page of Create Application from EAR File wizard, browse and select the ohw-uix-demo.ear file. You may also change the application name and the location of application. Click Next to continue.

  5. The EAR Modules page of the wizard shows the project name and the module name. Click Next to continue, or click Finish to create the application from EAR file.

  6. The Finish page of the wizard shows a summary of your settings for the application. Click Finish to create the application from EAR file. JDeveloper extracts all files from the EAR file and creates an application which is ready to edit and deploy.

  7. In the Application Navigator, open the project and edit desired files.

  8. To deploy the application, start the integrated Oracle WebLogic Server instance. From Run menu, choose Start Server Instance to start the integrated Oracle WebLogic Server.

  9. In the Application Navigator, select the ohw-uix-demo project. From the Application menu, select Deploy. Then from the submenu, select ohw-uix-demo, to, and then select IntegratedWLSConnection. JDeveloper starts the deployment process and the status of the deployment is reflected in the Log window.

    When the application is successfully deployed, JDeveloper prompts with Deployment finished message in the Log window.

21.4 Running the OHW-UIX Demo EAR File

After successful deployment of ohw-uix-demo.ear, open your browser and navigate to the following URL:

http://<yourHost>:<yourPort>/ohw-uix-demo/help/

For example:

If you have installed Oracle WebLogic Server on your local machine , you can open the demo help file with the following URL:

http://localhost:7101/ohw-uix-demo/help/

The URL automatically changes to http://localhost:7101/ohw-uix-demo/help/state?navSetId=ohguide&navId=0&destination= and the help opens with Table of Contents view. For more information on user interface of OHW-UIX, see Chapter 4, "OHW-UIX User Interface"Opens a new window.