IBM Content
Navigatorバージョン2リリース0
IBM Content Navigator APIを使用したアプリケー
ションの開発
SC19-3716-00
IBM Content
Navigatorバージョン2リリース0
IBM Content Navigator APIを使用したアプリケー
ションの開発
SC19-3716-00
注意
この情報とそれがサポートする製品を使用する前に、79ページの「通知」の情報をお読みください。
このエディションは、IBM Content Manager OnDemand for Multiplatforms（製品番号5724-J33）のバージョン8、リリース5以降、IBM Content Manager OnDemand f
or z / OS（製品番号5697-N93）のバージョン8リリース5以降に適用されます。 IBM Content Manager OnDemand for iのバージョン7、リリース1以降（製品番号5770
-RD1）、IBM Content Manager Enterprise Editionのバージョン8、リリース4以降（プログラム番号5724-B19）、バージョン8、リリース4以降IBM Content Manager f
or z / OS（プログラム番号5697-H60）、バージョン5リリース0以降のIBM FileNet Content Manager（プログラム番号5724-R81）、および新しい版で明記されていな
い限り、以降のすべてのリリースおよびモディフィケーション。
©Copyright IBM Corporation 2012。
米国政府ユーザーの制限された権利– IBM Corp.とのGSA ADPスケジュール契約によって制限された使用、複製、または開示
目次
ibm.comおよび関連リソース。。。。。v
コメントを送信する方法
IBMに連絡する。
。
。
。
。
プラグインコンポーネントのパッケージ化
。
。
。
。
。
。
。
。vi
。
。
。
。
。
。
。
。vi
。
。
。
。
。
。28
外部データサービス。。。。。。。。31
IBM Content Navigatorの外部データサービスを作成します。
IBM Content Navigatorを使用したアプリケーションの開発。。
。
。
。
。
。
。
。
。
。
。
。
。
。
。34
。
。
。
。
。
。
。
。36
。
。
。
。
。
。39
。
。
。
。
。
。
。
。49
外部データサービスRESTプロトコルの仕様
。。。。。。。。1
オブジェクトタイプリソース。
IBM Content Navigator開発アーキテクチャー。。。。。。。。
。。。。。３
。
36
特定のオブジェクトタイプリソース。
外部データサービスのサンプル。
サンプル外部データサービスのファイル。
IBM Content Navigator中間層サービス。
。
。
。
。5
。
サンプルの外部データサービスをデプロイする。
IBM Content Navigatorのサンプルアプリケーション。。。。。
IBM Content Navigator APIリファレンス
。。。。。。。。。7
IBM Content Navigatorモデリングライブラリの構造
。。。。。9
ウィジェットパッケージ
。
。
。
。
。
53
。 。 。 。 。 。 。 。 。 。 。 。 。13
プラグインコンポーネントの作成
メニューアクションの作成
メニューを作成します。
。
フィーチャーの作成。
レイアウトを作成する
。
。17
。18
。
。71
。
。74
ウィジェットパッケージを処理します。
。
。
。
。
。
。
。
。76
。
。
。
。76
。
。
。
。
。
。
。
。
。
。
。
。
。
。
。
。
。20
お知らせ 。。。。。。。。。。。。。79
。
。
。
。
。
。
。
。
。
。21
商標。
。
。
。
。22
。
。
。
。
。
。
。
。
。24
。
。
。
。
。
。
。
。
。26日
ウィジェットを作成する。
。
。
。
。
。
。
。
。
。
。27日
。70
。
。
。
。
。
。
。
。
。
。
ビューアを作成する。
。
。
。
サービスの作成。
。67
。
。
ビューアウィジェットパッケージ。
。
。
。
チームスペースビルダーウィジェットパッケージ。
。
。
。
。
。16
。
。
。
。
。
。
。
。
。
。
。
。57
。
。
。
。
。56
。
。
。
。
レイアウトウィジェットパッケージ。
。
要求または応答フィルターの作成。
©Copyright IBM Corp. 2012
。
ダイアログボックスウィジェットパッケージ。
IBM Content Navigatorへのプラグインの作成
。
管理ウィジェットパッケージ。
管理モデルパッケージ。
。49
。50
53
IBM Content Navigatorビジュアルウィジェットカタログ。
IBM Content NavigatorのURLを作成します。。。。。。。。。
。
。
。
。
。
。
。
。
。
。
。
。
。
。
。78
。
。
。
。
。
。81
索引。。。。。。。。。。。。。。。83
iii
iv IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
ibm.comおよび関連リソース
製品サポートおよび資料は、ibm.comから入手できます。 ®。
サポートと支援
製品サポートは、次のWebサイトで利用できます。
IBM ® コンテンツナビゲーター
http://www.ibm.com/support/entry/portal/overview/software/ Enterprise_Content_Manager /
Content_Navigator
情報センター
製品資料は、ibm.comのEclipseベースのインフォメーションセンターで確認できます。この情報は、以下のインフォメ
ーションセンターで入手できます。
v IBM Content Manager Enterprise Editionバージョン8.4インフォメーションセンター
http://publib.boulder.ibm.com/infocenter/cmgmt/v8r4m0/index.jsp?topic=/ com.ibm.developingeuc.doc /
eucdi000.htm
v IBM Content Manager OnDemand for Multiplatformsバージョン8.5情報
http://publib.boulder.ibm.com/infocenter/cmod/v8r5m0/ index.jsp？topic = /
com.ibm.developingeuc.doc / eucdi000.htmのセンター
v IBM FileNet ® P8バージョン5.1インフォメーションセンター（http：//）
publib.boulder.ibm.com/infocenter/p8docs/v5r1m0/index.jsp?topic=/ com.ibm.developingeuc.doc /
eucdi000.htm
PDFの出版物
ご使用のオペレーティングシステムのAdobe Acrobat Readerを使用して、PDFファイルをオンラインで表示で
きます。Acrobat Readerをインストールしていない場合は、Adobe Webサイト（http://www.adobe.com）から
ダウンロードできます。
次のPDF公開Webサイトを参照してください。
製品
ウェブサイト
IBM Content Navigator
http://www.ibm.com/support/
docview.wss？uid = swg27025015
viページの「コメントの送信方法」
お客様のフィードバックは、IBMが質の高い情報を提供するのに役立ちます。IBM Software Developmentが製
品に同梱しているこの情報やその他のドキュメントについてのコメントがあれば教えてください。viページの
『IBMへの連絡』
米国またはカナダのIBMカスタマーサービスに連絡するには、1-800-IBM-SERV（1-800-426-7378）に電
話してください。
©Copyright IBM Corp. 2012
v
コメントを送信する方法
お客様のフィードバックは、IBMが質の高い情報を提供するのに役立ちます。IBM Software Developmentが製品に同
梱しているこの情報やその他のドキュメントについてのコメントがあれば教えてください。
コメントを提供するには、次のいずれかの方法を使用できます。
v の各ページの下部にある[コメント]ウィンドウを使用してコメントを追加します
情報センター。インフォメーション・センターへの貢献を参照してください。
v をクリックしてコメントを送信します フィードバック のトピックの下部にあるリンク
情報センター。
v でオンライン読者のコメントフォームを使用してコメントを送信してください
http://www.ibm.com/software/data/rcf/。
v コメントを電子メールでcomment@us.ibm.comに送信してください。の名前を含める
製品、製品のバージョン番号、情報の名前と公開番号（該当する場合）。特定のテキストにコメントする場合は
、テキストの場所（タイトル、表番号、ページ番号など）を含めてください。
消耗品調査
http://www.ibm.com/survey/oid/wsb.dll/s/ag2c1のリンクから重要度の高い技術情報の調査に回答して、質の高いコンテ
ンツの価値についてどのように感じているかを教えてください。IBMがこの製品のインストールと使用を容易にするの
を支援したい場合は、次のリンクで消費性調査を行ってください：http://www.ibm.com/software/data/info/consumabilit
y-survey/。
関連情報：
インフォメーションセンターへの貢献
意見を共有し、インフォメーションセンターのドキュメントに貢献してください。IBM IDでサインインして、ドキュメン
トにコメントしたり、ディスカッションスレッドを開始したり、例を共有したり、トピックを評価したり、トピックやス
レッドを視聴したりできます。
IBMへの連絡
米国またはカナダのIBMカスタマーサービスに連絡するには、1-800-IBM-SERV（1-800-426-7378）に電
話してください。
利用可能なサービスオプションについては、次の番号のいずれかに電話してください。
v 米国：1-888-426-4343
v カナダ：1-800-465-9600
IBMへの連絡方法の詳細については、http：//www.ibm.com/contact/us/のContact IBM Webサイトを参照してくださ
い。
vi
IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content Navigatorを使用したアプリケーションの開発
IBM Content Navigatorは、コンテンツを管理するカスタムWebアプリケーションを構築するための強力なプラットフォームを提供
します。さまざまな拡張ポイントとアプリケーションプログラミングインターフェイス（API）を使用して、カスタムアクション
、メニュー、レイアウト、またはサービスを追加することにより、既存のWebクライアントを拡張できます。APIを使用して、標
準のWebクライアントを使用せずに、IBM Content Navigator機能を組み込んだカスタムアプリケーションを構築することもできま
す。
IBM Content Navigator Java APIを使用してプラグインを作成し、Webクライアントに追加する機能を実装します。
IBM Content Navigator JavaScript APIを使用して、プラグインで使用するカスタムウィジェットを作成します。さら
に、IBM Content Navigatorを使用して、コンテンツサーバーのAPIにアクセスできます。
©Copyright IBM Corp. 2012
1
2 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content Navigator開発アーキテクチャー
IBM Content Navigatorは、model-view-controller（MVC）アーキテクチャーを使用します。
次の図に示すように、IBM Content Navigatorのコンポーネントは、MVC設計に従って機能的に分離されています。
ウェブクライアント
Webクライアントは、ビューとモデル間の通信を提供するコントローラーとして機能します。ユーザーは
、Webクライアントに含まれているウィジェットを操作します。Webクライアントは、これらの相互作用
を、モデルクラスのインスタンスによって実行されるアクションに変換します。
ビジュアルウィジェットライブラリ
このJavaScriptクラスのライブラリーは、IBM Content Navigatorのビューを作成するために使用されるウィジェット
を定義します。
モデリングライブラリ
このJavaScriptクラスのライブラリーは、IBM Content Navigatorのモデルを定義します。モデリングクラス
は、ビジネスロジックとデータを提供します。これらのクラスは、中間層サービスとの通信を定義して、コ
ンテンツリポジトリとそれぞれのアプリケーションプログラミングインターフェイス（API）へのアクセス
を提供します。
モデリングクラスを使用して、Webクライアントとリポジトリの間の通信とデータ交換をカスタマイ
ズできます。
©Copyright IBM Corp. 2012
３
IBM
Content
Navigator
Webクライアント
IBM Content Navigatorビジュアルウィジェットライブラリ
検索フォー
コンテンツ
ム
リスト
レイアウト
コンテンツビューア
フォルダツリー
ワークフロー
カスタムプラグイン
ウィジェット
IBM Content Navigator JavaScriptモデリングライブラリ
デスクトップ
結果セット
リポジトリ
項目
リクエスト
チームスペース
カスタムプラグイン
JavaScript
IBM Content Navigatorミッドティアサービス
CM Java
API
OD Java
API
IBM
P8 Java
API
IBM Content
CMIS
IBM
FileNet
Content
P8コンテンツマネージャー
Manager
オンデマンド
Analyticsプラグイン
Content
EDSプラグイン
カスタム外部デ
カスタムプラグインサービス
カスタムサーバーまたはデータストア
ータサービス
Analytics
CMISリポジトリ
制限： CMISサービスは、IBM Content Navigator V2.0での技術プレビューのためにのみ提供されています。
カスタム・プラグインを使用して、アーキテクチャーの各レベルでIBM Content Navigatorをカスタマイズできま
す。プラグインを作成して、カスタムウィジェット、サービス、およびその他のコンポーネントを実装できます
。カスタム・プラグインを作成することにより、外部ソースからの情報とコンテンツを統合し、IBM Content Na
vigatorの動作を拡張または変更できます。
IBM Content Navigatorは、プラグインを使用してさまざまな機能を実装します。例えば、IBM Content Analytics with
Enterprise Searchは、プラグインとしてIBM Content Navigatorに統合されています。外部データサービスプラグイン
は、
4 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
コンテンツ・リポジトリー以外のソースからのデータの統合をサポートする多くのIBM Content Navigatorウィジェ
ット。この機能を使用して、選択リスト、選択リストの依存関係、検証などの機能をWebクライアントに追加できま
す。
「IBM Content Navigatorミッドティアサービス」
IBM Content Navigatorサービスは、リポジトリーへの接続を提供します。さらに、サービスは、リポジトリ全体で
の検索やドキュメントの表示などの機能をサポートします。
関連タスク：
13ページの 『IBM Content Navigatorへのプラグインの作成』
カスタム・プラグインを作成して、メニューやサービスなどの機能をIBM Content Navigatorに追加できます。
関連資料：
56ページの 『IBM Content Navigatorビジュアル・ウィジェット・カタログ』 IBM Content Navigatorビジュアル・ウィジェット・ラ
イブラリーのJavaScriptクラスは、パッケージごとにグループ化されています。一部のパッケージでは、クラスは、それらが表すウ
ィジェットのタイプによってさらにグループ化できます。
55ページの 『IBM Content Navigatorモデリング・ライブラリーの構造』モデリング・ライブラリーのクラスは、IB
M Content Navigatorのビジネス・ロジックとデータを提供します。これらのクラスは、コンテンツ・サーバーおよ
びIBM Content Navigator構成内のデータにアクセスして表すためにウィジェットによって使用されます。
IBM Content Navigatorミッドティアサービス
IBM Content Navigatorサービスは、リポジトリーへの接続を提供します。さらに、サービスは、リポジトリ全体での検
索やドキュメントの表示などの機能をサポートします。
IBM Content Navigatorには、以下に接続するためのサービスが含まれています。
v IBM Content Manager Express ® 版
v IBM Content Manager for z / OS ® リポジトリ
v IBM Content Manager Enterprise Editionリポジトリー
v IBM Content Manager OnDemandリポジトリー
v IBM FileNet Content Managerリポジトリー
v コンテンツ管理相互運用サービス（CMIS）リポジトリ
IBM Content Navigatorは、各リポジトリー・タイプのアプリケーション・プログラミング・インターフェース（API）を使用して、
これらのリポジトリーへの接続を確立します。これらのAPIを使用してカスタムプラグインを作成し、リポジトリアイテムに対して
アクションを実行できます。
IBM Content Navigatorには、以下のサービスをサポートするプラグインも含まれています。
エンタープライズ検索プラグインを備えたIBM Content Analytics
IBM Content Navigatorで使用するように構成されたさまざまなリポジトリーおよびデータ・ソース全体の
検索をサポートします。単純なクエリまたは高度なクエリで検索できます。さらに、ファセットを使用し
てアイテムを整理および分類できるため、ドキュメントをすばやく見つけやすくなります。プラグインは
、検索結果の操作に使用できるアクションを提供します。たとえば、検索で返されたドキュメントを編集
したり、ドキュメントをワークフローに追加したりできます。
外部データサービスプラグイン
外部データソースからIBM Content Navigatorへのデータの統合をサポートします。この外部データを使用し
て、フィールドのプロパティをカスタマイズし、IBM Content Navigatorでプロパティの動作を管理できます
。
IBM Content Navigator開発アーキテクチャー 5
このプラグインを使用するには、外部データソースからIBM Content Navigatorにデータを渡すサービ
スを作成する必要があります。
IBM Content Collectorビューアプラグイン
IBM Content Collectorを使用してアーカイブされた電子メールを表示するIBM Lotus ® ノート ® 文書、およびIBM Co
nnectionsアーカイブ。このプラグインを使用するには、以下を行う必要があります。
v IBM Content Collector WebサービスへのURLを提供します
v IBM Content Navigatorビューアのマッピングを更新してIBMを使用する
IBM Content CollectorアーカイブコンテンツタイプのContent Collectorビューア
関連タスク：
36ページの 『IBM Content Navigatorの外部データサービスの作成』 EDS RESTプロトコルを使用して、外部データソ
ースからデータを取得するリクエストを指定する外部データサービスを作成し、フィールドプロパティをカスタマイズ
し、IBM Content Navigatorでプロパティの動作を管理します。外部データサービスをWebアプリケーションとして実装
します。24ページの「サービスの作成」
プラグインを作成して、コンテンツサーバーで操作を実行するサービスを定義できます。たとえば、IBM FileNet P8
サーバー上の特定のドキュメントタイプにビューアを提供するサービスを作成できます。
6 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content Navigatorのサンプルアプリケーション
IBM Content Navigatorソフトウェアパッケージには、プラグイン、外部データサービス、および一連のWebページなど、いくつかのサン
プルアプリケーションが含まれています。これらのサンプルアプリケーションを使用して、カスタムアプリケーションを作成できます。
サンプルプラグインアプリケーション
サンプルプラグインアプリケーションは、カスタムビューアーを提供するプラグインを実装します。このサンプル
アプリケーションのファイルは、IBM Content Navigatorクライアントで使用するメニュー、機能、サービスなどの
カスタムコンポーネントを作成する方法を示しています。
サンプルプラグインのファイルは、 ECMClient_installdir \
samples \ samplePages ディレクトリ。の SamplePlugin.jar IBM Content Navigator管理ツールを使用してデプロイで
きるファイルは、
ECMClient_installdir \ ナビゲーター ディレクトリ。
外部データサービスのサンプル
サンプルの外部データサービスは、外部データソースから選択リストの値を取得するために使用されるサービスを実装
します。
サンプルWebページは、 ECMClient_installdir \ samples \ sampleEDSService ディレクトリ。
サンプルWebページ
このサンプルWebアプリケーションは、IBM Content Navigatorモデリングクラスとウィジェットクラスを使用するHTM
Lページを提供します。これらのページは、IBM Content Navigatorツールキットのさまざまな側面を示しています。
サンプルWebページは、 ECMClient_installdir \ samples \ samplePages ディレクトリ。
関連する概念：
49ページの「サンプルの外部データサービス」
サンプルの外部データサービスでは、選択リストの値は外部データソースから使用されます。
関連タスク：
13ページの 『IBM Content Navigatorへのプラグインの作成』
カスタム・プラグインを作成して、メニューやサービスなどの機能をIBM Content Navigatorに追加できます。
©Copyright IBM Corp. 2012
7
8 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content NavigatorのURLの作成
IBM Content Navigatorのデスクトップ、フォルダー、およびドキュメントは、URLベースのメカニズムを使用してリモ
ートで呼び出すことができ、リポジトリー内のアイテムの固有IDに関する情報を含む指定されたURLにユーザーのブラ
ウザーを送信します。この機能により、IBM Content Navigatorのソースコードが変更された場合でも、ドキュメントと
フォルダーをカスタムアプリケーションに簡単かつ一貫してプラグインできます。
あなたが始める前に
IBM Content Navigatorをインストールして構成する必要があります。
このタスクについて
特定のデスクトップ、フォルダー、またはURLのドキュメントでIBM Content Navigatorを開くことができます。例えば
、カスタム・アプリケーションにURLを組み込んで、特定の文書に対してIBM Content Navigatorを開くことができます
。
アイテムを選択してクリックすると、ドキュメントまたはフォルダのURLを取得できます
[アクション]> [リンクを表示]。
URLのタイプごとに、IBM Content Navigatorの異なるビューが開きます。
デスクトップURL
フルIBM Content Navigatorクライアントのデスクトップに関連付けられているデフォルトのペインを開
きます。
フォルダURL
指定されたフォルダーのビューを提供するIBM Content Navigatorリンク・ビューアーを開きます。
ドキュメントのURL
でドキュメントを開きます IBM Content Navigator Viewer または、ドキュメントのMIMEタイ
プに設定されたデフォルトビューア。
URLベースのインターフェースを使用できるサンプルシナリオは、カスタムアプリケーションのポータルに、特定のリ
ポジトリ内の特定のドキュメントまたはフォルダーへのリンクを埋め込むことです。レビュー参加者は、フォルダまた
はドキュメントの内容をレビューできます。たとえば、会社全体のイントラネット上のリンクを、安全および緊急プロ
トコルのドキュメントを含むリポジトリ内のフォルダに埋め込むことができます。より高度な例として、ドキュメント
をリポジトリに追加し、ドキュメントを記録するWebアプリケーションを作成できます。 docid 値を生成し、 docid 確
認番号としての値。の docid 次に、値をURL構文で使用して、ドキュメントへの有効なリンクを作成できます。
手順
IBM Content Navigatorデスクトップ、ドキュメント、またはフォルダーのURLを作成するには、次のようにします。
1。 次のベースURLをアプリケーションに挿入します。
デスクトップ
http：// サーバポート/ ナビゲーター/？
ドキュメントとフォルダー
http：// サーバポート/ navigator / bookmark.jsp？
©Copyright IBM Corp. 2012
9
ベースURLを入力したら、パラメーターを追加する前に疑問符（？）を使用します。
2。 適切なパラメータをURLに追加します。
各パラメーターと値のペアは、アンパーサンド（＆）で区切ります。以下のリストでは、URLに追加できるパ
ラメーター、適切な形式、および各パラメーターの有効な値について説明します。
特定のデスクトップへのログイン
表1.文書とフォルダーを表示するための有効なパラメーターと値
パラメーター
有効な値
デスクトップ
ログインするデスクトップを指定します。デスクトップに表示されるIDを ID の列 デスクトップ
管理ツールのタブ。
フォーマット： デスクトップ= desktop_ID
例： http：// myserver.mycompany。 com：9080 / navigator /？ デスクトップ= 買掛金勘
定
ドキュメントを表示する
有効なパラメーターと値は次のとおりです。
表2.文書を表示するための有効なパラメーターと値
パラメーター
デスクトップ
有効な値
ログインするデスクトップを指定します。デスクトップに表示さ
れるIDを ID の列 デスクトップ 管理ツールのタブ。
フォーマット： デスクトップ= desktop_ID
repositoryId
ログインするサーバーを指定します。サーバーのID列にサーバー
に表示されるIDを指定します リポジトリ 管理ツールのタブ。
フォーマット： repositoryId = リポジトリID
docid
文書のシステム生成の識別番号。を使用します template_name
このフォルダIDのプレフィックスとしての値。
フォーマット： docid = document_ID
template_name
ドキュメント、フォルダ、 または、カスタムドキュメントクラスまたはアイ
テムタイプの名前。
フォーマット： template_name = template_name
バージョン
現在、リリース済み、 または特定のバージョン番号。
フォーマット： バージョン= バージョンナンバー
vsld
文書に関連付けられているIBM FileNet P8バージョンシリー
ズオブジェクト。これはグローバル一意識別子（GUID）で
す。
フォーマット： vsld = GUID_number
10 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
例： http：// myserver.mycompany。 com：9080 / navigator / bookmark.jsp？ デスクトップ= 買掛金
勘定＆ repositoryId = AP_P8_System＆ docid = 30dd879c-ee2f-11db-8314-0800200c9a66＆ template_name
= APtemplate＆ バージョン= 解放された
フォルダを表示する
表3.フォルダーを表示するための有効なパラメーターと値
有効な値
パラメーター
ログインするデスクトップを指定します。デスクトップに表示さ
デスクトップ
れるIDを ID の列 デスクトップ 管理ツールのタブ。
フォーマット： デスクトップ= desktop_ID
repositoryId
ログインするサーバーを指定します。サーバーのID列にサーバー
に表示されるIDを指定します リポジトリ 管理ツールのタブ。
フォーマット： repositoryId = リポジトリID
文書のシステム生成の識別番号。を使用します template_name
docid
このフォルダIDのプレフィックスとしての値。
フォーマット： docid = document_ID
template_name
ドキュメント、フォルダ、 または、カスタムドキュメントクラスまたはアイ
テムタイプの名前。
フォーマット： template_name = template_name
例： http：// myserver.mycompany。 com：9080 / navigator / bookmark.jsp？ デスクトップ= 買
掛金勘定＆ repositoryId = CM_System
＆ docid = 30dd879c-ee2f-11db-8314-0800200c9a66＆ template_name
= CHEMtemplate
IBM Content NavigatorのURLの作成 11
12 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content Navigatorへのプラグインの作成
カスタム・プラグインを作成して、メニューやサービスなどの機能をIBM Content Navigatorに追加できます。
あなたが始める前に
IBM Content Navigatorへのプラグインを作成するには、以下のプログラミング言語を理解する必要があります。
v ジャワ
v JavaScript
さらに、プラグインで定義されたアクションのJavaScript関数を実装するには、Webプログラミングを理解する必要
があります。
また、IBM Content Navigatorが使用するツールキットであるDojo Toolkitについても理解している必要があります
。
このタスクについて
IBM Content Navigatorで使用するために作成するプラグインは、以下を提供する必要があります。
v ユーザーがプラグインを呼び出すことができるWebブラウザーのロジック
v プラグインがプラグインコンポーネントをロードできるようにする中間層サーバーロジック。
プラグインが機能するために管理者が追加情報を提供する必要がある場合は、構成コンポーネントも提供する必要があ
ります。例えば、IBM Content Analytics with Enterprise Searchプラグインでは、管理者がIBM Content Analytics with E
nterprise SearchサーバーへのURLを提供する必要があります。管理者は、IBM Content Navigator管理ツールを使用し
てプラグインを構成します。
プラグインは、単一のJARファイルに含まれている以下のコンポーネントで構成されています。
Webブラウザーのロジック
Webブラウザーのロジックは、ユーザーがWebクライアントからプラグインを呼び出すことができるようにするプラグイ
ンの必須コンポーネントです。
プラグインのWebブラウザーロジックコンポーネントは、IBM Content Navigatorクライアントと通信しま
す。Webクライアントは、Dojo Toolkitに基づくIBM Content Navigatorビジュアルウィジェットを使用して
構築されています。プラグインを作成するには、IBM Content NavigatorCビジュアルウィジェットとDojo
Toolkitを使用する必要があります。
WebブラウザーのロジックはJavaScriptで実装されています。
中間層サーバーロジック
中間層サーバーロジックは、プラグインの必須コンポーネントです。このロジックは、コンテンツサーバーの
APIを呼び出して、プラグインで使用されるデータ、またはユーザーに表示されるデータを取得します。
プラグインの中間層ロジックコンポーネントは、Webアプリケーションサーバー上のIBM Content Naviga
torサービスコンポーネントと通信します。中間層サーバーロジックはJavaで実装されます。
©Copyright IBM Corp. 2012
13
構成コンポーネント
構成コンポーネントは、IBM Content Navigator管理ツールを使用してプラグインのインスタンスを構成で
きるようにするプラグインのオプションのコンポーネントです。プラグインの構成コンポーネントの作成
については、次の手順のステップ2を参照してください。構成コンポーネントはJavaで実装されます。
手順
IBM Content Navigatorへのプラグインを作成するには：
1。 を拡張する プラグイン プラグインを作成するクラス。
2。 プラグインで構成が必要な場合は、表示する構成ペインを定義します
IBM Content Navigator管理ツール：
a。 を拡張する PluginConfigurationPane.js パラメータを定義するクラス
構成する必要があります。
b。 HTMLファイルを作成して、ユーザーインターフェイスを定義するフォームテンプレートを定義します
構成ペイン用。
c。 あなたの プラグイン クラスファイル、実装 getConfigurationDijitClass
返すメソッド PluginConfigurationPane.js クラス。
3。 適切な拡張 ecm.extension コンポーネントを作成するクラス
プラグインによって提供される機能を定義します。
コンポーネントタイプ
ecm.extension クラス
メニューアクション
PluginAction
メニュー
PluginMenuType そして PluginMenu
特徴
PluginFeature
レイアウト
PluginLayout
リクエストフィルター
PluginRequestFilter
応答フィルター
PluginResponseFilter
サービス
PluginService
ウィジェット
適用できません。代わりに、道場を拡張します
dijit._widget クラスまたは別の道場 ディジット
クラス。
4。 あなたの プラグイン クラスファイル、適切な実装 取得する 識別する方法
このプラグインに含まれているカスタムコンポーネント：
コンポーネントタイプ
方法
メニューアクション
getActions
メニュー
getMenuTypes そして getMenus
特徴
getFeatures
レイアウト
getLayouts
リクエストフィルター
getRequestFilters
応答フィルター
getResponseFilters
サービス
getServices
ウィジェット
getScript
5。 プラグインファイルをJARファイルにパッケージ化します。
14 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
6。 JARファイルをWebアプリケーションサーバーにデプロイします。
重要： プラグインJARファイルは、URLアドレス指定可能なWebアプリケーションサーバーで使用できる必要があります。そうでな
い場合、プラグインはWebクライアントで機能しません。
7。 IBM Content Navigator管理デスクトップを使用して、新しいプラグインを追加します。
プラグイン定義および構成ファイルのサンプル
サンプルプラグインの次のファイルは、プラグインと構成を定義します。
表4.プラグインと構成を定義するサンプルファイル
ファイル
SamplePlugin.java
説明文
このファイルは プラグイン サンプルプラグインによって提供され
るカスタムコンポーネントをリストするクラス。
SamplePlugin.js
このファイルは プラグイン サンプルプラグインによって提供され
るカスタムコンポーネントをリストするクラス。
ConfigurationPane.js
このファイルは、サンプルプラグインに使用される構成ペインを
定義します。
ConfigurationPane.html
このファイルは、サンプルプラグイン構成ペインで使用される
HTMLフォームテンプレートを提供します。
16ページの 『プラグイン・コンポーネントの作成』
プラグインを作成して、メニュー、サービス、ウィジェット、レイアウトなどのコンポーネントをIBM Content Nav
igatorに追加できます。28ページの「プラグインコンポーネントのパッケージ化」 プラグイン カスタムプラグインに
使用されるコンポーネントを識別するクラス。次に、JARファイルを作成して、IBM Content Navigatorにデプロイす
るコンポーネントをパッケージ化します。
IBM Content Navigatorへのプラグインの作成 15
関連する概念：
3ページの 『IBM Content Navigator開発アーキテクチャー』 IBM Content Navigatorは、model-view-con
troller（MVC）アーキテクチャーを使用します。
関連資料：
8ページの 『IBM Content Navigatorのサンプル・アプリケーション』 IBM Content Navigatorソフトウェア・パッケージには、プラグイン
、外部データ・サービス、および一連のWebページなど、いくつかのサンプル・アプリケーションが含まれています。これらのサンプル
アプリケーションを使用して、カスタムアプリケーションを作成できます。
関連情報：
Dojo Toolkitリファレンスガイド
IBM Content Navigatorで使用されるDojo Toolkitに関する情報を見つけてください。
クラスecm.widget.admin.PluginConfigurationPane
プラグインの構成インターフェースを作成するために拡張できる基本クラスを提供します。
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
プラグインコンポーネントの作成
プラグインを作成して、メニュー、サービス、ウィジェット、レイアウトなどのコンポーネントをIBM Content Navigatorに
追加できます。
17ページの「メニューアクションの作成」
プラグインを作成して、IBM Content Navigatorで使用するアクションを提供できます。たとえば、ドキュメント
をインポートするか、選択した一連のドキュメントのカスタムレポート生成を生成するカスタムアクションを定
義できます。このアクションは、ツールバーおよびコンテキストメニューに追加できます。18ページの「メニュ
ーの作成」
プラグインを作成して、IBM Content Navigatorで使用するカスタムツールバーまたはコンテキストメニューを提供できま
す。20ページの 『フィーチャーの作成』
プラグインを作成して、IBM Content Navigatorに主要な機能を追加できます。たとえば、コンテンツの使用状況に
関する統計データや最近のドキュメントアクティビティの概要を表示する機能を作成できます。フィーチャーを作
成したり、アーカイブするドキュメントを選択したりすることもできます。この機能は、お気に入り、参照、検索
、管理など、IBM Content Navigatorが提供する機能とともに表示できます。21ページの「レイアウトの作成」
プラグインを作成して、IBM Content Navigatorで使用するカスタムレイアウトを提供できます。レイアウトは、デ
スクトップで使用されるウィジェットの配置を定義します。
22ページの「要求または応答フィルターの作成」
プラグインを作成して、サービスに対して行われた要求をフィルタリングしたり、サービスから受信した応答をフ
ィルタリングしたりできます。たとえば、カスタム検証とエラー処理を提供するためにサービスに送信されるパラ
メーターを変更する要求フィルターを作成する場合があります。また、サービスをオーバーライドする要求フィル
ターを作成することもできます。たとえば、応答フィルターを作成して、データが表示される前に、サービスから
受信したデータにカスタムフォーマットを適用できます。
24ページの「サービスの作成」
プラグインを作成して、操作を実行するサービスを定義できます。
16 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
コンテンツサーバー。たとえば、IBM FileNet P8サーバー上の特定のドキュメントタイプにビューアを提供するサ
ービスを作成できます。26ページの 『ビューアーの作成』
プラグインを作成して、コンテンツビューアを提供できます。ユーザーは、IBM Content Navigator管理ツール
を使用して、カスタムビューアをドキュメントタイプにマップできます。27ページの「ウィジェットの作成
」
ウィジェットを作成して、プラグインのユーザーインターフェイスを提供できます。たとえば、ユーザーがカスタム
アクションを実行できるようにするウィジェットを作成できます。管理者がプラグインを構成できるようにするウィ
ジェットを作成することもできます。
メニューアクションの作成
プラグインを作成して、IBM Content Navigatorで使用するアクションを提供できます。たとえば、ドキュメントをイン
ポートするか、選択した一連のドキュメントのカスタムレポート生成を生成するカスタムアクションを定義できます。
このアクションは、ツールバーおよびコンテキストメニューに追加できます。
このタスクについて手順
アクションを作成するには：
1。 JavaScript関数を実装して、アクションの動作を定義します。ために
IBM Content Navigatorのアクションに関する情報については、
ecm.model.Action.js クラス。
2。 アクションを有効または無効にするタイミングを指定する場合は、
ecm.model.Action.js クラス。
3。 を拡張する PluginAction.java アクションのプラグインを定義するクラス：
a。 実装する getActionFunction JavaScriptの名前を返すメソッド
手順1で作成した関数。
b。 このアクションがアクションを有効にするための標準コードをオーバーライドする場合は、実装します
の getActionModelClass 手順2で作成したJavaScriptクラスの名前を返すメソッド。
4。 アクションをコンポーネントとして追加します Plugin.java サブクラス。追加する
アクション、実装 getFeatures のインスタンスを返すメソッド
PluginAction.java 手順3で作成したクラス。
カスタムメニューアクションのサンプルプラグインファイル
サンプルプラグインの次のファイルは、カスタムメニューアクションを定義します。
表5.プラグインメニューアクションを定義するサンプルファイル
ファイル
SamplePluginAction.java
説明文
このファイルは PluginAction.java サンプルアクションを定義する
クラス。
このアクションの動作は、
samplePluginAction で定義されている関数 SamplePlugin.js ファ
イル。
IBM Content Navigatorへのプラグインの作成 17
表5.プラグインメニューアクションを定義するサンプルファイル（続き）
ファイル
SamplePluginCheckInAction.java
説明文
このファイルは PluginAction.java サンプルアクションを定義する
クラス。
このアクションの動作は、
samplePluginAction で定義されている関数 SamplePlugin.js ファ
イル。
SamplePluginFilteredAction.java
このファイルは PluginAction.java サンプルアクションを定義する
クラス。このクラスは、MIMEタイプがテキストのドキュメントで
のみ使用可能なアクションを実装します。
このアクションの動作は、
samplePluginFilteredAction で定義されている関数 SamplePlugin.js
ファイル。
CustomAction.js
このファイルは 有効になっています MIMEタイプのテキストを持つ
ドキュメントに対してのみアクションが有効になるように機能しま
す。
次はどうする
カスタムツールバーまたはコンテキストメニューにアクションを追加するには、
getMenuItems のメソッド PluginMenu このインスタンスを返すサブクラス
PluginAction クラス。このメソッドは、によって表されるカスタムツールバーまたはメニューにアクションを追加しま
す PluginMenu サブクラス。
プラグインをWebクライアントに追加した後、IBM Content Navigator管理ツールを使用して、アクションをツ
ールバーまたはコンテキストメニューに追加します。
関連情報：
クラスecm.model.Action
ユーザーが実行可能なアクションを表します。このアクションは、IBM Content Navigator管理ツールでデスクトップ
用に構成できます。
クラスPluginAction
プラグインによって提供されるクライアント側のアクションを定義するために拡張された抽象クラスを提供します。こ
のクラスのサブクラスによって定義されるアクションは、IBM Content Navigatorツールバーとコンテンツリスト内のコ
ンテキストメニューに表示されます。
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
メニューを作成する
プラグインを作成して、IBM Content Navigatorで使用するカスタムツールバーまたはコンテキストメニューを提供できます
。
このタスクについて
メニューを作成するには、まずメニュータイプを作成する必要があります。メニュータイプは、ユーザーインターフェース
でメニューが表示される場所と方法を示します。たとえば、メニュータイプを定義して、カスタムウィジェットのコンテキ
ストメニューを作成できます。複数のメニューにメニュータイプを使用できます。
18 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
手順
カスタムメニューを作成するには：
1。 を拡張する PluginMenuType.java メニュータイプを定義するクラス：
メニューがツールバーの場合は、 isToolbar 返すメソッド 本当。 このメソッドを実装しない場合、またはメソッド
が返す場合 偽、 メニューはコンテキストメニューです。
デフォルトメニューの場合、メニュータイプはデフォルトメニューの識別子を提供します。ユーザーがこのメニ
ューのコピーを作成すると、コピーでメニュータイプが識別され、元のメニューにリンクされます。
2。 を拡張する PluginMenu.java メニューを定義するクラス：
a。 実装する getId メニューの識別子を返すメソッド。接頭辞
ユーザーがこのメニューのコピーを作成できる場合は、「デフォルト」の識別子。
b。 実装する getMenuType 返すメソッド PluginMenuType そのクラス
ステップ1で作成した。
c。 実装する getMenuItems 次のアクションのインスタンスを返すメソッド
メニューに含まれています。
3。 メニューをコンポーネントとして追加します Plugin.java サブクラス：
a。 実装する getMenuTypes のインスタンスを返すメソッド
PluginMenuType.java 手順1で作成したサブクラス。
b。 実装する getMenus のインスタンスを返すメソッド
PluginMenu.java 手順2で作成したサブクラス。
カスタムメニューのサンプルプラグインファイル
サンプルプラグインの次のファイルは、コンテキストメニューと2つのツールバーメニューを定義します。
表6.プラグインメニューを定義するサンプルファイル
ファイル
説明文
SamplePluginContextMenuMenuType.java
このファイルは PluginMenuType.java
コンテキストメニューのメニュータイプを作成するクラス。
SamplePluginContextMenuMenu.java
このファイルは PluginMenu.java 次のアクションを含むコンテキス
トメニューを定義するクラス：
v で定義されているサンプルアクション
SamplePluginAction.java ファイル
v プロパティ
v 助けて
v約
v プレビュー
v 開いた
次のアクションは、使用可能なアクションボックスにあります。
v カスタムチェックイン
v テキストドキュメントのみ
SamplePluginToolbarMenuType.java
このファイルは PluginMenuType.java
ツールバーのメニュータイプを作成するクラス。
IBM Content Navigatorへのプラグインの作成 19
表6.プラグインメニューを定義するサンプルファイル（続き）
ファイル
説明文
SamplePluginToolbarMenu.java
このファイルは PluginMenu.java 次のアクションを含むツールバー
を定義するクラス：
v で定義されているサンプルアクション
SamplePluginAction.java ファイル
v 助けて
v約
SamplePluginToolbarMenuType2.java
このファイルは PluginMenuType.java
ツールバーのメニュータイプを作成するクラス。
SamplePluginToolbarMenu2.java
このファイルは PluginMenu.java 次のアクションを含むツールバー
を定義するクラス：
v で定義されているサンプルアクション
SamplePluginAction.java ファイル
v で定義されているカスタムチェックイン
SamplePluginCheckInAction.java ファイル
v 助けて
次はどうする
Webクライアントにプラグインを追加した後、IBM Content Navigator管理ツールを使用してメニューをデス
クトップに追加します。
関連情報：
クラスPluginMenuType
プラグインによって提供されるカスタムメニュータイプを定義するために拡張された抽象クラスを提供します。
クラスPluginMenu
プラグインでメニューを定義するために拡張された抽象クラスを提供します。
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
フィーチャーを作成する
プラグインを作成して、IBM Content Navigatorに主要な機能を追加できます。たとえば、コンテンツの使用状況に関
する統計データや最近のドキュメントアクティビティの概要を表示する機能を作成できます。フィーチャーを作成し
たり、アーカイブするドキュメントを選択したりすることもできます。この機能は、お気に入り、参照、検索、管理
など、IBM Content Navigatorが提供する機能とともに表示できます。
手順
フィーチャーを定義するには：
1。 Webクライアントで機能を表すアイコンを作成します。アイコンは64でなければなりません
幅64ピクセル、高さ64ピクセル。最良の結果を得るには、アイコンを透明なPNGファイルとして作成します。
20 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
2。 のユーザーインターフェイスを定義するプライマリペインを提供するウィジェットを作成する
機能。このウィジェットは、機能の動作へのアクセスをユーザーに提供します。
3。 を拡張する PluginFeature 機能を説明するクラス：
a。 実装する getIconUrl で作成したアイコンを返すメソッド
20ページの手順1。
b。 実装する getContentClass ウィジェットのインスタンスを返すメソッド
手順2で作成したもの。
4。 サービスをコンポーネントとして追加します Plugin.java サブクラス。実装する
getFeatures のインスタンスを返すメソッド PluginFeature 手順3で作成したクラス。
カスタム機能のサンプルプラグインファイル
サンプルプラグインの次のファイルは、機能を定義します。
表7.プラグイン機能を定義するサンプルファイル
ファイル
説明文
SamplePluginFeature.java
このファイルは PluginFeature サンプルフィーチャを作成する
クラス。
次はどうする
Webクライアントにプラグインを追加した後、IBM Content Navigator管理ツールを使用して、機能をデスクトッ
プに追加します。あなたは上の機能を追加します
外観 デスクトップのタブ。
関連情報：
クラスPluginFeature
プラグインによって提供される機能を定義するために拡張された抽象クラスを提供します。機能は、主にユーザーイン
ターフェイスの左側にあるアイコンとして表示される主要な機能領域です。機能はデスクトップごとに構成可能です。
機能の例には、ブラウズやお気に入りなどがあります。
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
レイアウトを作成する
プラグインを作成して、IBM Content Navigatorで使用するカスタムレイアウトを提供できます。レイアウトは、デ
スクトップで使用されるウィジェットの配置を定義します。
手順
レイアウトを作成するには：
1。 を拡張する ecm.widget.layout.MainLayout.js プライマリを作成するクラス
レイアウトのウィジェット：
a。 実装する getAvailableFeatures 機能を返すメソッド
レイアウトで利用できる。各機能は、のインスタンスとして宣言されます
ecm.model.Feature クラス。
IBM Content Navigatorへのプラグインの作成 21
b。 実装する setFeatures 機能の構成方法
レイアウトに配置。
2。 を拡張する PluginLayout.java クラス。実装する getLayoutClass 方法
21ページの手順1で作成したウィジェットクラスのインスタンスを返します。
3。 レイアウトをコンポーネントとして Plugin.java サブクラス。追加する
機能、実装 getLayouts のインスタンスを返すメソッド
PluginLayout.java 手順2で作成したクラス。
カスタムレイアウトのサンプルプラグインファイル
サンプルプラグインの次のファイルは、レイアウトを定義します。
表8.プラグインのレイアウトを定義するサンプルファイル
ファイル
説明文
SampleLayout.js
このファイルは MainLayout.js サンプルプラグインレイアウトに
使用されるウィジェットを作成するクラス。
SamplePluginLayout.java
このファイルは PluginLayout.java サンプルプラグインレイアウト
を定義するクラス。
次はどうする
プラグインをWebクライアントに追加した後、IBM Content Navigator管理ツールを使用して、レイアウトを
デスクトップに関連付けます。
関連情報：
クラスecm.widget.layout.MainLayout
IBM Content Navigatorまたは同様のデスクトップレイアウトのメインレイアウトを提供します。このクラスは、レイア
ウトの左側に機能を含む起動バーを表示します。
クラスPluginLayout
プラグインによって提供されるレイアウトを定義するために拡張された抽象クラスを提供します。レイアウトはデス
クトップのメインウィジェットであり、デスクトップ内のウィジェットの全体的な配置を定義します。デスクトップ
に使用される特定のレイアウトは、IBM Content Navigator管理ツールで選択されます。
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
要求または応答フィルターの作成
プラグインを作成して、サービスに対して行われた要求をフィルタリングしたり、サービスから受信した応答をフィル
タリングしたりできます。たとえば、カスタム検証とエラー処理を提供するためにサービスに送信されるパラメーター
を変更する要求フィルターを作成する場合があります。また、サービスをオーバーライドする要求フィルターを作成す
ることもできます。たとえば、応答フィルターを作成して、データが表示される前に、サービスから受信したデータに
カスタムフォーマットを適用できます。
このタスクについて
外部データサービスプラグインは、要求フィルターと応答フィルターを使用して、サービスがカスタム選択リスト
と検証を提供できるようにします。
22 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
フィルターを使用するには、プラグインが JSONArtifact リクエストで送信されるオブジェクトまたは JSONObject
応答で返されるオブジェクト。
重要： 要求および応答フィルターに使用されるJSON形式は、予告なしに変更されることがあります。プラグインの要
求および応答フィルターを作成する場合、IBM Content Navigator Javaアプリケーションプログラミングインターフェー
スの新しいバージョンがリリースされたときに、コードを更新する必要がある場合があります。
手順
要求または応答フィルターを作成するには：
1。 リクエストフィルターを作成する場合は、 PluginRequestFilter クラス：
a。 実装する getFilteredServices の名前を返すメソッド
このフィルターが使用されるサービス。
b。 実装する フィルタ に適用されるフィルターを定義するメソッド
リクエスト。
ヒント： サービスに送信されるJSONオブジェクトを調べて、フィルターメソッドの要件を決定します。
2。 応答フィルターを作成する場合は、 PluginResponseFilter クラス：
a。 実装する getFilteredServices の名前を返すメソッド
このフィルターが使用されるサービス。
b。 実装する フィルタ に適用されるフィルターを定義するメソッド
リクエスト。
ヒント： サービスによって返されるJSONオブジェクトを調べて、フィルターメソッドの要件を決定しま
す。
3。 フィルターをコンポーネントとしてコンポーネントに追加します Plugin.java サブクラス：
フィルターのタイプ
に追加 Plugin.java サブクラス
リクエスト
実装する getRequestFilters のインスタンスを返すメソッド
PluginRequestFilter.java 手順1で作成したクラス。
応答
実装する getResponseFilters のインスタンスを返すメソッド
PluginResponseFilter.java 手順2で作成したクラス。
カスタム応答フィルターのサンプルプラグインファイル
サンプルプラグインの以下のファイルは、応答フィルターを定義します。
表9.プラグイン応答フィルターを定義するサンプルファイル
ファイル
説明文
SamplePluginResponseFilter.java
このファイルは PluginResponseFilter
検索結果にカスタムプロパティの書式を適用するフィルター
を定義するクラス。
IBM Content Navigatorへのプラグインの作成 23
関連情報：
クラスPluginRequestFilter
特定のサービスへのリクエストに対するフィルターを作成するために拡張された抽象クラスを提供します。フィルター
は、サービスによって検査される前に、要求パラメーターと共に提供されます。フィルターはパラメーターを変更した
り、要求を拒否したりできます。
クラスPluginResponseFilter
特定のサービスからの応答のフィルターを作成するために拡張された抽象クラスを提供します。サービスからの応答
は、Webブラウザーに返される前にJSON形式でフィルターに提供されます。その後、フィルターはその応答を変更
でき、変更された応答はWebブラウザーに返されます。
サービスを作成する
プラグインを作成して、コンテンツサーバーで操作を実行するサービスを定義できます。たとえば、IBM FileNet P8
サーバー上の特定のドキュメントタイプにビューアを提供するサービスを作成できます。
このタスクについて
コンテンツサーバーにネイティブなアプリケーションプログラミングインターフェイス（API）を使用して、
サービスによって実行される操作を定義します。
ヒント： IBM Content Navigatorプラグインサービスを実装する場合は、サーブレットのベストプラクティスに従ってくだ
さい。
v アプリケーションサーバーはマルチスレッドであるため、プラグインサービスは
複数のスレッドを安全に処理します。
v サービスは、複数のユーザーの複数のスレッドで呼び出されます。したがって、行う
インスタンス変数を使用しないでください。インスタンス変数を使用すると、ユーザー間での意図しない情報共有などの副
作用が発生する可能性があります。
手順
サービスを作成するには：
1。 を拡張する PluginService サービスを作成するクラス：
a。 実装する 実行する サービスへのアクセスを提供するメソッド
コンテンツサーバーのAPI。
b。 このサービスがIBM Content Navigatorサービスの1つを置き換える場合、
実装する getOverriddenService そのサービスを識別する方法。
c。 サービスで設定が必要な場合は、
PluginServiceCallbacks.loadConfiguration サービスに構成された値を取得するメソッド。
2。 サービスがカスタムビューアを提供する場合は、 PluginViewerDef クラスに
ビューアを起動するためのURLテンプレートを定義します。
3。 サービスをコンポーネントとして追加します Plugin.java サブクラス：
a。 実装する getServices のインスタンスを返すメソッド
PluginService.java 手順1で作成したクラス。
b。 サービスがカスタムビューアを提供する場合は、 getViewers 方法
のインスタンスを返す PluginViewerDef 手順2で作成したクラス。
24 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
カスタムサービスのサンプルプラグインファイル
サンプルプラグインの次のファイルは、サービスを定義します。
表10.プラグインサービスを定義するサンプルファイル
ファイル
SamplePluginService.java
説明文
このファイルは PluginService ドキュメントに関するシステム関
連の詳細を取得するサービスを定義するクラス。この情報を取
得するために、サービスは、ドキュメントがIBM Content Man
ager、IBM Content Manager OnDemand、またはIBM FileNet P
8リポジトリーにあるかどうかに応じて、適切なAPIを呼び出し
ます。
SamplePluginViewerDef.java
このファイルは PluginViewerDef で定義されているビューアを起動
するためのURLテンプレートを定義するクラス
SamplePluginViewerService.java ファイル。
SamplePluginViewerService.java
このファイルは PluginService アーカイブされたRSSフィード
の単純なフォーマットを行うカスタムビューアーを提供するサ
ービスを定義するクラス。
次はどうする
必要に応じて、カスタムアクション、ビューア、または機能からサービスを呼び出します。次に、IBM Content Navigatorを
使用して、これらのコンポーネントをデスクトップに関連付け、ユーザーがサービスを利用できるようにします。
IBM Content Navigatorへのプラグインの作成 25
関連する概念：
5ページの 『IBM Content Navigator中間層サービス』
IBM Content Navigatorサービスは、リポジトリーへの接続を提供します。さらに、サービスは、リポジトリ全体での検
索やドキュメントの表示などの機能をサポートします。
関連情報：
クラスPluginService
プラグインによって提供される各サービスを実装するクラスを作成するために拡張された抽象クラスを提供します。サ
ービスは、サーブレットまたはStrutsアクションと同様に、IBM Content Navigatorサーバーで操作を実行するアクション
です。サービスは、コンテンツサーバーアプリケーションプログラミングインターフェイス（API）およびJ2EE APIにア
クセスできます。
クラスPluginViewerDef
プラグインによって提供されるビューアを定義するために拡張された抽象クラスを提供します。ビューアは、ビュー
アマッピングで使用して、ビューアを呼び出すドキュメントのタイプを識別できます。ビューアは、このクラスで定
義されているテンプレートを使用してIBM Content Navigatorによって作成されたURLに基​​づいて、独自のiframeまた
はWebブラウザーウィンドウ内で起動されます。
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
ビューアを作成する
プラグインを作成して、コンテンツビューアを提供できます。ユーザーは、IBM Content Navigator管理ツール
を使用して、カスタムビューアをドキュメントタイプにマップできます。
手順
ビューアを作成するには：
1。 を拡張する PluginService ビューアを提供するサービスを作成するクラス。
2。 を拡張する PluginViewerDef を開くURLテンプレートを提供するクラス
ビューア。
カスタムビューアのサンプルプラグインファイル
サンプルプラグインの次のファイルは、ビューアを定義します。
表11.プラグインビューアを定義するサンプルファイル
ファイル
説明文
SamplePluginViewerDef.java
新しいカスタムビューアの定義。
このクラスは、サンプルビューアサービスをビューアとして定義
します。起動URLパターンは、ビューアを呼び出す方法を説明し
、ビューアサービスがドキュメントを取得して表示用にフォーマ
ットするために使用するパラメータを提供します。
SamplePluginViewerService.java
このクラスは、 PluginService.java
サービスを実装するクラス。このサービスは、アーカイブされた
RSSフィードの単純なフォーマットを実行するカスタムビューア
ーを提供します。
26日 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
関連情報：
クラスPluginService
プラグインによって提供される各サービスを実装するクラスを作成するために拡張された抽象クラスを提供します。サ
ービスは、サーブレットまたはStrutsアクションと同様に、IBM Content Navigatorサーバーで操作を実行するアクション
です。サービスは、コンテンツサーバーアプリケーションプログラミングインターフェイス（API）およびJ2EE APIにア
クセスできます。
クラスPluginViewerDef
プラグインによって提供されるビューアを定義するために拡張された抽象クラスを提供します。ビューアは、ビュー
アマッピングで使用して、ビューアを呼び出すドキュメントのタイプを識別できます。ビューアは、このクラスで定
義されているテンプレートを使用してIBM Content Navigatorによって作成されたURLに基​​づいて、独自のiframeまた
はWebブラウザーウィンドウ内で起動されます。
ウィジェットを作成する
ウィジェットを作成して、プラグインのユーザーインターフェイスを提供できます。たとえば、ユーザーがカスタムアク
ションを実行できるようにするウィジェットを作成できます。管理者がプラグインを構成できるようにするウィジェット
を作成することもできます。
このタスクについて
カスタム・アクション、フィーチャー、レイアウト、およびサービスのために、ユーザー・インターフェースのIBM Conte
nt Navigatorビジュアル・ウィジェット・ライブラリーのウィジェットを再利用できます。たとえば、独自のツリーウィジェ
ットを作成してフォルダー階層を参照するのではなく、 ecm.widget.FolderTree ウィジェット。
要件を満たすIBM Content Navigatorウィジェットがない場合は、カスタムウィジェットを作成できます。基本的なDojoから新
しいウィジェットを簡単に作成できるようにする、IBM Content Navigator JavaScriptモデリング・ライブラリーのクラス ディジット
ウィジェット。このライブラリーには、データを表すための一般的な方法を提供するDojoデータ・ストアのモデルが含まれてい
ます。これらのデータストアモデルクラスを使用すると、複数のウィジェットでデータを簡単に使用および表示できます。ライ
ブラリには、カスタムウィジェットのナビゲーションツリーのデータを取得するために使用できるDojoツリーのモデルも含まれ
ています。
手順
カスタムウィジェットを作成するには：
1。 ウィジェットがDojoを拡張している場合 dijit._Templated クラス、HTMLを作成する
ボタン、フィールド、ラベルなど、ウィジェットの視覚的表現を定義するテンプレート。このテンプレートは
、ウィジェットの初期DOM構造を生成するために使用されます。
2。 拡張して、カスタムウィジェットのクラスを定義するJavaScriptファイルを作成します。
道場 dijit._widget クラスまたは別の道場 ディジット クラス。道場を使う dijit._Templated クラスを作成し
、ステップ1で作成したテンプレートを参照します。
3。 プラグインでウィジェットをインスタンス化するJavaScriptファイルを作成します。
4。 ウィジェットスクリプトをコンポーネントとして Plugin.java サブクラス。たす
スクリプト、実装 getScript 手順3で作成したJavaScriptファイルを返すメソッド。
IBM Content Navigatorへのプラグインの作成 27日
カスタムウィジェットのサンプルプラグインファイル
サンプルプラグインの次のファイルは、カスタムウィジェットを定義します。
表12.カスタムウィジェットを定義するサンプルファイル
ファイル
説明文
MessagesDialog.js
このファイルはDojoを拡張したものです dijit.Dialog メッセージダイアログボ
ックスを提供するウィジェットを定義するクラス。
MessagesDialog.html
このファイルは、で定義されているウィジェットに使用されるH
TMLテンプレートを提供します
MessagesDialog.js ファイル。
PopupDialog.js
このファイルはDojoを拡張したものです dijit.Dialog ポップアップダイアログ
ボックスを提供するウィジェットを定義するクラス。
PopupDialog.html
このファイルは、で定義されているウィジェットに使用されるH
TMLテンプレートを提供します
PopupDialog.js ファイル。
SamplePlugin.js
このファイルは、 MessagesDialog.js
サンプルプラグインの進捗メッセージを表示するクラス。フ
ァイルは
PopupDialog.js ポップアップウィンドウでサンプルプラグインのヘ
ルプファイルを開くクラス。
次はどうする
ウィジェットを使用して、プラグインで定義されたカスタムアクションまたは機能のユーザーインターフェイスを提供し
ます。
関連情報：
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
独自のウィジェットを書く
Dojo Toolkitを使用してウィジェットを作成および変更する方法の詳細については、このWebページを参照してくださ
い。
プラグインコンポーネントのパッケージ化
あなたは プラグイン カスタムプラグインに使用されるコンポーネントを識別するクラス。次に、JARファイルを作成し
て、IBM Content Navigatorにデプロイするコンポーネントをパッケージ化します。
手順
プラグインをパッケージ化するには：
1。 プラグインに使用されるファイルを含むJARファイルを作成します。
JARファイルは次の構造を使用する必要があります。
パッケージ名
// Pluginクラスを拡張するすべてのJavaクラスと//プラグインに必要なその他のJavaクラスを含めます
Javaクラス1
Javaクラス2
28 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
。。。
Webコンテンツ
//プラグインWEB-INFで必要なすべての画像、JavaScript、およびHTMLファイルを
含めます。
manifest.mf
の中に パッケージ名 フォルダーに、プラグイン用に定義されたJavaクラスファイルを含めます。Javaクラスのパ
ッケージ名に基づいてサブフォルダーを作成します。ネストされたパッケージのネストされたフォルダーを使用し
て、標準のJARファイル構造に従います。
重要： すべてのJavaクラスは、名前付きパッケージに含まれている必要があります。デフォルトのパッケージは使用
できません。
2。 修正 manifest.mf プラグインに次のプロパティを含めるファイル：
プラグインクラス： pluginClassName
pluginClassName あなたの名前です Plugin.java サブクラス。また、JARファイルの任意の標準プロパ
ティを
manifest.mf ファイル。
関連情報：
クラスプラグイン
IBM Content Navigatorプラグインのメインクラスを提供します。抽象メソッドは、プラグインの名前とバージョン、
およびプラグインによって提供されるアクション、サービス、スクリプトを提供します。
IBM Content Navigatorへのプラグインの作成 29日
30 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
外部データサービス
外部データサービス（EDS）表現状態転送（REST）プロトコルを使用して外部データサービスを作成し、JSONファイ
ルやデータベース内のテーブルなどの外部ソースからデータを取得して、フィールドプロパティをカスタマイズし、プ
ロパティを管理できます。 IBM Content Navigatorでの動作。データフロー図を確認して、外部データサービスがIBM
Content Navigatorクライアントと外部データソースの間で要求を送信および返す方法を理解します。
外部データサービスを作成すると、既存のデータはIBM Content Navigatorのフィールド値やその他のフィールドプロパ
ティと統合されますが、データの保存と維持は引き続き、元の信頼できるデータソースでのみ行われます。データを別
のリポジトリに移動またはコピーせずにデータにアクセスできるため、ソースは元のデータストアに残ります。ビジネ
ス・ユーザーがWebクライアントを介してサービスを呼び出すときはいつでも外部データにアクセスできるように、外
部データ・ソースはIBM Content Navigatorで引き続き使用可能でなければなりません。
外部データサービスを使用する利点は、ユーザーインターフェースのプロパティと値をカスタマイズするためにIBM C
ontent Navigatorソースコードを変更する必要がないことです。したがって、データおよび外部データサービスはIBM
Content Navigatorソースコードとは別に配置されているため、IBM Content Navigatorへのアップグレードやその他の
主要な変更は、外部データサービスによって取得されるプロパティデータに影響を与えません。
外部データサービスを実装できる場所
外部データサービスを使用して、ユーザーがドキュメントを追加したり、フォルダーを追加したり、ドキュメントをチェックインしたり
、エントリーテンプレートを使用したり、ワークフローステッププロパティとワークフローフィルター基準フィールド（IBM FileNet P8
）を作成したり、次のフィールドプロパティとプロパティの動作をカスタマイズしたりできます。または検索を使用します。
データベースの値を検索して、選択リストを作成します
IBM Content Navigatorに接続されているものとは異なるコンテンツリポジトリまたはデータソースで
管理されている既存のデータを使用して、選択リストを作成します。
たとえば、外部サーバーまたはリポジトリで検索および管理されるJSONファイルの値を使用で
きます。
プレフィルプロパティ
事前入力されたプロパティとデフォルト値を指定します。
たとえば、特定のクラスID、認証済みユーザー、または親フォルダーに基づくカスタムのデフォルト
値をフィールドに事前入力できます。
プロパティの依存関係を指定する
プロパティ間の依存関係を定義します。
たとえば、地理的領域の選択リストプロパティとオフィスブランチの選択リストプロパティの間の依存関係
を指定して、ユーザーが地理的リージョンを選択したときに、選択した地理的リージョンに依存する後続の
選択リストに、その地理的地域に関係しています。
©Copyright IBM Corp. 2012
31
最小値と最大値を設定する
プロパティの最大値または最小値を定義するには、整数、浮動小数点数、または日付を指定します。
制限： 最小値または最大値をリセットして、使用しているリポジトリーで指定されている最小値または最大
値よりも制限を緩和することはできません。
たとえば、リポジトリの最小値が100の場合、サービスは値を150に設定できますが、50には設定できませ
ん。
読み取り専用ステータスを設定する
プロパティを読み取り専用に設定します。
たとえば、特定の値を必要とするプロパティを作成する場合があります。エラーの原因となる別の値をユー
ザーが入力できないようにするために、正しいデフォルト値を指定して、そのプロパティを読み取り専用に
することができます。
必要なステータスを設定する
プロパティを必須フィールドに設定します。プロパティでこの属性を使用すると、ユーザーインターフェースにアスタ
リスクが表示され、フィールドが必須であることを示します。フィールドに値が含まれていない場合、ユーザーはペー
ジまたはダイアログボックスから先に進むことができません。
非表示のステータスを設定する
ユーザーインターフェイスからプロパティを非表示にします。
たとえば、フォームに表示する後続のテキスト入力フィールドを動的に決定する選択リストを作成できま
す。特定の状況で適用されないプロパティを非表示にするには、hidden属性を使用できます。
プロパティの検証とエラーチェックを実装する
ユーザーがプロパティフィールドに値を入力するときに、カスタムメッセージを表示するか、支援を提供します。
制限： オブジェクトプロパティ、参照属性、読み取り専用プロパティ、非表示プロパティ、または
検索条件にカスタム検証を使用することはできません。
外部データサービスアーキテクチャとデータフロー
特定のアクションまたはプロパティに外部データサービスが実装されている場合、ビジネスユーザーがWebクライア
ントでそのアイテムを操作すると、サービスが呼び出されます。次の図は、外部データサービスがリクエストを送信
して返す方法を示しています。
32 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content Navigatorサーバー
IBM Content Navigatorクライアント
ユーザーは、プロパティのドロップダウンメニュ
1
2
ーをクリックして選択肢リストを選択します。
6
ユーザーインターフェイスのプロパティは、
7
EDSSupportPlugin
応答ペイロードのデータを基
外部ソースからのデータで更新されます。
になるリポジトリ情報とマー
ジします
5
応答ペイロード（POSTメ
ソッド）
３
リクエストペイロード（POSTメソッド）
外部データサービス
情報元
例：
-JSONファイル
4
尋問
- SQLデータベース
GetObjectタイプ
処理するすべてのクラスのリストを取得します。
UpdateObjectタイプ
クラスごとに現在の値を取得し、その情報を
応答ペイロードで返します。
外部データサービスは、アプリケーション開発者が作成する必要がある2つのサービスを使用して機能します
。
v あ GetObjectTypes すべてのクラス、アイテムタイプ、またはワークフローのリストを取得するサービス
外部データサービスが処理する必要のある情報。
v あ UpdateObjectType 現在の属性または値を取得するための各クラスのサービス
その情報を応答ペイロードで返します。
外部データサービスは、ユーザーが特定のダイアログボックスを開いたとき、またはユーザーインターフェイスのプロ
パティに値を設定しようとしたときに呼び出されます。中間層サービスは、要求ペイロードを外部データサービスに送
信します。外部データサービスは、クラスと属性に関する要求された情報について外部データソースに問い合わせます
。次に、応答ペイロードからの情報は、使用しているリポジトリー（例えば、IBM Content ManagerやFileNet P8など
）の基礎となる情報とマージされます。
ユーザー・インターフェースにデータが表示される優先順位は、IBM Content Navigatorが最初にクラス属性を使用し
、次にアクティブな選択済みエントリー・テンプレートで指定された値をチェックし、最後にIBM Content Navigato
rが外部データによって指定された値をチェックすることですサービス。
35ページの 『IBM Content Navigatorの外部データサービスの作成』 EDS RESTプロトコルを使用して、以
下を指定する外部データサービスを作成します。
外部データサービス 33
IBM Content Navigatorでフィールドプロパティをカスタマイズし、プロパティの動作を管理するために、外部デ
ータソースからデータを取得する要求。外部データサービスをWebアプリケーションとして実装します。
36ページの 『外部データ・サービスRESTプロトコル仕様』オブジェクト・タイプ要求、特定のオブジェクト
・タイプ要求、および各要求に対して作成する必要がある応答の仕様を理解してください。49ページの「サン
プルの外部データサービス」
サンプルの外部データサービスでは、選択リストの値は外部データソースから使用されます。
IBM Content Navigatorの外部データサービスの作成
EDS RESTプロトコルを使用して、外部データソースからデータを取得するリクエストを指定して、フィールドプロパ
ティをカスタマイズし、IBM Content Navigatorでプロパティの動作を管理する外部データサービスを作成します。外部
データサービスをWebアプリケーションとして実装します。
あなたが始める前に
外部データサービスを通じてカスタマイズできるIBM Content Navigatorのプロパティと領域を理解します。
オブジェクトタイプリクエストと特定のオブジェクトタイプリクエストを定義するための仕様を確認します。
外部データサービスを実装するには、次のスキルが必要です。
v ジャワ
v Java 2プラットフォーム、Enterprise Edition
v 2つのサービス（2つのJavaサーブレットなど）でWebアプリケーションを実装する
v データベース開発
v JSONの読み取りと書き込み
このタスクについて
サービスを設計する際は、以下のヒントを考慮して、選択リストおよびその他のフィールドプロパティの使いやすさを
向上させてください。
後続のリストを絞り込むことができるプロパティを追加して、選択リストのサイズを縮小します
たとえば、質問を使用してリストの範囲を絞り込んだり、プロパティ間の依存関係を使用して長い選択リ
ストを短い選択リストに分割したりできます。
依存選択リストを作成する
依存選択リストの値は、前の親リストで選択された値に応じて、別のリストに置き換えられます。たとえば
、次のように設定できます。 領域 そして 支店 選択リスト、ここで 支店
リストは 領域 リストの選択。ユーザーが別の地域を選択した場合、 支店 リストは、ブランチオフィスの別
のリストによってクリアされ、入力されます。
ユーザーがデータ入力のエラーをすぐに解決できるように、カスタム検証を実装します。
たとえば、文字の制限があるテキストフィールドを実装する場合、カスタム検証エラーメッセージを使用
して、
34 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
エラーの説明に加えて、サポートされていない文字のリストをユーザーに提供して、ユーザーが将来その
ような文字を入力するのを回避できるようにすることもできます。
手順
外部データサービスを作成するには：
1。 外部データによって処理されるクラスのリストを取得するサービスを作成します
サービス。ワークフロー情報については、クラスではなく、登録されているサービスタイプのリストを取
得するサービスを作成します。たとえば、 GetObjectTypes サービス：
v リクエスト： GET / types？repositoryId = repository_Id。
v 応答：
[{“ symbolicName”：“ object_type_or_service_type 」
} //その他のオブジェクトタイプ]
このサービスは、 取得する リポジトリIDを提供するリクエスト。この例の応答は、JSONファイル内の名前
の値の配列です。このリストには、外部データサービスによってサポートされるすべてのクラスが含まれてい
る必要があります。
2。 ある各クラスの現在の属性と値を取得するサービスを作成します
前のステップで作成したサービスに含まれています。このサービスは、クラスの現在の属性と値を取得し、それ
らのプロパティに関する情報を中間層サービスに返します。投稿されるデータはJSONであり、応答もJSONで
す。たとえば、 UpdateObjectType /という形式のURLでPOSTメソッドを処理するサーブレット タイプ/ object_type_name：
v リクエスト：
POST / type / class_name_or_item_type_name
{"repositoryId"： " target_repository "、
"objectId"： " if_an_existing_instance、_the_GUID_or_PID "、
"requestMode"： " shows_context_that_info_is_being_requested "、
"externalDataIdentifier"： " opaque_identifier_meaningful_to_service "、
"プロパティ"：
[{"symbolicName"： " symbolic_name "、
"値"： " the_current_value "、
} //その他のプロパティ...]}
v 応答：
{"externalDataIdentifier"： " opaque_identifier_meaningful_to_the_service "、
"プロパティ"：
[{"symbolicName"： " symbolic_name "、
「choiceList」：
{ "表示名"： " 表示名"、
外部データサービス 35
"選択肢"：
[{ "表示名"： " 名前"、
"値"： 値
}、
//選択肢リストの選択肢を増やします]}}
//その他のプロパティ]}
次はどうする
外部データサービスを作成したら、Webアプリケーションサーバーにサービスをデプロイして開始し、 EDSSupportPlugin
IBM Content Navigator管理ツールのプラグイン。
関連する概念：
5ページの 『IBM Content Navigator中間層サービス』
IBM Content Navigatorサービスは、リポジトリーへの接続を提供します。さらに、サービスは、リポジトリ全体での検
索やドキュメントの表示などの機能をサポートします。
関連タスク：
プラグインの登録と構成
関連資料：
41ページの 『例：GETメソッドの要求と応答』このサンプル・コードは、 取得する 外部データサービスへのリクエ
スト。次に、サービスは、サポートされているオブジェクトタイプを返します。これには、外部データソースから取
得した値でプロパティを更新するクラス、ワークフロー情報、またはアイテムタイプが含まれます。52ページの 『例
：POSTメソッドの要求と応答』このサンプル・コードは、IBM Content Navigatorユーザーが領域プロパティーの値を
選択すると、外部データ・サービスに要求を送信します。 領域。 次に、サービスはブランチオフィスプロパティの選
択リストを更新します。 支店、 に依存します 領域 プロパティ。
外部データサービスRESTプロトコルの仕様
オブジェクトタイプリクエストの仕様、特定のオブジェクトタイプリクエスト、リクエストごとに作成する必要があ
るレスポンスを理解します。
「オブジェクトタイプリソース」
オブジェクトタイプリソースは、外部データサービス用に取得するクラス、アイテムタイプ、ワークフローステッププ
ロセッサー、またはワークフロー受信トレイフィルターを表します。39ページの「特定のオブジェクトタイプリソース
」
特定のオブジェクトタイプリソースは、プロパティ値が外部データソースから取得されるプロパティを表します。
ユーザーが新しいアイテムを作成するか、特定のオブジェクトタイプのアイテムを変更すると、EDS RESTプロト
コルは特定のオブジェクトタイプリソースを使用して、対応するクラス、アイテムタイプ、ワークフローステップ
プロセッサー、またはワークフロー受信トレイフィルターのデータを外部データソース。
オブジェクトタイプリソース
オブジェクトタイプリソースは、外部データサービス用に取得するクラス、アイテムタイプ、ワークフローステッププロ
セッサー、またはワークフロー受信トレイフィルターを表します。
36 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
「GETメソッド」 取得する requestは、外部データサービスのオブジェクトタイプのリストを取得します。41ペ
ージの 『FileNet P8ワークフローへの外部データサービスの統合』外部データサービス（EDS）は、プロセスバ
スケット内フィルター基準のデータフィールド、ステッププロセッサー、およびワークフローの起動に実装でき
ます。サービスを見つけ、受信トレイフィルター、ステップ、またはワークフローを識別するマルチパート文字
列を作成する必要があります。
41ページの 『例：GETメソッドの要求と応答』このサンプル・コードは、 取得する 外部データサービスへのリ
クエスト。次に、サービスは、サポートされているオブジェクトタイプを返します。これには、外部データソー
スから取得した値でプロパティを更新するクラス、ワークフロー情報、またはアイテムタイプが含まれます。
GETメソッド
の 取得する requestは、外部データサービスのオブジェクトタイプのリストを取得します。
URI構文
応答では、オブジェクトタイプリソースを作成します。たとえば、
ObjectTypes.json ファイルには、外部データソースから取得した値でプロパティを更新するクラス名、アイテムタイ
プ名、またはワークフロー情報が含まれています。
IBM FileNet P8ワークフロー情報の場合、クラス名またはアイテムタイプ名の代わりにマルチパートの文字列値
が使用されます。
/ types？repositoryId = リポジトリID
リポジトリIDは、サービスで使用されるクラス名、アイテムタイプ名、またはワークフロー情報を含むデータソー
スのシンボリック名です。
コンテンツをリクエストする
GET / types？repositoryId = リポジトリID
応答内容
リクエストへのレスポンスには、次のパラメータを含むJSONペイロードが含まれている必要があります。
{"タイプ"：
[{"symbolicName"： "TypeOne"、}、
//その他のオブジェクトタイプ
。。。
]}
応答コード
表13.の応答コード 取得する 方法
コード
説明文
200 OK
メソッドは正常に完了しました。によって返される応答 取得する メソッドには、オブジェクトタイプのリストを含むJSON
ペイロードが含まれます。
400不正な要求
必須パラメーターの1つが欠落しているか、パラメーター値が無効でした。
外部データサービス 37
表13.の応答コード 取得する メソッド（続き）
コード
説明文
404お探しのページが見つかりませんでした
クラス名またはアイテムタイプ名が repositoryId 情報元。このエラーは、オブジェクトタイプのリクエストがこの外部データサービ
スによって実装されていないため、外部データサービスがクラスのプロパティ値を管理しないことを示しています。EDS RESTプロ
トコルは、IBM Content Navigatorにエラーを返しません。IBM Content Navigatorは外部データサービスを無視し、クラスの特定のオ
ブジェクトタイプのサービスを呼び出しません。
500内部サーバーエラー
サーバーエラーが発生しました。エラーの詳細については、JSON応答のuserMessage要素を参照してください。
関連資料：
「FileNet P8ワークフローへの外部データサービスの統合」外部データサービス（EDS）は、プロセスバスケットフィ
ルター基準のデータフィールド、ステッププロセッサー、およびワークフローの起動に実装できます。サービスを見つ
け、受信トレイフィルター、ステップ、またはワークフローを識別するマルチパート文字列を作成する必要があります
。
FileNet P8ワークフローへの外部データサービスの統合
外部データサービス（EDS）は、プロセスバスケット内フィルター基準のデータフィールド、ステッププロセッサー、お
よびワークフローの起動に実装できます。サービスを見つけ、受信トレイフィルター、ステップ、またはワークフローを
識別するマルチパート文字列を作成する必要があります。
次の領域のワークフローデータフィールドにEDSを実装できます。
v バスケット内フィルター基準の処理
v ワークフローとステッププロセッサのプロパティを起動する
EDSは、サービスリクエストタイプを識別するために、複数の部分からなる値を登録する必要があります。ワークフロー情報
の場合、クラス名またはアイテムタイプ名の代わりにマルチパート値が使用されます。
バスケット内フィルター基準の処理
マルチパート文字列を作成して、EDS実装で使用している受信フィルターを識別します。受信トレイフィルターを識
別するには、次の形式を使用します。
application_space_name.process_role_name.in-basket_name
例：
{"symbolicName"： "DefaultApplication.Personal_Items.My_Personal_Work"}
ワークフローとステッププロセッサを起動する
マルチパート文字列を作成して、EDS実装で使用しているワークフローの起動ステップまたはステッププロセッサの他
のステップを識別します。次の形式を使用して、ステップを識別します。
workflow_name.sheet_name.step_name
例：
{"symbolicName"： "Data_Field_Workflow.Workflow.LaunchStep"}
ワークフローレジストリは、トークン化された複数部分の文字列に対するオプションの4番目の部分をサポートします。
38 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
workflow_name.sheet_name.step_name.EDS_Service_value
の EDS_Service_value 値は、呼び出される公開されたカスタムデータフィールドの値から取得されます EDS_Service
その特定のステップで。ワークフローデザイナーは手動で作成する必要があります EDS_Service データフィールドを
指定し、そのデータフィールドを、 EDS_Service EDS処理の値。ワークフローがこの文字列をステップで公開する場
合、文字列はプロセッサプロパティユーザーインターフェイスに表示されません。代わりに、文字列は非表示のプロ
パティです。
たとえば、この文字列は、 Approval_Step とともに
EDS_Service の価値 MyService：
{"symbolicName"： "Data_Field_Workflow.Workflow.Approval_Step.MyService"}
例：GETメソッドのリクエストとレスポンス
このサンプルコードは 取得する 外部データサービスへのリクエスト。次に、サービスは、サポートされているオブジ
ェクトタイプを返します。これには、外部データソースから取得した値でプロパティを更新するクラス、ワークフロ
ー情報、またはアイテムタイプが含まれます。
リクエスト例
GET / types？repositoryId = リポジトリID
応答例
[{"SymbolicName"： "Book"}、{"SymbolicName
"： "Invoice"}、{"SymbolicName"： "Folder"}
{"SymbolicName"： "Document"}]
特定のオブジェクトタイプリソース
特定のオブジェクトタイプリソースは、プロパティ値が外部データソースから取得されるプロパティを表します。ユ
ーザーが新しいアイテムを作成するか、特定のオブジェクトタイプのアイテムを変更すると、EDS RESTプロトコル
は特定のオブジェクトタイプリソースを使用して、対応するクラス、アイテムタイプ、ワークフローステッププロセ
ッサー、またはワークフロー受信トレイフィルターのデータを外部データソース。
EDS RESTプロトコルは、アイテムが作成されるか、プロパティが変更されると、リソースのPOSTメソッドを
呼び出します。次に、サービスは必要な情報を応答で返します。 役職 リクエスト。
40ページの「POSTメソッド」 役職 メソッドは、特定のクラスの項目タイプの外部データソースからデータを取
得します。このメソッドを直接呼び出すことはありません。代わりに、EDS RESTプロトコルは、ワークフロー
情報またはコンテンツアイテムが追加または変更されているときに、このメソッドを自動的に呼び出します。42
ページの 『要求モード』
Webクライアントでアイテムが作成または変更されると、IBM Content Navigatorは 役職 特定のオブジェクトタイ
プリソースが外部データサービスにリクエストを送信するためのメソッド。この要求ペイロードには、実行されて
いるアクションを示す要求モードが含まれています。
43ページの「POSTメソッド要求ペイロードへの応答ペイロード」外部データサービスは、 役職 によって提出さ
れたメソッド
EDSSupportPlugin プラグイン。応答ペイロードには、サービスによって管理されるプロパティの値が
含まれています。
外部データサービス 39
49ページの「外部データサービスのエラー応答」 役職 メソッド呼び出しが失敗した場合、外部データサービス
が返す応答コードは、発生したエラーのタイプを示します。外部データサービスのエラー応答を記述します。
52ページの 『例：POSTメソッドの要求と応答』このサンプル・コードは、IBM Content Navigatorユーザーが領域
プロパティーの値を選択すると、外部データ・サービスに要求を送信します。 領域。 次に、サービスはブランチオ
フィスプロパティの選択リストを更新します。 支店、
に依存します 領域 プロパティ。
POSTメソッド
の 役職 メソッドは、特定のクラスの項目タイプの外部データソースからデータを取得します。このメソッドを直接呼び
出すことはありません。代わりに、EDS RESTプロトコルは、ワークフロー情報またはコンテンツアイテムが追加または
変更されているときに、このメソッドを自動的に呼び出します。
IBM Content Navigatorが 役職 メソッドでは、リクエストのペイロードに各プロパティの現在の値が含まれています。
現在の値は、次のいずれかの値になります。
v デフォルト値
v リポジトリ内のプロパティに永続化された値
v ユーザーがプロパティに入力した作業値
外部データサービスが返す応答ペイロードには、管理するプロパティへの変更が含まれます。サービスは、プロパティ
値の変更に加えて、プロパティの属性を変更できます。
その後、IBM Content Navigatorはこれらの変更をリポジトリー内の基本データとマージし、データをIBM Co
ntent Navigatorに返します。
URI構文
/タイプ/{ クラス名}
パス要素
表14.のパス要素 役職 方法
名前
タイプ
説明文
{オブジェクトタイプ名}
ストリング
更新されるプロパティを定義するクラス名またはアイテムタイプ名のシンボル名。
コンテンツをリクエストする
{"repositoryId"： " target_object_store_name "、
「objectId」
： " GUID_or_PID_of_item_that_is_being_edited "、
"requestMode"： " request_context "、
"externalDataIdentifier"： " identifier_for_the_service "、
"プロパティ"：
[{"symbolicName"： " プロパティ名"、
"値"
： 現在の価値、
}
//その他のプロパティ...
]、
40 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
"clientContext"：{"Key1"： " Va
lue1、
"キー2"： " 値2 "
}
}
表15.の要求パラメーター 役職 方法
名前
タイプは必須ですか？説明文
repositoryId
ストリングはい
プロパティデータを含むターゲット外部データストアのシンボル名。
objectId
文字列いいえ
編集中のアイテムを識別するグローバル一意識別子（GUID）または永続識別子（PID）。
requestMode
ストリングはい
次のいずれかの要求モード。 役職
メソッドが呼び出されています：
v initialNewObject
v initialExistingObject
v inProgressChanges
v finalNewObject
v finalExistingObject
要求モードについては、要求モードを参照してください。
externalData識別子
ストリングはい
外部データサービスによって返されたデータの状態を示す文字列。リクエストには、この識別子が含まれてい
る必要があります。 requestMode
パラメータは次のいずれかの値に設定されます。
v inProgressChanges
v finalNewObject
v finalExistingObject
プロパティ
アレイはい
クラスまたはアイテムタイプに定義されているプロパティの値を含む配列。プロパティごとに、リクエストに
はシンボル名とプロパティ値が含まれます。
clientContext 配列番号
特定のクラスまたはアイテムタイプのコンテキスト情報を指定する一連のキーと値のペアを含む配列。このパラ
メーターは、IBM Content Navigatorユーザーがドキュメントの追加、フォルダーの追加、エントリテンプレート
の使用、または検索の作成を開始したときに、外部データサービスに情報を送信するために使用されます。
応答コード
表16.の応答コード 役職 方法
コード
説明文
200 OK
メソッドは正常に完了しました。によって返される応答 役職 メソッドには、プロパティの更新された情報が含まれます。
400不正な要求
必須パラメーターの1つが欠落しているか、パラメーター値が無効でした。
404お探しのページが見つかりませんでした
リクエストで指定されたクラスが見つかりませんでした。このエラーは、クラスが無効であることを示すものではありません。代
わりに、外部データサービスがクラスのプロパティ値を管理しないことを示します。EDS RESTプロトコルは、IBM Content Navig
atorにエラーを返しません。
500内部サーバーエラー
サーバーエラーが発生しました。エラーの詳細については、JSON応答のuserMessage要素を参照してください。
外部データサービス 41
関連資料：
「リクエストモード」
Webクライアントでアイテムが作成または変更されると、IBM Content Navigatorは 役職 特定のオブジェクトタイプリ
ソースが外部データサービスにリクエストを送信するためのメソッド。この要求ペイロードには、実行されているア
クションを示す要求モードが含まれています。
リクエストモード
Webクライアントでアイテムが作成または変更されると、IBM Content Navigatorは 役職 特定のオブジェクトタイプリ
ソースが外部データサービスにリクエストを送信するためのメソッド。この要求ペイロードには、実行されているア
クションを示す要求モードが含まれています。
そのアクションに必要なデータで応答するように外部データサービスを構成する必要があります。たとえば、リクエ
ストがドキュメントの追加である場合、ドキュメントの追加ウィザードを開くと、サービスは、ドキュメントに定義
されている初期プロパティ値で応答する必要があります。 ドキュメントを追加 クラス。
の requestMode パラメーターは、IBM Content Navigatorで実行されているアクションを示します。このアクショ
ンは、外部データサービスによって返される応答を決定します。
入力ペイロードの場合、次の値がコンテキストIDで提供されます。
表17.入力ペイロードのコンテキストIDに提供される値
値
説明文
ユーザーID
IBM Content NavigatorにログインしているユーザーのユーザーI
D。
外部データサービスへのこの呼び出しを開始したブラウザのロ
ロケール
ケール。
使用中のデスクトップのデスクトップID。
デスクトップ
の requestMode パラメータには次の値を指定できます。
initialNewObject
新しいオブジェクトが作成されていることを示します。各プロパティの入力ペイロードには、リポジトリ
で定義されているシンボル名とデフォルト値が含まれています。
initialExistingObject
既存のオブジェクトが編集中であることを示します。プロパティごとに、サービスに渡される入力ペイロー
ドには、現在リポジトリに格納されているシンボル名と値が含まれています。入力ペイロードには、 objectId
編集中のコンテンツアイテムのグローバル一意識別子（GUID）または永続識別子（PID）を指定するパラメ
ーター。サービスはGUIDを使用してコンテンツアイテムを参照できます。ただし、クラスのリポジトリに
格納されている値は変更される可能性があることに注意してください。したがって、入力ペイロードで提供
される値は、クラスのリポジトリーに現在格納されている値と一致しない場合があります。入力ペイロード
には、 externalDataIdentifier
パラメータ。代わりに、このパラメーターは外部データサービスによって設定され、応答ペイロードで
返されます。中に行われた後続のリクエスト
42 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
クラスの更新には、 externalDataIdentifier データの現在の状態をサービスに示すパラメータ。
inProgressChanges
依存プロパティを持つ1つ以上のプロパティの変更に応じて外部データサービスが呼び出されているこ
とを示します。入力ペイロードには、次の情報を含めることができます。
v クラスまたはアイテムタイプの各プロパティの現在の作業値
v の externalDataIdentifier サービスに指示するパラメータ
更新したプロパティの以前の状態
v 既存のクラスの場合、 objectId GUIDを指定するパラメーター
または編集中のコンテンツアイテムのPID外部データサービスは、管理するプロパティの属性または
作業値が変更された場合に、この要求に応答します。また、サービスはカスタム検証エラーを返すために
応答します。
finalNewObject
オブジェクトがリポジトリに永続化される前のこの値は、オブジェクトを作成する一連の交換の最後に外部
データサービスが呼び出されていることを示します。この呼び出しの後、新しいオブジェクトが作成され、
プロパティ値がリポジトリに保持されます。各プロパティについて、サービスに渡される入力ペイロードに
は、クラスによって定義されたすべてのプロパティの作業値が含まれています。
finalExistingObject
外部データサービスが一連の交換の最後に呼び出され、既存のプロパティを更新することを示します。こ
の呼び出しの後、更新されたプロパティ値はリポジトリに保持されます。各プロパティについて、サービ
スに渡される入力ペイロードには、クラスまたはアイテムタイプによって定義されたすべてのプロパティ
の作業値が含まれています。
POSTメソッド要求ペイロードへの応答ペイロード
外部データサービスは、 役職 によって提出されたメソッド
EDSSupportPlugin プラグイン。応答ペイロードには、サービスによって管理されるプロパティの値が含まれています
。
応答内容
リクエストへのレスポンスには、次のパラメータを含むJSONペイロードが含まれている必要があります。
{"externalDataIdentifier"： " opaque_identifier_meaningful_to_the_service "、
"プロパティ"：
[{"symbolicName"： " symbolic_name "、
"値"： potential_new_value、
"customValidationError"： " 無効な理由の説明 "、
"customInvalidItems"：[0,3,4,8]、//無効な複数値アイテム "displayMode"： " readonly_or_readwrite
"、
"必須"： 正しいか間違っているか、
「非表示」： 正しいか間違っているか、
「maxValue」： overridden_​​maximum_value、
「minValue」： overridden_​​minimum_value、
「maxLength」： 基本最大長、
外部データサービス 43
「choiceList」：
{ "表示名"： " 表示名"、
"選択肢"：
[ { "表示名"： " 名前"、
"値"： 値
}、
{ "表示名"： " 名前"、
"値"： 値
}、
//その他の選択肢...]}
"hasDependentProperties"： 正しいか間違っているか、
}
//その他のプロパティ...
]
}
表18.の応答パラメーター 役職 方法
名前
タイプは必須ですか？説明文
externalData識別子
文字列いいえ
識別子は、サービスが返しているデータの状態を示すコンテキスト情報を提供します。
このパラメーターは、データソースにとって意味のある値で実装します。通常、パラメーターは、最小値、最大
値、選択リストなど、プロパティ値以外の属性を定義する特定の構成を参照します。これらの構成は、他のプロ
パティ値に基づいて動的に選択できます。構成を動的に選択するために、サービスは externalDataIdentifier 前
回の呼び出し以降に構成が変更されたことを判別するパラメーター。
属性の動的動作または依存関係を実装しない場合は、データの状態をキャプチャする必要がない場合があります。
この状況では、固定文字列値を返すパラメータを実装する場合があります。
外部データサービスが動的なデータを返す場合は、データの状態をキャプチャする必要があります。たとえば、
サービスは、値または他の属性が別のプロパティの値によって決定されるプロパティを管理する場合があります
。この状況では、パラメーターを実装して、依存プロパティの値または他の属性を決定するために使用された特
定の構成を参照する値を返す必要があります。パラメータは、プロパティデータの変化を識別するのに十分な情
報をキャプチャする必要があります
externalDataIdentifier パラメータがサービスに返されます
inProgressChanges リクエスト。
たとえば、条件のリストを使用して、作業プロパティ値に基づいて構成のセットを選択するとします。でキャプ
チャされるデータ externalDataIdentifier パラメータには、一致条件のインデックスが含まれる場合があります。
プロパティ
アレイはい
外部データサービスによって管理されるプロパティの値を含む配列。プロパティごとに、シンボル名と、値、
選択リスト、最大長などの属性を指定できます。
44 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
プロパティ属性
の プロパティ パラメータには、外部データサービスによって管理される各プロパティの次の属性が含まれます。外部デ
ータサービスはこれらの値の多くを動的に決定できるため、サービスは各応答で異なる値を返すことができます。
表19.応答ペイロードのプロパティの属性
名前
タイプ
必須？
説明文
symbolicName
ストリング
はい
プロパティの記号名。名前は、要求ペイロードで指定された記号名と一致する必要があり
ます。
値
クラスの設定により 番号
プロパティの値。外部データサービスによって設定される値は、クラスのプロパティに指定されて
決定
いるデータ型に対応している必要があります。
外部データサービスは、他の別のプロパティの値に基づいてプロパティ値を動的に決定できます
。
サービスが値を指定しない場合、プロパティの現在の作業値は変更されません。
カスタム検証エラ
ストリング
番号
プロパティ値が無効である理由を説明するメッセージ。
ー
プロパティの現在の値を検証するように外部データサービスを構成できます。値が無効な場合、
サービスは値を変更せずに、エラーメッセージを
customValidationError パラメータ。
たとえば、サービスはアカウント番号が無効であると判断する場合があります。ただし、サービスで
アカウント番号を置き換える必要はありません。代わりに、サービスでエラーメッセージを返すよう
に構成できます。 customValidationError パラメータ。
このパラメーターが応答に含まれている場合、プロパティー値は無効と見なされます。ただし、この
属性がない場合は、パラメーターが外部データサービスによって実行される検証に合格したことのみ
を示します。サービスによって検証されない属性に基づいて、値は引き続き無効である可能性があり
ます。
値は正規表現を使用して検証されます。たとえば、次の正規表現を使用して、単純な電子メールア
ドレスを検証できます。
「\\ b [\\ w \\ .-] + @ [\\ w \\ .-] + \\。\\ w {2,4} \\ b」
制限： ワークフロープロパティ、チームスペース、およびエントリテンプレートプロパティのプロ
パティにカスタム検証を使用できます。オブジェクトプロパティ、参照属性、読み取り専用プロパ
ティ、非表示プロパティ、または検索条件にカスタム検証を使用することはできません。
カスタム無効
インデックスの
アイテム
配列
番号
複数値プロパティの値のリストのインデックスの配列。
外部データサービスが複数値のプロパティを検証する場合、このパラメーターを返して、無効な特定
の値を示すことができます。複数値のプロパティが無効であり、このパラメーターが設定されていな
い場合、プロパティ値は全体として無効と見なされます。
この属性は、 customValidationError
パラメータは、プロパティが無効であることを示します。
外部データサービス 45
表19.応答ペイロードのプロパティーの属性（続き）
名前
タイプ
必須？
説明文
ディスプレイモード
ストリング
番号
IBM Content Navigatorがプロパティー値を読み取り専用として表示するかどうかを指定するストリ
ング。
外部データサービスは、このパラメーターを次のいずれかの値に設定できます。
読み取り専用
ユーザーはプロパティ値を表示できますが、変更することはできません。
読み書き
ユーザーはプロパティ値を変更できます。この設定がデフォルト値です。
プロパティ値がクラスで読み取り専用に設定されている場合、外部データサービスは値
を書き込み可能にすることができません。この状況では、readwriteの値は無視されます
。
フォーマット
ストリング
番号
プロパティに入力する値の正しい形式を説明する式。用途 formatDescription の説明を提供する フォーマット
パラメータ。
フォーマット
ストリング
番号
説明文
で指定された式と一致しない形式をユーザーが入力した場合にツールチップに表示される説明
フォーマット
パラメータ。
必須
ブール
番号
プロパティに値が必要であることを示すためにtrueに設定されるブール値。
外部データサービスは、他のプロパティの値に基づいてこの設定を動的に決定できます。ただし、
サービスは 必須 パラメータの場合 必須 パラメータは、クラスでtrueに設定されています。
隠された
ブール
番号
プロパティーがIBM Content Navigatorで非表示になることを示すためにtrueに設定されるブール値
。
外部データサービスは、他のプロパティの値に基づいてこの設定を動的に決定できます。
このパラメーターを指定しない場合、クラスで指定された値が使用されます。
maxValue
整数、浮動、ま
番号
プロパティの最大値を示す数値。
たは日時
外部データサービスは、他のプロパティの値に基づいてこの設定を動的に決定できます。
リポジトリ内のプロパティに最大値が指定されている場合、サービスは設定の制限を緩和できません
。つまり、サービスは最大値をより小さい値にのみ設定できます。最大値を増やすことはできません
。たとえば、リポジトリの最大値が100の場合、サービスは値を50に設定できますが、150には設定で
きません。
minValue
整数、浮動、ま
番号
プロパティの最小値を示す数値。
たは日時
外部データサービスは、他のプロパティの値に基づいてこの設定を動的に決定できます。
リポジトリのプロパティに最小値が指定されている場合、サービスは設定の制限を緩和できません。
つまり、サービスは最小値をより大きな値にのみ設定できます。最小値を下げることはできません。
たとえば、リポジトリの最小値が100の場合、サービスは値を150に設定できますが、50には設定でき
ません。
46 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表19.応答ペイロードのプロパティーの属性（続き）
名前
タイプ
必須？
説明文
maxLength
整数
番号
プロパティ値の最大文字数を示す数値。
外部データサービスは、他のプロパティの値に基づいてこの設定を動的に決定できます。
Content Engineのプロパティーに最大長が指定されている場合、サービスは設定の制限を緩和できま
せん。つまり、サービスは最大長をより小さい値にのみ設定できます。最大長を増やすことはできま
せん。たとえば、Content Engineの最大長が100の場合、サービスは値を50に設定できますが、
150。
choiceList
対象
番号
プロパティ値の選択肢のリストを定義する配列。
外部データサービスは、リポジトリのプロパティに選択リストが定義されていない場合にのみ、選
択リストを指定できます。サービスは、他のプロパティの値に基づいて、リスト内の選択肢を動的
に決定できます。
の choiceList 値には、選択肢のフラットリストを含めることができます。
「choiceList」：
{ "表示名"： " display_name_for_the_choice_list "、
"選択肢"：
[ { "表示名"： " display_name_for_a_specific_choice "、
"値"： 値
}、
{ "表示名"： " display_name_for_a_specific_choice "、
"値"： 値
}、
//その他の選択肢...]}
重要： 外部データサービスを使用して提供する選択リストに関連付けられている同じプロパティのC
ontent Engine定義に選択リストを実装しないでください。
hasDependentプロパティ
ブール
番号
他のプロパティがこのプロパティの値に依存する場合にtrueに設定されるブール値。
このパラメーターをtrueに設定すると、 役職 メソッドが呼び出され、このプロパティが更新され
るたびに、新しい値に基づいて依存プロパティが更新されます。
デフォルトでは、このパラメーターはfalseに設定されています。
外部データサービスのエラー応答
もし 役職 メソッド呼び出しが失敗した場合、外部データサービスが返す応答コードは、発生したエラーのタイプを示
します。外部データサービスのエラー応答を記述します。
外部データサービス 47
たとえば、応答コード 404お探しのページが見つかりませんでした メソッドがクラスやアイテムタイプなどのリソースを
見つけられなかったことを示します。応答コード 400不正な要求
必須パラメーターが指定されなかったか、パラメーターに誤った値が指定されたことを示します。
メソッドによって返されるJSON応答には、エラー状態に関する追加情報が含まれています。次の例は、応答がその情
報を提供するために使用する形式を示しています。
＃応答
HTTP / 1.1 404が見つかりません
Content-Type：application / json; charset-UTF-8
{「userMessage」：
{"テキスト"： "指定されたオブジェクトタイプは有効なオブジェクトタイプではありません。"、
} "underlyingDetails"：
{「原因」：
["より詳細なメッセージ1"、
"より詳細なメッセージ2"、]}}
例：POSTメソッドのリクエストとレスポンス
このサンプルコードは、IBM Content Navigatorユーザーが領域プロパティの値を選択すると、外部データサービスに
リクエストを送信します。 領域。 次に、サービスはブランチオフィスプロパティの選択リストを更新します。 支店、
に依存します 領域 プロパティ。
リクエスト例
POST / type / class_name_or_item_type_name
{"repositoryId"： "ObjectStore1"、
"objectId"： "{EC4D244B-5980-4 ... 6978-8796-A5B4C3D2E1F0}"、 "requestMode"： "inPro
gressChanges"、 "properties"：
[{"symbolicName"： "地域"、
"value"： "Western"、}]、
「clientContext」：
{"userid"： "user1"、 "locale"： "e
n_US"、 "desktop"： "default"}}
応答例
{"externalDataIdentifier"： " opaque_identifier_meaningful_to_the_service "、
"プロパティ"： [
{"symbolicName"： "ブランチオフィス"、
"dependentOn"： "Region"、 "dependentValu
e"： "Western"、 "choiceList"：{
"displayName"： "Western Branch Offices"、
48 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
"選択肢"：[{
"displayName"： "ロサンゼルス"、 "value"： "ロ
サンゼルス"}、
{"displayName"： "サンフランシスコ"、
"値"： "サンフランシスコ"}、
{"displayName"： "ソルトレイクシティ"、
"値"： "ソルトレイクシティ"}、
{"displayName"： "シアトル"、
"値"： "シアトル"}]}}]}
外部データサービスのサンプル
サンプルの外部データサービスでは、選択リストの値は外部データソースから使用されます。
サンプルデータソースであるサンプル外部データサービスとJSONファイルは、 ECMClient_installdir \ samples \
sampleEDSService \ WEB-INF \クラス ディレクトリ。
「サンプル外部データサービスのファイル」
サンプルサービスは、例として、および独自の外部データサービスの開始点として使用できます。サンプルサー
ビスは、 GetObjectTypes
サーブレット、 UpdateObjectTypes サーブレット、オブジェクトタイプリソースJSONファイル、データソースとして
のJSONファイル、および web.xml デプロイメントファイル。56ページの 『サンプル外部データ・サービスのデプロイ
』サンプル外部データ・サービスを変更してコンテンツ・クラスに適したものにしてから、サービスをWebアプリケー
ション・サーバーにデプロイします。
関連資料：
8ページの 『IBM Content Navigatorのサンプル・アプリケーション』 IBM Content Navigatorソフトウェア・パッケージには、プラグイン
、外部データ・サービス、および一連のWebページなど、いくつかのサンプル・アプリケーションが含まれています。これらのサンプル
アプリケーションを使用して、カスタムアプリケーションを作成できます。
サンプル外部データサービスのファイル
サンプルサービスは、例として、および独自の外部データサービスの開始点として使用できます。サンプルサービスは
、 GetObjectTypes サーブレット、
UpdateObjectTypes サーブレット、オブジェクトタイプリソースJSONファイル、データソースとしてのJSONファイル、および web.xml
デプロイメントファイル。
サンプルサービスは、次のファイルで構成されています。
GetObjectTypesServlet.javaサーブレット
このサーブレットは、外部データサービスで処理するすべてのクラスのリストを取得します。
UpdateObjectTypeServlet.javaサーブレット
クラスごとに、このサーブレットは現在の属性または値を取得し、その情報を応答ペイロードで返します
。
外部データサービス 49
ObjectTypes.jsonファイル
このJSONファイルは、外部データサービスに使用するクラスを決定します。
データソースとしてのJSONファイル
これらのJSONファイルはサンプルEDSの外部データソースであり、JSONの必要な形式を理解するために
使用できます。の
ECMClient_installdir \ samples \ sampleEDSService \ WEB-INF \ classes
ディレクトリには、次のサンプルJSONデータソースファイルが含まれています。
v 論文
v本
v 資料
v Eメール
v フォルダ
v 請求書
v NOINDEX
v DefaultApplication *
v Data_Field_ *
重要： これらのファイルは、主に予想されるJSON形式を理解し、独自の外部データサービス用のJSON
の作成を開始するために提供されます。EDSの展開にサンプルファイルを使用するには、詳細な構成が必
要です。
JSONは、システム上のクラス、アイテムタイプ、および対応するカスタムプロパティと一致する必要があ
ります。サンプルで提供されているJSONファイルを使用するには、JSONファイルを変更して、正しいカ
スタムプロパティが実際のクラスおよびIBM FileNet P8またはIBM Content Managerリポジトリのカスタム
プロパティと整合するようにする必要があります。同様に、ワークフローJSONファイル（IBM FileNet P8
）を使用するには、JSONを変更して、適切なステップ、ステップ名、ワークフローデータフィールド、そ
の他のカスタムプロパティなど、IBM Content Navigatorワークフローに一致させる必要があります。
サンプルEDSをワークフローフィルターに適用するには、 アプリケーションスペース、ロール、インバス
ケット、 それに応じてフィルター基準を設定する必要があります。EDSがリクエストでロケール情報を送
信できることを示すために、サンプルのローカライズされたファイルがサンプルに含まれています。EDS
開発者は、EDSがリクエスト内のロケール情報を確認し、適切な正しい変換でレスポンスJSONを返すよう
に指定できます。
web.xmlファイル
の web.xml ファイルは、Webアプリケーションの構成およびデプロイメント情報を提供します。このフ
ァイルは、 WEB-INF 外部データサービス用に存在するディレクトリ階層のコンテキスト下のディレクト
リ。
サンプル外部データサービスのデプロイ
コンテンツクラスに適するようにサンプルの外部データサービスを変更し、サービスをWebアプリケーションサ
ーバーにデプロイします。
このタスクについて
Eclipseプロジェクトは、サンプルEDSサービスに付属しています。構成に合わせて、プロジェクトで参照されるライ
ブラリを変更する必要があります。たとえば、\ navigator \ build \ lib \ j2ee \ j2ee.jar あなたへの正しい道ではないかも
しれません
50 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
j2ee.jar ファイル。環境に対応するJARファイルを見つけ、そのJARファイルを指すようにプロジェクト構成を更新
します。
手順
サンプルの外部データサービスをデプロイするには：
1。 サンプルの外部データサービスをインストールディレクトリから
Rationalの動的Webプロジェクト ® アプリケーション開発者。
2。 サンプルのJSONファイルを変更して、正しいカスタムプロパティが
IBM FileNet P8またはIBM Content Managerリポジトリーの実際のクラスおよびカスタム・プロパティーと整合
しています。
3。 プロジェクトをコンパイルし、WARファイルをビルドします。あなたは使うことができます build.xml あるファイル
開始点としてサンプルに含まれています。
4。 WARファイルをWebアプリケーションサーバーにデプロイします。
5。 呼び出される外部データサービスサポートプラグインを登録して構成します。
edsPlugin、 サンプルの外部データサービスを使用するには：
a。 ロード edsPlugin.jar ファイル。IBM Content Navigator管理で
ツール、プラグインの構成オプションで、URLまたはファイルパスを定義します。 edsPlugin.jar ファイル：
v 次のサンプル形式でURLを入力します。 http：//
host_name：port_number / ECMClient_installdir / plugins / edsPlugin.jar。
v サーバーにインストールされているファイルへのパスを入力します。次に例を示します。
–
マイクロソフトウィンドウズ： C：\ Program Files \ IBM \ ECMClient \ plugins \ edsPlugin.jar
–
LinuxまたはAIX ®：/ opt / IBM / ECMClient / plugins / edsPlugin.jar
の ECMClient フォルダーは、IBM Content Navigatorのインストール・ディレクトリーです。
b。 後に edsPlugin.jar ファイルがロードされたら、URLを指定する必要があります
EDSが展開されます。たとえば、次のように指定できます。 http：// host_name：port_n
umber / sampleEDSService。
c。 クリック セーブ そして 閉じる。
d。 Webブラウザを更新します。
結果
選択リストのプロパティから値を選択すると、リストには、外部データサービスから指定された外部データソー
スからの値が含まれます。
次はどうする
IBM Content Navigatorクライアントで、フィールドとプロパティに正しいデータが表示され、期待どおりに動
作していることを確認します。
外部データサービス 51
52 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
IBM Content Navigator APIリファレンス
IBM Content Navigatorは、カスタムアプリケーションを作成できるように、JavaScriptおよびJavaアプリケーションプログ
ラミングインターフェース（API）を提供します。JavaScript APIには、ビジュアルウィジェットライブラリとモデリング
ライブラリのクラスが含まれています。Java APIには、IBM Content Navigatorへのプラグインを作成するために使用できる
クラスが含まれています。
Mozilla Firefox Webブラウザーのスクリーンリーダーユーザーは、Tabキーを使用して、JavaScript APIリファレンス
ドキュメントのランドマークナビゲーション領域を移動します。
重要： IBM Content Navigator APIは、予告なしに変更されることがあります。APIを使用してアプリケーションまたは
プラグインを開発する場合、APIの新しいバージョンがリリースされたときにコードを更新する必要がある場合があり
ます。
「IBM Content Navigatorモデリングライブラリの構造」
モデリング・ライブラリーのクラスは、IBM Content Navigatorのビジネス・ロジックとデータを提供します。これ
らのクラスは、コンテンツ・サーバーおよびIBM Content Navigator構成内のデータにアクセスして表すためにウィ
ジェットによって使用されます。
56ページの 『IBM Content Navigatorビジュアル・ウィジェット・カタログ』 IBM Content Navigatorビジュアル・ウィジェッ
ト・ライブラリーのJavaScriptクラスは、パッケージごとにグループ化されています。一部のパッケージでは、クラスは、そ
れらが表すウィジェットのタイプによってさらにグループ化できます。
IBM Content Navigatorモデリングライブラリの構造
モデリング・ライブラリーのクラスは、IBM Content Navigatorのビジネス・ロジックとデータを提供します。これら
のクラスは、コンテンツ・サーバーおよびIBM Content Navigator構成内のデータにアクセスして表すためにウィジェ
ットによって使用されます。
次の図は、モデリングライブラリのプライマリクラスの階層を示しています。
©Copyright IBM Corp. 2012
53
デスクトップ
リポジトリ
閲覧者
アクション
ワークスペーステンプレート
ワークスペース
検索テンプレ
エントリーテンプレート
特徴
コンテンツクラス
ワークリストフォルダ
ート
検索基準検索
基準
属性の定義
ワークリスト
ユーザー
ユーザー・グループ
結果セット
項目
結果セットのコ
ンテンツアイテム
結果セット
作業項目
この図に示すように、 デスクトップ クラスは、モデル内の他のオブジェクトを包含します。の デスクトップ オブジェ
クトは、一連のユーザーがアクセスできるリポジトリ、機能、アクション、およびビューアを指定します。
のインスタンス リポジトリ クラスは特定のリポジトリを表します。リポジトリーは、IBM Content ManagerまたはIBM Con
tent Manager OnDemandサーバー、あるいはIBM FileNet Content Engineオブジェクト・ストアにすることができます。
の リポジトリ オブジェクトを使用すると、リポジトリオブジェクトにアクセスしてアクションを実行できます。これらの
オブジェクトは、モデリングライブラリのクラスによっても表されます。
SearchTemplate クラス
このクラスは、リポジトリーに保管されている検索を表します。IBM Content ManagerまたはIBM FileN
et P8リポジトリでは、 SearchTemplate オブジェクトは、保存された検索を表します。IBM Content Ma
nager OnDemandリポジトリーでは、 SearchTemplate オブジェクトはフォルダを表します。
54 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
あ SearchTemplate オブジェクトを使用すると、ユーザーは検索の実行に使用される基準を入力または変更
できます。基準は、モデルライブラリで SearchCriterion クラス。
EntryTemplate クラス
このクラスは、IBM FileNet P8リポジトリーに保管されているエントリー・テンプレートを表します。あ EntryTemplate
オブジェクトを使用すると、ドキュメント、フォルダ、またはカスタムオブジェクトを作成できます。あ EntryTemplate
オブジェクトは、宛先フォルダ、プロパティ、およびセキュリティのデフォルト値も提供します。
ContentClass クラス
このクラスは、IBM FileNet P8リポジトリ内のドキュメントまたはフォルダークラス、またはIBM Cont
ent Managerリポジトリ内のアイテムタイプを表します。あ
ContentClass オブジェクトにより、ユーザーはアイテムにアクセスし、アイテムのプロパティと属性を
編集できます。各プロパティまたは属性は、
AttributeDefinition タイプや許可された値など、プロパティまたは属性に関する情報を含むクラス。
WorklistFolder クラス
この抽象クラスは、受信トレイまたは受信トレイと呼ばれることもある作業リストのコレク
ションを表します。のサブクラス
WorklistFolder クラスは、さまざまなタイプの作業リストと受信トレイのコレクションを表します。たとえ
ば、 ProcessApplicationSpace クラスは、IBM FileNet P8プロセスアプリケーションにアクセスできるユーザ
ーを決定するプロセスロールのコレクションを表します。の ProcessRole クラスは、IBM FileNet P8サーバ
ーで定義されたロールを表します。このクラスのインスタンスは、アプリケーションスペースで定義されて
いる受信トレイへのアクセス権を持つユーザーを決定します。
ワークリスト クラス
このクラスは、単一の作業リストを表します。あ ワークリスト オブジェクトは、ユーザーに割り当てら
れている作業項目を処理する機能をユーザーに提供します。モデルには、 ProcessInBasket IBM FileNe
t P8リポジトリのサブクラス。
ワークスペース クラス
このクラスはチームスペースを表します。あ ワークスペース オブジェクトは、チームがタスクを完了するために
必要なコンテンツを整理および共有する機能をユーザーに提供します。
チームスペースに属する個々のユーザーとグループは、モデルでは ユーザー そして ユーザー・グループ
クラス。
ワークスペーステンプレート クラス
このクラスはチームスペーステンプレートを表します。あ ワークスペーステンプレート オブジェクトは、チームスペース
を作成するための事前定義されたオプションのセットをユーザーに提供します。
ResultSet クラス
このクラスは、検索によって返されるアイテムのセットを表します。あ
ResultSet オブジェクトは、ドキュメント、フォルダ、または作業項目を見つけて選択する機能をユー
ザーに提供します。の個々のアイテム ResultSet オブジェクトは、モデルでは 項目 クラスまたはそのサブクラスの1つ：
v の ContentItem クラスは、ドキュメント、フォルダ、またはその他のコンテンツを表します
リポジトリ内のアイテム。
v の 作業項目 クラスはワークフローアイテムを表します。
IBM Content Navigator APIリファレンス 55
モデリングライブラリ内の他のクラスは、図に示されているクラスをサポートします。たとえば、モデルには次
のクラスが含まれています。
v の SearchTemplateFolder クラスと WorkspaceFolder クラスはコレクションを表します
検索テンプレートとチームスペースの。これらの抽象クラスは、ユーザーインターフェイスのナビゲーションツ
リーに表示される最近のフォルダーやすべてのフォルダーなどのアイテムのコレクションを提供します。IBM
Content Manager OnDemandリポジトリーの場合、 SearchTemplateFolder
オブジェクトはキャビネットを表します。
v の リクエスト クラスは、IBM Content Navigatorに対して行われた要求を表します
サービス。
v の PropertyFormatter クラスは、適用されるフォーマットを表します
プロパティが表示されたとき。このクラスを拡張またはオーバーライドして、特定のタイプのプロパティのカスタ
ム書式を提供できます。
v _ ModelStore クラスと接尾辞が付いているクラス TreeModel 表す
Dojoデータストアとツリー。これらのクラスはDojoで使用できます ディジット ウィジェットにデータを入力するク
ラス。
関連する概念：
3ページの 『IBM Content Navigator開発アーキテクチャー』 IBM Content Navigatorは、model-view-con
troller（MVC）アーキテクチャーを使用します。
IBM Content Navigatorビジュアルウィジェットカタログ
IBM Content NavigatorビジュアルウィジェットライブラリのJavaScriptクラスは、パッケージごとにグループ化されています
。一部のパッケージでは、クラスは、それらが表すウィジェットのタイプによってさらにグループ化できます。
57ページの「ウィジェットパッケージ」のクラス ecm.widget パッケージは、ドキュメント、フォルダー、作業項
目などのリポジトリオブジェクトの作成、編集、検索に使用するウィジェットを定義します。このパッケージに
は、ボタン、メニュー、タブなどの一般的なユーザーインターフェイスコンポーネントを定義するクラスも含ま
れています。67ページの 『管理ウィジェット・パッケージ』 ecm.widget.admin パッケージは、IBM Content Nav
igator管理ツールを構成するウィジェットを定義します。これらのウィジェットを使用して、管理ユーザーインタ
ーフェイスをカスタマイズできます。70ページの 『管理モデル・パッケージ』 ecm.widget.admin.model パッケー
ジは、IBM Content Navigator管理ツールのユーザー・インターフェースのモデルを提供します。このパッケージ
のウィジェットを使用して、IBM Content Navigator管理ツールの機能を拡張できます。あるいは、これらのウィ
ジェットを使用して、IBM Content Navigatorユーザー・インターフェースに基づく個別の管理ユーザー・インタ
ーフェースを提供できます。71ページの「ダイアログボックスウィジェットパッケージ」
ecm.widget.dialogパッケージには、IBM Content Navigator Webクライアントで使用されるダイアログボックスを定義する
クラスが含まれています。74ページの「レイアウトウィジェットパッケージ」 ecm.widget.layout パッケージには、Webク
ライアントレイアウトのコンポーネントを定義するクラスが含まれています。
80ページの「プロセスウィジェットパッケージ」 ecm.widget.process パッケージには、IBM FileNet P8ワークフロ
ー用のカスタム起動プロセッサーとステッププロセッサーを構築するために使用されるクラスが含まれています。
77ページの「Teamspace Builderウィジェットパッケージ」 ecm.widget.workspaceBuilder パッケージには、作成と
56 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
チームスペースとチームスペーステンプレートを編集します。IBM Content Navigatorでは、これらのウィジェットはチームスペ
ースビルダーに使用されます。78ページの「ビューアウィジェットパッケージ」 ecm.widget.viewer パッケージには、ドキュメン
トのコンテンツを表示するために使用されるクラスが含まれています。
関連する概念：
3ページの 『IBM Content Navigator開発アーキテクチャー』 IBM Content Navigatorは、model-view-con
troller（MVC）アーキテクチャーを使用します。
ウィジェットパッケージ
のクラス ecm.widget パッケージは、ドキュメント、フォルダー、作業項目などのリポジトリオブジェクトの作成、編集
、検索に使用するウィジェットを定義します。このパッケージには、ボタン、メニュー、タブなどの一般的なユーザー
インターフェイスコンポーネントを定義するクラスも含まれています。
ドキュメントとフォルダーのウィジェット
これらのウィジェットは、ドキュメントとフォルダを表示および編集するために使用されます。
表20.文書およびフォルダーを表示および編集するために使用されるウィジェット
ウィジェットクラス
説明文
AddContentItemGeneralPane
AddContentItemDialogウィジェットでドキュメントまたはフォルダをリポ
ジトリに追加するために使用されるペインを提供します。このペインは、
ドキュメントをリポジトリにチェックインするために、CheckInDialogウ
ィジェットでも使用されます。
AddContentItemPropertiesPane
ユーザーがドキュメントまたはフォルダーをリポジトリに追加するときに
プロパティを編集するためにAddContentItemDialogウィジェットで使用さ
れるペインを提供します。このペインは、ユーザーがリポジトリにドキュ
メントをチェックインするときにプロパティを編集するために、CheckInD
ialogウィジェットでも使用されます。
AddContentItemSecurityPane
リポジトリに追加されているドキュメントまたはフォルダーのセキ
ュリティ設定を表示および編集するためにAddContentItemDialogウ
ィジェットで使用されるペインを提供します。このペインは、リポ
ジトリにチェックインされているドキュメントまたはフォルダーの
セキュリティ設定を表示および編集するために、CheckInDialogウィ
ジェットでも使用されます。
AttributeDefinitionsForm
IBM Content Managerクラスまたは項目タイプの属性を定義する
ために使用されるウィジェットを提供します。
ChildComponentPropertiesPane
IBM Content Manager項目タイプの子コンポーネントの属性を表示
および編集するために使用されるウィジェットを提供します。
子項目タイプは、固有の属性を持つことができます。例えば、IBM
Content Collectorは、子コンポーネントを使用して、Eメール・イ
ンスタンス情報と、個別のEメール項目タイプの属性への参照を保
管します。
IBM Content Navigator APIリファレンス 57
表20.文書およびフォルダーの表示および編集に使用されるウィジェット（続き）
ウィジェットクラス
説明文
ChildComponentSelector
IBM Content Manager項目タイプの子コンポーネントを表示する
ために使用されるウィジェットを提供します。
CommonPropertiesPane
プロパティの表示と編集に使用されるウィジェットを提供します。
このウィジェットは、ドキュメントの追加、フォルダの作成、プロ
パティの編集を行うダイアログボックスで使用できます。
ContentClassSelector
ドキュメントまたはフォルダのクラスを選択するために使用されるツリ
ーまたはドロップダウンリストを含むウィジェットを提供します。
ContentList
検索結果、フォルダーの内容、または作業リスト内の作業項目を表
示するウィジェットを提供します。このウィジェットを使用して、
フォルダーをナビゲートしたり、表示されているアイテムのアクシ
ョンを起動したりできます。
ContentListDropDownDialog
コンテンツリストで使用されるドロップダウンリストを含むウィジ
ェットを提供します。
ContentListToolbar
ContentListウィジェットのツールバーとして使用されるウィジェッ
トを提供します。
FolderSelector
リポジトリ、ワークスペース、または親フォルダ内のフォルダを選択するた
めに使用されるウィジェットを提供します。
FoldersFiledInPane
ドキュメントがファイルされているフォルダを示すウィジェット
を提供します。
FolderTree
リポジトリ内のフォルダを参照するために使用されるウィジェットを提
供します。
ItemEditPane
リポジトリ内のフォルダまたはドキュメントを編集するために使用さ
れるウィジェットを提供します。
ItemPreviewPane
アイテムのコンテンツのプレビューを表示するウィジェットを提
供します。
ItemPropertiesDisplayPane
アイテムのプロパティの読み取り専用ビューを表示するウィジ
ェットを提供します。
ItemPropertiesPane
アイテムのプロパティを編集するために使用されるウィジェットを
提供します。
ItemPropertiesStackPane
ItemPropertiesPaneウィジェットのスタックを含むペインを提
供します。通常、ItemPropertiesStackPaneには単一のItemPro
pertiesPaneウィジェットが含まれています。ただし、参照属
性の場合、ユーザーが開く参照属性ごとに個別のItemProperti
esPaneウィジェットがスタックに追加されます。ユーザーに
は、スタックの一番上のウィジェットが表示されます。
ItemSecurityPane
SecurityPaneウィジェットを含み、[プロパティの編集]ダイアログ
で使用されるウィジェットを提供します。このクラスは、セキュ
リティ情報を表示するためにSecurityPaneウィジェットが必要と
するアイテムのアクセス許可およびその他のアイテム情報を取得
します。
58 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表20.文書およびフォルダーの表示および編集に使用されるウィジェット（続き）
ウィジェットクラス
説明文
ModifyPermissionPane
ドキュメントまたはフォルダにアクセスするための権限を編集す
るために使用されるペインを提供します。
SecurityPane
アイテムにアクセスできるユーザーとロールのリストを含むウィジ
ェットを提供します。
VersionsPane
アイテムのバージョンを表示するために使用されるウィジェットを提供
します。
検索ウィジェット
これらのウィジェットは、リポジトリを検索するためのメカニズムを提供します。
表21.リポジトリーの検索に使用されるウィジェット
ウィジェットクラス
説明文
AttributeDefinitionWidget
検索ビルダーが、検索テンプレートの属性を表すために使用する
ウィジェットを提供します。
BasicSearchBuilder
検索ビルダーインターフェースに使用されるウィジェットを提供
します。検索ビルダーは、検索の作成と編集、およびアドホック
検索の実行に使用されます。
BasicSearchDefinition
BasicSearchBuilderウィジェットが検索基準を定義および保存する
ために使用するウィジェットを提供します。
ClassCriteria
保存された検索が検索用に定義されている項目クラスを表示するた
めに使用されるウィジェットを提供します。IBM FileNet Workplac
e XTで複数のアイテムクラスの検索をサポートするように定義され
た保存済み検索の場合、このウィジェットには、ユーザーが選択で
きるアイテムクラスのドロップダウンリストを開くためのリンクが
含まれています。
SearchBuilder
BasicSearchBuilderウィジェットを含むラッパーウィジェットを提
供します。このウィジェットは、開いている検索の維持や検索がキ
ャンセルされたときにウィジェットを閉じるなど、他のウィジェッ
トとの関係を処理します。このウィジェットは、検索を開いたり閉
じたりしたときに、保存された検索をロックまたはロック解除しま
す。
SearchForm
保存された検索の検索フォームをレンダリングするために使用されるウ
ィジェットを提供します。適切なアクセス権を持つユーザーは、このウ
ィジェットを使用して、保存された検索を編集できます。
SearchInCriteria
保存された検索で検索されるフォルダーまたはリポジトリーを表示
するウィジェットを提供します。IBM FileNet Workplace XTで複数
のフォルダーまたはリポジトリーの検索をサポートするように定義
された保存済み検索の場合、このウィジェットには、ユーザーが選
択できるフォルダーまたはリポジトリーのドロップダウンリストを
開くリンクが含まれています。
IBM Content Navigator APIリファレンス 59
表21.リポジトリーの検索に使用されるウィジェット（続き）
ウィジェットクラス
説明文
SearchMoreOptions
検索の追加オプションを表示するウィジェットを提供します。
追加オプションには、オブジェクトタイプ、バージョン、プロ
パティの結合関係、およびテキスト条件が含まれます。
SearchPropertyOptions
ドロップダウンダイアログボックスのプロパティ検索条件を
含むウィジェットを提供します。ダイアログボックスは、す
べての条件または任意の条件に一致する結果を返すように定
義できます。
SearchResultsDisplayOptions
検索結果の表示に使用される列を含むウィジェットを提供します
。検索結果は、プロパティで降順または昇順で並べ替えることが
できます。テキスト検索が有効になっている場合、検索結果は降
順でランクでソートできます。
SearchSelector
検索テンプレートを選択するために使用されるツリーまたはドロップダ
ウンリストを含むウィジェットを提供します。
SearchTab
SearchFormウィジェットとContentListウィジェットを含み、ウィ
ジェットイベントが一緒に配線されたウィジェットを提供します。
SearchTabContainer
開いている検索タブを含み、制御するウィジェットを提供します
。
TextSearchOptions
IBM FileNet P8リポジトリーにテキスト検索オプションを入力するた
めに使用されるウィジェットを提供します。検索オプションには、使
用するテキスト検索演算子が含まれています。ユーザーはテキスト検
索セクションを表示または非表示にして、テキスト検索機能を有効ま
たは無効にできます。
チームスペースとユーザーウィジェット
これらのウィジェットは、チームスペースの定義とユーザーの選択をサポートします。
表22.チームスペースの定義とユーザーの選択に使用されるウィジェット
ウィジェットクラス
説明文
チームリスト
チームスペースに割り当てられているユーザーとグループのリス
トを表示するウィジェットを提供します。
UserGroupSelector
ユーザーまたはグループを選択するために使用されるウィジェットを提供し
ます。このウィジェットは、ユーザーとグループの両方、またはユーザーの
みを表示するように構成できます。ウィジェットは、複数の選択または単一
の選択のみをサポートするように構成することもできます。
UserGroupSelectorPane
によって使用されるペインを提供します
_PropertiesMixin プロパティ値を割り当てるユーザーまたはグルー
プを選択するクラス。ウィジェットは、エントリー・テンプレー
ト・ワークフローの投票承認プロパティーを表示するように構成
できます。
60 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
ユーザーインターフェースウィジェット
これらのウィジェットは、一般的なユーザーインターフェイスコンポーネントを提供します。
表23.一般的なユーザーインターフェイスコンポーネントを定義するために使用されるウィジェット
ウィジェットクラス
説明文
_HoverHelpMixin
ユーザーインターフェイスでホバーヘルプを作成および表示するた
めの基本クラスを提供します。
_MoveUpDownMixin
リスト内のアイテムを上下に移動するために使用されるウィジ
ェットの基本クラスを提供します。
_PropertiesMixin
プロパティメタデータを操作するためのメソッドを含む基本クラ
スを提供します。このクラスは、プロパティのフォームフィール
ドを作成し、プライベート配列変数に値を保持するために使用さ
れる関数を提供します。
_RepositoryDe​​pWidgetBase
使用されているリポジトリに基づいて変更されるすべてのウィジェ
ットの基本クラスを提供します。このクラスは、このクラスから継
承するウィジェットに共通のプロパティと接続を提供します。例え
ば、このクラスは、ユーザーがIBM FileNet Content Managerリポ
ジトリーを使用しているかIBM Content Managerリポジトリーを使
用しているかに基づいて異なるツールバーをロードする必要がある
ウィジェットに使用されます。
_SecurityMixin
IBM FileNet P8セキュリティデータを操作するためのメソッドを
含む基本クラスを提供します。
_TilesListItemFactory
ecm.widget.TilesListウィジェットのエントリを生成するために使
用されるクラスを提供します。
ActionMenu
コンテキストメニューとして使用されるウィジェットを提供します。
バナー
IBM Content Navigatorアプリケーションのユーザー・インターフ
ェースに表示されるバナーを提供します。
BookmarkPane
ブックマークされたフォルダを表示できるURLアドレス可能なペ
ージを提供するウィジェットを提供します。ページのURLは、 リ
ンクを表示 アクションまたは リンクとしてメール フォルダに対
するアクション。
ブレッドクラム
IBM Content Navigatorアプリケーションでのユーザーの位置を表
示するウィジェットを提供します。
ボタン
ユーザーインターフェイスのボタンとして使用されるウィジェットを提供し
ます。
このクラスはDojoを拡張します
dijit.form.Button ボタンのホバーヘルプを提供するクラス。
IBM Content Navigator APIリファレンス 61
表23.一般的なユーザーインターフェイスコンポーネントを定義するために使用されるウィジェット（続き）
ウィジェットクラス
説明文
チェックボックス
同じプロパティの複数の値を選択するために使用できるチェッ
クボックスを提供します。
このクラスはDojoを拡張します
dijit.form.CheckBox チェックボックスのホバーヘルプを提供する
クラス。
コンボボックス
フィールドとドロップダウンリストで構成される組み合わせボック
スを表示するウィジェットを提供します。ユーザーはリストから値
を選択するか、フィールドに値を入力できます。フィールドの値は
、リストの値と一致する必要はありません。
このクラスはDojoを拡張します
dijit.form.ComboBox 組み合わせボックスのホバーヘルプを提供
するクラス。
CompositeButton
このウィジェットは、コンテナーの左側にボタンアイコン、中央に
ボタンタイトル、または右側にアクションボタンアイコンを表示す
るように構成できるボタンを提供します。このボタンは、アイテム
のセキュリティエントリを表示するためにSecurityPaneウィジェッ
トで使用されます。
DatePicker
日付を選択するために使用されるウィジェットを提供します
。このクラスは、
idx.form.DatePicker 追加のフォーマットパターンを提供
するクラス。
デスクトップペイン
デスクトップの表示に使用されるウィジェットを提供します。
DropDownDialog
ドロップダウンリストの表示に使用されるウィジェットを提供しま
す。
DropDownInput
ドロップダウンリストとフィールドを組み合わせたウィジェットを提供
します。ユーザーはフィールドに値を入力するか、ドロップダウンリス
トから値を選択できます。
DropDownLink
ドロップダウンメニューと概要のリンクを含むウィジェットを提
供します。
省略
省略記号（...）を表示するウィジェットを提供して、ユーザーがすべ
ての値を表示しないようにデータが切り捨てられていることを示しま
す。ウィジェットは、左側または右側のデータを切り捨てるように構
成できます。デフォルトでは、データは右側で切り捨てられます。
お気に入りツリー
ユーザーのお気に入りを表示するために使用されるツリーを含むウ
ィジェットを提供します。
62 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表23.一般的なユーザーインターフェイスコンポーネントを定義するために使用されるウィジェット（続き）
ウィジェットクラス
説明文
FilteringSelect
ドロップダウンリストとフィールドで構成される組み合わせボック
スを提供します。ユーザーはリストから値を選択するか、フィール
ドに値を入力できます。リストはフィルタリングされ、フィールド
に入力された値で始まる値が表示されます。有効なエントリは、リ
ストの値と完全に一致する必要があります。
このクラスはDojoを拡張します
dijit.form.FilteringSelect ホバーヘルプをサポートするクラス。
FilterTextBox
テキストボックスの入力をフィルター処理するために使用されるウィジェットを提
供します。
GlobalToolbar
IBM Content Navigatorアプリケーションのグローバルツールバー
として使用されるウィジェットを提供します。
ホバーヘルプ
ユーザーインターフェイスのヘルプにリンクする疑問符アイコンを表
示するために使用されるウィジェットを提供します。
HoverHelpText
ユーザーインターフェイスのグリッドセルにホバーヘルプとテキストを表示
するために使用されるウィジェットを提供します。
InbasketContainer
IBM FileNet Process Engineロールに関連付けられている受信トレ
イを表示するために使用されるウィジェットを提供します。各受信
トレイは、InbasketTabContainerウィジェットに含まれているCo
ntentListウィジェットに表示されます。
InbasketFilterContainer
受信トレイのコンテンツで指定されたクエリフィルターを表示す
るために使用されるウィジェットを提供します。フィルターを使
用して、受信トレイに表示されるアイテムのクエリを絞り込むこ
とができます。
InbasketFiltersPane
受信トレイフィルタを操作するための[フィルタ]および[リセット]ボ
タンを表示するために使用されるウィジェットを提供します。さら
に、このウィジェットには、現在有効なフィルターの数が表示され
ます。
LoginPane
コンテンツ管理サーバーへのログインに使用されるウィジェットを
提供します。このウィジェットは、サーバーに対して認証するため
の資格情報をユーザーに要求します。
メッセージバー
IBM Content Navigatorアプリケーションでメッセージバーとして使用
されるウィジェットを提供します。
MultiColumnList
アイテムの選択に使用される単純な複数列リストを提供します。
MultiValueChoicePane
選択リストから複数の値を選択するために使用されるウィジ
ェットを提供します。このウィジェットは、IBM FileNet Co
ntent Managerリポジトリーに使用されます。
IBM Content Navigator APIリファレンス 63
表23.一般的なユーザーインターフェイスコンポーネントを定義するために使用されるウィジェット（続き）
ウィジェットクラス
説明文
MultiValueInputPane
複数の値を入力するために使用されるウィジェットを提供します。この
ウィジェットは、IBM FileNet Content Managerリポジトリーに使用さ
れます。
NumberTextBox
数値の入力に使用されるテキストボックスを含むウィジェッ
トを提供します。
このクラスはDojoを拡張します
dijit.form.NumberTextBox ホバーヘルプをサポートするクラス。
ラジオボタン
1つだけ選択できる選択肢のセットを含むウィジェットを提供しま
す。
このクラスはDojoを拡張します
dijit.form.RadioButton ホバーヘルプをサポートするクラス。
RangeBoundTextBox
有効な値の範囲が指定されているテキストボックスを含むウィジェ
ットを提供します。
このクラスはDojoを拡張します
dijit.form.RangeBoundTextBox 大きな指数の範囲チェックをサポ
ートするクラス。
ReferenceAttributeButton
IBM Content Managerリポジトリー内の参照属性によって識別さ
れるオブジェクトを表示するためのボタンとして使用されるウィ
ジェットを提供します。
RepositorySelector
リポジトリを選択するために使用されるウィジェットを提供します。
選択する
クリックされたときにドロップダウンリストを表示するボタンと
して使用されるウィジェットを提供します。
このクラスはDojoを拡張します
dijit.form.DropDownButton ボタンのホバーヘルプを提供します。
SelectObject
クエリを入力してリポジトリオブジェクトを選択するために使用す
るウィジェットを提供します。
ShowHyperlinkPane
ドキュメントまたはフォルダのハイパーリンクを表示するために使用される
ウィジェットを提供します。
SingleSelectTree
ユーザーがツリー内のノードを一度に1つ選択できるツリーを
含むウィジェットを提供します。
SingleValueTreePane
ユーザーが一度に1つの値を選択できるツリーを含むウィジェット
を提供します。このウィジェットは、IBM FileNet Content Manag
erオブジェクトストアに使用されます。
64 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表23.一般的なユーザーインターフェイスコンポーネントを定義するために使用されるウィジェット（続き）
ウィジェットクラス
説明文
SloshBucket
より大きなアイテムのセットから一意のアイテムのサブセットを選択する
ために使用されるウィジェットを提供します。
ウィジェットには2つの単一列リストが含まれています。1つのリストに
は使用可能なアイテムが含まれ、もう1つのリストには選択されたアイテ
ムが含まれます。の
追加 ボタンと 削除する リスト間で項目を移動するために使用され
るボタンは、列の間に表示されます。オプションで、ウィジェット
には アップ ボタンと ダウン
選択したアイテムの注文に使用するボタン。
StateSelect
ドロップダウン選択ボックスを含むウィジェットを提供します。
このクラスはDojoを拡張します
dijit.form.Select 選択ボックスに対してプログラムで設定できるオ
プションをサポートするクラスですが、ユーザーには表示されませ
ん。
テキストボックス
テキストボックスを含むウィジェットを提供します。
このクラスはDojoを拡張します
dijit.form.TextBox テキストボックスのホバーヘルプを提供する
クラス。
タイルリスト
Microsoft Windowsエクスプローラーのタイルビューと同様に、タイルリ
ストビューにコンテンツを表示するウィジェットを提供します。IBM Co
ntent Navigatorでは、このウィジェットはチームスペースとチームスペー
ステンプレートのリストを表示します。ただし、任意のタイプのコンテ
ンツを表示するために使用できます。
TilesListItem
TilesListウィジェットに表示される単一行の項目を含むウィジェッ
トを提供します。
TimePicker
時間を選択するために使用されるウィジェットを提供します。
このクラスは、 idx.form.TimePicker
追加のフォーマットパターンを提供するクラス。
TitlePane
タイトル付きのコンテンツボックスを含むウィジェットを提供します。このウ
ィジェットは、開いたり折りたたんだりできます。
このクラスは、 idx.layout.TitlePane
ウィジェットのホバーヘルプを提供するクラス。
TreeDndSource
リポジトリ内のフォルダをナビゲートするために使用されるツリーを
含むウィジェットを提供します。このウィジェットはDojoを拡張しま
す
dijit.tree.dndSource クラスを使用して、ユーザーがドラッグアンド
ドロップ機能を使用して もっと ノード。（ もっと より多くの結果
が存在する場合、ノードはツリーに表示されます。ユーザーがこの
ノードをクリックすると、追加の結果が表示されます。）
IBM Content Navigator APIリファレンス 65
表23.一般的なユーザーインターフェイスコンポーネントを定義するために使用されるウィジェット（続き）
ウィジェットクラス
説明文
TreeSelector
リポジトリ内のフォルダをナビゲートするために使用されるツリー
を含むウィジェットを提供します。このウィジェットでは、ユーザ
ーは複数のフォルダーを選択できますが、アイテム値のないノード
を選択することはできません。
TreeSloshBucket
ツリーを使用して利用可能で選択されたアイテムを表示するS
loshバケットを含むウィジェットを提供します。
ValidationTextBox
指定された基準に対してユーザー入力が検証されるテキストボッ
クスを含むウィジェットを提供します。
このクラスはDojoを拡張します
dijit.form.ValidationTextBox バイトの最大長の検証を追加するク
ラス。
チームスペースウィジェット
これらのウィジェットは、チームスペースを表示および編集するために使用されます。
表24.チームスペースの表示と編集に使用されるウィジェット
ウィジェットクラス
説明文
WorkspacePropertiesPane
チームスペーステンプレートのプロパティを表示または編集するために使
用されるウィジェットを提供します。
WorkspaceSelector
チームスペースを選択するために使用されるツリーまたはドロップダ
ウンリストを含むウィジェットを提供します。
ワークフローウィジェット
これらのウィジェットは、ワークフロー、ワークリスト、およびワークアイテムを表示および編集するために使用されます。
表25.ワークフロー、作業リスト、および作業項目を表示および編集するために使用されるウィジェット
ウィジェットクラス
説明文
ReassignToUserDialog
IBM FileNet P8ワークフロー項目を別のユーザーに再割り当てするために
使用されるダイアログボックスを提供します。
StartWorkflow
ワークフローでフォルダーとドキュメントを開始するために使用されるウィ
ジェットを提供します。
SuspendWorkItems
ワークフローのフォルダーとドキュメントを一時停止するために使用
されるウィジェットを提供します。
TrackerHistoryPane
IBM FileNet P8ワークフローの履歴を表示するために使用され
るウィジェットを提供します。
トラッカーマイルストーンペイン
トラッカーのマイルストーンを表示するために使用されるペイン
を提供します。
WorkItemAttachmentsPane
作業項目の添付を表示または編集するために使用されるウィジェ
ットを提供します。
WorkItemPropertiesPane
作業項目のプロパティを表示または編集するために使用されるウ
ィジェットを提供します。
66 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表25.ワークフロー、作業リスト、および作業項目を表示および編集するために使用されるウィジェット（続き）
ウィジェットクラス
説明文
WorklistSelector
プロセスワークフローアイテムをナビゲートするために使用されるツ
リーを含むウィジェットを提供します。このウィジェットは、選択可
能なワークリスト、プロセスロール、および受信トレイを表示します
。
管理ウィジェットパッケージ
のクラス ecm.widget.admin パッケージは、IBM Content Navigator管理ツールを構成するウィジェットを定義します
。これらのウィジェットを使用して、管理ユーザーインターフェイスをカスタマイズできます。
一般的なウィジェット
これらのウィジェットは、管理ツールの一般的なレイアウトを定義します。
表26.管理ツールの一般的なレイアウトを定義するウィジェット
ウィジェットクラス
説明文
ActionMenu
IBM Content Navigator管理ツールで使用されるコンテキストメ
ニューを提供します。
AdminGrid
管理オブジェクトを表示するために使用されるスクロール可
能な表グリッドを提供します。
AdminLoginDialog
IBM Content Navigator管理ツールから選択したリポジトリーに
ログインするために使用するダイアログボックスを提供します
。
AdminTabs
各ペインに対応するタブを持つ複数のペインを持つIBM Content N
avigator管理ツールのコンテナーを提供します。
管理ツリー
デスクトップ、ラベル、メニュー、プラグイン、リポジトリ、設
定、ビューアマップなどの管理オブジェクトのナビゲーションツ
リーを提供します。
IconMappingDialog
アイコンをMIMEタイプにマップするために使用されるダイアログボックスを
提供します。
IconStatusDialog
ドキュメントの状態にマップされているアイコンを編集するため
のダイアログボックスを提供します。
NexusAdminPane
アプリケーションレイアウトの管理ビューを提供します。
このビューは、管理および構成タスクに使用されます。
ViewerMappingDialog
ビューアマップを作成または編集するためのダイアログボックスを提供します
。
デスクトップ構成ウィジェット
これらのウィジェットは、Webクライアントで使用可能なデスクトップを構成するために使用されます。
IBM Content Navigator APIリファレンス 67
表27.デスクトップの構成に使用されるウィジェット
ウィジェットクラス
説明文
デスクトップの外観
デスクトップの外観をカスタマイズし、ユーザーがこのデスクトッ
プからアクセスできる機能を指定するために使用されるペインを提
供します。
デスクトップメニュー
デスクトップからアクセスできるメニューを指定するために使
用されるペインを提供します。
デスクトップリポジトリ
デスクトップからアクセスできるリポジトリを指定するために
使用されるペインを提供します。
デスクトップワークフロー
特定のデスクトップに表示されるIBM FileNet P8アプリケーシ
ョンスペースを指定するために使用されるペインを提供します
。
TabDesktop
デスクトップの作成または編集に使用されるウィジェットを提供しま
す。ウィジェットは、タブ付きペインにデスクトッププロパティを表
示します。
TabDesktops
利用可能なすべてのデスクトップを一覧表示するウィジェットを提供します。
ウィジェットは、タブ付きペインにリストを表示します。
ラベル構成ウィジェット
このウィジェットは、Webクライアントで使用されるラベルをカスタマイズするために使用されます。
表28.ラベルをカスタマイズするために使用されるウィジェット
ウィジェットクラス
説明文
TabInterfaceText
Webクライアントの特定の領域に表示されるラベルのテキストを
カスタマイズするために使用されるウィジェットを提供します。
メニュー構成ウィジェット
これらのウィジェットは、Webクライアントで使用可能なコンテキストメニューとツールバーを構成するために使用され
ます。
表29.メニューの構成に使用されるウィジェット
ウィジェットクラス
説明文
TabMenu
ツールバーまたはコンテキストメニューの編集に使用するタブを提供
します。
TabMenus
使用可能なツールバーとコンテキストメニューを一覧表示するタブを提供します。
このタブは、編集またはコピーするツールバーまたはメニューを選択するために使
用されます。
68 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
プラグイン構成ウィジェット
これらのウィジェットは、プラグインの構成をサポートしています。
表30.プラグインの構成に使用されるウィジェット
ウィジェットクラス
説明文
PluginConfigurationPane
プラグインの構成インターフェースを作成するために拡張できる
基本クラスを提供します。
TabPlugin
プラグインの追加またはプラグインの情報の編集に使用するタ
ブを提供します。
TabPlugins
利用可能なプラグインを表示するタブを提供します。このタブを使用
して、編集または削除するプラグインを選択します。
リポジトリ構成ウィジェット
これらのウィジェットは、IBM Content Navigatorが接続するリポジトリーを構成するために使用されます。
表31.リポジトリーの構成に使用されるウィジェット
ウィジェットクラス
説明文
ODCustomPropertiesDialog
IBM Content Manager OnDemandリポジトリーへの接続のカスタム
プロパティを編集するために使用されるダイアログボックスを提供
します。
RepositoryConfigurationParameters
リポジトリーのプロパティーを構成するために使用されるウィジ
ェットを提供します。
RepositoryFolders
リポジトリフォルダのプロパティを指定するために使用される
ペインを提供します。このペインでは、ユーザーがリポジトリ
を参照するときにフォルダが表示される順序も決定します。
RepositorySearch
リポジトリの検索プロパティ、検索演算子、および検索結果を構
成するために使用されるペインを提供します。
RepositorySystemProperties
リポジトリ内のドキュメントとフォルダに表示されるシステム
プロパティを指定するために使用されるペインを提供します。
TabRepositories
利用可能なリポジトリを示すタブを提供します。
TabRepository
リポジトリの表示と構成に使用するタブを提供します。ユーザーはこ
のタブを使用して、リポジトリパラメータ、システムプロパティ、お
よびフォルダを編集します。
設定ウィジェット
これらのウィジェットは、一般的な構成タスクをサポートしています。
表32.設定を構成するために使用されるウィジェット
ウィジェットクラス
説明文
SettingAdminUsers
管理者権限を持つユーザーを指定するために使用されるウィジェ
ットを提供します。
IBM Content Navigator APIリファレンス 69
表32.設定の構成に使用されるウィジェット（続き）
ウィジェットクラス
説明文
SettingIconMapping
アイコンのMIMEタイプへのマッピングおよびアイコンが表す状態
を表示および編集するために使用されるウィジェットを提供します
。
ロギング
Webクライアントによって実行されるロギングをカスタマイズするた
めに使用されるウィジェットを提供します。
SettingMimeTypeIconMapping
Webクライアントで提供される事前定義されたアイコンまたはカスタ
ムアイコンにMIMEタイプのリストをマップするために使用されるウ
ィジェットを提供します。
SettingOnDemand
OnDemand Web Enablement Kitで使用される設定を構成するた
めに使用されるウィジェットを提供します。
SettingStatusIconMapping
リポジトリー上のドキュメント、フォルダー、および作業項目の
横に表示されるアイコンをカスタマイズするために使用されるウ
ィジェットを提供します。
TabSettings
構成内のすべてのデスクトップに適用される値を設定するために使
用されるウィジェットを含むウィジェットを提供します。ウィジェ
ットはタブ付きペインに表示されます。
ビューアマッピングウィジェット
これらのウィジェットは、コンテンツビューアから特定のファイルタイプへのマッピングをサポートしています。
表33.ビューアのマッピングを構成するために使用されるウィジェット
ウィジェットクラス
説明文
TabViewer
ファイルを開くために使用されるビューアを追加または編集するために使
用されるタブを提供します。
TabViewers
ファイルを開くために使用できるビューアを一覧表示するタブを提
供します。
管理モデルパッケージ
のクラス ecm.widget.admin.model パッケージは、IBM Content Navigator管理ツールのユーザー・インターフェースの
モデルを提供します。このパッケージのウィジェットを使用して、IBM Content Navigator管理ツールの機能を拡張でき
ます。あるいは、これらのウィジェットを使用して、IBM Content Navigatorユーザー・インターフェースに基づく個別
の管理ユーザー・インターフェースを提供できます。
これらのウィジェットは、管理ユーザーインターフェイスのモデルを定義します。
表34.管理ユーザー・インターフェースのモデルを定義するウィジェット
ウィジェットクラス
説明文
AdminTreeModel
管理オブジェクトの階層ナビゲーションツリーを含むウィジェット
を提供します。
70 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表34.管理ユーザー・インターフェースのモデルを定義するウィジェット（続き）
ウィジェットクラス
説明文
NexusAdminCategoryObject
IBM Content Navigator管理ツールでカテゴリー・オブジェク
トを処理するために使用されるメソッドを提供します。これ
らのカテゴリオブジェクトは、 デスクトップ、リポジトリ、
プラグイン、ビューアマップ、 そして
メニュー 管理ツールのメインナビゲーションツリーのノード。
メソッドは、カテゴリに基づいて異なる動作をします。たとえば
、 onClick メソッドはタブを開き、選択したカテゴリの子を表示し
ます。
NexusAdminInstanceObject
IBM Content Navigator管理ツールでデスクトップ、リポジトリー
、プラグイン、ビューアーマップ、およびメニューオブジェクト
を処理するために使用されるメソッドを提供します。
メソッドの動作は、オブジェクトのタイプによって異なります。
たとえば、
getMenuActions メソッドは、オブジェクトに使用できるメニューアクション
をリストします。このメソッドは、デフォルトのビューアマップオブジェク
トの編集アクションとコピーアクションを返します。このメソッドは、リポ
ジトリオブジェクトの編集アクションと削除アクションを返します。
NexusAdminInterfaceTextObject
IBM Content Navigator管理ツールの一般的なインターフェース
テキストを表します。
NexusAdminSettingsObject
IBM Content Navigator管理ツールのロギングやアイコン
マッピングなどの一般的な設定を表します。
ダイアログボックスウィジェットパッケージ
ecm.widget.dialogパッケージには、IBM Content Navigator Webクライアントで使用されるダイアログボックスを定
義するクラスが含まれています。
メッセージダイアログボックス
これらのウィジェットは、メッセージの表示に使用されるダイアログボックスを定義します。
表35.メッセージの表示に使用されるウィジェット
ウィジェットクラス
説明文
ErrorDialog
サービス要求によって生成されたエラーメッセージを表示するた
めに使用されるダイアログボックスを提供します。
MessageDialog
ユーザーに簡単なメッセージを表示するダイアログボックスを提供
します。
ステータスダイアログ
サーバーへの要求の処理中にステータスメッセージを表示するた
めに使用されるダイアログボックスを提供します。
IBM Content Navigator APIリファレンス 71
検索ダイアログボックス
これらのウィジェットは、検索をサポートするダイアログボックスを定義します。
表36.アイテムの検索に使用されるウィジェット
ウィジェットクラス
説明文
ODManageSaveSearchDialog
IBM Content Manager OnDemandリポジトリーに保存された検索を
選択するために使用されるダイアログ・ボックスを提供します。
ODSaveSearchDialog
IBM Content Manager OnDemandリポジトリーに保存された検索を編
集するために使用されるダイアログ・ボックスを提供します。
SaveSearchDialog
IBM Content Manager OnDemandリポジトリーの保存済み検索を作
成するために使用されるダイアログ・ボックスを提供します。
SearchBuilderDialog
検索テンプレートを追加するために使用されるダイアログボックスを提供し
ます。
SearchDialog
保存された検索を開いて実行するために使用されるダイアログボックス
を提供します。
SearchSelectorDialog
検索テンプレートの選択に使用するダイアログボックスを提供し
ます。
選択ダイアログボックス
これらのウィジェットは、オブジェクトとユーザーを選択するために使用されるダイアログボックスを定義します。
表37.アイテムを選択するために使用されるウィジェット
ウィジェットクラス
説明文
ContentClassSelectorDialog
コンテンツクラスの選択に使用するダイアログボックスを提供しま
す。
SelectObjectDialog
リポジトリアイテムの検索と選択に使用するダイアログボック
スを提供します。
SelectUserGroupDialog
ユーザーとグループの選択に使用するダイアログボックスを提供し
ます。
作業項目とワークフローのダイアログボックス
これらのウィジェットは、作業項目とワークフローで使用されるダイアログボックスを定義します。
表38.作業項目およびワークフローで使用されるウィジェット
ウィジェットクラス
説明文
ReassignToUserDialog
IBM FileNet P8ワークフロー項目を別のユーザーに再割り当てするために
使用されるダイアログボックスを提供します。
StartWorkflow
ワークフローでフォルダーとドキュメントを開始するために使用する
ダイアログボックスを提供します。
StepProcessorWindow
IBM FileNet Business Process Managerウィジェットを別のブラウ
ザーウィンドウに表示するために使用されるメカニズムを提供しま
す。
SuspendWorkItems
ワークフローの作業項目を一時停止するために使用されるダイアログボック
スを提供します。
72 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表38.作業項目およびワークフローで使用されるウィジェット（続き）
ウィジェットクラス
説明文
WorkflowSubscriptionsDialog
ワークフローの作業項目を一時停止するために使用されるダイアログボック
スを提供します。
WorkspacePropertiesDialog
ワークスペースのプロパティの編集に使用するダイアログボックスを
提供します。
その他のダイアログボックス
これらのウィジェットは、さまざまなダイアログボックスを定義します。
表39.ダイアログボックスを定義するウィジェット
ウィジェットクラス
説明文
AboutDialog
バージョン情報など、アプリケーションに関する情報を表示
するダイアログボックスを提供します。
AddAnnotationDialog
IBM Content Manager OnDemandリポジトリー内の文書に注
釈を追加するために使用されるダイアログ・ボックスを提供
します。
AddContentItemDialog
ドキュメントまたはフォルダをリポジトリに追加するために使用されるダイアログボ
ックスを提供します。ユーザーは、このダイアログボックスを使用して、ドキュメン
トまたはフォルダーを追加するために必要なすべてのパラメーターを指定できます。
AddPermissionDialog
ドキュメントまたはフォルダに権限を追加するために使用されるダイ
アログボックスを提供します。
AddToFavoritesDialog
リポジトリアイテムをお気に入りとして追加するために使用するダイアログボ
ックスを提供します。
AnnotationDialog
IBM Content Manager OnDemandリポジトリー内の項目の注釈を追
加および表示するために使用されるダイアログボックスを提供しま
す。
ApplyRemoveHoldDialog
IBM Content Manager OnDemandドキュメントの保留を適用また
は削除するために使用されるダイアログボックスを提供します。
BaseDialog
他のすべてのダイアログボックスを提供する基本ダイアログボックス ecm.widget.dialog
ダイアログボックスクラスが派生します。
ChangePasswordDialog
IBM Content ManagerサーバーまたはIBM Content Manager OnD
emandサーバーでパスワードを変更するために使用されるダイア
ログボックスを提供します。
CheckInDialog
リポジトリにドキュメントをチェックインするために使用されるダイアログ
ボックスを提供します。
確認ダイアログ
質問を表示し、アクションを承認またはキャンセルするようユー
ザーに促すダイアログボックスを提供します。
ContentViewerWindow
ContentViewerウィジェットを表示する別のブラウザーウィン
ドウを提供します。
CreateHoldDialog
IBM Content Manager OnDemandアイテムの保留を作成するために使
用されるダイアログボックスを提供します。
IBM Content Navigator APIリファレンス 73
表39.ダイアログボックスを定義するウィジェット（続き）
ウィジェットクラス
説明文
EditPropertiesDialog
ドキュメント、フォルダ、コンテンツアイテムのプロパティを編集す
るためのダイアログボックスを提供します。
LoginDialog
コンテンツサーバーへのログインに使用するダイアログボックスを提供
します。
MoveFileDialog
ドキュメントまたはフォルダをあるフォルダから別のフォルダに移動する
ために使用するダイアログボックスを提供します。
PrintDialog
1つ以上のドキュメントを印刷するために使用されるダイアログボックス
を提供します。
ShowHyperlinkDialog
フォルダーへのハイパーリンクまたはドキュメントの特定のバージョンへ
のハイパーリンクを表示するために使用されるダイアログボックスを提供
します。
UnfileDialog
フォルダからドキュメントまたはフォルダを削除するために使用されるダ
イアログボックスを提供します。
はいいいえキャンセルダイアログ
質問とボタンを表示するダイアログボックスを提供しま
す はい・いいえ、 そして
キャンセル。
レイアウトウィジェットパッケージ
の ecm.widget.layout パッケージには、Webクライアントレイアウトのコンポーネントを定義するクラスが含まれています。
これらのウィジェットは、Webクライアントレイアウトのコンポーネントを定義します。
表40. Webクライアントのレイアウトのコンポーネントを定義するウィジェット
ウィジェットクラス
説明文
_TabContainerBase
タブ付きレイアウトの最も外側のタブコンテナーを提供します
。
AdminPane
レイアウトに管理インターフェースを表示するために使用され
るペインを提供します。
BaseLayout
他のすべてのレイアウトウィジェットの派生元となる基本クラス
を提供します。
BookmarkActionsHandler
を拡張します CommonActionsHandler ブックマークに関連する
アクションの追加ハンドラーを提供するクラス。
BookmarkLayout
ブックマークの表示に使用されるデスクトップレイアウトを提供
します。
BrowseFlyoutPane
フォルダーとドキュメントの参照に使用されるフライアウ
トペインを提供します。
BrowsePane
フォルダとドキュメントの閲覧に使用されるペインを提
CommonActionsHandler
多くの一般的なアクションのデフォルト実装を提供します。この
供します。
クラスは、ecm.widget.dialogパッケージおよびecm.modelパッケ
ージからメソッドを呼び出します。
お気に入りペイン
ユーザーが最も頻繁に使用するドキュメント、フォルダー、または
定義済みの検索を保存してアクセスするために使用されるペインを
提供します。
74 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表40. Webクライアントのレイアウトのコンポーネントを定義するウィジェット（続き）
ウィジェットクラス
説明文
FlyoutMenuContainerChild
機能に使用されるフライアウトペインのコンテナを提供しま
す。
Horizo​​ntalScrollPane
水平方向にスクロールできるペインを提供します。
LaunchBarContainer
レイアウトで使用可能な機能を表示する垂直バーを提供し
ます。
LaunchBarDialogPane
LaunchBarContainerフライアウトに配置された任意のペイン用に拡張さ
れたウィジェットを提供します。このペインには、LaunchBarContaine
rウィジェットのコンテンツ領域のフライアウトペインとオープニングペ
インにコンテンツをロードすることを制御するために親コンテナーによ
って使用されるフラグとコールバックが用意されています。
LaunchBarPane
LaunchBarContainerウィジェットのコンテンツ領域に配置された
ペイン用に拡張されたウィジェットを提供します。このクラスは
、ナビゲーションとコンテンツの読み込みを制御するために親コ
ンテナーによって使用されるフラグとコールバックを提供します
。
MainLayout
IBM Content Navigatorまたは同様のデスクトップレイアウトの
メインレイアウトを提供します。このクラスは、レイアウトの
左側に機能を含む起動バーを表示します。
ManageTeamspacesPane
ユーザーがアクセスできるすべてのチームスペースとチームスペーステン
プレートのリストを表示するウィジェットを提供します。リストから、適
切な権限を持つユーザーは、チームスペースおよびチームスペーステンプ
レートを開いたり、編集したり、削除したりできます。適切な権限を持つ
ユーザーは、ビルダーを開いて、このウィジェットから新しいテンプレー
トとチームスペースを作成することもできます。
NavigatorMainLayout
を拡張します MainLayout IBM Content Navigatorに固有の追
加の対話を提供するクラス。
RecentActivityPane
アイテムの最近のアクティビティに関する情報を表示するペ
インを提供します。
SearchFlyoutPane
レイアウトの検索インターフェイスを含むフライアウトペイ
ンを提供します。
SearchPane
レイアウトの検索インターフェースを含むペインを提供し
ます。
TeamspaceBuilderPane
チームスペースビルダーをレイアウトに表示するペインを提
供します。
TeamspaceFlyoutPane
起動バーのチームスペース機能に使用されるフライアウトペイ
ンを提供します。
TeamspacePane
レイアウトにチームスペースを表示するために使用されるペイン
を提供します。
WorkFlyoutPane
リポジトリーの選択、およびIBM Content ManagerワークリストとI
BM FileNet P8アプリケーションスペースのナビゲートに使用される
フライアウトペインを提供します。
IBM Content Navigator APIリファレンス 75
表40. Webクライアントのレイアウトのコンポーネントを定義するウィジェット（続き）
ウィジェットクラス
説明文
WorkPane
ワークフローナビゲーションコンポーネントを含むペインを提
供します。このペインは、リポジトリーの選択を、ワークフロ
ー特権を持つIBM FileNet P8リポジトリーとIBM Content Man
agerリポジトリーに制限します。
プロセスウィジェットパッケージ
の ecm.widget.process パッケージには、IBM FileNet P8ワークフロー用のカスタム起動プロセッサーとステッププロセッサ
ーを構築するために使用されるクラスが含まれています。
これらのウィジェットは、起動プロセッサとステッププロセッサを定義します。
表41.起動プロセッサーとステッププロセッサーを定義するウィジェット
ウィジェットクラス
説明文
_ProcessorMixin
ステッププロセッサメタデータを操作するメソッドを定義するミッ
クスインを提供します。このクラスは、IBM FileNet P8ワークフロ
ー応答ボタンを作成します。さらに、クラスは、フィールド化され
たデータを操作するためのユーティリティ関数を提供します。
LaunchProcessorLayout
ワークフロープロセスの起動に使用されるレイアウトを提
供します。
マイルストーン
IBM FileNet P8ワークフローのマイルストーンを表示するために使用
されるレイアウトを提供します。
ProcessorLayout
IBM FileNet P8ワークフロープロセッサの基本レイアウトを提供
します。
StepProcessorLayout
ステッププロセッサの基本レイアウトを提供します。
TrackerLayout
IBM FileNet P8ワークフロートラッカーページの基本レイアウトを
提供します。ユーザーはトラッカーページを使用して、実行中のワ
ークフローの進行状況を監視できます。
Teamspace Builderウィジェットパッケージ
の ecm.widget.workspaceBuilder パッケージには、チームスペースとチームスペーステンプレートを作成および編集するウィジェ
ットが含まれています。IBM Content Navigatorでは、これらのウィジェットはチームスペースビルダーに使用されます。
これらのウィジェットは、チームスペースまたはチームスペーステンプレートを作成するために使用されます。
表42.チームスペースおよびチームスペーステンプレートの作成に使用されるウィジェット
ウィジェットクラス
説明文
ClassesPane
チームスペースユーザーがドキュメントをリポジトリに追加するために
使用できるクラスを指定するために使用されるウィジェットを提供しま
す。
IBM Content Navigatorでは、このウィジェットは「クラスの選
択」ペインを定義します。
EditRoleDialog
ロールの名前と説明を編集するためのダイアログボックスを提供
します。
76 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
表42.チームスペースとチームスペーステンプレートの作成に使用されるウィジェット（続き）
ウィジェットクラス
説明文
FoldersAndDocsPane
チームスペースに含めるデフォルトのドキュメントとフォルダーを選
択するために使用されるウィジェットを提供します。
IBM Content Navigatorでは、このウィジェットは「フォルダーとドキュ
メントを含める」ペインを定義します。
ManageTeamspaceDialog
リポジトリーに定義されているチームスペースとチームスペーステン
プレートをリストするウィジェットを提供します。
IBM Content Navigatorでは、このウィジェットはチームスペー
スビューペインを定義します。
ペイン
すべてのチームスペースビルダーペインの派生元となる
基本クラスを提供します。
プロパティペイン
チームスペースおよびチームスペーステンプレートのプロパティを指定す
るために使用されるウィジェットを提供します。チームスペースの場合、
このウィジェットは名前、説明、およびテンプレートを指定するために使
用されます。チームスペーステンプレートの場合、このウィジェットは名
前、説明、およびセキュリティを指定するために使用されます。
IBM Content Navigatorでは、このウィジェットは「チームスペースの定
義」ペインと「チームスペースのテンプレートの定義」ペインを定義し
ます。
RenameFolderDialog
チームスペースのフォルダの名前を変更するために使用されるダイアログボックス
を提供します。
RoleSloshBucket
チームスペースのユーザーにロールを割り当てるために使用されるSloshバ
ケットを提供します。
IBM Content Navigatorでは、このウィジェットは ユーザー
を選択 ペイン。
RolesPane
チームスペースにユーザーを追加し、ユーザーに役割を割り当てるため
に使用されるウィジェットを提供します。
IBM Content Navigatorでは、このウィジェットは「ユーザーの選
択」ペインを提供します。
SearchTemplatesPane
チームスペースユーザーが利用できる検索を選択するために使
用されるウィジェットを提供します。
IBM Content Navigatorでは、このウィジェットは「検索の選
択」ペインを提供します。
選択ツールバー
チームスペースビルダーで複数のアイテムの選択をサポートする
ツールバーを提供します。
TeamspaceBuilder
チームスペースビルダーのユーザーインターフェイスを含むウィジ
ェットを提供します。
TeamspaceColumnPropsPane
検索によって返される情報の列を表示するウィジェットを提供し
ます。
TeamspacePropertiesDialog
チームスペースのプロパティを編集するために使用されるウィジェッ
トを提供します。
IBM Content Navigator APIリファレンス 77
表42.チームスペースとチームスペーステンプレートの作成に使用されるウィジェット（続き）
ウィジェットクラス
説明文
UsersPane
チームスペースにユーザーを追加し、これらのユーザーに役割を割り当てる
ために使用されるウィジェットを提供します。
IBM Content Navigatorでは、このウィジェットは ユーザ
ーを選択 ペイン。
VerticalSloshBucket
チームスペースビルダーでクラスまたはエントリテンプレート、検索、
および既存のロールをチームスペーステンプレートに追加するために使
用される垂直スロッシュバケットを提供します。
ビューアウィジェットパッケージ
の ecm.widget.viewer パッケージには、ドキュメントのコンテンツを表示するために使用されるクラスが含まれています。
これらのウィジェットは、コンテンツの表示に使用されるダイアログボックスを定義します。
表43.コンテンツの表示に使用されるウィジェット
ウィジェットクラス
説明文
AjaxViewer
ドキュメントのページごとの表示をサポートするウィ
ジェットを提供します。
ContentViewer
ドキュメントの個々のビューアが表示されるタブを含むウィジェッ
トを提供します。
ContentViewerPane
単一のドキュメントビューアをサポートするウィジェットを提供します。
このウィジェットは、ContentViewerウィジェットに含まれています。
78 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
お知らせ
この情報は、米国で提供される製品およびサービスのために作成されました
IBMは、本書で説明されている製品、サービス、または機能を他の国では提供しない場合があります。お住まいの地域
で現在利用可能な製品とサービスについては、最寄りのIBM担当者にお問い合わせください。IBM製品、プログラム、
またはサービスへの言及は、そのIBM製品、プログラム、またはサービスのみが使用される可能性があることを明示ま
たは暗示することを意図したものではありません。代わりに、IBMの知的所有権を侵害しない、機能的に同等の製品、
プログラム、またはサービスを使用できます。ただし、IBM以外の製品、プログラム、またはサービスの操作を評価お
よび検証するのはユーザーの責任です。
IBMは、この文書に記載されている主題を対象とする特許または特許申請中の可能性があります。このドキュメント
の提供により、これらの特許のライセンスが付与されることはありません。ライセンスに関するお問い合わせは、書
面で以下にお送りいただけます。
IBMライセンシングIBMディレクターIB
M Corporation North Castle Driveアーモ
ンク、NY 10504-1785
米国
2バイト（DBCS）情報に関するライセンスの問い合わせについては、お住まいの国のIBM知的財産部門に問い合わせ
るか、書面で問い合わせを送信してください。
知的財産権使用許諾法および知的財産法日本IBM
神奈川県大和市下鶴間1623-14
次の段落は、そのような規定が現地の法律と矛盾する英国またはその他の国には適用されません。
INTERNATIONAL BUSINESS MACHINES CORPORATIONは、この出版物を「現状のまま」提供し、明示的または黙
示的を問わず、非侵害、商品性、または特定の目的への適合性の黙示の保証を含め、いかなる保証も行いません。一部
の州では、特定の取引で明示的または黙示的な保証の免責を認めていないため、この声明はお客様に適用されない場合
があります。
この情報には、技術的な誤りや誤植が含まれる場合があります。本書の情報は定期的に変更されます。これらの
変更は、発行物の新しい版に組み込まれます。IBMは予告なしに、随時、この文書に記載されている製品またはプ
ログラムに対して、改良または変更を行うことがあります。
この情報でのIBM以外のWebサイトへの参照は、便宜のためにのみ提供されており、これらのWebサイトを保証するも
のではありません。それらのWebサイトにある資料は、このIBM製品の資料の一部ではなく、それらのWebサイトの使
用はお客様の責任で行ってください。
©Copyright IBM Corp. 2012
79
IBMは、ユーザーに義務を負わせることなく、ユーザーが適切と考える方法で提供する情報を使用または配
布することがあります。
（i）独立して作成されたプログラムと他のプログラム（このプログラムを含む）との間の情報の交換、および（ii）
交換された情報の相互利用を可能にする目的で情報を入手したいこのプログラムのライセンシー、連絡する必要があ
ります：
IBM Corporation J46A / G4 555 Bailey
Avenue San Jose、CA 95141-1003
米国
そのような情報は、場合によっては料金の支払いを含め、適切な条件に従って利用できる可能性があります。
本書に記載されているライセンス・プログラムおよびその使用可能なすべてのライセンス対象物は、IBM顧客契約、IB
Mインターナショナル・プログラム・ライセンス契約、または同等の契約に基づいてIBMから提供されます。
ここに記載されているパフォーマンスデータは、管理された環境で決定されたものです。そのため、他の動作環境で得
られた結果は大幅に異なる場合があります。一部の測定は開発レベルのシステムで行われた可能性があり、これらの測
定値が一般に利用可能なシステムで同じになる保証はありません。さらに、一部の測定値は外挿によって推定された可
能性があります。実際の結果は異なる場合があります。このドキュメントのユーザーは、特定の環境に該当するデータ
を確認する必要があります。
IBM以外の製品に関する情報は、それらの製品のサプライヤー、それらの公開された発表、またはその他の公に利用可
能なソースから取得されました。IBMはこれらの製品をテストしておらず、IBM以外の製品に関連するパフォーマンス
、互換性、またはその他の主張の正確さを確認できません。IBM以外の製品の機能に関する質問は、それらの製品のサ
プライヤーにご連絡ください。
IBMの将来の方向性または意図に関するすべての記述は、予告なく変更または撤回される可能性があり、目標と目的
のみを表します。
この情報には、日常の業務で使用されるデータとレポートの例が含まれています。それらをできるだけ完全に説明する
ために、例には個人、会社、ブランド、製品の名前が含まれています。これらの名前はすべて架空のものであり、実際
の企業で使用されている名前や住所との類似性は完全に偶然です。
著作権使用許諾：
この情報には、さまざまなオペレーティングプラットフォームでのプログラミング手法を示す、サンプル言語のソース
言語のアプリケーションプログラムが含まれています。お客様は、サンプルプログラムが記述されているオペレーティ
ングプラットフォームのアプリケーションプログラミングインターフェイスに準拠したアプリケーションプログラムを
開発、使用、マーケティング、または配布する目的で、IBMへの支払いなしに、これらのサンプルプログラムを任意の
形式でコピー、変更、および配布することができます。これらの例は、すべての条件下で十分にテストされていません
。したがって、IBMは、これらのプログラムの信頼性、保守性、または機能を保証または示唆することはできません。
80 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
この製品の一部は次のとおりです。
v Copyright©2011、Oracleおよび/またはその関連会社。全著作権所有。
ここに含まれるOracle Outside In Technologyは使用制限付きライセンスの対象であり、このアプリケーションと
組み合わせてのみ使用できます。「商標」
商標
以下の用語は、International Business Machines Corporationの米国およびその他の国における商標です。http：//ww
w.ibm.com/legal/copytrade.shtml
Microsoft、Windows、およびWindows NTは、Microsoft Corporationの米国およびその他の国における商標です。
JavaおよびすべてのJavaベースの商標は、Sun Microsystems、Inc.の米国およびその他の国における商標です。
Linuxは、Linus Torvaldsの米国およびその他の国における登録商標です。
その他の会社、製品、およびサービスの名前は、他社の商標またはサービスマークである場合があります。
お知らせ 81
82 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
インデックスA
ecm.widget.layoutパッケージ
クラスの概要74 ecm.widget.process
行動
パッケージ
17個のメニューアクション用のプラグイン
の作成
17個の管理ツールウィジェット用のプ
ラグインの作成
デスクトップ67
J
JavaScript API
ecm.modelパッケージ53 ecm.widgetパッケージ
クラスの概要76 ecm.widget.viewerパ
57 ecm.widget.adminパッケージ67 ecm.widget.
ッケージ
admin.model 70 ecm.widget.dialogパッケージ71
クラスの概要78 ecm.widget.workspaceBuilderパッケ
ecm.widget.layoutパッケージ74 ecm.widget.pro
ージ
cessパッケージ76 ecm.widget。ビューアパッケ
クラスの概要76 edsPlugin.ja
ージ78
グラフィカルインターフェース67ラベル67メニュー67アプリケーション
rファイル
ecm.widget.workspaceBuilderパッケージ76
50個の外部データサービス
の登録
作成34配備50 edsPlugin.jarファ
機能の作成20レイアウトの作成21メニ
イル50エラー応答
ューアクションの作成17メニューの作成
18
外部データサービスRESTプロトコル48
プラグインコンポーネントの作成16プラグインの
オブジェクトタイプリソース37概要31
作成13要求または応答フィルターの作成22
L
ラベルウィジェット
管理ツール67レイアウトウィジェッ
ト
特定のオブジェクトタイプリソース39、48 POSTメソッ
サービスの作成24ビューアの作成26ウィジェ
ecm.widget.layoutパッケージ74レイアウト
ド40登録50リクエストモード42要件34応答コンテンツ4
ットの作成27 IBM Content Navigatorを使用
3 RESTプロトコル仕様36サンプル外部データサービス4
した開発1
21のプラグインの作成
9サンプルファイル49ワークフロー統合38
M
開発アーキテクチャ3中間層サービス5
メニューウィジェット
管理ツール67メニュー
プラグインコンポーネントのパッケージ化28サンプルアプ
リケーション7アーキテクチャ
18個のメッセージウィジェット用のプラグ
開発3中間層サービス5
インの作成
F
ダイアログボックス71モデリングライブラリ
特徴
D
構造53
20 finalExistingObjectリクエストモード用の
プラグインの作成
デスクトップウィジェット
管理ツール67アプリケーションの開
発
特定のオブジェクトタイプリソース42 finalNewOb
jectリクエストモード
特定のオブジェクトタイプリソース42フォルダーウィジ
アーキテクチャ3中間層サービス
O
オブジェクトタイプリクエスト
エラー応答48外部データサービス37 G
ェット
5ダイアログボックスウィジェット
ETメソッド37 GETメソッドの例39応答
ecm.widgetパッケージ57
コンテンツ43
メッセージ71検索71選択
71作業項目71ワークフロ
ー71ドキュメントウィジェット
G
グラフィカルインターフェイスウィジェット
管理ツール67
P
特定のオブジェクトタイプリソース
ecm.widgetパッケージ57
例48外部データサービス39 POSTメソ
私
ッド40プラグインコンポーネント
IBM Content Navigator
E
アプリケーションの開発1 initialExistingObjec
ecm.modelパッケージ
構造53 ecm.widgetパッケ
t要求モード
特定のオブジェクトタイプリソース42 initialNewOb
jectリクエストモード
ージ
クラスの概要57 ecm.widget.adminパ
ッケージ
クラスの概要67 ecm.widget.adm
特定のオブジェクトタイプリソース42 inProgressC
作成16機能20レイアウト21メニューアクショ
ン17メニュー18パッケージング28要求または
応答フィルター22サービス24ビューア26ウィ
ジェット27
hangesリクエストモード
特定のオブジェクトタイプリソース42
in.model
クラスの概要70 ecm.widget.dialogパ
ッケージ
クラスのまとめ71
©Copyright IBM Corp. 2012
83
プラグイン
ビジュアルウィジェットライブラリ（ 続く）
13 POSTメソッドの
teamspaceビルダーウィジェットパッケージ76ビューアウィジェットパッケージ78ウィジェットパッケージ57
作成
特定のオブジェクトタイプリソース40プロセスウィジ
ェット
ecm.widget.processパッケージ76
W
R
ウィジェット
リクエストフィルター
管理モデルウィジェットクラス70
22リクエストモードのプラグインを作
成する
finalExistingObject 42
管理ウィジェットクラス67プラグインの作成27ダ
イアログボックスウィジェットクラス71ドキュメ
finalNewObject 42
ント57フォルダ57レイアウトウィジェットクラス
initialExistingObject 42
74プロセスウィジェットクラス76検索57
initialNewObject 42
inProgressChanges 42
requestModeパラメータ
特定のオブジェクトタイプリソース42応答フィルタ
ー
チームスペースビルダーウィジェットクラス76チームスペ
22のプラグインの作成
ース57ユーザー57ビューアーウィジェットクラス78ウィジ
ェットクラス57ワークフロー57作業項目ウィジェット
S
サンプルアプリケーション
カスタマイズ7
外部データサービスのサンプル
選択リストのカスタマイズ31検索ウィジェ
ット
ダイアログボックス71 ecm.widgetパ
ダイアログボックス71ワークフローウィジェット
ダイアログボックス71
ecm.widgetパッケージ57
ッケージ57選択ウィジェット
ダイアログボックス71サービス
24のプラグインの作成
T
チームスペースビルダーウィジェット
ecm.widget.workspaceBuilderパッケージ76チームスペースウィジェット
ecm.widgetパッケージ57
U
URL
IBM Content Navigator 9ユーザー・インタ
ーフェース・ウィジェット用に作成
ecm.widgetパッケージ57ユーザーウィジェット
ecm.widgetパッケージ57
V
閲覧者
26ビジュアルウィジェットライブラリ用の
プラグインの作成
管理モデルウィジェットパッケージ70
管理ウィジェットパッケージ67ダイアログボックスウィ
ジェットパッケージ71レイアウトウィジェットパッケージ74プロセスウィジェットパッケージ76
84 IBM Content Navigator：IBM Content Navigator APIを使用したアプリケーションの開発
？
製品番号：1234-SS1
SC19-3716-00