プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発
12c (12.2.1.2.0)
E82760-01
  目次へ移動
目次
前
前 		 次
次		  

17 OHWのデプロイメントの理解

この章では、OHWのデプロイメント・プロセスと構成ファイル、OHWのアーティファクトのインストール方法、OHWでのカスタム・ヘルプセットの表示の構成方法、アクセスURLの変更方法、スタンドアロンWebアプリケーションおよび別のWebアプリケーションの一部としてのOHWのデプロイ方法について説明します。

この章の内容は次のとおりです。

17.1 OHWのデプロイメントについて

ヘルプ作成者によるヘルプ・コンテンツの作成が終了した後、OHW管理者は、OHWを使用してヘルプ・コンテンツをデプロイするようWeb構成を変更する必要があります。

OHWは、様々な方法でデプロイできます。ただし、すべてのデプロイ・モードには共通する特定のタスクがあります。この章では、後続の手順の前提条件となる共通のタスクについて説明します。

OHWに慣れていない場合は、デモ・ファイルのデプロイから開始できます。詳細は、第16章「OHWのデモ・ファイルのデプロイ」を参照してください。デモEARファイルには、サンプル・ヘルプセットを即時にデプロイするためのファイルがすべて含まれます。

OHWの新しいヘルプセットを作成する場合、次の各項で、OHWのデプロイメント・プロセスに役立つ情報と、OHWヘルプ・システムを作成してデプロイする手順を参照してください。

構成ファイルの作成とアプリケーション・サーバーの構成が行われていない場合、OHW管理者は、後続の項で説明するタスクを実行してOHWヘルプ・システムをデプロイする必要があります。

17.2 要件および依存性の検証

OHWの次の要件について検証する必要があります。

表17-1 OHWデプロイの最小要件

要件 説明

アプリケーション・サーバー

OHWには、Java Servlet、JSPおよびJSFをサポートするJava EE 1.5互換のアプリケーション・サーバーが必要です。Oracle WebLogic Server(スタンドアロンとしてまたはJDeveloperと統合して提供されている)では、構成作業を最小限に抑えることができるため、その使用をお薦めします。サポートされているアプリケーション・サーバーの詳細は、OTNの「動作保証情報」のアプリケーション・サーバーに関する項を参照してください。

クライアント

クライアントはHTMLのみを受信するため、必要となるのは、OHWヘルプ・コンテンツを表示して閲覧するためのWebブラウザのみです。WebブラウザのJavaScriptサポートは有効にする必要があります。

OHWは、Microsoft Internet Explorer 7、Microsoft Internet Explorer 8、Mozilla FireFox 2、Mozilla FireFox 3、Apple SafariおよびGoogle Chromeでサポートされます。サポートされているブラウザの詳細は、OTNの「リリース・ノート - JDeveloper 11g」のADF Facesおよびデータの視覚化に関する項を参照してください。

Rich ADF Faces

OHWでは、Rich ADF FacesライブラリおよびRich ADF Facesに依存する機能が使用可能である必要があります。また、アプリケーション・サーバーは、正しいJARファイルをインストールするか、またはOracle JDeveloperのADFランタイム・インストーラを実行し、ADFベースのアプリケーション用に構成する必要があります。詳細は、Oracle WebLogic Application Consoleのオンライン・ヘルプを参照してください。

17.3 OHWライブラリ・ファイルの検証

OHWはRich ADF Facesのテクノロジに依存しているため、Rich ADF FacesをサポートするようOHWヘルプ・ファイルのデプロイ先であるアプリケーション・サーバーを構成する必要があります。

Oracle WebLogic Serverを使用している場合は、Oracle WebLogic Application Consoleを調べて、次のライブラリがデプロイされていることを確認します。

  • ADF (adf.oracle.domain(1.0,11.1.1.2.0))

  • Java Server Faces(jsf(1.2,1.2.9.0))

  • JavaServer Pages標準タグ・ライブラリ(jstl(1.2,1.2.0.1))

これらのライブラリは、Oracle WebLogic Application Consoleのデプロイ・ページに表示されます。ライブラリがインストールされていない場合は、Oracle WebLogic Configurationウィザードを使用して、Oracle JRFライブラリを含むようにWebLogicドメインを拡張します。Oracle JRFライブラリを含めた後にOracle WebLogic Serverを再起動すると、Oracle WebLogic Application Consoleのデプロイ・ページにライブラリが表示されます。ドメイン拡張の詳細は、「Oracle ADFアプリケーションの管理」を参照してください。

