| Oracle® WebCenter Content Imaging開発者ガイド 11g リリース1 (11.1.1) B72422-01 |
|
 前 |
 次 |
この章の内容は次のとおりです。
この章で使用する例は、既存のImagingアプリケーションが存在すること、アプリケーションに1つ以上のドキュメントが保存されていること、およびアプリケーションに以前に保存した検索があることを前提としています。
URLツールはImagingユーザー・インタフェースのURLのセットで、このURLを使用して、検索の実行やドキュメントの表示など、特定のユーザー・インタフェース機能へ直接アクセスすることができます。これらのツールは、専用のアクセス・ページから公開され、正式なAPIとして、アプリケーションでサポートされています。Imaging 11g URLツールは、以前のImaging 10g URLツールと同様の方法で実装されています。
このセクションでは、Imaging 11gでどのようにURLツールが実装されているか、その基本的な情報を説明します。この情報は、どのサーバーにどのようなURLツールがインストールされているかの判断や、インストールされているURLツールの管理に役立ちます。imaging-uiプロジェクトでは、URLツールは一括実装されているため、特定のコード・ベースでどのようなツールが使用できるかを判断するのは簡単です。また、コードを調べることにより、特定のURLツールで想定されているパラメータや動作を判断することもできます。
現在、URLツールのアクセスポイントは、http://<server>:<port>/imaging/faces/Pages/UrlTools.jspxにあるUrlTools.jspxページです。
現在、次のツールがサポートされています。
検索URLツール: 検索UIツールへの直接アクセスを提供します。
ビューアURLツール: ビューアUIツールへの直接アクセスを提供します。
アップロードURLツール: アップロードUIツールへの直接アクセスを提供します。
ユーザー・プリファレンスURLツール: ユーザー・プリファレンスUIツールへの直接アクセスを提供します。
次のURLパラメータはすべてのツールで使用され、どのURLツールにでもパラメータとして追加できます。セミコロンで区切られたパラメータ名は、これらのパラメータ名が同じものを意味していることを示します。これはImaging 10gで使用されていた名前との下位互換のための機能です。
| パラメータ名 | 説明 | 有効な値 | デフォルト |
|---|---|---|---|
|
HideBanner |
バナーを表示するかしないかを示します。デフォルトでは、バナーは表示されます。ViewDocumentツールによって使用されません。 |
1またはtrue: バナーを非表示にします 0またはfalse (デフォルト): バナーを表示します |
0 - 別途指定のないかぎり、すべてのURLツールにバナーを表示します |
|
HideWorkcenter |
UIのナビゲーション・ペインが表示されないことを示します。ViewDocumentツールによって使用されません。 |
1またはtrue: ナビゲーション・ペインを非表示にします 0またはfalse: ナビゲーション・ペインを表示します |
1 - 別途指定のないかぎり、すべてのURLツールでナビゲーション・ペインを非表示にします |
|
LockBanner |
バナーをロックするか、ロックを解除するかを示します。バナーをロックするとは、バナーが非表示にされ、展開できなくなるという意味です。 URLでこのパラメータが指定されていても、HideBanner=0の方が優先されます。 |
1またはtrue: バナーをロックします 0またはfalse: バナーのロックを解除します |
0 - 別途指定のないかぎり、すべてのURLツールでバナーのロックを解除します |
|
LockWorkcenter |
ナビゲーション・ペインをロックするか、ロックを解除するかを示します。ナビゲーション・ペインをロックするとは、ナビゲーション・ペインが非表示にされ、展開できなくなるという意味です。 URLでこのパラメータが指定されていても、HideWorkcenter=0の方が優先されます。 |
1またはtrue: 0またはfalse: ナビゲーション・ペインのロックを解除します。 |
1 - 別途指定のないかぎり、すべてのURLツールでナビゲーション・ペインをロックします |
|
ToolName |
リクエストの処理に使用するツールを示します。 |
現在、使用できるツールはExecuteSearch (またはAWSER)とViewDocument (またはAWVWR)の2つのみです。 |
なし |
|
skin |
使用するスキンを示します。 |
アプリケーションに展開された任意の値。通常は
|
デフォルトはユーザーが選択します。 |
次のURLツールがサポートされています。
検索URLツール(ExecuteSearch)は、直接アクセスが可能なツールとして、検索結果ユーザー・インタフェースを公開します。ExecuteSearchツールで使用できるURLパラメータの概要は次のとおりです。残りのパラメータはすべてフィールド値で、これらは検索条件に挿入する必要があります。
| パラメータ名 | 説明 | 有効な値 | デフォルト |
|---|---|---|---|
|
SearchId |
これは実行する検索のIDです。これが指定されていない場合、SearchNameが使用されます。SearchIdおよびSearchNameが指定されていないと、ユーザーにエラーが表示されます。 |
Imagingシステムに存在し、現在のユーザーがアクセスできるSearchIdのすべての値 |
なし |
|
SearchName |
パラメータにSearchIdが見つからない場合、SearchNameが検索されます。SearchIdおよびSearchNameが指定されていないと、ユーザーにエラーが表示されます。 |
Imagingシステムに存在し、現在のユーザーがアクセスできるSearchNameのすべての値。ただし、検索名で使用されている特殊ASCII文字はすべて16進数(base 16)コードで置き換える必要があります。たとえば、This&Thatという名前の検索で使用されているアンパサンドは、URLではhttp://machinename:port/imaging/faces/Pages/UrlTools.jspx?ToolName=AWSER&SearchName=This%26Thatのように定義する必要があります。 |
なし |
|
ClearSearches |
セッションのこの時点までに実行された検索をすべて削除します。 |
1またはtrue: 検索をクリアします。 |
Falseまたは0 |
|
_ipmOperator.<FieldName> |
<FieldName>で指定されたフィールドの演算子を指定します。たとえば、フィールドCompanyは_ipmOperator.Companyを使用します。このパラメータは省略可能で、検索でPicklist演算子が使用されている場合のみ使用されます。 |
Java APIのSearch.Operator列挙の文字列値。text型フィールドで使用できるオプションは次のとおりです。
number、decimal、およびdate型フィールドで使用できるオプションは次のとおりです。
|
値が指定されていない場合、APIにはnoneが指定され、APIはnoneが指定されたように動作します。 |
|
ORAIPM_EMPTY_URL_PARAMETER |
検索フィールドのデフォルト値が存在する場合は、これを削除します。 |
ORAIPM_EMPTY_URL_PARAMETER |
なし |
URLにあるパラメータが検索フィールドとして含まれているときに、ユーザーがその検索条件で使用される演算子の選択をできる場合、ユーザーが別の値を入力しないかぎり、保存済検索のパラメータに指定された値がこの演算子のデフォルトとして使用されます。例10-1および例10-2は、ExecuteSearch URLツールを使用して検索を実行するURLの例です。
例10-1 検索の実行
この例では、Find HR Docsという名前の検索により、Employee Nameフィールドの値がJon Doeであるドキュメントすべての結果リストが戻されます。
http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx?ToolName=ExecuteSearch&SearchName=Find+HR+DOCS&EmployeeName=Jon+Doe
例10-2 検索フィールドのデフォルト値の削除
ExecuteSearch検索ツールは、検索フィールドのデフォルト値があれば、それを使用します。このデフォルト値を削除する必要がある場合は、空のURLパラメータを示すURLパラメータを追加します。そのためには、パラメータに値"ORAIPM_EMPTY_URL_PARAMETER"を指定します。たとえば、検索を実行するときに、フィールド"AText80"のデフォルト値を削除しなければならない場合は、次のURLを指定します。
http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx?ToolName=ExecuteSearch&SearchName=Search%20Documents&AText80=ORAIPM_EMPTY_URL_PARAMETER
ただし、ExecuteSearchツールのデフォルトではImagingユーザー・インタフェースのバナーとナビゲーション・ペインはロックされています。また、このツールでは検索結果のフォームもロックされています。
ビューアURLツールは、直接アクセスが可能なツールとして、ImagingビューアUIツールを公開します。ViewDocumentツールで使用できるURLパラメータの概要は次のとおりです。
| パラメータ名 | 説明 | 有効な値 | デフォルト |
|---|---|---|---|
|
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 |
例10-3は、ViewDocument URLツールを使用して、ビューアにドキュメントを開くURLの例です。
アップロードURLツールは、直接アクセスが可能なツールとして、アップロード・ユーザー・インタフェースを公開します。UploadDocumentツールで使用できるURLパラメータの概要は次のとおりです。残りのパラメータはすべてフィールド値とみなされ、アップロード・フォームのアプリケーション・フィールドに自動的に移入するために使用されます。
| パラメータ名 | 説明 | 有効な値 | デフォルト |
|---|---|---|---|
|
AppId |
これは、ドキュメントを索引付けするアプリケーションのIDです。これが指定されていない場合、AppNameが使用されます。AppIdおよびAppNameが指定されていないと、ユーザーにエラーが表示されます。 |
Imagingシステムに存在し、現在のユーザーがアクセスできる検索Idのすべての値 |
なし |
|
AppName |
パラメータにAppIdが見つからない場合、AppNameが検索されます。AppIdおよびAppNameが指定されていないと、ユーザーにエラーが表示されます。 |
Imagingシステムに存在し、現在のユーザーがアクセスできる検索名のすべての値 |
なし |
|
ShowFieldsWithValues |
通常、URLに指定されたフィールドはすべてアップロード・フォームから削除されます。このパラメータをtrueに設定すると、これらのフィールドが他のフィールドとともに表示されます。 |
1またはtrue - 検索をクリアします 0またはfalse - 検索をクリアしません |
False |
例10-4および例10-5は、UploadDocument URLツールを使用してドキュメントをアップロードするURLの例です。
例10-4 AppIdを使用してドキュメントをアップロード
この例では、アップロード・ツールによりIDが157のアプリケーションがロードされ、表示されます。フィールドMyTextFieldおよびMyNumberFieldには自動的に値が移入され、ユーザーが使用できるフィールドのリストから削除されます。
http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx?ToolName=UploadDocument&AppId=157&MyTextField=Text%20Value&MyNumberField=123
例10-5 AppNameを使用してドキュメントをアップロード
この例では、アップロード・ツールによりMy Appという名前のアプリケーションがロードされ、表示されます。フィールドMyTextFieldおよびMyNumberFieldには自動的に値が移入されますが、ShowFieldsWithValuesパラメータがtrueに設定されているため、ユーザーが使用できるフィールドのリストからは削除されません。
http://<server>:<port>/imaging/faces/Pages/UrlTools.jspx?ToolName=UploadDocument&AppName=My%20App&MyTextField=Text%20Value&MyNumberField=123&ShowFieldsWithValues=true
UploadDocumentツールのデフォルトでは、Imagingユーザー・インタフェースのバナーとナビゲーション・ペインはロックされています。
|
注意: 日付フィールドの必須フォーマットは、次のISOの標準日付書式と時間書式です。 yyyy-MM-dd'T'HH:mm:ss.SSSZ 次に例を示します。 2022-12-30T00:00:00.000-0700 |
ユーザー・プリファレンスURLツールは、直接アクセスが可能なツールとして、プリファレンス・ページ・ユーザー・インタフェースを公開します。現在、ツール名以外のUserPreferences URLパラメータはありません。例10-6は、ユーザー・プリファレンスURLツールへのアクセスに使用できるURLの例です。
