Web ベースの製品のヘルプ・コンテンツの構成

ヘルプ・システムは、ご使用のアプリケーション・サーバーでデプロイされる Web アーカイブ (WAR) ファイルとしてパッケージされています。製品を開始または停止するときに、ヘルプ・システムも開始または停止します。ヘルプ・システムには、手動で更新できるヘルプ・コンテンツが含まれています。ibm.com® Web サイトからのヘルプ・コンテンツを配信するようにヘルプ・システムを構成して、コンテンツは常に最新にすることもできます。3 つ目のオプションは、イントラネット・サーバーからヘルプ・コンテンツを配信する方法です。

定義

以下の定義は、ヘルプ・コンテンツの配信で使用されます。

ローカル・ヘルプ
製品をホストするローカル・サーバー、またはイントラネット・サーバーにあるヘルプ・コンテンツ。 ご使用のコンピューターからヘルプにアクセスできます。
リモート・ヘルプ
ibm.com Web サイトまたはその他 jazz.net などの公式なインフォメーション・センター・サイトにあるヘルプ・コンテンツ。
イントラネット・ヘルプ
イントラネット・サーバーにあるヘルプ・コンテンツ。 コンテンツは最初に Web からイントラネット・サーバーにダウンロードされます。
ローカル・ヘルプ更新プログラム
ご使用の製品がローカル・ヘルプまたはイントラネット・ヘルプを使用するように構成されている場合、 このユーティリティーを使用すると、ヘルプ更新プログラム・サイトまたはダウンロードした更新プログラム圧縮ファイル (次の定義を参照) から、初期コンテンツをダウンロードしたり、既存のコンテンツを更新することができます。
ヘルプ更新プログラム・サイト
製品のインフォメーション・センターがホストされている ibm.com サイト。 このサイトには、ブラウザーまたは (ご使用の製品がリモート・ヘルプを使用するように構成されている場合は) 製品のヘルプ・システムからアクセスできます。 このサイトは、ローカル・ヘルプ更新プログラムのソースとしても使用できます。
ヘルプ・ダウンロード・サイト
この Web サイト (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) には、 製品用のヘルプ・コンテンツの圧縮ファイルがあり、このヘルプ・コンテンツはローカル・ヘルプまたはイントラネット・ヘルプを更新するためにオプションで使用できます。 ファイルのフォーマットは prod_coden.n_updateSite.zip で、 prod_code は製品コード、n.n はバージョン番号です。

概要

この製品には、製品のアップデートとは独立して更新できるヘルプ・コンテンツがあります。デフォルトでは、ご使用の製品はローカルでヘルプ・コンテンツにアクセスするように構成されています。これは、ヘルプの Web アーカイブ (WAR) ファイルにすべてのヘルプ・コンテンツが含まれており、製品のインストール時に同時にインストールされることを意味しています。 ヘルプ・コンテンツへのアクセス方法には、ローカル・アクセスを含む 3 つの方法があります。
  • 製品をホストするサーバーにあるコンテンツにアクセスできます。
  • Web にあるヘルプ・コンテンツにアクセスできます。
  • イントラネット・サーバーにあるヘルプ・コンテンツにアクセスできます。

3 つのヘルプ・コンテンツ・オプション。

製品サーバーのヘルプ・コンテンツにアクセスする

管理者がこのオプションを構成した場合、またはご使用の製品が当初からこのオプションによって構成されていた場合、ヘルプ・コンテンツは、ご使用の製品をホストするサーバーにあります。

管理者: インストールおよび構成: 製品をインストールします。ご使用のヘルプがすべてのコンテンツをローカルで備えている場合、またはヘルプがリモート・ヘルプ用に構成されている場合は、他のオプションは必要ありません。

管理者: コンテンツの更新: リモート・ヘルプが構成されていない場合、ヘルプ更新プログラム・サイトまたはヘルプ・ダウンロード・サイトを使用して、コンテンツを手動で更新します。

ユーザー: ヘルプへのアクセス: 製品を参照し、それを使用開始します。ヘルプが必要なときには、「ヘルプ (?)」をクリックし、ウィンドウ内の「ヘルプ」を開きます。それ以外に必要な操作はありません。

Web からヘルプ・コンテンツにアクセスする

管理者がこのオプションを構成した場合、またはご使用の製品が当初からこのように構成されてきた場合は、ibm.com Web サイトを通じて製品のインフォメーション・センターにリンクできます。 インターネットに接続されている場合にのみ、製品についての Web ベースのヘルプにアクセスできます。 切断状態にある場合は、限られたヘルプ・トピックにのみアクセスできます。 詳細については、「参照」にあるヘルプ・コンテンツのトピックをご覧ください。

注: このヘルプ・オプションを使用するには、インターネット接続が必要です。
管理者: インストールおよび構成:
  1. 製品をインストールします。
  2. 製品およびヘルプを始動します。
  3. ローカル・ヘルプ更新プログラムを使用して、ヘルプ WAR にある既存のヘルプ・コンテンツを削除します。
  4. リモート・ヘルプを構成して、製品のパブリック・インフォメーション・センターをポイントします。

管理者: コンテンツの更新: アクションは必要ありません。 コンテンツは、常に使用可能な最新の情報になっています。

ユーザー: ヘルプへのアクセス: 製品を参照し、それを使用開始します。ヘルプが必要なときには、「ヘルプ (?)」をクリックし、ウィンドウ内の「ヘルプ」を開きます。

イントラネット・サーバーからヘルプ・コンテンツにアクセスする (Enterprise ソリューション)

社内のサポートに応じて、内部イントラネット・サーバーからヘルプ・コンテンツにアクセスできます。 この方法では、製品のヘルプ・コンテンツがインストールされるファイアウォールの後ろにあるサーバーに、イントラネット管理者がリンクを設定すると仮定します。 このオプションを選択すると、イントラネット・サーバーへのリンクを指定する必要があります。 管理者は、ヘルプ・コンテンツを定期的に更新しなければなりません。

管理者: インストールおよび構成:
  1. 製品を製品サーバーにインストールします。
  2. イントラネット・サーバーからのヘルプ・コンテンツの配信の説明に従って、イントラネット・ヘルプをインストールして構成します。
  3. 製品を始動します。
  4. ローカル・ヘルプ更新プログラムを使用して、既存のコンテンツをヘルプから削除します。
  5. リモート・ヘルプを構成し、ステップ 2 で使用した情報を使用して、イントラネット・サーバーを使用します。

管理者: コンテンツの更新: ヘルプ更新プログラム・サイトまたはヘルプ・ダウンロード・サイトを使用して、イントラネット・サーバー上でコンテンツを手動で更新します。

ユーザー: ヘルプへのアクセス: 製品を参照し、それを使用開始します。ヘルプが必要なときには、「ヘルプ (?)」をクリックし、ウィンドウ内の「ヘルプ」を開きます。それ以外に必要な操作はありません。


フィードバック