アドオンの作成
新しく作成された機能アドオンは、FileNet® P8 Global Configuration Database (GCD) に自動的に登録されます。アドオンの登録後に、新しいオブジェクト・ストアか既存のオブジェクト・ストアにそのアドオンをインストールできます。
アドオンはドメインのリソースです。アドオンを作成するには、ドメイン・レベルの書き込み権限が必要です。アドオンは、AddOn オブジェクトで表されます。AddOn オブジェクトのインスタンスを作成するときは、Domain オブジェクトを、ドメインの GCD 内でそのアドオンを識別するグローバル固有 ID (GUID) とともに指定します。
AddOn オブジェクトは、保存されると GCD に登録されます。1 つのアドオン ID を複数のドメイン内に登録する場合、すべてのドメインで同じ ID になります。
AddOn オブジェクトの値の設定は、オブジェクトの保存時には検証されません。これらの設定は、AddOn オブジェクトをオブジェクト・ストア上にインストールする際に検証されます。無効な設定はエラーとして報告されます。
Addon オブジェクトは、その DisplayName プロパティーによって識別されます。必須ではありませんが、オブジェクトの DescriptiveText プロパティーには、アドオンが提供する機能の詳細を設定することをお勧めします。
AddOn オブジェクトに対して設定する他の主要な値は以下のとおりです。
- インポート・データ・セット
インポート・データ・セットは、アドオン内にインストールされるオブジェクトの XML 表現です。インポート・データ・セットを参照するアドオンを作成するには、その前にインポート・データ・セットを作成しなければなりません。
- アドオンのインポート・スクリプト
-
アドオンをオブジェクト・ストアにインストールするときに、XML データ・セットに定義されたオブジェクトがオブジェクト・ストアにインポートされます。AddOn オブジェクトをインストールするときに、オプションでインポート前またはインポート後の JavaScript スクリプトを実行できます。例えば、オブジェクトをインポートする前に、スクリプトを実行して、セキュリティーの変更、またはユーザーやグループの追加を行うことができます。
注: インポート・スクリプトは、アドオンのインポート・データ・セットと同じトランザクション内で開始されるため、操作を最小限に抑えることをお勧めします。 - アドオンのタイプ
アドオンが「オプション (optional)」か「推奨 (recommended)」かを識別する、アドオンの AddOnType プロパティーを設定する必要があります。ユーザーのシステムで必要とされないか、特殊な細分化された機能性を持つ機能アドオンについては、「オプション」にします。「推奨」される機能アドオンとは、ほとんどシステムの一部としてインストールされるものです。
- アドオンの前提条件
アドオンは、他のアドオンに依存している場合があります。依存されるアドオンは前提条件と呼ばれ、依存するアドオンより先にインストールする必要があります。アドオンの前提条件は、その ID を AddOn オブジェクトの Prerequisites プロパティー (IdList オブジェクト) に追加することで指定されます。依存するアドオンをオブジェクト・ストアに正しくインストールするには、その前提条件のアドオンをまずインストールする必要があります。オブジェクト・ストアにまだインストールされていない前提条件を指定すると、アドオンのインストールでエラーが発生し、失敗します。
単一の依存アドオンに複数の前提条件がある場合、依存アドオンを最後にインストールするのであれば、前提条件アドオンをインストールする順序は自由です。しかし、複数の依存アドオンのそれぞれに 1 つ以上の前提条件アドオンがある場合は、前提条件をインストールする順序が重要になります。順番にインストールして、前提条件アドオンをあらかじめインストールしておき、それを前提条件と見なす依存アドオンから検出できるようにする必要があります。
- アドオンの置き換え
-
既存のアドオンの新しいバージョンを追加する場合、新しいアドオンの SupersededAddOnIds プロパティーに値を入力することが重要です。古いアプリケーションは、この情報を使用して、必要なアドオンがオブジェクト・ストアにインストールされているかどうか判別できます。例えば、アプリケーションは、GCD に登録されているアドオンがオブジェクト・ストアにもインストールされているかどうかを判別できます。アプリケーションは、最初に当該 AddOn オブジェクトの SupersededAddOnIds プロパティーの値を検査し、次に ObjectStore オブジェクトに対して、Id を指定して isAddOnInstalled を呼び出します。