インデックス ファイルの例

以下の例では、架空の sp 管理モジュールのインデックス ファイルを示します。この例の目的は、管理モジュールのインデックス ファイルの開発でよく使用されるインデックス ファイル エントリの使用を明確にすることです。
casp1032jp
以下の例では、架空の 
CA Spectrum
管理モジュールのインデックス ファイルを示します。この例の目的は、管理モジュールのインデックス ファイルの開発でよく使用されるインデックス ファイル エントリの使用を明確にすることです。
この例のシナリオは、Jill Corporation が、
CA Spectrum
管理サポートを提供する一連のネットワーク ハブ デバイスを販売するというものです。
CA Spectrum
 VAR として、Jill Corporation は、CA からソフトウェア開発者名 JillCorp と 16 進数の開発者 ID 2f7 を受け取りました。
Jill Corporation は、Hub_Jill 管理モジュールの一部として配布および販売されている一連のハブ デバイスの汎用管理であるモデル タイプ Hub_Jill をすでに開発しています。Jill Corporation は、最近、新しい Jill 700 ハブを追加し、Jill 700 ハブ用の新しい 
CA Spectrum
 管理モジュール Hub_Jill700 を開発し、ハブ ハードウェアに同梱して販売しようとしています。
このタスクを実行するため、Jill Corporation の開発者は CA Model Type Editor を使用して、Jill 700 ハブ用の新しいモデル タイプ Hub_Jill700 をベース モデル タイプ Hub_Jill から派生させ、新しい Hub_Jill700 モデル タイプ用のデータベース インポート ファイル Jill700.e を作成しました。また、この開発者は、レベル 1 ツールキットおよび CORBA Toolkit を使用して、Jill 700 ハブの管理に必要なその他の
CA Spectrum
 サポート ファイルを作成しました。開発ホストでは、Jill 700 ハブ用の 
CA Spectrum
 サポート ファイルが、/usr/devarea/spectrum ディレクトリの 
CA Spectrum
 インストール領域に存在します。
/usr/devarea/ を基準とする Jill 700 ハブ用の 
CA Spectrum
CA Spectrum
 サポート ファイルの完全なセットは以下のとおりです。
  • 部分記述ファイル
    Hub_Jill700.mmd
  • SpectroSERVER
     データベース インポート ファイル
    SS/db/Jill700.e
  • SpectroSERVER
     イベント処置ファイル
    SS/CsVendor/JillCorp/EventDisp
  • SpectroSERVER
     アラート マップ ファイル
    SS/CsVendor/JillCorp/Hub_Jill700/AlertMap
  • OneClick アプリケーション設定ファイル
    tomcat/webapps/spectrum/WEB-INF/devman/config/contrib/
    jill700-app-config.xml
  • いくつかの OneClick カスタマイズ xml ファイル
    tomcat/webapps/spectrum/WEB-INF/devman/config/
    view-jill700-devicedetails-config.xml
    tomcat/webapps/spectrum/WEB-INF/devman/config/
    privileges-jill700-config.xml
    tomcat/webapps/spectrum/WEB-INF/devman/config/
    table-jill700-sessions-config.xml
    tomcat/webapps/spectrum/WEB-INF/devman/config/
    search-jill700-criteria.xml
開発者は、新しい Hub_Jill700 管理モジュールにこれらのファイルをパッケージする必要があります。最終的な目的は、VCD にこの管理モジュールを追加して、顧客に配布できるようにし、
CA Spectrum
 領域にインストールできるようにすることです。
最初のタスクは、Hub_Jill700 のインデックス ファイルを作成することです。インデックス ファイルの名前は、管理モジュールと同じ名前である必要あるため、Hub_Jill700.i と命名されています。Hub_Jill700.i は、
CA Spectrum
 インストール ディレクトリ /usr/devarea/spectrum に作成されると仮定します。開発者には、インデックス ファイルを手動で作成するか、mmship ツールを使用してインデックス ファイルを作成し、生成されたファイルを編集するというオプションがあります。この例の目的のため、開発者はインデックス ファイルを最初から作成したと仮定します。
