ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Help開発者ガイド
11g リリース2(11.1.2.3.0)
B71911-01
  目次
目次
戻る
戻る 		 次へ
次へ		  

19 ADFリッチ・クライアントのヘルプ・プロバイダ

この章では、オンライン・ヘルプとADF Facesアプリケーションの統合方法およびOHWのヘルプ・プロバイダとしての登録方法について説明します。

この章の構成は、次のとおりです。

19.1 ADFリッチ・クライアントのヘルプ・プロバイダについて

ご使用のADF Facesアプリケーションにオンライン・ヘルプを組み込む場合、ADF Faces(ADFリッチ・クライアントとも呼ばれる)には、そのための簡単な方法が用意されています。オンライン・ヘルプ・システムを作成して、アプリケーションのコンポーネントにヘルプ・トピックを統合できます。

この章では、ヘルプ・プロバイダとしてのOHWの構成方法、ADFリッチ・クライアントのその他のヘルプ・プロバイダ、およびHelpTopicId属性を使用してヘルプ・トピックをアプリケーションに関連付ける方法について説明します。

19.2 オンライン・ヘルプとADF Facesアプリケーションの統合

ヘルプ・トピックをADF Facesコンポーネントと統合すると、そのコンポーネントにヘルプ・アイコン(疑問符を青色の円で囲んだもの)が表示されます。ヘルプ・アイコンをクリックすると、図19-1に示すように、関連するヘルプ・トピックが新しいウィンドウに表示されます。

図19-1 ADF Facesアプリケーションのヘルプ・アイコン

図19-1の説明
「図19-1 ADF Facesアプリケーションのヘルプ・アイコン」の説明

オンライン・ヘルプとアプリケーションの統合は、次の手順で実行する簡単なプロセスです。

オンライン・ヘルプとアプリケーションとの統合方法の詳細は、『Oracle Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド』のコンポーネントへのヘルプの表示に関する項を参照してください。

19.3 ADFリッチ・クライアントのヘルプ・プロバイダとしてのOHW-RCの登録

ADF Facesリッチ・クライアントには、多様なヘルプ・プロバイダが用意されています。これらの異なるヘルプ・プロバイダを組み合せるか、独自のヘルプ・プロバイダ・クラスを作成できます。また、ヘルプ・プロバイダとしてOHWを使用することもできます。

ADFリッチ・クライアント・アプリケーションのヘルプ・プロバイダとしてOHWを設定するには、次のタスクを実行する必要があります。

  1. WebアプリケーションとしてOHWをデプロイします。

    1. Webアプリケーション・サーバーにADFアプリケーションをデプロイします。

    2. このデプロイのコンテキスト・ルートを書き留めます。

    3. このデプロイのweb.xmlファイルを開きます。

    4. OHWサーブレット・インスタンスを見つけます。

  2. jspx Webページを開発します。

    1. ADF FacesベースのWebアプリケーションを作成します。

    2. 特定のコンポーネント（input*、select*など）用にjspx Webページを作成し、helpTopicIdという名前の属性を見つけて、OHWインスタンスで表示するIDを指定します。

  3. ヘルプセットをコピーし、<application_root>/public_htmlフォルダの下にあるディレクトリに配置します。たとえば、このディレクトリをhelpsetsという名前にします。

  4. adf-settings.xmlファイルを設定します。

    1. アプリケーションのディレクトリに移動し、.adf/META-INF/ディレクトリを検索します。このディレクトリの下に、adf-settings.xmlファイルがあります。.adf/META-INF/ディレクトリがない場合は、META-INFディレクトリをViewController/srcディレクトリの下に作成します。

    2. adf-settings.xmlにコードを入力します。次に例を示します。

      <adf-settings xmlns="http://xmlns.oracle.com/adf/settings">
 
  <help-provider>
 
    <help-provider-class>oracle.help.web.rich.helpProvider.OHWHelpProvider</help-provider-class>
 
    <property>
      <property-name>ohwConfigFileURL</property-name>
      <value>/helpsets/ohwconfig.xml</value>
    </property>
 
    <!--property>
      <property-name>group</property-name>
      <value>null</value>
    </property-->
 
    <property>
      <property-name>baseURI</property-name>
      <value>http://localhost:8989/help-ohw-rcf-context-root/ohguide/</value>
    </property>
 
  </help-provider>
 
</adf-settings>

      このadf-settings.xmlファイルを、次のように設定してください。

      • OHWをヘルプ・プロバイダとして使用する場合は、このadf-settings.xmlファイルで、クラスをOHWHelpProviderにする必要があります。

      • ohwConfigFileURLプロパティを、/helpsets/ohwconfig.xmlを指すように設定します。helpsetsディレクトリは、手順3で作成したものです。


        注意:

        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>

        propプロパティは、Oracle WebLogic Serverを-Dpropオプションを指定して起動することで事前定義または指定できます。たとえば、-Dprop=/Oracle/helpと指定します。

      • groupプロパティに、ohwconfig.xmlファイルのグループ名（ヘルプ・プロバイダで使用するもの）を指定します。

      • baseURIプロパティに、手順1でデプロイしたRCFアプリケーションの、サーバー・ホスト、コンテキスト・ルートおよびOHWサーブレット・インスタンスを指定します。

19.4 HelpTopicId属性の使用

ヘルプ・トピックをADFコンポーネントに関連付けるには、ヘルプ・トピックの一意のIDをHelpTopicId属性の値として割り当てる必要があります。HelpTopicId属性は、プロパティ・インスペクタの「外観」セクションで使用できます。

図19-2 HelpTopicId属性

図19-2の説明は前後のテキストを参照。

ヘルプ・トピックをコンポーネントに関連付ける前に、アプリケーションにヘルプ・プロバイダが登録されていることを確認してください。ヘルプ・プロバイダとしてOHWを登録する方法については、第19.3項「ADFリッチ・クライアントのヘルプ・プロバイダとしてのOHW-RCの登録」を参照してください。

HelpTopicId属性の詳細は、『Oracle Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド』のコンポーネントへのヘルプの表示に関する項を参照してください。

19.5 その他のヘルプ・プロバイダの使用

ADFリッチ・クライアントの一般的な2つのヘルプ・プロバイダは、ResourceBundleHelpProviderとELHelpProviderです。ResourceBundleHelpProviderでは、リソース・バンドルに定義されているヘルプをADF Facesアプリケーションに表示できます。リソース・バンドルは、ヘルプ・ファイル、制御ファイル、グラフィックおよびその他の関連ファイルのコンテナです。ELHelpProviderでは、XLIFFファイルに定義されているヘルプ・テキストをADF Facesアプリケーションに表示できます。XLIFFファイルはマップに変換されるか、ヘルプ・テキスト文字列のマップを含むマネージドBeanを作成します。ELHelpProviderではヘルプ・ファイルは作成されませんが、このファイルをADF Facesアプリケーションに関連付けるのに役立ちます。

これらおよびその他のヘルプ・プロバイダの詳細は、『Oracle Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド』のコンポーネントへのヘルプの表示に関する項を参照してください。

  戻る
戻る 		 次へ
次へ
  目次
目次