18-8 Oracle Fusion Middleware Developers Guide for Oracle Help
You may also copy the web.xml from demo EAR file and edit it to your requirements. The file is available in
ohw-rc-thick-demo\ohw-rc-thick-demo\WEB-INF directory.
If you are editing the demo EAR file’s web.xml, follow these instructions:
a.
Modify the display-namedisplay-name and descriptiondescription section to display your custom helpset
name. For example:
web-app display-nameMy Moduledisplay-name
descriptionMy module helpdescription web-app
b.
Optionally, you may wish to edit the servlet-name element under servlet element to change your URL used to access OHW-RC. For more
information about changing the access URL, see Section 18.6, Changing the
OHW-RC Access URL .
9.
Compress the OHW-RC_deployment_name directory into a WAR file.
10.
Create application.xml in OHW-RC_HOME\META-INF directory. In this file, you will provide the web module name of each product that you will deploy.
You may also copy the application.xml from demo EAR file and edit it to your requirements. The file is available in ohw-rc-thick-demo\META-INF
directory. Specify the WAR file name, created in step 9, in web-uriweb-uri element. If you wish to change the access URL of the
application, update the context-rootcontext-root element. For more information, see
Section 18.6.2, Changing the access URL to another name .
11.
Compress the OHW-RC_HOME directory into a EAR file.
12.
Start the
Oracle WebLogic Server
and deploy the EAR file. If
Oracle WebLogic Server
is already running, you must shut it down and then restart it before the changes made since you last started the servlet will be available. For
more information about deploying an EAR file, see the Install an Enterprise application section in Oracle Fusion Middleware Oracle WebLogic Server
Administration Console Online Help.
13.
Direct the browser to http:hostname:portOHW-RC_deployment_ nameohguide, where hostname is the name of the machine on which
Oracle WebLogic Server
is installed. The first page of the demo help system displays in the browser. If there is more
than one helpset, use the dropdown list in the toolbar to select a helpset, then click the helpset switcher to display the TOC and index from the selected helpset only.
The text search will search only for items in the selected helpset.
18.6 Changing the OHW-RC Access URL
The URL to access OHW-RC is http:hostname:portmymoduleohguide, where hostname is the
name of the machine on which OHW-RC and
Oracle WebLogic Server
are installed. You can change this URL in the following ways:
■
Changing the final URL element of the access URL
■
Changing the access URL to another name
Understanding OHW-RC Deployment 18-9
18.6.1 Changing the final URL element of the access URL
To change the help at the end of the URL, edit web.xml in OHW-RC_ HOME\OHW-RC_deployment_name\WEB-INF.
The servlet-mapping parameter url-pattern specifies the URL used to access OHW-RC. For example, if you change url-pattern from the default
help to onlinereference, the URL used to access OHW-RC would become http:hostname:portmymoduleonlinereference.
For example: servlet-mapping
servlet-namemymoduleservlet-name url-patternonlinereferenceurl-pattern
servlet-mapping
18.6.2 Changing the access URL to another name
To change the access URL for your application , edit the context-root element entry under web element in application.xml, located in OHW-RC_
HOME\META-INF:
web web-urimy_module.warweb-uri
context-rootmy_modulecontext-root web
For example, if you want the OHW-RC access URL to be http:hostname:portjdeveloperhelp, modify the root element:
web web-urimy_module.warweb-uri
context-rootjdevelopercontext-root web
18.7 Deploying OHW-RC as a Standalone Web Application
One of the ways that OHW-RC can be deployed is to have it as a standalone Web application. To deploy OHW-RC as a standalone application, an OHW-RC WAR file,
containing all files needed to run the OHW-RC, must be copied into a separate deployment directory in the application server that has a dedicated context path.
The OHW-RC administrator needs to perform some primary tasks, and then go on to deploy the OHW-RC help system as a standalone Web application, as follows. To
know more about the tasks, see Chapter 18, Understanding OHW-RC Deployment
.
18.7.1 Installing the OHW-RC Artifacts
The Oracle WebLogic Server and other servlet containers allow OHW-RC modules to be compressed as WAR Web ARchive files, which are then deployed as an EAR
Enterprise ARchive file, which wraps any WAR and JAR Java ARchive files and the OHW-RC installable files. One way to do this is to create WAR or EAR files using the
standard Java JAR utility.
Then the OHW-RC WAR or EAR file needs to be extracted by the application server so that the Web client can access the OHW-RC pages. You may consult the relevant
application server guidelines on how to deploy WAR or EAR files.
18-10 Oracle Fusion Middleware Developers Guide for Oracle Help
Another way is to manually create the Web application using a web developer studio like
Oracle JDeveloper Studio
, include the ohw-rcf.jar, ohw-share.jar, help-share.jar in the library path, and extract the ohw-rcf-webapp.zip to the
public html directory.
18.7.2 Configuring OHW-RC as Standalone Web Application
After all files have been put in the right locations, the OHW administrator still needs to modify some configuration files to make OHW-RC work:
■
Modify web.xml file to include JSF and Trinidad parameters. For example:
?xml version = 1.0 encoding = UTF-8? web-app xmlns:xsi=http:www.w3.org2001XMLSchema-instance ...
context-param param-namejavax.faces.STATE_SAVING_METHODparam-name
param-valueclientparam-value context-param
context-param param-nameorg.apache.myfaces.trinidad.CHECK_FILE_
MODIFICATIONparam-name param-valuefalseparam-value
context-param ...
... web-app
■
Modify web.xml to support OHW-RC front servlets and JSF filter. For example:
?xml version = 1.0 encoding = UTF-8? web-app xmlns:xsi=http:www.w3.org2001XMLSchema-instance ...
... ...
filter filter-nametrinidadfilter-name
filter-class org.apache.myfaces.trinidad.webapp.TrinidadFilter
filter-class filter
filter-mapping filter-nametrinidadfilter-name
servlet-nameFaces Servletservlet-name dispatcherFORWARDdispatcher
dispatcherREQUESTdispatcher filter-mapping
servlet servlet-nameFaces Servletservlet-name
servlet-classjavax.faces.webapp.FacesServletservlet-class load-on-startup1load-on-startup
servlet servlet
servlet-nameOHW Servlet 1servlet-name servlet-classoracle.help.web.rich.OHWServletservlet-class
init-param param-nameohwConfigFileURLparam-name
param-valuehelpsetsohwconfig.xmlparam-value init-param
