Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Help
11g Release 2 (11.1.2.0.0)

Part Number E16280-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

16 Deploying OHW Demo File

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

The OHW demo EAR file contains all class libraries that you require to view the demo and try out the release. It includes sample helpsets, OHW servlet file, and XML configuration files. You can deploy the demo file to experience the OHW 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:

16.1 Understanding the OHW Demo Files

The OHW demo file is available in two variants: ohw-rcf-demo-thin.ear and ohw-rcf-demo-thick.ear.

The ohw-rcf-demo-thick.ear contains ADF, JSF and JSTL libraries preconfigured for deployment. The file is recommended if you are not using a supported application server or JDeveloper, or if you are using a supported application server but do not have the libraries installed. For more information about supported application servers, see the "Certification Information" page on OTN.

The ohw-rcf-demo-thin.ear does not contain ADF, JSF and JSTL libraries, hence it is required that the libraries must be installed on the application server before deployment. JDeveloper is required for this demo file. For more information on how to deploy libraries, see Section 16.2, "Installing the OHW Demo EAR File on Standalone Oracle WebLogic Server".

Note:

Do not deploy both ohw-rcf-demo-thin.ear and ohw-rcf-demo-thick.ear on Oracle WebLogic Server as they would conflict when you run the demo EAR files.

Both OHW demo EAR files, ohw-rcf-demo-thin.ear and ohw-rcf-demo-thick.ear, contain two OHW sample helpsets along with their help topics, helpset file, and control files. They also contain ohwconfig.xml which is needed to configure OHW.

When extracted into a directory, the OHW demo file extracts files into their respective name directories, ohw-rcf-demo-thin and ohw-rcf-demo-thick. The EAR file contains a WAR file and a META-INF directory, which contains the application.xml file. The WAR file contains all helpset directories along with their help topics, helpset file, and control files.

Table 16-1 describes the files and directories in OHW demo EAR files.

Table 16-1 OHW-RC Demo Files and Directories

File Description

application.xml

Java EE application file.

The file is available in META-INF directory.

helpsets directory

Web module containing two helpsets: ohguide and the sample shakespeare, in their respective directories.

The helpsets directory exists in the respective WAR files (ohw-rcf-demo-thick.war or ohw-rcf-demo-thin.war).

trinidad-config.xml

faces-config.xml

web.xml

weblogic.xml

Contains configuration and deployment information that affects OHW thin and thick clients.

The files are available in WEB-INF directory of WAR files.

help-share.jar

ohw-rcf.jar

ohw-share.jar

The following library files are available for thick clients only:

  • adf-richclient-api-11.jar

  • adf-richclient-impl-11.jar

  • trinidad-api.jar

  • trinidad-impl.jar

OHW library files required for deployment.

The files are available in WEB-INF\lib directory of WAR files.

ohwconfig.xml

OHW configuration file.

The file is available in helpsets directory.


16.2 Installing the OHW Demo EAR File on Standalone Oracle WebLogic Server

Before you start the demo file installation, verify that ADF, JSF, and JSTL libraries are installed in Oracle WebLogic Server. For more information, see Section 17.2, "Verifying OHW Library Files".

After the library verification, installing the demo EAR file is a very simple process:

  1. Download the OHW demo EAR file from OTN. The name of the demo file is ohw-rcf-demo-thick.ear. This file includes OHW library files 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-rcf-demo-thick.ear file, or in the Current Location, browse and select the EAR file.

    Click Next to continue.

  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-rcf-demo-thick.ear. If there are errors while deploying the file, you are navigated to Deployment home page where the errors are listed in red text.

16.3 Installing the OHW Demo EAR File on JDeveloper Integrated Oracle WebLogic Server

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

  1. Download the OHW demo EAR file from OTN. The name of the demo file is ohw-rcf-demo-thin.ear. This file includes OHW and sample helpsets.

  2. Start JDeveloper.

  3. Create a new application from the ohw-rcf-demo-thin.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-rcf-demo-thin.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 the 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-rcf-demo-thin project. From the Build menu, select Deploy.

    If you are deploying the demo application for the first time, select ohw-rcf-demo-thin from the submenu, and follow these steps:

    1. On the Deployment Action page of Deploy ohw-rcf-demo-thin dialog box, select Deploy to Application Server as the deployement action, and then click Next.

    2. On the Select Server page, select IntegratedWebLogicServer as the application server, and then click Next.

    3. On the Weblogic Options 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.

    4. On the Summary page, verify your settings, and click Finish.

    If you have deployed the demo application before and want to continue using the same settings, you can choose ohw-rcf-demo-thin to IntegratedWebLogicServer from the submenu.

    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.

16.4 Running the OHW Demo EAR File

After successful deployment of demo file, open your browser and navigate to the following URL:

http://<yourHost>:<yourPort>/<jdevProjectName>/ohguide/

If you have installed the OHW demo EAR file using Oracle WebLogic Administration Console, use the following URL:

http://localhost:7101/ohw-rcf-demo/ohguide

If you have installed the OHW demo EAR file using Oracle JDeveloper, use the following URL:

http://localhost:7101/ohw-rcf-demo-thin/ohguide

For more information on user interface of OHW, see Chapter 3, "Oracle Help for the Web User Interface".