新規コアの追加方法

このページでは、IPT上級者向けの設定方法を説明します。

IPTは常に3つのコア（タクソン、オカレンス、イベント）をデフォルトでインストールした状態で出荷されます。IPT 2.1以降、カスタムコアをIPTに追加することができるようになり、新しいデータ標準のプロトタイプを作成するコミュニティにとって有用です。この方法では、コミュニティは自分たちのデータを新しいコアにマッピングする試みを開始し、そのプロパティのセットを繰り返し改良することができます。

以下の3つのステップで説明します。

  1. 新しいコアを作成し、

  2. GBIFに登録して、

  3. それを使用するIPTを設定する。

手順

  1. コアXMLの定義を書く

    コアとなるXMLの定義は、GBIF拡張スキーマに準拠することが必要です。ダーウィンコア・オカレンスコアなど、既存のコア定義を単純に適用するのが最も簡単です。コア定義には、レコード識別子となるプロパティ（例：オカレンスコアの場合は http://rs.tdwg.org/dwc/terms/occurrenceID、イベントコアの場合は GBIFシソーラススキーマに準拠する必要がある点のみ異なります。この場合も、link:https://rs.gbif.org/vocabulary/dwc/basis_of_record_2022-02-02.xml[ダーウィンコアタイプ語彙など、既存の語彙定義を適用するのが最も簡単です。

  2. GBIFにコアを登録する

    コアの定義がまだ変更されていない間に、GBIFサンドボックスレジストリに登録されます。コアを登録するには、こちらの手順で rs.gbif.org リポジトリにプルリクエストを行います。審査に通れば、https://rs.gbif.org/sandbox/core/ にマージされ、サンドボックスレジストリの拡張機能リストに含まれます。コア定義が確定すると、つまり、そのプロパティのセットが凍結されると、https://rs.gbif.org/core/ でホストされ、ライブレジストリの拡張機能リストに含まれます。コア以外の拡張機能や語彙を登録する場合も、同じプロセスが適用されます。

  3. IPTを設定する

    例えば、Material Sample Coreを使用するようにIPTを設定するには、 `$IPT_DATA_DIR/config/ipt.properties`に以下の2行を追加してください。

    上記のように、コロンがある場合は必ずエスケープしてください* 
    ipt.core_rowTypes=http\://rs.tdwg.org/dwc/terms/MaterialSample
ipt.core_idTerms=http\://rs.tdwg.org/dwc/terms/materialSampleID

    これは、IPTがrowType http://rs.tdwg.org/dwc/terms/MaterialSample を持つすべての拡張をコアタイプとして認識し、その識別子の項として http://rs.tdwg.org/dwc/terms/materialSampleID を使用するように設定するものである。複数のコアを指定することができ、パイプ文字の | で区切ります。ipt.core_idTerms の最初のエントリが core_rowTypes の最初のエントリの ID となり、以下同様です。最後に、ipt.properties ファイルを保存して、Tomcat を再起動し、コアをインストールします。これでコアはIPTで使用できるようになりました。