| Oracle® Fusion Middleware Oracle WebLogic Server管理コンソールの拡張 12c (12.1.2) E48058-02 |
|
 前 |
 次 |
この章では、コンソール拡張ヘルプの作成方法とそのヘルプを管理コンソールのヘルプ・システムにマージする方法について説明します。管理コンソールのヘルプ・ビューアは、オープン・ソース・ヘルプ・システムであるJavaHelp 2.0の実装を使用するOracle WebLogic Portal Webアプリケーションです。
この章の内容は以下のとおりです。
コンソール拡張ヘルプ・トピックの作成に必要な主な手順は次のとおりです。
HTMLトピックのファイルとJavahelpコントロールのファイルを含むJavahelpヘルプセットを作成します。
コンソール拡張ヘルプ・トピックから状況依存リンクを確立します。
コンソール拡張を使用してヘルプ・システムをデプロイします。
JavahelpシステムはJavahelpソフトウェアを使用して作成できます。または、Javahelpを作成するヘルプ作成ツールを使用できます。詳細な手順については、Javahelpのドキュメントまたは作成ツールのドキュメントを参照してください。
JavaHelpの詳細およびJavahelpソフトウェアのダウンロードの詳細は、「JavaHelp System」(http://javahelp.java.net/)を参照してください。
管理コンソールのヘルプ・システムに必要なファイルは以下のとおりです。これらのファイルをまとめて「ヘルプセット」と呼びます。
トピックのファイル(.html)
これらのファイルにはヘルプ・コンテンツがあります。これらのファイルを作成するには、HTMLファイルを作成する任意のエディタを使用できます。
ヘルプセット・ファイル(.hs)
このXMLファイルは、マップ・ファイルの名前と場所、ヘルプセットのタイトルなどの情報を含めた拡張ヘルプセットを定義します。
コンソール拡張ヘルプセットでは、Helpsetファイルの名前は拡張の名前で始める必要があります。たとえば、Joltコンソール拡張Helpsetファイルの名前はjolt.hsです。(Joltコンソール拡張は管理コンソールの標準拡張です。)ローカライズされたヘルプセットでは、拡張の名前の最後にロケール情報を追加します。たとえば、jolt_en_US.hs。
マッピング・ファイル(.jhm)
このXMLファイルはコンテキスト・ヘルプIDをヘルプ・トピックにマップします。
目次ファイル(.xml)
このXMLファイルはヘルプの目次を定義します。
省略可能なファイルは以下のとおりです。
索引ファイル(.xml)
このXMLファイルはヘルプの索引を定義します。
全文検索データベース
これらのデータベース・ファイルがJavahelpソフトウェアまたはJavahelpを作成するヘルプ作成ツールの使用によって生成されます。
ヘルプセットをマージし、ローカライズされたヘルプセットを提供するためにはさらに考慮事項があります。詳細は、「拡張ヘルプをマージするためのディレクトリ構造」および「ヘルプセットのローカライズ」を参照してください。
拡張ヘルプセットが構成され、適切に名前が指定されていれば、コンソール拡張ヘルプセットの目次と検索データベースが主要な管理コンソール・ヘルプに自動的にマージされます。拡張ヘルプセットは、ヘルプが管理コンソールと同じサーバー・インスタンスにデプロイされるときにのみマージされます。
管理コンソールのヘルプセット・ファイルはマージ・タイプをJavahelp AppendMergeタイプに設定します。そのタイプは、コンソール拡張ヘルプセットを主要なコンソール・ヘルプにマージする方法を定義します。
Javahelpのマージの詳細は、「ヘルプセットのマージ」(http://www.oracle.com/technetwork/indexes/documentation/index.html)を参照してください。WebLogic Serverにヘルプセットをマージする方法の詳細は、「ヘルプセットをマージする方法」も参照してください。
拡張のヘルプを主要なコンソール・ヘルプにマージするには、ヘルプ・ファイルは次のように構成されていることが必要です。ヘルプセット・ファイルを含めたディレクトリの名前はbea-helpsetsでなければなりません。
...\console_extension\bea_helpsets\extension_name_locale.hs ...\console_extension\bea_helpsets\locale\extension_name-map.jhm ...\console_extension\bea_helpsets\locale\extension_name-toc.xml ...\console_extension\bea_helpsets\locale\extension_name-search\search database files ...\console_extension\bea_helpsets\locale\topics_dir\HTML topic files... ...\console_extension\bea-helpsets\locale\topics_dir\images\Graphic files... ...\console_extension\PortalConfig\... ...\console_extension\WEB-INF\... ...\console_extension\Other extension source directories...
|
注意: HTMLトピックのファイルと画像ファイルは、複数のディレクトリおよびサブディレクトリに配置されている場合がありますが、すべては、 |
例:
...\my_ext\webapp\bea_helpsets\my_ext_en_US.hs ...\my_ext\webapp\bea_helpsets\en_US\my_ext_map.jhm ...\my_ext\webapp\bea_helpsets\en_US\my_ext_toc.xml ...\my_ext\webapp\bea_helpsets\en_US\my_ext-search\search database files... ...\my_ext\webapp\bea_helpsets\en_US\pagehelp\HTML topic files... ...\my_ext\webapp\bea_helpsets\en_US\taskhelp\HTML topic files... ...\my_ext\webapp\bea-helpsets\en_US\taskhelp\images\Graphic files... ...\my_ext\webapp\jsp\... ...\my_ext\webapp\PortalConfig\... ...\my_ext\webapp\WEB-INF\...
複数のローカライズされたヘルプセットを同時にヘルプに含めることができます。特定ロケールのヘルプ・ファイルを検索するには、ヘルプ・ビューアがjava.util.ResourceBundleで使用される方法と同じ方法を使用します。ヘルプ・ビューアは拡張のためにbea-helpsetsディレクトリの下に以下のディレクトリ構造を想定しています。
...\extension_name_locale_1.hs...\extension_name_locale_2.hs...\extension_name_locale_3.hs...\locale_1\map.jhm...\locale_1\toc.xml...\locale_1\search\Search db files......\locale_1\topics\HTML topic files......\locale_1\topics\images\Graphic files...(optional) ...\locale_2\map.jhm...\locale_2\toc.xml...\locale_2\my_search\Search db files......\locale_2\topics\HTML topic files......\locale_1\topics\images\Graphic files...(optional) ...\locale_3\map.jhm...\locale_3\toc.xml...\locale_3\search\Search db files......\locale_3\topics\HTML topic files...\locale_3\topics\images\Graphic files...(optional)
たとえば、図8-1を参照してください。
ブラウザで指定したロケールのヘルプ・コンテンツが見つからない場合は、ヘルプ・ビューアによりデフォルトのフォルダのコンテンツが表示されます。
ユーザーがヘルプ・ビューアから初めてヘルプを要求する場合、管理コンソール・ヘルプセットが解析され、ヘルプセット・オブジェクトが作成されて、捕捉されます。ヘルプ・ビューアが拡張ヘルプセットのサーバー拡張フォルダとドメイン拡張フォルダを検索し、それらを管理コンソール・ヘルプセットにマージします。コンソールは以下の場所で拡張を探します。
WL_HOME/server/lib/console-ext
WL_HOME/server/lib/console-ext/autodeploy
DOMAIN_HOME/console-ext
ヘルプセットが以下のルールに従ってマージされます。
ユーザーが要求したロケールに対するコンソール・ヘルプと拡張ヘルプが存在する場合、拡張ヘルプがコンソール・ヘルプにマージされます。
ユーザーが要求したロケールに対するコンソール・ヘルプと拡張ヘルプが存在しない場合、コンソール・ヘルプが英語で表示されます。ヘルプ・ビューアが英語のロケールのための拡張ヘルプを検索し、それが見つかった場合は、拡張ヘルプがコンソール・ヘルプにマージされます。
ユーザーが要求したロケールのコンソール・ヘルプが存在して、そのロケールの拡張ヘルプが存在しない場合、ヘルプ・ビューアが英語のロケールのための拡張ヘルプを検索し、それが見つかった場合は、拡張ヘルプがコンソール・ヘルプにマージされます。
特定のロケールのための拡張ヘルプを検索する場合、ヘルプ・ビューアが言語、国、およびバリアントのヘルプセットを探します。3つとも見つからない場合は、ヘルプ・ビューアが言語と国を探します。言語と国でも見つからない場合は、次のリストに示すように、ヘルプ・ビューアが言語を探します。
言語+ "_" +国+ "_" +バリアント
言語+ "_" +国
言語
ユーザーが管理コンソールの上部にある「コンテンツ・ヘッダー」メニューの「ヘルプ」リンクをクリックして管理コンソールからヘルプを要求します。そのリンクが現在のページのヘルプ・トピックを表示します。
コンソール拡張ページのための状況依存のヘルプを提供するには、
ブック、ページまたはページでの対象のためにヘルプIDの提供必要があります。
Javahelpマップ(.jhm)ファイルにヘルプIDのヘルプ・ファイルへのマップが必要です。
ここで、コンソール拡張の開発者は管理コンソールの左側の「操作ガイド」パネルまたは構成ページやモニター・ページの右側の「詳細」のリンクを提供することはできません。
各Portalページやブックには、ヘルプIDがあり、ページの対象には、ヘルプIDがあります。helpidまたはhelpurlpatternsを指定する必要があります。
helpidという名前のmetaタグを使用してヘルプIDとバンドル名を指定することで、ポータル・ページやブックのヘルプ・コンテキストを指定します。ヘルプIDとバンドル名はセミコロン(;)で区切ります。または、ポータルとブックは祖先ページやブックからコンテキストを継承できます。
ヘルプIDには英数字、ハイフン(-)、およびアンダースコア(_)のみが含まれます。その他の文字は拒否され、一般的なエラー・メッセージが表示されます。
ヘルプWebアプリケーションがhelpidメタ・データからヘルプIDとバンドル名を読み込みます。ページまたはブックがhelpidを設定しない場合、ヘルプ・アプリケーションがhelpidを取得するために親ページまたはブックを再帰的に検索します。最も近い親からのhelpidが使用されます。
管理コンソールの全体的なHomeブックには、コンテキストのhelpidが見つからない場合、コンソールのデフォルトのヘルプ・ページが表示されることを確認するhelpidがあります。helpid値をbea.wls.console.pageHelpKeyというJavaScript変数に割り当てます。
コンテンツ・ヘッダーのヘルプリンクをクリックすると、helpidがヘルプWebアプリケーションに問合せパラメータとして渡されます。ヘルプWebアプリケーションがhelpidを使用してマッピング(.jhm)ファイルを問合せ、ヘルプ・リソースを返します。
次の例では、Joltコンソール拡張の「JoltConnectionPoolの設定」ページの「構成」>「一般」タブのためにhelpidを割り当てる方法を示します。この断片はJoltFullFeatures.bookファイルから取得されます。
<netuix:page markupName="page" markupType="Page" definitionLabel="JoltConnectionPoolConfigGeneralTabPage" title="tab.general.label" presentationClass="page-content"> <netuix:meta name="helpid" content="Jolt.jolt.joltconnectionpoolconfiggeneral.title;jolt"/>
管理コンソールは、ヘルプを呼び出すための別の方法を提供します。一般的なヘルプURLパターンは、ポータル・ページやブックのhelpurlpatternメタ・データ・タグを使用して定義できます。パターンの値には、netuixメタ・タグを使用して任意のページやブックに代入できる変数があります。たとえば、helpurlpatternメタ・タグの値を次のように設定します。
<netuix:meta name="helpurlpattern" content=
"/consolehelp/console-help.portal?_nfpb=true&_pageLabel=page&helpId=${helpid}"/>
次に、<netuix:meta>タグを使用してhelpid値を指定します。
<netuix:meta name="helpid" content="applications.CreateDeploymentPlan"/>
URLパターンのhelpid変数はhelpidメタ・タグに提供されている値と代入されます。
helpurlpatternは任意のページやブックに指定できます。それを指定しない場合、helpurlpatternを探すために親ページとブックは再帰的に検索されます。最も近い親からのhelpurlpatternが使用されます。パターンが見つかった場合、有効なURLに到着するために、現在のページやブックに定義した任意の変数置換値がURLパターンに適用されます。
helpurlpatternは、拡張ヘルプの別のURLを提供するときの便利な方法です。my_extensionという拡張を考慮してください。ヘルプの要求をWebページに転送する必要があります。my_extensionという拡張がルート・ページやブックにhelpurlpatternを次のように定義します。
<netuix:meta name="helpurlpattern"
content="http://my_web_site.com/my_product/docs/${product_name}/index.html"/>
product_nameメタ・タグは置換値を提供できます。
<netuix:meta name="product_name" content="my_extension"/>
生成されたヘルプ・リンクはhttp://my_web_site.com/my_product/docs/my_extension/index.htmlを指します。
ポータル・ページとブックで定義した ヘルプIDをJavahelpマップ(.jhm)ファイルのHTMLヘルプ・トピックのファイルにマップします。たとえば、マップ・ファイルの次の要素がヘルプID domainconfigを ページ・ディレクトリにあるdomainConfig.htmlトピック・ファイルに関連付けます。
<mapID target="domainconfig" url="Pages/domainConfig.html"/>
指定したトピック・ファイルへのパスは、マップ・ファイルの場所を基準にしたパスです。マップ・ファイルはlocaleディレクトリにあります。詳細は、「拡張ヘルプをマージするためのディレクトリ構造」を参照してください。
ルック・アンド・フィール(LAF)を提供し、それをヘルプWebアプリケーションのポータル(console-help.portal)の対象とすることで、ヘルプWebアプリケーションをリブランディングできます。管理コンソールWebアプリケーションと同じサーバー・インスタンスにデプロイされるときにのみ、拡張LAFがヘルプWebアプリケーションをリブランディングできます。ルック・アンド・フィールの変更の詳細は、第5章「管理コンソールのリブランディング」を参照してください。
ヘルプWebアプリケーションはコンソールと同じサーバー・インスタンスにデプロイされるときにのみ、拡張ヘルプがコンソール・ヘルプにマージされます。ヘルプWebアプリケーションは別のサーバー・インスタンスにデプロイされると、それがマージされません。
同様に、ヘルプWebアプリケーションはコンソールと同じサーバー・インスタンスにデプロイされるときにのみ、ヘルプWebアプリケーションがリブランディングされます。