Oracle WebLogic Serverを使用しない場合は、ohw-rcf-demo-thick.earのすべてのjarファイルが、WARデプロイメント・ファイルの\WEB-INF\libディレクトリにコピーされていることを確認してください。ライブラリ・ファイルはOTNからダウンロードするか、デモ・ファイルからコピーできます。ライブラリは、ohw-rcf-demo-thick.earファイルのohw-rcf-demo-thick\ohw-rcf-demo-thick\WEB-INF\libディレクトリにあります。

17.4 OHWのアーティファクトのインストール

OHWが機能するためには、いくつかのファイルがサーバーにインストールされている必要があります。詳細は、OHWの様々なデプロイに関するトピックを参照してください。

OHWの配布コンポーネントは、ohw-rcf.jar、ohw-share.jar、help-share.jarなどのJARファイルとohw-rcf-webapp.zipで構成されています。ohw-rcf-webapp.zipにはhelppagesディレクトリがあり、このディレクトリには、OHWの正常な実行に必要なjspx (XML形式のJSFページ)などのインストール可能ファイルが含まれます。

アーティファクトは、OTNからダウンロード可能です。

17.5 OHW構成ファイルの理解

OHWヘルプセットのデプロイを開始する前に、OHWを正しく構成するために作成または変更の必要なファイルがあります。次に、XML構成ファイルの理解に役立つ情報を示します。

  • application.xml: 指定のJava EEアプリケーションで実行するすべてのWebモジュールのマニフェスト。デプロイされる各製品のそれぞれのWebモジュールを指し示します。

    application.xmlの名前および場所は、Java EE標準によって固定されています。このファイルは、<OHW_HOME>\META-INF\ディレクトリにあります。

  • web.xml: OHW構成ファイルの場所など、OHWコンポーネントの初期化パラメータを設定します。各Webモジュールに1つのweb.xmlインスタンスがあります。このファイルは、<OHW_HOME>\<OHW_deployment_name>\WEB-INF\ディレクトリにあります。

    OHWのすべての前提条件が正しくロードされて初期化されていることを確認するために設定の必要な、次の最小限のパラメータのセットがあります。

    • JSFのサーブレットおよびサーブレット・マッピング

    • Trinidadリソース・サーブレット、サーブレット・マッピング、フィルタおよびフィルタ・マッピング

    • OHWのフィルタおよびフィルタ・マッピング

    • ヘルプ・インスタンスのサーブレットおよびサーブレット・マッピング

    次に、サンプルweb.xmlファイルの例を示します。

    <context-param>
  <param-name>org.apache.myfaces.trinidad.CHANGE_PERSISTENCE</param-name>
  <param-value>oracle.adf.view.rich.change.FilteredPersistenceChangeManager</param-value>
</context-param>
<filter>
  <filter-name>trinidad</filter-name>
  <filter-class>org.apache.myfaces.trinidad.webapp.TrinidadFilter</filter-class>
</filter>
<filter-mapping>
  <filter-name>trinidad</filter-name>
  <servlet-name>Faces Servlet</servlet-name>
