ナビゲーション・ヘッダーをスキップ
Oracle Help for the Web開発者ガイド Table of Contents
目次
Previous topic
前へ
Next topic
次へ

デプロイ・バンドルを使用したOC4JでのOHWのデプロイ

Oracle Technology Network(OTN)でダウンロード可能なOracle Help for the Web(OHW)リリース・ファイルの1つに、OHWデプロイ・バンドルがあります。デモ・バンドルとは異なり、デプロイ・バンドルはどのJavaサーブレットに対しても事前構成されていません。OHWデプロイ・バンドルには、UIXおよびOHWに対して最適化された、OHWヘルプ・システムをデプロイするために必要なファイルのみが含まれています。デプロイ・バンドルを使用してOracle9iAS Containers for J2EE(OC4J)でOHWを構成する必要がある場合、このページを参照してください。Apache Tomcatでデプロイする場合は、「デプロイ・バンドルを使用したTomcatでのOHWのデプロイ」を参照してください。

このページでは、次の項目について説明します。

サーバーおよびアプリケーション・ディレクトリ構造の例

OC4JおよびOHWの基本インストールと一貫性のある一般的なディレクトリ構造の例を次に示します。このページで後述されている手順に従う場合、このサンプル・ディレクトリを見本にしてください。

サーバーの構成:

  +---<mypath>
  |+----j2ee
  ||+-----home
  |||+------config
  ||||--------server.xml
  ||||--------http-web-site.xml
  |.....
  |||+------lib
  ||||--------ohw.jar
  ||||--------uix2.jar
  ||||--------regexp.jar
  ||||--------share.jar
  |.....
  |+----lib
  ||------xmlparserv2.jar
  |.....

アプリケーションの構成:

  +---<mypath>/j2ee/home/applications
  |
  |+----ohw-eapp
  ||+-----META-INF
  |||+------application.xml
  ||+-----project_one
  |||+------cabo (automatically generated at runtime)
  |||+------helpsets
  ||||--------ohwconfig.xml
  ||||+-------Tutorial
  |||||---------OHW help content/images and control files
  ||||+-------UserGuide
  |||||---------OHW help content/images and control files
  |||+------jsLibs
  ||||--------OHW JavaScript files
  |||+------WEB-INF
  ||||--------web.xml
  ||+-----project_two
  |||+------cabo (automaticallygenerated at runtime)
  |||+------helpsets
  ||||--------ohwconfig.xml
  ||||+-------GettingStarted
  |||||---------OHW help content/images and control files
  |||+------jsLibs
  ||||--------OHW JavaScript files
  |||+------WEB-INF
  ||||--------web.xml
  |
  |+----uixresources-eapp
  ||+-----META-INF
  |||+------application.xml
  ||+-----cabo
  |||+------images
  |||+------jsLibs
  |||+------jsps
  |||+------styles
  ||||+-------cache
  |||+------WEB-INF
  ||||--------web.xml
  |.....

OC4Jのインストールとテスト

OC4Jは、スタンドアロン・モードまたはHTTPサーバーと組み合せた状態のどちらかで実行できます。スタンドアロン・モードでは、URLは直接OC4Jに送信されます。HTTPサーバーと組み合せた状態では、URLはHTTPサーバーに送信されます。HTTPサーバーは、HTTPの要求をURLからOC4Jに転送するように構成されています。この項では、OC4Jをスタンドアロン・モードで実行する場合のみについて説明します。OC4JをHTTPサーバーと組み合せた状態で実行する場合の構成は、『Oracle9iAS Containers for J2EE ユーザーズ・ガイド リリース9.0.4』を参照してください。

