Installing the OHW-RC Demo EAR File on Oracle WebLogic Server
18.3 Installing OHW-RC Artifacts
There are some files needed to be installed on the server to make OHW-RC working. The details about this will be shown in different possible deployment of OHW-RC topics. The OHW-RC distributable components consist of JAR files like ohw-rcf.jar, ohw-share.jar, help-share.jar, and ohw-rcf-webapp.zip. The ohw-rcf-webapp.zip contains the helppages directory, which contains installable files like jspx XML style of a JSF page that are needed to run OHW-RC properly. All artifacts are available on OTN for download.18.4 Understanding OHW-RC Configuration Files
Before you start deploying the OHW-RC helpset, there are some files that need to be created or modified to configure OHW-RC correctly. The following information will help you understand the XML configuration files: ■ application.xml : A manifest of all web modules that run under a given Java EE application. It points to each web module of each product that is deployed. The name and location of application.xml is fixed by the Java EE standard. The file is available in OHW-RC_HOME\META-INF\ directory. ■ web.xml : Sets the initialization parameters for the OHW-RC components, including the location of the OHW-RC configuration file. There is one instance of web.xml for each web module. The file is available in OHW-RC_ HOME\OHW-RC_deployment_name\WEB-INF\ directory. There is a minimum set of parameters need to be set in order to assure all prerequisites for OHW-RC are loaded and initialized correctly: – JSF servlet and servlet mapping – Trinidad resource servlet, servlet mapping, filter and filter mapping – OHW-RC filter and filter mapping – help instance servlet and servlet mapping The following example shows a sample web.xml file: context-param param-nameorg.apache.myfaces.trinidad.CHANGE_PERSISTENCEparam-name param-valueoracle.adf.view.rich.change.FilteredPersistenceChangeManagerpara m-value context-param filter filter-nametrinidadfilter-name filter-classorg.apache.myfaces.trinidad.webapp.TrinidadFilterfilter-class filter filter-mapping filter-nametrinidadfilter-name servlet-nameFaces Servletservlet-name filter-mapping servlet servlet-nameFaces Servletservlet-name servlet-classjavax.faces.webapp.FacesServletservlet-class load-on-startup1load-on-startup servlet 18-4 Oracle Fusion Middleware Developers Guide for Oracle Help servlet-mapping servlet-nameFaces Servletservlet-name url-patternfacesurl-pattern servlet-mapping servlet servlet-nameresourcesservlet-name servlet-classorg.apache.myfaces.trinidad.webapp.ResourceServletservlet-clas s servlet servlet-mapping servlet-nameresourcesservlet-name url-patternadfurl-pattern servlet-mapping servlet-mapping servlet-nameresourcesservlet-name url-patternafrurl-pattern servlet-mapping -- configuration for product1 help front servlet -- servlet servlet-nameproduct1servlet-name servlet-classoracle.help.web.rich.OHWServletservlet-class init-param param-nameohwConfigFileURLparam-name param-valuehelpsetsproduct1ohwconfig.xmlparam-value init-param load-on-startup2load-on-startup servlet -- configuration for product2 help front servlet -- servlet servlet-nameproduct2servlet-name servlet-classoracle.help.web.rich.OHWServletservlet-class init-param param-nameohwConfigFileURLparam-name param-valuehelpsetsproduct2ohwconfig.xmlparam-value init-param load-on-startup3load-on-startup servlet -- servlet mappings for the OHW-RC front servlets -- servlet-mapping servlet-nameproduct1servlet-name url-patternproduct1url-pattern servlet-mapping servlet-mapping servlet-nameproduct2servlet-name url-patternproduct2url-pattern servlet-mapping -- OHW-RC servlet filter definition and mappings -- filter filter-nameOHWRCFRequestFilterfilter-name filter-classoracle.help.web.rich.OHWFilterfilter-class filter filter-mapping filter-nameOHWRCFRequestFilterfilter-nameParts
» Oracle Fusion Middleware Online Documentation Library
» Oracle Help for the Web – Rich Client
» Oracle Help for the Web – UIX
» Oracle Help in Oracle JDeveloper Oracle Help Licensing and Support
» OHJ Topic Windows Oracle Fusion Middleware Online Documentation Library
» Case Sensitive Search for Topic List
» Branding area Open, Pluggable Architecture
» Toolbar area Open, Pluggable Architecture
» Navigator area Open, Pluggable Architecture
» Topic view area Open, Pluggable Architecture
» OHW-RC Global Toolbar Oracle Fusion Middleware Online Documentation Library
» Show permanent link for this topic page OHW-RC Contents Navigator
» OHW-RC Index Navigator Oracle Fusion Middleware Online Documentation Library
» OHW-RC Search Navigator Oracle Fusion Middleware Online Documentation Library
» About OHW-RC Feature Bookmarking Feature
» Branding area Single Pane Layout Feature
» Helpset switcher Single Pane Layout Feature
» Tab bar Single Pane Layout Feature
» OHW-RC Topic Pane OHW-UIX Table of Contents
» OHW-UIX Index OHW-UIX Search OHW-UIX Topics
» File Name Extensions Oracle Fusion Middleware Online Documentation Library
» The helpset Element Helpset File
» The title Element Helpset File
» The maps Element Helpset File
» The wintype Element Helpset File
» The links Element Helpset File
» The view Element Helpset File
» The subhelpset Element Helpset File
» Sample Helpset File Helpset File
» TOC Elements Table of Contents File
» Link File Elements Link File
» Search Index File Topic ID Links
» Associative Links Oracle Fusion Middleware Online Documentation Library
» Custom Protocol Links Oracle Fusion Middleware Online Documentation Library
» Popups Oracle Fusion Middleware Online Documentation Library
» Topic IDs Oracle Fusion Middleware Online Documentation Library
» Window Types Oracle Fusion Middleware Online Documentation Library
» The oracle.help.engine.XMLMapFixedConventionEngine Help Engine
» The oracle.help.engine.XMLMapConventionEngine Help Engine Optimizing Dynamic Maps
» The debugMode Attribute The helpConfiguration Element
» Best Practice for Internationalization
» The locale Child Element books The contentLocation Element
» Sample locales Section The locales Element
» Sharing Resources Across Helpsets
» The parameters Element Oracle Fusion Middleware Online Documentation Library
» The navigatorAliases Element Custom Protocol Links Preloading Helpsets Containing Embedded Help
» HTML Files Authoring Embedded Help
» Starting the Wizard Creating a Helpset File
» Specifying Authoring Tool and HTML Browser Specifying Source Directory
» Defining Full-Text Search View Defining Map File
» Converting Associative Links Converting Popup Window Links
» Window Identity Defining Window Types
» Placement Attributes Style Attributes
» Finalizing the HelpSet Oracle Fusion Middleware Online Documentation Library
» Java Requirements Oracle Fusion Middleware Online Documentation Library
» Running the Indexer Oracle Fusion Middleware Online Documentation Library
» Running the JapaneseIndexer Oracle Fusion Middleware Online Documentation Library
» Installing OHJDK Contents of an OHJDK Release
» Setting the Java CLASSPATH for OHJDK Development
» Oracle Help for Java Runtime in JDeveloper Overview of Adding OHJ to an Application
» Constructing the Help Object
» Adding the Favorites Tab or Custom Tab
» When to Create the Help object
» Showing the Navigator Window
» Catching TopicDisplayExceptions Showing a Topic
» Disposing of the Help Object
» Mapping Topic IDs to Help Topics Programming Your Application to Support Context-Sensitive Help
» CSHManager Constructors Setting the Default Book
» Associating Topic IDs with User Interface Components
» Explicitly Showing Help for Components
» Supported Java Virtual Machines
» Which OHJ JAR Files Must Be Shipped
» Creating JAR files Deploying Compressed Help Content in JARs
» Which Book Constructor to Use
» Understanding the OHW-RC Demo Files
» Installing the OHW-RC Demo EAR File on Oracle WebLogic Server
» Installing the OHW-RC Demo EAR File on Oracle JDeveloper
» Running the OHW-RC Demo EAR File
» Verifying Requirements and Dependencies
» Verifying OHW-RC Library Files
» Installing OHW-RC Artifacts Oracle Fusion Middleware Online Documentation Library
» Understanding OHW-RC Configuration Files
» Configuring OHW-RC to Display Custom Helpsets
» Installing the OHW-RC Artifacts
» Configuring OHW-RC as Standalone Web Application
» Application and OHW-RC Configuration Files and Setup Running the application
» Mapping Topic IDs to Help Topics
» Linking to the Front Main Page Linking to a Topic
» Specifying the Locale and Group
» Using HelpTopicId Attribute Oracle Fusion Middleware Online Documentation Library
» Understanding the OHW-UIX Demo File
» Installing the OHW-UIX Demo EAR File on Oracle WebLogic Server
» Installing the OHW-UIX Demo EAR File using Oracle JDeveloper
» Running the OHW-UIX Demo EAR File
» Understanding OHW-UIX Configuration Files
» Configuring OHW-UIX to Display Custom Helpsets
» Upgrading OHW-UIX and UIX Mapping Topic IDs to Help Topics
Show more