開発者が Hub_Jill700.i の編集を完了すると、そのコンテンツは以下のようになります(参照しやすいように行番号を付けています)。
1. mm: Jill 700 Hub Management Module 2. rev: 1.0 3. irev: 01.00.00.000 4. level: 1 5. 6. vend: JillCorp 7. pprep: 3M-02F7-1001 Hub_Jill 8. file: Install mmdesc ? Hub_Jill700.mmd ? ? 9. 10. deflt: SS db sdir $SPECROOT/SS/db 11. file: SS db ? Jill700.e ? ? 12. 13. deflt: SS vfile sdir $SPECROOT/SS 14. file: SS vfile ? CsVendor/JillCorp/EventDisp ? ? 15. file: SS vfile ? CsVendor/JillCorp/Hub_Jill700/AlertMap ? ? 16. 17. deflt: SS,OC evformat sdir $SPECROOT/custom/Events 18. file: SS,OC evformat ? CsEvFormat/Event00821000 ? ? 19. file: SS,OC evformat ? CsEvFormat/Event00821001 ? ? 20. 21. deflt: SS,OC pcause sdir $SPECROOT/SG-Support 22. file: SS,OC pcause ? CsPCause/Prob00821000 ? ? 23. file: SS,OC pcause ? CsPCause/Prob00821001 ? ? 24. 25. deflt: OC file sdir $SPECROOT/tomcat/webapps/spectrum/WEB-INF/devman 26. deflt: OC file tdir tomcat/webapps/spectrum/WEB-INF/devman 27. file: OC file ? config/contrib/jill700-app-config.xml ? ? 28. file: OC file ? config/view-jill700-devicedetails-config.xml ? ? 29. file: OC file ? config/privileges-jill700-config.xml ? ? 30. file: OC file ? config/table-jill700-sessions-config.xml ? ? 31. file: OC file ? config/search-jill700-criteria.xml ? ?
このインデックス ファイルについて分析していきます。
インデックス ファイルの名前は、Hub_Jill700.i です。これは Hub_Jill700 管理モジュールのインデックス ファイルであることを示しています。
Hub_Jill700.i の最初の 5 行では、Hub_Jill700 管理モジュールについて説明しています。
  • 1 行目では、Hub_Jill700 管理モジュールのわかりやすい名前が「Jill 700 ハブ管理モジュール」であることを示しています。インストール プログラムでは、インストール サマリにこの名前が表示されます。2 行目では、Hub_Jill700 管理モジュールのわかりやすいバージョンが 1.0 であることを示しています。
  • 3 行目では、Hub_Jill700 管理モジュールの内部バージョンが 01.00.00.000 であることを示しています。(内部バージョンの形式は dd.dd.dd.ddd である必要があります。ここで、d はそれぞれ 10 進の数字です)。インストール時に、この番号を使用して、新しいバージョンへの古いバージョンの Hub_Jill700 のインストールを検出します(これはダウングレードと呼ばれ、インストールするユーザの同意が必要です)。Jill Corporation が今後 Hub_Jill700 管理モジュールを更新および再リリースする場合、この番号の「パッチ リリース」セグメント(最後の ddd 値)は 0 より大きい値である必要があります(01.00.00.001 や 01.01.00.123 など)。これは、再リリースされた管理モジュールが最初のリリースよりも新しいことを示します。
    注:
    前の数字のどこかのセグメントが増えるたびに、この値を再び 0 から始めてダウングレードとしてフラグが設定されることがないように、「パッチ リリース」値(番号の最後の ddd セグメント)は、指定されたモジュールの前のバージョンよりも大きくする必要があります。
  • 4 行目は、Hub_Jill700 の拡張モジュール レベルが 1 であることを示しています。これは、Hub_Jill700 が 
    CA Spectrum
     製品のオプション拡張、すなわち管理モジュールであることを示しています(必須の
    CA Spectrum
     コア コンポーネントまたは独立外部アプリケーションとは対象的に)。
  • 6 行目では、Hub_Jill700 の開発者が JillCorp であることを示しています。これは、CA が Jill Corporation 用に割り当てた開発者名です。
7、8 行目は共に部分記述エントリです。
  • 7 行目では、管理モジュール Hub_Jill700 が 3M-02F7-1001 という名前のパーツを表していることを示しています。3M-02F7-1001 パーツには、物理 Hub_Jill700 および追加の管理モジュール Hub_Jill (Hub_Jill700 のベース モデル タイプを含む)が含まれます。
  • 8 行目には、パーツ 3M-02F7-1001 の部分記述が含まれています。このファイルは必須ですが、インストールでは使用されません。
    8 行目では、file: エントリが動作する方法を確認する最初の機会を提供します。行は以下のとおりです。
    file: Install mmdesc ? Hub_Jill700.mmd ? ?
    file: ラベルは、出荷ファイルが管理モジュールに含まれることを示しています。
    次の 2 つのフィールド(Install mmdesc)は、製品および出荷ファイルのタイプを指定します。ファイル製品 Install は、ファイルが管理モジュールのインストール時に使用されることを示します。ファイル タイプ mmdesc は、ファイルが管理モジュールの部分記述ファイルであることを示します。
    次の 2 つのフィールド(? Hub_Jill700.mmd)は、部分記述ファイルのソース(最終的に VCD 上に配置しようとしているファイル)の場所を指定します。ソース ディレクトリ フィールドは ? です。これはデフォルト値を使用することを示します。部分記述ファイルのデフォルトのソース ディレクトリは「.」です(SEI ツールキットに同梱されている mkmm.sys ファイルの以下の deflt: エントリで指定)。
    deflt: Install mmdesc sdir .
    部分記述ファイルのソース名は、明示的に Hub_Jill700.mmd として指定されます。部分記述ファイルのソースの場所が ./Hub_Jill700.mmd となるように、ソース ディレクトリと名前を一緒に保持します。これは相対パスであるため、インデックス ファイルが含まれるディレクトリ、この場合は /usr/devarea/spectrum が基準となります。すべてまとめると、部分記述ファイルのソースは /usr/devarea/spectrum/Hub_Jill700.mmd です。
    最後の 2 つのフィールド(? ?)は、VCD からインストールする必要がある部分記述ファイルを指定します。ターゲット ディレクトリ フィールドは ? であるため、インストール プログラムは、部分記述ファイルのデフォルトのターゲット ディレクトリを使用します。このデフォルト ディレクトリは、Install-Tools/MMD です。これは mkmm.sys ファイルの以下の deflt: エントリで指定されます。
    deflt: Install mmdesc tdir Install-Tools/MMD req=yes
     
    この例で示されている req=yes オプションは、mkmm.sys データ ファイルでのみ使用されるものです。Install-Tools/MMD は部分記述ファイルのインストール用に許可されている唯一のターゲット ディレクトリであるため、req=y フラグは、Install-Tools/MMD が mkmm.loc ファイルやインデックス ファイルの他の deflt: エントリによってオーバーライドされないようにします。VAR 拡張モジュールの開発者が、インデックス ファイルや mkmm.loc ファイルでこの req=yes オプションを使用することはできません。
