Understanding the OHW-UIX Demo File

Understanding OHW-UIX Deployment 22-3 1. Set up the directory structure as following: OHW-UIX_HOME | — OHW-UIX_deployment_name | — cabo — helpsets | — custom_helpset_directory — META-INF — WEB-INF | — lib — META-INF For example: my_module | — my_module_help | — cabo — helpsets | — my_ModuleHelpset — META-INF — WEB-INF | — lib — META-INF 2. Create your own helpset directory. Place all your help files in or under OHW-UIX_HOME\OHW-UIX_deployment_name\helpsets\custom_ helpset_directory directory, including the helpset file, topic files, and the other control files index, table of contents, etc.. Also, place any JAR files here, if you are using JAR files for your helpset. You can use JARred and unJARred helpsets together in the same deployment. 3. Create the configuration file. In an editor, create an XML file and save it as ohwconfig.xml, in the OHW-UIX_HOME\OHW-UIX_deployment_ name\helpsets directory. You may also copy the ohwconfig.xml from demo EAR file and edit it to your requirement. The file is available in ohw-uix-demo\ohw-uix-demo\helpsets directory. If you are creating a new ohwconfig.xml file, see Chapter 9, Oracle Help for the Web Configuration File for more information about behaviors you can configure. If you are editing the demo EAR file’s ohwconfig.xml, follow these instructions: a. Modify the booksbooks section to direct it to your helpset. For example: books helpSet id=myModule location=my_ModuleHelpsetmy_ModuleHelpset.hs books b. Remove the helpsets which you do not wish to provide from the booksbooks section. If removed, the helpsets would not appear in the helpset switcher dropdown list of the OHW-UIX user interface. If you have 22-4 Oracle Fusion Middleware Developers Guide for Oracle Help only one helpSet element in the booksbooks section, the helpset switcher is not available. c. Update the brandingsbrandings section to display your own brand. For example: brandings branding text=My Module brandings 4. Download the cabo and OHW-UIX library files from OTN. Copy the cabo files in OHW-UIX_HOME\OHW-UIX_deployment_name\cabo and library files in OHW-UIX_HOME\OHW-UIX_deployment_name\WEB-INF\lib directory. You may also copy the library files from demo EAR file. The files are available in ohw-uix-demo\ohw-uix-demo\cabo and ohw-uix-demo\ohw-uix-demo\WEB-INF\lib directory. 5. Create the UIX configuration file uix-config.xml in OHW-UIX_ HOME\OHW-UIX_deployment_name\WEB-INF directory. You may also copy the uix-config.xml from demo EAR file and edit it to your requirements. The file is available in ohw-uix-demo\ohw-uix-demo\WEB-INF directory. 6. Create web.xml to set the initialization parameters in OHW-UIX_ HOME\OHW-UIX_deployment_name\WEB-INF directory. You may also copy the web.xml from demo EAR file and edit it to your requirements. The file is available in ohw-uix-demo\ohw-uix-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-UIX. For more information about changing the access URL, see Changing the OHW-UIX Access URL . 7. Compress the OHW-UIX_deployment_name directory into a WAR file. 8. Create application.xml in OHW-UIX_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-uix-demo\META-INF directory. Specify the WAR file name, created in step 7, 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 22.4.2, Changing the access URL to another name . 9. Compress the OHW-UIX_HOME directory into a EAR file.