18.14 キー・マップ・ファイルの使用

URLをユーザーに提供する場合、あるいはハイパーリンクをWebサイトに追加する場合は、キー・マップ・ファイルを使用して、URLリクエスト内のパラメータを単純化したり非表示にしたりできます。この項では、次の情報について説明します。

キー・マッピングの理解
キー・マッピングを使用可能にする方法
キー・マップ・ファイルへのキー・マッピング・エントリの追加
JSP以外のレポートでのキーの使用
JSPとしてのレポート実行でのキーの使用

18.14.1 キー・マッピングの理解

キー・マップ・ファイルには、レポートを実行するコマンド文字列が含まれており、それぞれのコマンド文字列の先頭には一意のキー識別子が付加されています。レポートをJSPとして実行する場合を除いて、ランタイムURLでこのキーのみを参照するようにできます。Oracle Reports Servlet (rwservlet)によってこのキー値はキー・マップ・ファイル(cgicmd.dat)に送信され、このファイルから指定キーに関連付けられたコマンドがrwservletに返されて処理されます。キー・マッピングを使用することによって、すべてのコマンドライン・オプションを非表示にできます。

キー・マッピングは次の場合に便利です。

URLを短縮して、使いやすくする場合
元のURLを変更することなく、ランタイム・コマンドをマッピングし直す場合
企業にとって典型的ないくつかの実行構成を標準化する場合
ユーザーからパラメータの一部(データベース接続文字列など)を非表示にする場合
ユーザーがレポートの実行に使用できるパラメータを制限する場合

キー・マップ・ファイル(cgicmd.dat)からキー名を指定するときは、そのキー名をレポート・リクエストURLの問合せ文字列の開始位置(疑問符の後)に配置する必要があります。ただし、CMDKEYコマンドライン・キーワードの値としてキー名を指定する場合(CMDKEY=keyname)は例外です。この場合は、レポート・リクエストURLにおける問合せ文字列の任意の位置にキー名を配置できます。CMDKEYキーワードは、JSPとして実行されるジョブおよびrwservletコマンドで使用できます。

注意:

詳細は、第A.5.14項「CMDKEY」を参照してください。

18.14.2 キー・マッピングを使用可能にする方法

キー・マッピングは、標準ファイル名cgicmd.datを持つ有効なファイルが、Webサーバー・マシン上のデフォルトの場所($DOMAIN_HOME/config/fmwconfig/servers/<WLS_SERVER_NAME>/applications/reports_<version>/configuration/cgicmd.datディレクトリ)にある場合に有効になります(WindowsまたはUNIXの場合)。

18.14.3 キー・マップ・ファイルへのキー・マッピング・エントリの追加

キー・マップ・ファイルにキー・マッピング・エントリを追加する手順は、次のとおりです。

Reports Serverをホスティングするマシン上のcgicmd.datファイルにナビゲートし、これをテキスト・エディタで開きます。

このファイルは、WindowsとUNIXのどちらの場合も、次のディレクトリにあります。
```
$DOMAIN_HOME/config/fmwconfig/servers/<WLS_SERVER_NAME>/applications/reports_<version>/configuration/cgicmd.dat
```
キー・マッピング・エントリを追加します。例:
```
key1: report=your_report.rdf userid=username/password@my_db desformat=html SERVER=server_name destype=cache
```
この例のkey1は、キーの名前です。

ファイル自体に記述されている特殊なパラメータを除いて、コマンドライン・オプションはrwclientの構文規則に従います。詳細は、第A.2.1項「rwclient」を参照してください。
Webページでハイパーリンクを追加または更新します。

詳細は、第18.6項「Webブラウザからのレポート・リクエストの指定」を参照してください。

18.14.4 JSP以外のレポートでのキーの使用

レポート・リクエストURLにキー名を指定するときは、そのキー名が問合せ文字列内の最初の値(疑問符の直後)になるように配置する必要があります。例:

http://…/rwservlet?keyname

キー名では大文字と小文字が区別されるので、キー・マップ・ファイル(cgicmd.dat)に指定されているとおりに正確に入力する必要があります。

次に示すのは、パラメータ・フォームを使用した制限付きの実行に対するキー・マッピングの例です。

URLは次のようになります。

http://web_server.domain_name:port/reports/rwservlet?run_report&par1&par2&parN

キー・マップ・ファイル(cgicmd.dat)には次の記述が含まれている場合があります。

run_report: report=myreport deptno=%1 myparam=%2 %*

これによって、次のコマンドライン・リクエストに相当するリクエストが生成されます。

rwclient report=myreport deptno=par1 myparam=par2 parN

18.14.5 JSPとしてのレポート実行でのキーの使用

レポートをJSPとして実行する場合に、cgicmd.datファイル内のコマンド・キーをコールするときは、URLでcmdkeyキーワードを使用する必要があります。cmdkeyの値(keyname)では大文字と小文字が区別されるので、cgicmd.datに指定されているとおりに正確に入力する必要があります。たとえば、JSP URLは次のようになります。

http://…/myreport.jsp?cmdkey=keyname

注意:

rwservletコマンドでcmdkeyを使用することもできます。

JSPまたはrwservletでcmdkeyを使用する場合は、問合せ文字列内の任意の位置に配置できます。例:

http://…/example.jsp?parameter1=value1&cmdkey=keyname
http://…/rwservlet?parameter1=value1&cmdkey=keyname

使用上の注意

キー・マッピングの使用時に、パラメータがURLからキーに置換される順序は、URLのcmdkeyの配置により決定されます。たとえば、cgicmd.datファイルに次のようなキーがあるとします。

mykeys: DEPTNO=%1 MYPARAM=%2

このキーを参照するJSPレポートを次のように実行します。

http://neptune.world.com:80/jsp/myreport.jsp?userid=scott/tiger@hrdb
  &cmdkey=mykeys&10&test

このURLでのcmdkeyの配置により、10は%1に対応し、testは%2に対応します。これらがURLで1番目と2番目のパラメータではなくても、URLのcmdkeyに従い、10とtestは1番目と2番目のパラメータになります。この例では、URLは次のようになります。

http://neptune.world.com:80/jsp/myreport.jsp?userid=scott/tiger@hrdb
  &DEPTNO=10&MYPARAM=test