スタンドアロンOC4Jの最新リリースは、OTN-J(http://otn.oracle.co.jp/products/ias/index.html)からダウンロードできます。

注意: 次に列挙した指示は、システムのパス設定にJava2 SDKバイナリがあることを想定しています。コマンドラインからJava実行可能ファイルおよびJAR実行可能ファイルを実行できない場合、Java2 SDKで提供されているドキュメントに従って解決してください。(推奨はJDK 1.3.1です。)

OC4JのZIPファイル(oc4j_extended.zip)のダウンロード後、次の手順に従ってOC4Jをインストールしてください。

  1. oc4j_extended.zipをサーバーの任意のディレクトリに解凍します。

    これにより、OC4Jディレクトリ構造およびファイルが<mypath>/j2ee/homeディレクトリの下(たとえば<mypath>/j2ee/home/applicationsまたは<mypath>/j2ee/home/configなど)に作成されます。

  2. コンソール・ウィンドウからOC4Jインストール・コマンドを実行します。

    DOSシェルまたはUNIX端末を使用して、カレント・ディレクトリを<mypath>/j2ee/homeディレクトリに変更し、次のコマンドを実行します。

    java -jar oc4j.jar -install

    プロンプトが表示された後、adminユーザーのパスワードを入力します。このパスワードは、後で管理タスクを実行する際に必要になります。

  3. インストールをテストします。

    <mypath>/j2ee/homeディレクトリから、次のコマンドを実行してOC4Jを起動します。

    java -jar oc4j.jar

    OC4Jが起動したことを示す出力、たとえば「OracleAS <version> Containers for J2EE initialized」などが表示されます。

  4. OC4Jが正常に動作していることを確認するために、ブラウザから次にアクセスします。

    http://localhost:8888/

    ブラウザのプロキシ構成設定によっては、OC4Jをホストするマシンの完全なドメイン名を指定する必要があります(たとえば次のとおりです)。

    http://<yourhost.domain.com>:8888/

    インストールが正常に終了した場合は、ブラウザに「OracleAS Containers for J2EE <version> - Up and running」などの初期画面メッセージが表示されます。

OC4Jを停止するには、<mypath>/j2ee/homeディレクトリから次のコマンドを実行します。

java -jar admin.jar ormi://localhost:23791 admin <password> <your admin password> -shutdown

ここで入力するパスワードは、OC4Jをインストールしたときのパスワードと同じである必要があります。

OC4Jを起動するには、<mypath>/j2ee/homeディレクトリから次のコマンドを実行します。

java -jar oc4j.jar

admin.jarコマンドライン・ツールを使用してサーバーを管理する方法は、『Oracle9iAS Containers for J2EE ユーザーズ・ガイド リリース9.0.4』を参照してください。

OHWデプロイ・バンドルのダウンロード

最新情報は、OHWのダウンロード・ページで入手可能なダウンロードおよびインストール方法をチェックしてください。

  1. OHWデプロイ・バンドルをOTN(http://otn.oracle.com/tech/java/help/content.html)からダウンロードします。デプロイ・バンドルのファイル名はohw-deploy-nnn.zipで、nnnはOHWのリリース番号です(たとえばohw-deploy-1_1_1.zip)。このファイルにはOHW、サンプル・ヘルプセットおよびOC4Jサーブレット・エンジンが含まれています。

  2. ohw-deploy-nnn.zipファイルを一時的なディレクトリに解凍します。これにより、次のファイルが解凍されます。
       ohw.jar
       regexp.jar
       share.jar
       uix2.jar
       xmlparserv2.jar
       ohw-install.zip
       uix2-install.zip
       ohwconfig.xml
       web.xml

OHWサーブレットのインストール

この項では、OC4Jがインストールされており、ohw-deploy-nnn.zipファイルがダウンロード済であると想定して説明します。まだ行っていない場合、「OC4Jのインストールとテスト」および「OHWデプロイ・バンドルのダウンロード」を参照してください。

  1. ohw-deploy-nnn.zipから、次のJARファイルを<mypath>/j2ee/home/libにコピーします。

       ohw.jar
       regexp.jar
       share.jar
       uix2.jar
  2. JARファイルのxmlparserv2.jarが<mypath>/libにない場合、ohw-deploy-nnn.zipからこのディレクトリにコピーします。

    xmlparserv2.xmlは、OC4Jをインストールしたときに<mypath>/libに作成されたはずです。

OHWに使用するJ2EEアプリケーションの設定

この項では、OC4JでOHWに使用するJ2EEアプリケーションをセットアップする方法について説明します。ここでは、OC4Jがインストール済であると想定して説明します。まだ行っていない場合、「OC4Jのインストールとテスト」を参照してください。

  1. アプリケーションを格納する次のディレクトリを<mypath>j2ee/home/applicationsの下に作成します。

     <mypath>/j2ee/home/applications/ohw-eapp
     <mypath>/j2ee/home/applications/ohw-eapp/META-INF
    
  2. OHWアプリケーションを、OC4Jサーバー構成ファイルのserver.xmlに追加します。これにより、OHWアプリケーションの名前と場所が定義されます。server.xmlファイルは、Webモジュールで使用される*-web-site.xmlファイルも定義します。

    <mypath>/j2ee/home/configディレクトリにあるserver.xmlファイルをエディタで開き、<application-server></application-server>セクションを変更してOHWアプリケーション情報を追加します。

    ファイルの場所: <mypath>/j2ee/home/config/server.xml

    編集と使用方法の例:

    <application name="ohw-eapp" path="../applications/ohw-eapp" auto-start="true" />

    属性 説明
    application name

    任意の名前。

    path

    server.xml(または .warファイルのパスおよび名前)に対して相対的な、J2EEアプリケーションへのパス。

    auto-start

    OC4J起動時に自動的に起動。trueに設定します。

    注意: WAR/EARファイル・ベースのデプロイは、「WAR/EARファイルを使用したOHWヘルプ・システムのデプロイ」を参照してください。

    server.xmlファイルの例

    
     <?xml ... >
     <!DOCTYPE ... >
    
     <application-server application-directory="../applications"
      deployment-directory="../application-deployments">
       <library path="../tools.jar" />
       <rmi-config path="./rmi.xml" />
       ...
       <global-application name="default" path="application.xml" />
       <application name="ohw-eapp" path="../applications/ohw-eapp" auto-start="true" />
       <global-web-app-config path="global-web-application.xml" />
       <web-site path="./http-web-site.xml" />
       ...
     </application-server>

OHWに使用するUIXリソース・アプリケーションの設定

OHWには、複数のWebモジュールで共有できる、インストール可能な一連のUIXリソース・ファイルが含まれています。これらは、UIXでOHWのUIを作成する場合に使用する、画像、スタイルシート、JSPおよびJavaScriptライブラリ・ファイルです。この項では、OC4JでOHWに使用するUIXリソース・アプリケーションのセットアップ方法を説明します。これにより、同じOC4Jコンテナにある複数のWebモジュールが、インストール可能なUIXリソース・ファイルの1つのコピーを共有できます。

注意: 1.0.8より前のリリースおよび1.1.xのOHWでは、各Webモジュールに、インストール可能なUIXリソース・ファイルのプライベート・コピーがありました。

同じ<mypath>/j2ee/homeディレクトリにある他のアプリケーションによって使用される、それ自体のURLがあるUIXリソース・アプリケーションを別に作成することにより、インストール可能なUIXリソース・ファイルをWebモジュールごとに複製する手間が省けます。ディスク・スペースの使用量が減り、UIXのアップグレード・プロセスが簡略化されるのみでなく、サーバーへのHTTPリクエスト数も確実に減ります。

インストール可能な一連のUIXリソース・ファイルの共有により、UIXで使用される様々な画像、スタイルシート、JSPおよびJavaScriptライブラリ・ファイルが、ブラウザやキャッシュ・テクノロジによってダウンロードやキャッシュされることを回避できます。インストール可能なUIXリソース・ファイルのプライベート・コピーが各Webモジュールにある場合、ファイルは、使用するアプリケーション・モジュールごとに異なるURLでアクセスされます。複数のWebモジュールでリソース・ファイルを共有することにより、ブラウザは、この共有リソースを参照するすべてのアプリケーションに対して、各リソース・ファイルを1回ダウンロードするだけで済みます。

インストール可能なUIXリソース・ファイルの共有の詳細は、JDeveloperのオンライン・ヘルプ(UIXのダウンロード・バンドルが用意されています)で閲覧できる「UIX開発者ガイド」の「インストール」の章を参照してください。

Webアプリケーションにインストール可能なUIXリソース・ファイルをOC4Jでデプロイする方法の手順について、次に説明します。

注意: ブラウザから、XMLファイルにサンプルXMLファイルのコンテンツをコピーする場合、ファイルの先頭の空白を必ず削除してください。

  1. UIXリソース・アプリケーションを格納する次のディレクトリを<mypath>j2ee/home/applicationsの下に作成します。

     <mypath>/j2ee/home/applications/uixresources-eapp
     <mypath>/j2ee/home/applications/uixresources-eapp/META-INF
  2. application.xmlファイルを<mypath>/j2ee/home/applications/uixresources-eapp/META-INFディレクトリにインストールし、UIXのWebモジュールを定義します。

    エディタで、次のコンテンツをapplication.xmlファイルにコピーします。

    ファイルの場所: <mypath>/j2ee/home/applications/uixresources-eapp/META-INF/application.xml

    UIXリソースに使用するapplication.xmlファイルの例:

     <?xml version="1.0"?>
     <!DOCTYPE application PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN"
     "http://java.sun.com/dtd/application_1_3.dtd">
    
     <application>
    
       <display-name>uixresources-eapp</display-name>
       <module>
         <web>
           <web-uri>cabo</web-uri>
           <context-root>/</context-root>
         </web>
       </module>
    
     </application>

    注意: <web-uri>は、caboに設定されています。これはインストール可能なUIXリソース・ファイルが含まれるWebモジュールのURI/ディレクトリ名です。<context-root>はWebモジュールのルートです。Webモジュール・ファイルがディレクトリにデプロイされる場合、通常は「/」になります。

  3. uix2-install.zip(ohw-deploy-nnn.zipを解凍して取得)を<mypath>/j2ee/home/applications/uixresources-eappディレクトリに解凍します。

    これによりcaboディレクトリが作成され、サブディレクトリのimagesstylesjspsおよびjsLibsが、次のように<mypath>/j2ee/home/applications/uixresources-eappの下にインストールされます。

      <mypath>/j2ee/home/applications/uixresources-eapp/cabo/images/<files>
      <mypath>/j2ee/home/applications/uixresources-eapp/cabo/jsLibs/<files>
      <mypath>/j2ee/home/applications/uixresources-eapp/cabo/jsps/<files>
      <mypath>/j2ee/home/applications/uixresources-eapp/cabo/styles/<files>
  4. UIXのWebモジュールで使用されるweb.xmlファイルをインストールします。

    <mypath>/j2ee/home/applications/uixresources-eapp/cabo/WEB-INFディレクトリを作成し、次のコンテンツをweb.xmlファイルにコピーします。

    UIXのWebモジュールで使用されるweb.xmlの例:

     <?xml version="1.0"?>
     <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
     "http://java.sun.com/j2ee/dtds/web-app_2_3.dtd">
    
     <web-app>
    
     </web-app>

    web.xmlファイルは基本的に空ですが、UIXのWebモジュールをデプロイするために必要です。

  5. UIXリソース・アプリケーションを、OC4Jサーバー構成ファイルのserver.xmlに追加します。

    <mypath>/j2ee/home/configディレクトリにあるserver.xmlファイルをエディタで開き、<application-server></application-server>セクションを変更してUIXリソース・アプリケーション情報を追加します。

    ファイルの場所: <mypath>/j2ee/home/config/server.xml

    編集の例:

     <application name="uixresources-eapp" path="../applications/uixresources-eapp" auto-start="true" />

    server.xmlファイルの例

    
     <?xml ... >
     <!DOCTYPE ... >
    
     <application-server application-directory="../applications"
      deployment-directory="../application-deployments">
       <library path="../tools.jar" />
       <rmi-config path="./rmi.xml" />
       ...
       <global-application name="default" path="application.xml" />
       <application name="ohw-eapp" path="../applications/ohw-eapp" auto-start="true" />
       <application name="uixresources-eapp" path="../applications/uixresources-eapp" auto-start="true" />
       <global-web-app-config path="global-web-application.xml" />
       <web-site path="./http-web-site.xml" />
       ...
     </application-server>
  6. Webモジュールのアクセス位置を、http-web-site.xml構成ファイルにあるUIXリソース・アプリケーションにバインドします。

    http-web-site.xmlファイルをエディタで開き、UIXのWebモジュールのアクセス位置をルート要素<web-site>の子として追加します。

    ファイルの場所: <mypath>/j2ee/home/config/http-web-site.xml

    編集と使用方法の例:

     <web-app application="uixresources-eapp" name="cabo" root="/cabo" />
    属性 説明
    application

    Webモジュールがバインドされる、インストール可能なUIXリソースに使用するJ2EEアプリケーションの名前。server.xmlに設定されているアプリケーション名と一致します(ステップ5を参照)。

    name

    UIXのWebモジュールの名前。caboファイルがあるディレクトリへのパスを表します。ステップ2のweb-uriの名前と一致します。

    root URLで使用される名前。ルートURLの名前は、これとは異なります。

    http-web-site.xmlファイルの例

    
     <?xml version="1.0"?>
     <!DOCTYPE web-site PUBLIC "Orion Web-site" "http://xmlns.oracle.com/ias/dtds/web-site.dtd">
    
     <web-site port="8888" display-name="Default Oracle9iAS Containers for J2EE Web Site">
       <default-web-app application="default" name="defaultWebApp" />
       ...
       ...
       <web-app application="uixresources-eapp" name="cabo" root="/cabo" />
       <access-log path="../log/http-web-access.log" />
     </web-site>
  7. インストール可能なUIXリソース・ファイルのプライベート・コピーがインストールされている場合、すべて削除します。

    共有されているインストール可能なUIXリソース・ファイルは、そのプライベート・コピーをインストールしなければ、同じサーブレット・エンジン・インスタンスにデプロイされたWebモジュールで使用できます。

OHWヘルプセットを格納するディレクトリ構造の準備

ここでは、OHWアプリケーションがセットアップ済であると想定して説明します。まだ行っていない場合、「OHWに使用するJ2EEアプリケーションの設定」を参照してください。

次の手順に従って、OHWヘルプ・システムをデプロイするためのディレクトリ構造を準備してください。

  1. 各ヘルプ・システムに、次のWebモジュール・ディレクトリを<mypath>j2ee/home/applications/ohw-eappの下に作成します。
     <mypath>/j2ee/home/applications/ohw-eapp/project_one/helpsets
     <mypath>/j2ee/home/applications/ohw-eapp/project_one/WEB-INF
    

    通常、そして使用しやすいように、開発中のプロジェクトのヘルプセットは、helpsetsディレクトリまたはその下に格納されます。

    数個のヘルプセットが含まれる2つの大きいヘルプ・システムがある場合、ヘルプ・システムごとにWebモジュール・ディレクトリを作成する必要もあるでしょう。たとえば、project_oneおよびproject_twoという2つのヘルプ・システムがある場合、次が作成できます。

     <mypath>/j2ee/home/applications/ohw-eapp/project_one/helpsets
     <mypath>/j2ee/home/applications/ohw-eapp/project_one/WEB-INF
     <mypath>/j2ee/home/applications/ohw-eapp/project_two/helpsets
     <mypath>/j2ee/home/applications/ohw-eapp/project_two/WEB-INF
  2. Webモジュールごとに、OHWヘルプ・システムを構成するヘルプ・コンテンツ・ファイルおよび制御ファイルをhelpsetsディレクトリに配置するか、またはhelpsetsの下にサブディレクトリを作成してその中に配置します。

    たとえば、WebモジュールにTutorialおよびUserGuideという2つのヘルプセットがある場合、次を作成します。

      <mypath>/j2ee/home/applications/ohw-eapp/project_one/helpsets/Tutorial
      <mypath>/j2ee/home/applications/ohw-eapp/project_one/helpsets/UserGuide
    

    Webモジュールにあるヘルプセットは実行時にマージされるので、複数の作成者が複数のヘルプセットを作成した場合でも、それらをシームレスにマージできます。マージの動作はOHW構成ファイル(デフォルトはohwconfig.xml)に設定されている属性によって指定されます。

    設定に関係なく、ヘルプセット・ファイル、ヘルプ・トピック(HTML)ファイルおよびその他の制御ファイル(索引、目次など)を含むすべてのヘルプ・ファイルを、ヘルプセット・ディレクトリに配置します。制御ファイルの詳細は、「ファイルについて」を参照してください。ヘルプセットにJARファイルを使用している場合は、JARファイルも配置します。(JAR形式および非JAR形式のヘルプセットを、同じデプロイで使用できます。)

    注意: デフォルトでは、ヘルプセットと同じ場所にあるヘルプ・トピックのHTMLファイルはOHWによって自動的に処理されます。リモートでヘルプ・トピックのHTMLファイルを使用する場合は、「OHW構成ファイル」を参照してください。

  3. 各Webモジュール(たとえばproject_one)で、ohw-install.zip(ohw-deploy-nnn.zipを解凍して取得)を<mypath>j2ee/home/applications/ohw-eapp/project_one Webモジュール・ディレクトリに解凍します。

    これによりjsLibsというサブディレクトリが作成され、OHWのJavaScriptファイルが、たとえば次のようなサブディレクトリに格納されます。

      <mypath>/j2ee/home/applications/ohw-eapp/project_one/jsLibs/<files>
  4. (オプション)各Webモジュール(たとえばproject_one)で、uix2-install.zip(ohw-deploy-nnn.zipを解凍して取得)を<mypath>/j2ee/home/applications/ohw-eapp/project_one Webモジュール・ディレクトリに解凍します。

    これによりcaboサブディレクトリ構造が作成され、画像、JavaScriptおよびスタイルシートなどの、共有できるインストール可能なUIXリソース・ファイルが次のディレクトリに格納されます。

      <mypath>/j2ee/home/applications/ohw-eapp/project_one/cabo/images/<files>
      <mypath>/j2ee/home/applications/ohw-eapp/project_one/cabo/jsLibs/<files>
      <mypath>/j2ee/home/applications/ohw-eapp/project_one/cabo/jsps/<files>
      <mypath>/j2ee/home/applications/ohw-eapp/project_one/cabo/styles/<files>
      

    注意: これは最も簡単なディレクトリ設定で、インストール可能なUIXリソース・ファイルのプライベート・コピーが各Webモジュールにあります。さらに効果的なソリューションである、複数のWebモジュールでUIXファイルの1つのコピーを共有する方法は、「OHWに使用するUIXリソース・アプリケーションの設定」を参照してください。

1つ以上のヘルプセットのOHW構成ファイルへの追加

ここでは、OHWのヘルプ・コンテンツ・ファイルおよび制御ファイルをhelpsetsディレクトリにインストール済であると想定して説明します。まだ行っていない場合、「OHWヘルプセットを格納するディレクトリ構造の準備」を参照してください。

ohwconfig.xmlは、唯一の非OC4J構成ファイルです。特にこのファイルは、OHWで使用するヘルプセットが格納されている場所を定義します。一度設定すれば、ohwconfig.xmlファイルは通常編集する必要がありません。ヘルプ・コンテンツをリフレッシュすると、ヘルプセットが追加される場合があるので、その際は指定する必要があります。

次の手順に従って、1つ以上のヘルプセットをOHW構成ファイルに追加してください。

  1. ohwconfig.xmlファイル(ohw-deploy-nnn.zipファイルを解凍して取得)を<mypath>/j2ee/home/applications/ohw-eapp/project_one/helpsetsディレクトリに解凍します。

  2. ohwconfig.xmlファイルをエディタで開き、開発中のヘルプセットおよびヘルプ・トピックのHTMLファイルの場所を<books></books>セクションに指定します。

    <books>要素には、任意の数のヘルプセットまたはHelpBook、または両方の組合せを含めることができます。ヘルプセットは実行時にマージされるので、複数の作成者が複数のヘルプセットを作成した場合でも、それらをシームレスにマージできます。マージの動作はcombineBooks属性およびuseLabelInfo属性によって指定されます。Oracle Helpのヘルプ・トピックHTMLファイルが、Oracle Helpによって予定されていた場所以外に格納された場合、<helpSet>要素には0個以上の<contentLocation>要素を含めることができます。その際、<contentLocation>要素は、一連のヘルプ・トピックHTMLファイルのルート位置を指定するために使用されます。ohwconfig.xmlファイルに設定されているこれらの要素の詳細は、「OHW構成ファイル」を参照してください。

    ファイルの場所: j2ee/home/applications/ohw-eapp/project_one/helpsets/ohwconfig.xml

    編集と使用方法の例:

     <books combineBooks="true" useLabelInfo="true">
       <helpSet jar="UserGuide/project_one.jar" location="project_one.hs" />
       <helpSet location="Tutorial/overview.hs" />
         <contentLocation baseURI="http://www.myCompany.com/help/" />
       </helpSet>
     </books>
    属性 説明
    combineBooks

    trueの場合、実行時に「目次」および「索引」を含むナビゲータ(タブ)の1セットにヘルプセットを結合します。

    useLabelInfo

    trueの場合、作成者定義のラベルが、マージされたヘルプセット/HelpBookのナビゲータ(タブ)に使用されます。

    jar

    ohwconfig.xmlに対して相対的な、.jarファイルへのパス。 OHWでは、コンテンツが.jarファイルに格納されている必要はありません。しかし、ほとんどの製品ではファイル管理を容易にするために、そのように設定されています。

    location

    .hsヘルプセット定義ファイルの場所。.jarファイルが使用されている場合、場所は .jarファイルの最上部に相対しています。.jarファイルが使用されていない場合、ohwconfig.xmlファイルに相対しています。

    baseURI

    ヘルプ・コンテンツのセットのルート位置を示す絶対URI。他の場所または他のWebサーバーにあるファイルの場合もあります。

    ohwconfig.xmlファイルの例

     <helpConfiguration>
    
       <branding>
         ...
       </branding>
    
       <localeSettings>
         ...
       </localeSettings>
    
       <books combineBooks="false" useLabelInfo="true">
         <helpSet jar="UserGuide/project_one.jar" location="project_one.hs" />
         <helpSet location="Tutorial/overview.hs" />
           <contentLocation baseURI="http://www.myCompany.com/help/" />
         </helpSet>
       </books>
    
       <parameters>
        ...
       </parameters>
    
     </helpConfiguration>

OHWに使用する1つ以上のWebモジュールの設定

この項では、Webモジュール・ディレクトリをOHWヘルプ・システムに作成済であると想定して説明します。まだ行っていない場合、「OHWヘルプセットを格納するディレクトリ構造の準備」および「1つ以上のヘルプセットのOHW構成ファイルへの追加」を参照してください。

次の手順に従って、1つ以上のWebモジュールをOC4Jでデプロイするために設定します。

  1. 各モジュールで、Webモジュール情報をOC4J構成ファイルのapplication.xmlに追加します。これにより、Webモジュール・ファイルがデプロイされる場所へのパスが定義されます。

    ohw-demo-nnn.zipにはサンプルapplication.xmlファイルが含まれています。このファイルをコピーおよび変更したり、または独自のファイルを作成(後述のサンプル・ファイルを参照)したりできます。

    各Webモジュールの<mypath>/j2ee/home/applications/ohw-eapp/META-INFおよび<module></module>セクションに、application.xmlファイルをエディタで作成または開きます。

    ファイルの場所: <mypath>/j2ee/home/applications/ohw-eapp/META-INF/application.xml

    編集と使用方法の例:

     <module>
    <web>
    <web-uri>project_one</web-uri>
    <context-root>/</context-root>
    </web>
    </module>
    属性 説明
    web-uri

    J2EEアプリケーション(または.warファイル名)からWebモジュールへのパス。

    context-root

    Webモジュールのルート。Webモジュール・ファイルがディレクトリにデプロイされる場合、通常は「/」になります。

    注意: WAR/EARファイル・ベースのデプロイは、「WAR/EARファイルを使用したOHWヘルプ・システムのデプロイ」を参照してください。

    application.xmlファイルの例

     <?xml version="1.0"?>
    <!DOCTYPE application PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN" "http://java.sun.com/dtd/application_1_3.dtd"> <application> <display-name>ohw-eapp</display-name> <module> <web> <web-uri>project_one</web-uri> <context-root>/</context-root> </web> </module> <module> <web> <web-uri>project_two</web-uri> <context-root>/</context-root> </web> </module> </application>
  2. 各Webモジュールで、web.xmlファイル(ohw-deploy-nnn.zipを解凍して取得)を<mypath>/j2ee/home/applications/ohw-eapp/project_one/WEB-INFディレクトリに配置します。

    このサンプル・サーブレット構成ファイルは、ohwconfig.xmlファイルが<mypath>/j2ee/home/applications/ohw-eapp/project_one/helpsetsディレクトリにあるかぎり、変更せずに使用できます。独自のweb.xmlファイルを作成することも可能です。

    ファイルの場所: j2ee/home/applications/ohw-eapp/project_one/WEB-INF/web.xml

    使用方法の例:

     <init-param>
       <param-name>configFileName</param-name>
       <param-value>/helpsets/ohwconfig.xml</param-value>
     </init-param>
    属性 説明
    param-name

    configFileNameは、OHWで使用されるパラメータ名です。変更しないでください。

    param-value

    サーブレットのコンテキスト・パスに対して相対的な、Webモジュールからohwconfig.xmlファイルへのパス。ほとんどのユーザーは、このパラメータを変更しないことをお薦めします。

    使用方法の例:

     <servlet-mapping>
       <servlet-name>OHW</servlet-name>
       <url-pattern>/</url-pattern>
     </servlet-mapping>
    属性 説明
    servlet-name

    URLパターンが適用されるOHWサーブレット。変更しないでください。

    url-pattern

    OHWサーブレットの位置を示すURL。たとえば、Webモジュール名がproject_oneでURLパターンが/help/*の場合、OHWにアクセスするURLはhttp://myname.oracle.com:8888/project_one/help/になります。

    web.xmlファイルの例

     <?xml version="1.0"?>
    <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/j2ee/dtds/web-app_2_3.dtd"> <web-app> <login-config>
    <auth-method>BASIC</auth-method>
    </login-config>
    <servlet> <servlet-name>OHW</servlet-name> <servlet-class>oracle.help.OHW</servlet-class> <init-param> <param-name>configFileName</param-name> <param-value>/helpsets/ohwconfig.xml</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>OHW</servlet-name> <url-pattern>/help/*</url-pattern> </servlet-mapping> </web-app>
  3. Webモジュールを追加する場合、ステップ1と2を繰り返します。

1つ以上のWebモジュールのOHWアプリケーションへのバインド

この項では、1つ以上のWebモジュールをOHWヘルプ・システムに定義済であると想定して説明します。まだ行っていない場合、「OHWヘルプセットを格納するディレクトリ構造の準備」「1つ以上のヘルプセットのOHW構成ファイルへの追加」および「OHWに使用する1つ以上のWebモジュールの設定」を参照してください。

次の手順に従って、1つ以上のWebモジュールをOHWアプリケーションにバインドしてください。

  1. 各Webモジュールで、http-web-site.xmlファイルのWebモジュールのアクセス位置をOHWアプリケーションにバインドします。

    <mypath>/j2ee/home/configにあるhttp-web-site.xmlをエディタで開き、Webモジュールごとに次の行を追加します。

    
     <web-app application="ohw-eapp" name="project_one" root="/project_one" />

    ファイルの場所: j2ee/home/config/http-web-site.xml

    編集と使用方法の例:

     <web-app application="ohw-eapp" name="project_one" root="/project_one" />
    属性 説明
    application

    Webモジュールがバインドされる、OHWに使用するJ2EEアプリケーションの名前。server.xmlに設定されているアプリケーション名と一致します(「OHWに使用するJ2EEアプリケーションの設定」のステップ2を参照)。

    name

    Webモジュール名(または.war ファイル名)。Webモジュール・ファイルがあるディレクトリへのパスを表します。「OHWに使用する1つ以上のWebモジュールの設定」のステップ1に記述されているweb-uriの名前と一致します。

    root URLで使用される名前。ルートURLの名前は、これとは異なります。

    注意: WAR/EARファイル・ベースのデプロイは、「WAR/EARファイルを使用したOHWヘルプ・システムのデプロイ」を参照してください。

    http-web-site.xmlファイルの例

     <?xml version="1.0"?>
     <!DOCTYPE web-site PUBLIC "Orion Web-site" "http://xmlns.oracle.com/ias/dtds/web-site.dtd">
    
     <web-site port="8888" display-name="Default Oracle9iAS Containers for J2EE Web Site">
       <default-web-app application="default" name="defaultWebApp" />
       <web-app application="ohw-eapp" name="project_one" root="/project_one" />
       <web-app application="ohw-eapp" name="project_two" root="/project_two" />
       <web-app application="uixresources-eapp" name="cabo" root="/cabo" />
    <access-log path="../log/http-web-access.log" /> </web-site>

OC4JでのOHWヘルプ・システムの表示

注意: JAVA_HOME環境変数を、JDK 1.2.2以上(推奨はJDK 1.3.1)がインストールされているホストのディレクトリに設定していることを確認してください。

次の手順に従って、ヘルプ・システムをOHWで表示します。

  1. 「OC4Jのインストールとテスト」で説明されている方法でサーブレット・エンジンを起動します。OC4Jをすでに実行している場合、最後にサーブレットを起動したときから変更された箇所を確認するために、シャットダウンして再起動する必要があります。

  2. ブラウザにhttp://<hostname>:8888/project_one/help/またはhttp://<hostname>:8888/project_two/help/と入力します。ここで<hostname>はOC4JおよびOHWがインストールされているマシンの名前です。

    OC4JがインストールされているコンピュータでOC4Jを表示する場合、ブラウザの構成によってはhttp://localhost:8888/project_one/help/というURLも使用できます。

    ヘルプ・システムの最初のページがブラウザに表示されます。1つ以上のヘルプセットがある場合、ツールバーのドロップダウン・リストからヘルプセットを選択し、「ヘルプセットの切替え」をクリックすれば、選択したヘルプセットのみの目次および索引が表示されます。テキスト検索では、選択したヘルプセット内の項目のみを検索します。

    ページが予定したように表示されない場合、OC4Jによるエラー・メッセージのログがないかどうか、コンソール・ウィンドウをチェックしてください。<mypath>/j2ee/home/logの下にもOC4Jによってエラー・メッセージのログ・ファイルが作成されます。

OHWにアクセスするURLの変更

前述の「OC4JでのOHWヘルプ・システムの表示」で説明したように、OHWヘルプ・システムにアクセスするURLはhttp://<hostname>:8888/project_one/help/で、ここで<hostname>はOHWおよびOC4Jがインストールされているマシンの名前です。

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

URLの末尾のhelpの変更

<mypath>/j2ee/home/applications/ohw-eapp/project_one/WEB-INFにあるweb.xmlファイルを編集し、URLの末尾のhelpを変更します。

web.xmlファイルの例:

 <?xml version="1.0"?>
 <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/j2ee/dtds/web-app_2_3.dtd">

 <web-app>

    <servlet>

       <servlet-name>OHW</servlet-name>
       <servlet-class>oracle.help.OHW</servlet-class>

       <init-param>
          <param-name>configFileName</param-name>
          <param-value>/helpsets/ohwconfig.xml</param-value>
       </init-param>

    </servlet>

    <servlet-mapping>
       <servlet-name>OHW</servlet-name>
       <url-pattern>/help/*</url-pattern>
    </servlet-mapping>

 </web-app>

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

project_oneを他の名前に変更

<mypath>/j2ee/home/configにあるhttp-web-site.xmlファイルを編集して、project_oneを他の名前に変更します。

http-web-site.xmlファイルの例

 <?xml version="1.0"?>
 <!DOCTYPE web-site PUBLIC "Orion Web-site" "http://xmlns.oracle.com/ias/dtds/web-site.dtd">

 <web-site port="8888" display-name="Default Oracle9iAS Containers for J2EE Web Site">
   <default-web-app application="default" name="defaultWebApp" />
   <web-app application="ohw-eapp" name="project_one" root="/project_one" />
   <web-app application="ohw-eapp" name="project_two" root="/project_two" />
   <access-log path="../log/http-web-access.log" />
 </web-site>

root="/project_one"はURLで使用される名前(たとえばhttp://<hostname>:8888/project_one/help/)を指定します。

OHWにアクセスするURLをhttp://<hostname>:8888/developer/help/にする場合、root="/project_one"root="/developer"に変更します。

OHWおよびUIXのアップグレード

OHW/OC4Jインストールをアップグレードする前に、最新のダウンロードとインストール方法を、OHWのダウンロード・ページでチェックしてください。

注意: アップグレードの前にOC4J/OHWインスタンスを停止してください。OHWおよびUIXをアップグレードした後OC4J/OHWを再起動してください。

OHWを新しいリリースにアップグレードするには、OHWおよびUIXのJARファイル、およびOHWのJavaScriptファイル(ohw-install.zipとして配布)を置き換える必要があります。次のとおりにOHWをアップグレードしてください。

  1. 前述の「OHWサーブレットのインストール」の手順を繰り返します。これによりOHWおよびUIXのJARファイルが更新されます。

  2. 前述の「OHWヘルプセットを格納するディレクトリ構造の準備」のステップ3を繰り返します。これによりohw-install.zipが解凍され、WebモジュールのjsLibsディレクトリ(たとえば<mypath>/j2ee/home/applications/ohw-eapp/project_one/jsLibs)のファイルが更新されます。

UIXをアップグレードするには、インストール可能なUIXリソース・ファイル(uix2-install.zipとして配布)を置き換える必要があります。インストール可能なUIXリソース・ファイルを新しいリリースにアップグレードするには、次の1つを行います。

WAR/EARファイルを使用したOHWヘルプ・システムのデプロイ

OC4JではOHWのWebモジュールがWAR(Web ARchive)ファイルに圧縮されます。したがって、OHWアプリケーション全体は、WARファイルおよびJARファイルをまとめるEAR(Enterprise ARchive)ファイルとしてデプロイされます。WARファイルおよびEARファイルは、標準JavaのJARユーティリティを使用して作成します。この項では、OC4J、OHWおよび開発中のOHWヘルプ・ファイルがインストール済で、開発中のインスールがテスト済であり、WAR/EARファイルを作成する準備ができていると想定して説明します。

注意: スタンドアロンOC4Jの場合、EAR形式でアーカイブされたアプリケーションを、admin.jarコマンドライン・ルーツを使用してデプロイできます。詳細は、『Oracle9iAS Containers for J2EE ユーザーズ・ガイド リリース9.0.4』を参照してください。開発環境でOracle9iAS 9.0.xを使用しているユーザーの場合、Oracle Enterprise Management(OEM)でデプロイする必要があります。詳細は、『Oracle9i Application Server 管理者ガイド リリース2(9.0.4)』および『Oracle Enterprise Manager管理者ガイド』を参照してください。

OC4JへデプロイするためにOHWのWebモジュールをEARファイルにアーカイブするディレクトリ構造を次に示します。

ディレクトリ構造

  +---<mypath>
  |+----j2ee
  ||+-----home
  |||+------config
  ||||--------server.xml
  ||||--------http-web-site.xml
  |.....
  |.....
  |.....

  +---<mypath>/j2ee/home/applications
  |+----ohw-eapp
  ||+-----META-INF
  |||+------application.xml
  |||-----project_one.war
  |||-----project_two.war
  ||+-----project_one
  |||+------cabo (generated at runtime)
  |||+------helpsets
  ||||--------ohwconfig.xml
  ||||+-------Tutorial
  |||||---------OHW help content/images and control files
  ||||+-------UserGuide
  |||||---------OHW help content/images and control files
  |||+------jsLibs
  ||||--------OHW JavaScript files
  |||+------WEB-INF
  ||||--------web.xml
  ||+-----project_two
  |||+------cabo (generated at runtime)
  |||+------helpsets
  ||||--------ohwconfig.xml
  ||||+-------GettingStarted
  |||||---------OHW help content/images and control files
  |||+------jsLibs
  ||||--------OHW JavaScript files
  |||+------WEB-INF
  ||||--------web.xml
  |.....

WAR/EARファイルを使用してOHWヘルプ・システムをデプロイする場合、次の説明に従ってください。

  1. デプロイに不要なファイル、特にランタイム・テストの際に各Webモジュールに自動的に作成されるcabo/images/cacheサブディレクトリをすべて削除します。

  2. WebモジュールごとにWARファイルを作成します。.warファイルはWebモジュールの最上部に作成されます。Webモジュール・ルートで、次のコマンドを発行します。

     % jar cvfM ../project_one.war *

    Mオプションは、manifest(.MF)ファイルの作成を抑制します。OC4J構成ファイル(application.xml)そのものがmanifestファイルなので、manifestファイルは不要です。.warファイルにはWebモジュールのコンテンツ全体(たとえばproject_oneディレクトリの下の全ファイルおよび全サブディレクトリ)が含まれます。

  3. ohw-eappディレクトリの下のすべてのWebモジュールに対してステップ2を繰り返します。

  4. .war ファイルをOHWアプリケーション・ルート(ohw-eapp)に配置します。

    OC4JへデプロイするためにOHWアプリケーションをEARファイルにアーカイブするディレクトリ構造を次に示します。

    アーカイブ・ディレクトリの形式

        +---ohw-eapp
        ¦ +---META-INF
        ¦ ¦ +--application.xml
        ¦ +---project_one.WAR
        ¦ +---project_two.WAR
  5. application.xmlファイルを変更します。 .warファイル名を<mypath>/j2ee/home/applications/ohw-eapp/META-INFにあるapplication.xmlファイルに追加します。

    一般的に、.warファイルはWebモジュールの最上部を指定する<context-root>とともにアプリケーション(Webモジュールではない)の最上部に配置されています。

    編集の例:

     <application>
       <display-name>ohw-eapp</display-name>
       <module>
         <web>
           <web-uri>project_one.war</web-uri>
          <context-root>/project_one</context-root>
         </web>
       </module>
       <module>
         <web>
           <web-uri>project_two.war</web-uri>
          <context-root>/project_two</context-root>
         </web>
       </module>
     </application>
  6. .earファイルをOHWアプリケーション全体に対して作成します。OHWアプリケーション・ルートで、次のコマンドを発行します。

     % jar cvfM ../ohw.ear *.war META-INF/application.xml

    Mオプションは、manifest(.MF)ファイルの作成を抑制します。OC4J構成ファイル(application.xml)そのものがmanifestファイルなので、manifestファイルは不要です。一般的に、.earファイルは、server.xmlファイルで定義されたとおり、Webアプリケーションへのエントリ・ポイントに配置されます。

    application .earファイル(ohw.ear)にはMETA-INFディレクトリおよびそのapplication.xmlファイルと同様、すべてのWebモジュールの .warファイルが含まれます。

  7. http-web-site.xmlファイルを変更します。.warファイル名を<mypath>/j2ee/home/configにあるhttp-web-site.xmlファイルに追加します。

    編集の例:

     <?xml version="1.0"?>
     <!DOCTYPE web-site PUBLIC "Orion Web-site" "http://xmlns.oracle.com/ias/dtds/web-site.dtd">
    
     <web-site port="8888" display-name="Default Oracle9iAS Containers for J2EE Web Site">
       <default-web-app application="default" name="defaultWebApp" />
       <web-app application="ohw-eapp" name="project_one" root="/project_one" />
       <web-app application="ohw-eapp" name="project_two" root="/project_two" />
       <web-app application="uixresources-eapp" name="cabo" root="/cabo" />
    <access-log path="../log/http-web-access.log" /> </web-site>
  8. server.xmlファイルを変更します。 次のアプリケーション・エントリを<mypath>j2ee/home/configにあるserver.xmlファイルに追加します。

    編集の例:

    
     <?xml ... >
     <!DOCTYPE ... >
    
     <application-server application-directory="../applications"
      deployment-directory="../application-deployments">
       <library path="../tools.jar" />
       <rmi-config path="./rmi.xml" />
       ...
       <global-application name="default" path="application.xml" />
       <application name="ohw-eapp" path="../applications/ohw.ear" auto-start="true" />
       <application name="uixresources-eapp" path="../applications/uixresources-eapp" auto-start="true" />
    <global-web-app-config path="global-web-application.xml" /> <web-site path="./http-web-site.xml" /> ... </application-server>

実行時、OC4Jによって新しい.earファイルまたは変更された.earファイルが検出され、非圧縮されます。これにより、すべての.warファイルが正しいWebモジュール・ディレクトリに非圧縮されます。OC4Jでの.warファイルおよび.earファイルの使用方法の詳細は、『Oracle9iAS Containers for J2EE ユーザーズ・ガイド リリース9.0.4』を参照してください。