この章では、ビューアUIツールがどのように実装されているかについて説明します。ビューアUIツールは、ViewDocumentユーザー・インタフェース機能への直接アクセスを提供します。
この章の内容は次のとおりです。
URLツールはImagingユーザー・インタフェースのURLで、このURLを使用して、ドキュメントの表示など、特定のユーザー・インタフェース機能へ直接アクセスすることができます。このツールは、専用のアクセス・ページから公開され、正式なAPIとして、アプリケーションでサポートされています。
現在、URLツールのアクセスポイントは、http://<server>:<port>/imaging/faces/Pages/UrlTools.jspxにあるUrlTools.jspxページです。
注意:
ご使用のサーバー・アーキテクチャを既存のクライアントURLが引き続き利用できるようにネットワーク・マッピングを使用して変更するか(同じマシンまたはIPアドレスでIPMマシンをUCMマシンに置き換えることが可能)、またはすべてのクライアント参照を変更する必要があります。この項には、使用されるURLパラメータを示しています。これらは、パラメータとしてURLツールに追加できます。セミコロンで区切られたパラメータ名は、これらのパラメータ名が同じものを意味していることを示します。
パラメータ名 | 説明 | 有効な値 | デフォルト |
---|---|---|---|
LockBanner |
バナーをロックするか、ロックを解除するかを示します。バナーをロックするとは、バナーが非表示にされ、展開できなくなるという意味です。 URLでこのパラメータが指定されていても、HideBanner=0の方が優先されます。 |
1またはtrue: バナーをロックします 0またはfalse - バナーのロックを解除します |
0 - 別途指定のないかぎり、URLツールでバナーのロックを解除します |
LockWorkcenter |
ナビゲーション・ペインをロックするか、ロックを解除するかを示します。ナビゲーション・ペインをロックするとは、ナビゲーション・ペインが非表示にされ、展開できなくなるという意味です。 URLでこのパラメータが指定されていても、HideWorkcenter=0の方が優先されます。 |
1またはtrue: ナビゲーション・ペインをロックします。 0またはfalse - ナビゲーション・ペインのロックを解除します。 |
1 - 別途指定のないかぎり、URLツールでナビゲーション・ペインをロックします |
ToolName |
リクエストの処理に使用するツールを示します。 |
現在あるツールは2つのみです。これらはExecuteSearch (またはAWSER)およびViewDocument (またはAWVWR)です。 |
なし |
skin |
使用するスキンを示します。 |
アプリケーションに展開された任意の値。通常は
|
現行ユーザーの設定が使用されます。 |
ビューアURLツールは、直接アクセスが可能なツールとして、ImagingビューアUIツールを公開します。
パラメータ名 | 説明 | 有効な値 | デフォルト |
---|---|---|---|
showHistory |
ビューアの履歴パネルを表示または非表示にします。 |
1またはtrue: 履歴を表示します 0またはfalse: 履歴を非表示にします |
False |
showProperties |
ビューアの「プロパティ・パネル」を表示または非表示にします。 |
1またはtrue: プロパティを表示します 0またはfalse: プロパティを非表示にします |
False |
showStickyNotes |
ビューアの「付箋」パネルを表示または非表示にします。 |
1またはtrue: 付箋を表示します 0またはfalse: 付箋を非表示にします |
False |
DocumentId |
ユーザーに表示するドキュメントのドキュメントID。これが指定されていない場合、ドキュメントの表示は失敗し、エラーが表示されます。 |
有効なドキュメントID。これは検索により、またはユーザー・インタフェースもしくはWebサービスAPIを通じたドキュメントの索引付けの結果として取得されます。 |
なし |
supportingKey |
表示すべきサポート情報のキー |
任意の有効なサポート情報キーの値。 |
なし |
folder |
ビューアの保存先フォルダ名。これは省略可能な値です。これにより、UIキャッシュ内に様々なドキュメントを分類して蓄積することができます。 |
フォルダ名として使用できる文字列値。 |
これが指定されていない場合、フォルダ名は"default"となります。これは検索結果が表示済ドキュメントを保存するフォルダと同じです。 |
showTabs |
ユーザーがフォルダ内のドキュメントを切り替えられるように、タブを表示するかどうかを示します。 |
1またはtrue - タブを非表示にします 0またはfalse - タブを表示します |
False |
closeAllTabs |
URLツールに対して、ドキュメントが開かれるフォルダ内のタブをすべて閉じるように指示します。 |
1またはtrue - フォルダ内のドキュメントをすべて閉じます。 0またはfalse - フォルダ内のドキュメントは閉じません。 |
False |
forceHideProperties |
ビューアの「プロパティ・パネル」を閉じます。このオプションにより、システムのデフォルトおよびユーザー・プリファレンスが無視されます。 |
1またはtrue - 「プロパティ・パネル」を強制的に閉じます。 0またはfalse - 「プロパティ・パネル」を強制的に閉じません。 |
False |
forceHideStickyNotes |
ビューアの付箋パネルを閉じます。このオプションにより、システムのデフォルトおよびユーザー・プリファレンスが無視されます。 |
1またはtrue - 付箋パネルを強制的に閉じます。 0またはfalse - 付箋パネルを強制的に閉じません。 |
False |
forceHideHistory |
ビューアの履歴パネルを閉じます。このオプションにより、システムのデフォルトおよびユーザー・プリファレンスが無視されます。 |
1またはtrue - 履歴パネルを強制的に閉じます。 0またはfalse - 履歴パネルを強制的に閉じません。 |
False |
HideBanner |
ビューアのバナーを表示または非表示にします。 |
1またはtrue - バナーを非表示にします 0またはfalse - バナーを表示します |
True |
例30-1 ドキュメントを開いて表示
次に示すのは、ViewDocument URLツールを使用して、ビューアにドキュメントを開くURLの例です。
この例ではIDが123.RPO_456のドキュメントがフォルダEBS1に入っています。パラメータshowTabs=0によりビューアのドキュメント・タブが非表示になっているため、ユーザーはフォルダ内の別のドキュメントに表示を切り替えられません。
http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx?ToolName=ViewDocument&DocumentId=123.RPO_456&folder=EBS1&showTabs=0