ターゲット名も ? であるため、デフォルトのターゲット ファイル名を使用します。これは常にソース ファイル名と同じであり、この場合は Hub_Jill700.mmd となります。そのため、部分記述ファイルは 
CA Spectrum
 のインストール ディレクトリを基準として Install-Tools/MMD/Hub_Jill700.mmd にインストールされます。
  • 10 行目の deflt: エントリおよびそれ以降の他の deflt: エントリは、管理モジュールに含まれるその他のさまざまなタイプのファイルのデフォルトのソース ディレクトリおよびターゲット ディレクトリをセットアップします。代表的な例として 10 行目を以下の構文で見ていきます。
    deflt: SS db sdir $SPECROOT/SS/db
    $SPECROOT は環境変数です。これはまず、エクスポートされた値に展開されます。レベル 1 
    CA Spectrum
     開発環境では、$SPECROOT が
    CA Spectrum
    のインストール ディレクトリに設定されます。この場合は、/usr/devarea/spectrum です。したがって、deflt: エントリは以下のようになります。
    deflt: SS db sdir /usr/devarea/spectrum/SS/db
    deflt: ラベル自体が、出荷ファイルのデフォルト属性を設定していることを示しています。
    次の 2 つのフィールド(SS db)は、製品 SS およびファイル タイプ db の出荷ファイルのデフォルト属性を設定していることを示しています。これらは 
    SpectroSERVER
     データベース インポート ファイルです。
    次のフィールド(sdir)は、設定しているデフォルト属性がデフォルト ソース ディレクトリであることを示しています。
    最後のフィールド(<
    $SPECROOT
    >/SS/db)は、設定されているデフォルト値です。したがって、このエントリは、
    SpectroSERVER
    データベース ファイルのデフォルト ソース ディレクトリを /usr/devarea/spectrum/SS/db に設定します。このデフォルト ソース ディレクトリはインデックス ファイル内の後続の「file: SS db」エントリに適用されます。
  • 11 行目の file: エントリおよびそれ以降の他の file: エントリは、管理モジュールの出荷ファイルについて説明しています。代表的な例として 11 行目を以下の構文で見ていきます。
    file: SS db ? Jill700.e ? ?
    file: ラベルは、出荷ファイルが管理モジュールに含まれることを示しています。
    次の 2 つのフィールド(SS db)は、製品および出荷ファイルのタイプを指定します。ファイル製品 SS は、ファイルが
    SpectroSERVER
     製品の一部であることを示しています。ファイル タイプ db は、ファイルが
    SpectroSERVER
     データベース インポート ファイルであることを示します。
    次の 2 つのフィールド(? Jill700.e)は、
    SpectroSERVER
     データベース インポート ファイルのソースの場所を指定します。ソース ディレクトリ フィールドは ? です。これは、インポート ファイルのデフォルト ソース ディレクトリを使用することができることを示しています。
    前述のとおり、10 行目では、デフォルト ソース ディレクトリが <
    $SPECROOT
    >/SS/db に設定されています。これは /usr/devarea/spectrum/SS/db となります。部分記述ファイルのソース名は、明示的に Jill700.e として指定されます。ソース ディレクトリと名前をまとめると、部分記述ファイルのソースの場所は /usr/devarea/spectrum/SS/db/Jill700.e です。
    最後の 2 つのフィールド(? ?)は、VCD からインストールする必要があるデータベース インポート ファイルを指定します。ターゲット ディレクトリ ? は、データベース インポート ファイルのデフォルト ターゲット ディレクトリを使用できることを示しています。このデフォルト ターゲット ディレクトリは SS/db (mkmm.sys で設定)です。ターゲット ファイル名も ? であるため、デフォルトのターゲット ファイル名を使用します。これは常にソース ファイル名と同じであり、この場合は Jill700.e となります。そのため、部分記述ファイルは spectrum のインストール ディレクトリを基準として SS/db/Jill700.e にインストールすることができます。
注:
すべての顧客定義イベント、想定される原因、およびインデックス ファイルのイベント テーブル ファイルを $
SPECROOT
\custom ディレクトリに配置する必要があります。