</filter-mapping>
<servlet>
  <servlet-name>Faces Servlet</servlet-name>
  <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
  <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
  <servlet-name>Faces Servlet</servlet-name>
  <url-pattern>/faces/*</url-pattern>
</servlet-mapping>
<servlet>
  <servlet-name>resources</servlet-name>
  <servlet-class>org.apache.myfaces.trinidad.webapp.ResourceServlet</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>resources</servlet-name>
  <url-pattern>/adf/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
  <servlet-name>resources</servlet-name>
  <url-pattern>/afr/*</url-pattern>
</servlet-mapping> 
<servlet-mapping>
    <servlet-name>resources</servlet-name>
    <url-pattern>/ohr/*</url-pattern>
  </servlet-mapping> 
 
<!-- configuration for product1 help front servlet -->
<servlet>
  <servlet-name>product1</servlet-name>
  <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
  <init-param>
    <param-name>ohwConfigFileURL</param-name>
    <param-value>/helpsets/product1/ohwconfig.xml</param-value>
  </init-param>
  <load-on-startup>2</load-on-startup>
</servlet>
 
<!-- configuration for product2 help front servlet -->
<servlet>
  <servlet-name>product2</servlet-name>
  <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
  <init-param>
    <param-name>ohwConfigFileURL</param-name>
    <param-value>/helpsets/product2/ohwconfig.xml</param-value>
  </init-param>
  <load-on-startup>3</load-on-startup>
</servlet>
 
<!-- servlet mappings for the OHW-RC front servlets -->
<servlet-mapping>
  <servlet-name>product1</servlet-name>
  <url-pattern>/product1/*</url-pattern>
</servlet-mapping>
 
<servlet-mapping>
  <servlet-name>product2</servlet-name>
  <url-pattern>/product2/*</url-pattern>
</servlet-mapping>
 
<!-- OHW-RC servlet filter definition and mappings -->
<filter>
  <filter-name>OHWRCFRequestFilter</filter-name>
  <filter-class>oracle.help.web.rich.OHWFilter</filter-class>
</filter>
 
<filter-mapping>
  <filter-name>OHWRCFRequestFilter</filter-name>
  <servlet-name>Faces Servlet</servlet-name>
</filter-mapping>

  • ohwconfig.xml(デフォルトのファイル名): 表示するヘルプセットと、それらの表示方法を指定します。ロケール、ブランド情報およびその他各種設定も指定できます。この構成ファイルの詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。このファイルの名前と場所は、OHWフロント・サーブレット初期化パラメータとして設定されます。このパラメータは、サーブレット・コンテナごとに個別に処理されます。ohwConfigFileURL初期化パラメータは、{%some_parameter}トークンを含むパスを取ります。トークンの値は、JavaのSystem.getPropertyコールで解決されます。最新の情報一覧については、常にサーブレット・コンテナのドキュメントを確認してください。

    このファイルは、<OHW-RC_HOME>\<OHW-RC_deployment_name>\helpsetsディレクトリにあります。propシステム・プロパティを使用して、ohwConfigURLを指定することもできます。たとえば、web.xmlでは、ohwConfigURLは次のように構成されます。

    <param-name>ohwConfigFileURL</param-name>
<param-value>file:///{%prop}/help/ohwconfig.xml</param-value>

    adf-settings.xmlでは、ohwConfigURLは次のように構成されます。

    <property>
    <property-name>ohwConfigFileURL</property-name>
    <value>file:///{%prop}/help/ohwconfig.xml</value>
</property>

  • trinidad-config.xml: TrinidadおよびADFリッチ・コンポーネントの構成を指定します。OHWで使用されるスキニング・オプションを指定します。このファイルは、<OHW_HOME>\<OHW_deployment_name>\WEB-INF\ディレクトリにあります。

  • faces-config.xml: これはJSF構成ファイルです。このファイルは、<OHW_HOME>\<OHW_deployment_name>\WEB-INF\ディレクトリにあります。

    ADF Facesレンダー・キット情報は、このファイルに追加する必要があります。

    <application>
  <default-render-kit-id>oracle.adf.rich</default-render-kit-id>
  <locale-config>
    <default-locale>en</default-locale>
  </locale-config>
</application>

17.6 OHWでのカスタム・ヘルプセットの表示の構成

この項では、OHWヘルプ・システムで必要とされるディレクトリ構造の作成、カスタム・ヘルプセット・ファイルの正しい場所への追加、構成ファイルの作成と変更、およびアプリケーション・サーバーへのヘルプ・システムのデプロイに役立つ情報が提供されます。

この項の説明では、OHWのデモEARファイルがインストール済で、ユーザーがデモEARファイルのディレクトリ構造に精通していることを想定しています。まだデモ・ファイルがインストールされていない場合は、第16章「OHWのデモ・ファイルのデプロイ」の手順に従ってインストールしてください。

OHWヘルプ・システムを設定する手順は、次のとおりです。

  1. 次のようにディレクトリ構造を設定します。

    <OHW-RC_HOME>
  |
  — <OHW-RC_deployment_name>
      |
      — helppages
      — helpsets
          |
          — <custom_helpset_directory>
      — META-INF
      — WEB-INF
          |
          — lib
  — META-INF

    次に例を示します。

    my_module
  |
  — my_module_help
      |
      — helppages
      — helpsets
          |
          — my_ModuleHelpset
      — META-INF
      — WEB-INF
          |
          — lib
  — META-INF

  2. 独自のヘルプセット・ディレクトリを作成します。ヘルプセット・ファイル、トピック・ファイルおよび他の制御ファイル(索引、目次など)を含め、独自のヘルプ・ファイルをすべて<OHW_HOME>\<OHW_deployment_name>\helpsets\<custom_helpset_directory>ディレクトリの下に配置します。また、ヘルプセットにJARファイルを使用する場合は、JARファイルもここに配置します。JARファイルを作成したヘルプセットとJARファイルを作成していないヘルプセットを1つのデプロイで一緒に使用できます。

  3. 構成ファイルを更新および構成します。デモEARのohwconfig.xmlをohw-rc-thick-demo\ohw-rc-thick-demo\helpsetsディレクトリからコピーして、<OHW_HOME>\<OHW_deployment_name>\helpsetsディレクトリに保存します。次の手順で、必要に応じてファイルを編集します。

    1. 自分のヘルプセットにダイレクトするように<books></books>セクションを変更します。次に例を示します。

      <books>
  <helpSet id="myModule" location="my_ModuleHelpset/my_ModuleHelpset.hs" />
</books>

    2. <books></books>セクションから、希望しないヘルプセットを削除します。削除されたヘルプセットは、OHWユーザー・インタフェースのヘルプセット・スイッチャのドロップダウン・リストに表示されなくなります。<books></books>セクション内に<helpSet>要素が1つしかない場合、ヘルプセット・スイッチャは使用できません。

    3. <brandings></brandings>セクションを更新して、独自のブランドを表示します。次に例を示します。

      <brandings>
  <branding text="My Module" />
</brandings>

    ohwconfig.xmlファイルで構成できる動作の詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。

  4. ohw-rc-thick-demo\ohw-rc-thick-demo\helppagesディレクトリを<OHW_HOME>\<OHW_deployment_name>ディレクトリにコピーします。

  5. 次のライブラリ・ファイルを、JDeveloperから<OHW_HOME>\<OHW_deployment_name>\WEB-INF\libディレクトリにコピーします。

    ファイル名 場所
    JSFライブラリ・ファイル(jsf-1.2.war) <JDEV_HOME>\wlserver_10.3\common\deployable-libraries
    JSTLライブラリ・ファイル(jstl-1.2.war) <JDEV_HOME>\wlserver_10.3\common\deployable-libraries
    ADFライブラリ・ファイル(adf-richclient-api-11.jar、adf-richclient-impl-11.jar) <JDEV_HOME>\oracle_common\modules\oracle.adf.view_11.1.1

  6. faces-config.xmlおよびtrinidad-config.xmlに、OHWでのJSFとJSTLのサポートを構成します。XMLファイルをohw-rc-thick-demo\ohw-rc-thick-demo\WEB-INFディレクトリからコピーして、<OHW_HOME>\<OHW_deployment_name>\WEB-INFディレクトリに保存します。

    faces-config.xmlは、JSFアプリケーションのリソースとページ移動のルールを登録するJSF構成ファイルです。trinidad-config.xmlでは、ADF Faces機能を構成できます。faces-config.xml同様、trinidad-config.xmlは、JSF式言語(EL)または静的値を使用して要素プロパティを定義できる単純なXML構造を持ちます。

  7. Oracle WebLogic Serverを使用する場合、weblogic.xmlをohw-rc-thick-demo\ohw-rc-thick-demo\WEB-INFディレクトリからコピーして、<OHW_HOME>\<OHW_deployment_name>\WEB-INFディレクトリに保存します。必要に応じてファイルを編集します。

  8. web.xmlをohw-rc-thick-demo\ohw-rc-thick-demo\WEB-INFディレクトリからコピーして、<OHW_HOME>\<OHW_deployment_name>\WEB-INFディレクトリに保存します。次の手順で、必要に応じてファイルを編集します。

    1. <display-name></<display-name>と<description></description>セクションを変更して、カスタム・ヘルプセット名を表示します。次に例を示します。

      <web-app>
  <display-name>My Module</display-name>
  <description>My module help</description>
</web-app>

    2. オプションで、<servlet>要素の下の<servlet-name>要素を編集して、OHWのアクセスに使用するURLを変更することもできます。アクセスURLの変更の詳細は、第17.7項「OHWのアクセスURLの変更」を参照してください。

  9. <OHW-RC_deployment_name>ディレクトリをWARファイルに圧縮します。

  10. application.xmlをohw-rc-thick-demo\META-INFディレクトリからコピーして、<OHW-RC_HOME>\META-INFディレクトリに保存します。必要に応じてファイルを編集します。このファイルで、デプロイする各製品のWebモジュール名を指定します。

    手順9で作成したWARファイル名を<web-uri></web-uri>要素に指定することもできます。アプリケーションのアクセスURLを変更する場合は、<context-root><context-root>要素を更新します。詳細は、第17.7.2項「アクセスURLの名前の変更」を参照してください。

  11. <OHW_HOME>ディレクトリをEARファイルに圧縮します。

  12. Oracle WebLogic Serverを起動してEARファイルをデプロイします。Oracle WebLogic Serverが実行されている場合は、サーブレットを最後に起動してから加えた変更が有効になるように、シャットダウンしてから再起動する必要があります。EARファイルのデプロイの詳細は、Oracle Fusion Middleware Oracle WebLogic Server管理コンソール・オンライン・ヘルプのエンタープライズ・アプリケーションのインストールに関する項を参照してください。

  13. ブラウザでhttp://<hostname>:<port>/<OHW-RC_deployment_name>/ohguide/を指定します。<hostname>は、Oracle WebLogic Serverがインストールされているシステムの名前です。

    デモ・ヘルプ・システムの最初のページがブラウザに表示されます。複数のヘルプセットがある場合は、ツールバーのドロップダウン・リストを使用して1つのヘルプセットを選択し、ヘルプセット・スイッチャをクリックして、選択したヘルプセットのみの目次および索引を表示します。テキスト検索では、選択したヘルプセットの項目のみ検索されます。

17.7 OHWのアクセスURLの変更

OHWにアクセスするURLは、http://<hostname>:<port>/mymodule/ohguide/です。<hostname>は、OHWおよびOracle WebLogic Serverがインストールされているシステムの名前です。

このURLは、次の方法で変更できます。

17.7.1 アクセスURLの最後のURL要素の変更

URLの最後にあるhelpを変更するには、<OHW_HOME>\<OHW_deployment_name>\WEB-INFのweb.xmlを編集します。

<servlet-mapping>のパラメータである<url-pattern>に、OHWへのアクセスに使用するURLを指定します。たとえば、<url-pattern>を、デフォルトの/help/*から/onlinereference/*に変更した場合、OHWへのアクセスに使用するURLはhttp://<hostname>:<port>/mymodule/onlinereference/となります。

次に例を示します。

<servlet-mapping>
   <servlet-name>mymodule</servlet-name>
   <url-pattern>/onlinereference/*</url-pattern>
</servlet-mapping>

17.7.2 アクセスURLの名前の変更

アプリケーションのアクセスURLを変更するには、<OHW_HOME>\META-INFにあるapplication.xml内で、<web>要素の下の<context-root>要素エントリを編集します。

<web>
   <web-uri>my_module.war</web-uri>
   <context-root>my_module</context-root>
</web>

たとえば、OHWのアクセスURLをhttp://<hostname>:<port>/jdeveloper/help/にする場合は、ルート要素を次のように変更します。

<web>
   <web-uri>my_module.war</web-uri>
   <context-root>jdeveloper</context-root>
</web>

17.8 スタンドアロンWebアプリケーションとしてのOHWのデプロイ

OHWのデプロイ方法の1つに、スタンドアロンWebアプリケーションとしてデプロイする方法があります。OHWをスタンドアロン・アプリケーションとしてデプロイするには、OHWの実行に必要なすべてのファイルを含むOHWのWARファイルを、専用のコンテキスト・パスを持つアプリケーション・サーバーの個別のデプロイ・ディレクトリにコピーする必要があります。

次に説明するように、OHW管理者は、主要なタスクを実行してから、スタンドアロンWebアプリケーションとしてOHWヘルプ・システムをデプロイする必要があります。タスクの詳細は、第17章「OHWのデプロイメントの理解」を参照してください。

17.8.1 OHWのアーティファクトのインストール

Oracle WebLogic Serverおよび他のサーブレット・コンテナでは、OHWのモジュールをWAR (Web ARchive)ファイルとして圧縮できます。これらのファイルは、WARファイル、JAR (Java ARchive)ファイルおよびOHWのインストール可能ファイルをラップするEAR (Enterprise ARchive)ファイルとしてデプロイされます。これを行うには、標準のJava JARユーティリティを使用して、WARまたはEARファイルを作成する方法があります。

OHWのWARまたはEARファイルは、WebクライアントがOHWのページにアクセスできるように、アプリケーション・サーバーによって解凍される必要があります。WARまたはEARファイルのデプロイ方法については、関連するアプリケーション・サーバーのガイドラインも参照してください。

また、Oracle JDeveloper StudioのようなWeb開発環境で、Webアプリケーションを手動で作成し、ライブラリ・パスにohw-rcf.jar、ohw-share.jarおよびhelp-share.jarを含め、public htmlディレクトリにohw-rcf-webapp.zipを解凍する方法もあります。

17.8.2 スタンドアロンWebアプリケーションとしてのOHWの構成

すべてのファイルを正しい場所に配置した後、OHWが機能するためには、OHW管理者が一部の構成ファイルを変更する必要があります。

  • JSFおよびTrinidadパラメータを含むようにweb.xmlファイルを変更します。

    次に例を示します。

    <?xml version = '1.0' encoding = 'UTF-8'?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... >
  <context-param>
    <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
    <param-value>client</param-value>
  </context-param>
  <context-param>
    <param-name>org.apache.myfaces.trinidad.CHECK_FILE_MODIFICATION</param-name>
    <param-value>false</param-value>
  </context-param>
  ...
  ...
</web-app>

  • OHWフロント・サーブレットおよびJSFフィルタをサポートするようにweb.xmlを変更します。

    次に例を示します。

    <?xml version = '1.0' encoding = 'UTF-8'?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... >
  ...
  ...
  <filter>
    <filter-name>trinidad</filter-name>
    <filter-class>
        org.apache.myfaces.trinidad.webapp.TrinidadFilter
    </filter-class>
  </filter>
  <filter-mapping>
    <filter-name>trinidad</filter-name>
    <servlet-name>Faces Servlet</servlet-name>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>REQUEST</dispatcher>
  </filter-mapping>
  <servlet>
    <servlet-name>Faces Servlet</servlet-name>
    <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet>
    <servlet-name>OHW Servlet 1</servlet-name>
    <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
    <init-param>
      <param-name>ohwConfigFileURL</param-name>
      <param-value>/helpsets/ohwconfig.xml</param-value>
    </init-param>
    <load-on-startup>2</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>OHW Servlet 1</servlet-name>
    <url-pattern>/ohguide/*</url-pattern>
  </servlet-mapping> 
  ...
  ...
</web-app>

  • ohwconfig.xmlとhelpsetsディレクトリを作成していない場合は、第17.6項「OHWでのカスタム・ヘルプセットの表示の構成」の手順1、2および3の説明に従って、ファイルとディレクトリを作成してください。

    作成している場合、ohwconfig.xmlを変更し、ヘルプ・コンテンツを必要に応じて編集します。表示するヘルプセットと、それらの表示方法を指定します。ロケール、ブランド情報およびその他各種設定も指定できます。このファイルの名前と場所は、ohwConfigFileURLサーブレット初期化パラメータとして設定されます。このパラメータは、サーブレット・コンテナごとに個別に処理されます。ohwConfigFileURLパラメータは、param-valueを指定するweb.xmlで定義されます。

    この構成ファイルの詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。

アプリケーションのEARファイルの外部でヘルプ・コンテンツを指定する場合、web.xmlファイルを構成する必要があります。<param-value>要素では、変数を使用して、ohwconfig.xmlのパスを次の構文で定義できます。

<init-param>
  <param-name>ohwConfigFileURL</param-name>
  <param-value>
    file:///{%yourVariableName}/help/ohwconfig.xml
  </param-value>
</init-param>

OHWのパスで変数({%yourVariableName}など)が検出されると、同じ名前のJavaシステム・プロパティ(yourVariableName)が検索され、その変数値がJavaシステム・プロパティに定義されている値に置き換えられます。Javaシステム・プロパティは、Oracle WebLogic Serverの起動スクリプトで定義できます。

[Ctrl]+[N]のショートカット・キーによる新しいヘルプ・ウィンドウのオープンのサポート

web.xmlを構成して、ユーザーが[Ctrl]キーを押しながら[N]キーを押した場合に、新しいブラウザ・ウィンドウが開かれるように設定できます。次のコードをweb.xmlに追加して、ショートカット・キーのサポートを有効にします。

<context-param>
  <param-name>oracle.adf.view.rich.newWindowDetect.OPTIONS</param-name>
  <param-value>on</param-value>
</context-param>

部分ページ移動のサポート

パフォーマンスを向上させるために、OHWでの部分ページ移動を有効にできます。デフォルトでは、部分ページ移動のサポートはADF Facesアプリケーションで無効ですが、次のコードをweb.xmlに追加して、ヘルプセット内での使用を有効にできます。

<context-param>
  <param-name>oracle.adf.view.rich.pprNavigation.OPTIONS</param-name>
  <param-value>onWithForcePPR</param-value>
</context-param>

17.9 Webアプリケーションの一部としてのOHWのデプロイ

OHWのデプロイ方法として、Webアプリケーションと共存させる方法があります。Webアプリケーションとして、JSF、ADFまたはJSPアプリケーション、あるいはJava EE Webアプリケーションを使用できます。これにより、OHWを既存のアプリケーションに含まれるWebプロジェクトの1つとしてデプロイできるようになります。

既存のWebアプリケーションの一部としてOHWをデプロイする場合、WebアプリケーションとOHWヘルプ・システムでは、どちらも同じweb.xmlを共有します。このため、OHWヘルプ・システムの詳細なチューニングが制限され、アプリケーションで競合が生じる場合があります。OHWをWebアプリケーションから個別にデプロイして、ヘルプ・システムとアプリケーションをリンク付けることをお薦めします。詳細は、第17.8項「スタンドアロンWebアプリケーションとしてのOHWのデプロイ」を参照してください。アプリケーションでADF Facesを使用する場合、ADFアプリケーションのADF FacesコンポーネントでhelpTopicId属性を使用できます。詳細は、第19.2項「オンライン・ヘルプとADF Facesアプリケーションの統合」を参照してください。

17.9.1 OHWのアーティファクトのインストール

ohw-rcf-webapp.zipを、既存のWebアプリケーションのpublic_htmlフォルダ(またはWebアプリケーションのルート・ディレクトリ)に解凍します。

ohw-rcf.jar、ohw-share.jarおよびhelp-share.jarファイルを、アプリケーションのWEB-INF/libフォルダ、または定義されたライブラリ・フォルダにコピーします。JDeveloperで開発している場合は、これらのJARファイルをプロジェクト(「プロジェクト・プロパティ」 > 「ライブラリとクラスパス」)に追加してください。

17.9.2 Webアプリケーションの一部としてのOHWの構成

すべてのファイルを正しい場所に配置した後、OHWが機能するためには、OHW管理者が一部の構成ファイルを変更する必要があります。

  • JSFおよびTrinidadパラメータがない場合は、これらを含むようにweb.xmlファイルを変更します。

    次に例を示します。

    <?xml version = '1.0' encoding = 'UTF-8'?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... >
  <context-param>
    <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
    <param-value>client</param-value>
  </context-param>
  <context-param>
    <param-name>org.apache.myfaces.trinidad.CHECK_FILE_MODIFICATION</param-name>
    <param-value>true</param-value>
  </context-param>
  ...
  ...
</web-app>

  • OHWフロント・サーブレットおよびJSFフィルタをサポートするようにweb.xmlを変更します。

    OHWが既存のアプリケーションの一部であるため、OHW管理者は、load-on-startup順序が、正しい順序で維持されているかどうかを確認する必要があります。

    次に例を示します。

    <?xml version = '1.0' encoding = 'UTF-8'?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... >
  ...
  ...
  <filter>
    <filter-name>trinidad</filter-name>
    <filter-class>
        org.apache.myfaces.trinidad.webapp.TrinidadFilter
    </filter-class>
  </filter>
  <filter-mapping>
    <filter-name>trinidad</filter-name>
    <servlet-name>Faces Servlet</servlet-name>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>REQUEST</dispatcher>
  </filter-mapping>
  <servlet>
    <servlet-name>Faces Servlet</servlet-name>
    <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet>
    <servlet-name>product1</servlet-name>
    <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
    <init-param>
      <param-name>ohwConfigFileURL</param-name>
      <param-value>/helpsets/product1/ohwconfig.xml</param-value>
    </init-param>
    <load-on-startup>2</load-on-startup>
  </servlet>
  ...
  ...
</web-app>

  • ohwconfig.xmlを変更し、必要に応じてヘルプ・コンテンツを編集します。ヘルプセットまたはohwconfig.xmlファイルを作成していない場合は、手順1、2および3の説明に従って作成してください。

    ohwconfig.xmlファイルは、表示するヘルプセットと、それらの表示方法を指定します。ロケール、ブランド情報およびその他各種設定も指定できます。このファイルの名前と場所は、(web.xmlで定義される)ohwConfigFileURLサーブレット初期化パラメータとして設定されます。このパラメータは、サーブレット・コンテナごとに個別に処理されます。この構成ファイルの詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。

17.10 1つのWebアプリケーションへの複数ヘルプ・インスタンスのデプロイ

OHWでは、1つのWebアプリケーションまたはエンタープライズ・アプリケーションに、複数のヘルプ・インスタンス(1つのヘルプ・インスタンスには複数のヘルプセットが含まれる場合があります)をデプロイすることがサポートされています。このサポートの主な理由の1つは、OHW構成からのアップグレード時に必要となる変更を最小限に抑えるためです。OHWの複数ヘルプ・インスタンスのデプロイは、JSFサーブレットにリクエストを転送するOHWフロント・サーブレットを用意することによって可能になります。

17.10.1 アプリケーションおよびOHWの構成ファイルの設定

OHWフロント・サーブレットにサーブレット・マッピングを追加するように、アプリケーションのweb.xmlファイルを変更する必要があります。

次に、OHWの複数ヘルプ・インスタンスのデプロイをサポートするために必要な変更を行ったweb.xmlファイルの例を示します。

<!-- configuration for product1 help front servlet -->
<servlet>
  <servlet-name>product1</servlet-name>
  <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
  <init-param>
    <param-name>ohwConfigFileURL</param-name>
    <param-value>/helpsets/product1/ohwconfig.xml</param-value>
  </init-param>
  <load-on-startup>2</load-on-startup>
</servlet>
 
<!-- configuration for product2 help front servlet -->
<servlet>
  <servlet-name>product2</servlet-name>
  <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
  <init-param>
    <param-name>ohwConfigFileURL</param-name>
    <param-value>/helpsets/product2/ohwconfig.xml</param-value>
  </init-param>
  <load-on-startup>3</load-on-startup>
</servlet>
 
<servlet-mapping>
  <servlet-name>product1</servlet-name>
  <url-pattern>/product1/*</url-pattern>
</servlet-mapping>
 
<servlet-mapping>
  <servlet-name>product2</servlet-name>
  <url-pattern>/product2/*</url-pattern>
</servlet-mapping>

このサンプル・コードには、product1およびproduct2という2つのOHWフロント・サーブレットがあります。各サーブレットは、ユーザー・インタフェースに表示するブックおよびビューのセットを決定するOHW構成ファイルを、個別にロードできます。product1サーブレットは、URLパターン/product1/*にマップされています。これにより、URLの最後の部分にproduct1を含む、リッチOHWのコンテキスト・ルートにマップされたURLを指定すると、このサーブレットに再ルーティングされます。同様に、product2は、URLパターン/product2/*にマップされています。

17.10.2 アプリケーションの実行

OHWをアプリケーション・サーバーに正常にデプロイした後、次のようなURLを使用して、構成済のOHWフロント・サーブレットに接続できます。

http://www.myhelpserver.com:<port>/docs/product1

前例のURLでは、/helpsets/product1/ohwconfig.xmlのOHW構成ファイルをロードするproduct1サーブレットが呼び出され、次のようなURLにリダイレクトされます。

http://www.myhelpserver.com:<port>/docs/faces/helppages/main.jspx?config=product1

また、OHWは(OHWと同様に)、URLに追加されたロケールおよびグループ情報を処理できます。

  前
前 		 次
次
  目次へ移動
目次