| Oracle® Fusion Middleware Oracle WebCenter Contentサービス・リファレンス 11gリリース1 (11.1.1) B72418-01 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle WebCenter Contentサービス・リファレンス 11gリリース1 (11.1.1) B72418-01 |
|
前 |
次 |
この章では、フォルダ・サービスの使用時およびカスタマイズ時に利用できるOracle WebCenter Contentサービスについて説明します。
この章の内容は、次のとおりです。
フォルダは、従来のファイル・システムと同様に、Content Serverリポジトリ内の一部またはすべてのコンテンツを編成および検索するための階層フォルダ・インタフェースを提供する現在のWebCenter Content機能の名前です。この機能は、WebCenter ContentのFrameworkFoldersコンポーネントによってサポートされています。コントリビューション・フォルダと呼ばれる、以前のバージョンのフォルダで使用されるサービス(WebCenter ContentのFolders_gコンポーネントでサポートされているサービス)の詳細は、第7章を参照してください。
WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります
個々のフォルダ・サービスの場所は、それぞれのサービスの説明の中で示します。
|
注意: 最も一般的に使用されるサービスには、より広範囲な説明があります。 |
個々のフォルダ・サービスの説明では、そのフォルダ・サービスのタイプについて示します。この項では、次のサービスについて説明します。
フォルダ構造の参照に使用されるサービス。次の参照モードでのフォルダ構造のページ区切りに使用できます。
フォルダとファイル、それぞれの単独のページング(デフォルトの動作)
フォルダとファイルを結合したページング(doCombinedBrowse=trueを設定する必要があります)
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
item: (fFolderGUID、pathおよびitemsをいずれも指定していない場合は必須。)参照対象のアイテム。path:path to itemの形式で指定するか、またはfFolderGUIDを指定する場合はfFolderGUID:GUID of itemの形式で指定します。どちらの参照モードでも使用できます。
items: (fFolderGUID、pathおよびitemをいずれも指定していない場合は必須。)参照対象の各アイテム。path:path to itemまたはfFolderGUID:GUID of itemの形式で指定した識別子のカンマ区切りリストの形式で指定します。どちらの参照モードでも使用できます。
path: (lFolderGUIDを指定していない場合は必須。)現在のフォルダのフルパス。どちらの参照モードでも使用できます。
fFolderGUID: (pathを指定していない場合は必須。)現在のフォルダを参照するパスのかわりに使用できます。どちらの参照モードでも使用できます。
オプションのサービス・パラメータ
fldapp: ユーザーが参照している場所のフォルダ・アプリケーションを指定します。どちらの参照モードでも使用できます。
folderCount: (整数)返すフォルダの数。デフォルトは50です。単独参照モードで使用できます。
folderStartRow: (整数)データを返す最初の行番号。ページ区切りに使用されます。デフォルトは0 (ゼロ)です。単独参照モードで使用できます。
fileCount: (整数)返すファイルの数。デフォルトは50です。単独参照モードで使用できます。
fileStartRow: (整数)データを返す最初の行番号。ページ区切りに使用されます。デフォルトは0 (ゼロ)です。単独参照モードで使用できます。
foldersFilterParams: 参照のフィルタ・パラメータのカンマ区切りのリスト。たとえば、foldersFilterParams=fIsContribution&fIsContribution=1では、fIsContribution=1のフォルダが返されます。どちらの参照モードでも使用できます。
foldersSortField: レコードをソートする、FolderFolders表内のフィールド名。どちらの参照モードでも使用できます。
foldersSortOrder: 昇順でソートする場合はAsc、降順でソートする場合はDescを指定します。どちらの参照モードでも使用できます。
$fieldName: foldersFilterParamsおよびfilesFilterParamsパラメータで指定したフィールドの値。どちらの参照モードでも使用できます。
filesFilterParams: 参照のフィルタ・パラメータのカンマ区切りのリスト。たとえば、filesFilterParams=fOwner&fOwner=sysadminでは、fOwner=sysadminのフォルダが返されます。どちらの参照モードでも使用できます。
結果
ResultSets:
FolderInfo: ユーザーが現在参照しているフォルダに関する情報。
ChildFolders: このフォルダ内に存在するすべてのフォルダに関する情報。
ChildTargetFolders: ChildFolders ResultSet内のショートカットのすべてのターゲット・フォルダに関する情報。
ChildFiles: このフォルダ内に存在するすべてのファイルに関する情報。
numFolders: (文字列)ChildFolders ResultSet内のフォルダ数。
hasMoreChildFolders: (ブール)リクエストですべての子のフォルダが返されたわけではない場合、これはtrueです。これはfolderCount値に到達したときに発生します。返すことができる追加のフォルダがあった可能性があります。
numFiles: (整数)ChildFiles ResultSet内のファイル数。
TotalChildFoldersCount: (整数)親フォルダ内のアイテム(フォルダおよびファイル)の合計数。
TotalChildFilesCount: (整数)親フォルダ内のファイルの合計数。
TotalChildItemsCount: (整数)親フォルダ内のアイテム(フォルダおよびファイル)の合計数。
hasMoreChildFiles: (ブール)リクエストですべての子のファイルが返されたわけではない場合、これはtrueです。これはfileCount値に到達したときに発生します。返すことができる追加のドキュメントがあった可能性があります。
hasMoreChildItems: (ブール)リクエストですべての子のアイテム(フォルダおよびファイル)が返されたわけではない場合、これはtrueです。これはカウントに到達したときに発生します。返すことができる追加のアイテムがあった可能性があります。
ツリー・コントロールを含む小さなポップアップを準備するサービス。このツリー・コントロールを使用して、フォルダ構造を参照し、ドキュメントまたはフォルダを選択できます。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
target: ユーザーがこのポップアップでターゲットとするエンティティ・タイプ。ユーザーが選択を許可されているものに応じて、fileまたはfolderに設定できます。
結果
ResultSets:
ChildFolders: ルート・アイテムの子のフォルダ。
ChildFiles: ルート・アイテムの子のファイル。targetがfileに設定されていない場合はnullになります。
フォルダでユーザーがある場所から別の場所にアイテムをコピーできるようにするサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
destination: すべてのアイテムのコピー先。この識別子は、path:$PATH'またはfFolderGUID:$FOLDER_GUIDの形式にする必要があります。
item1: コピー対象のアイテム。この操作で複数のアイテムをコピーする場合は、item2, item3,などのように指定できます。これらのアイテムをIDまたはフルパスのどちらかで指定します。各アイテムは、path:$PATH、fFolderGUID:$FOLDER_GUIDまたはfFileGUID:$FILE_GUIDの形式にする必要があります。
オプションのサービス・パラメータ
overwrite: 1に設定すると、ネーミングの競合が発生した場合に既存のコピー先が上書きされます。上書きされたアイテムはごみ箱に移動されます。
copyOwnerFilesToNewFiles: 1に設定すると、タイプがownerのすべてのファイルが新しい所有者ファイルにコピーされます。このアクションによって、コピー対象の各所有者ファイルに対して新しいチェックインが発生します。デフォルトでは、所有者ファイルのコピーは、ソース・ドキュメントを指すソフト・ファイルです。
copySoftFilesToNewFiles: 1に設定すると、コピー対象のすべてのソフト・ファイルの新しいコンテンツ・アイテムが作成されます。デフォルトでは、ソフト・ファイルのコピーは同じコンテンツ・アイテムを指す別のソフト・ファイルです。
constructDialog: これを1に設定すると、コピー・アクションの結果、またはコピー・アクションが失敗した可能性がある場合はその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されます。
結果
ResultSets:
ItemsRequiringOverwrite: overwriteフラグが設定されていないときに、コピー先に競合するアイテムが存在する場合、このResultSetによって、どのような競合が存在するかが示されます。競合がある場合は、どのアイテムも移動されません。この戻りによって、競合の可能性に対する迅速なサーバー・レスポンスが可能になり、クライアント・アプリケーションが上書きに関する確認をユーザーに求めることができます。
TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報
didBackgroundTask: (文字列)一部またはすべてのタスクがバックグラウンドで実行された場合は、このパラメータが1に設定されます。
mainTasksComplete: (文字列)サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は、このパラメータが1に設定されます。これは、コピー後のチェックはまだ完了していなくても、アイテムのコピーは完了していることを知るために役立ちます。
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
フォルダ内のドキュメントへのリンクを作成するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fParentGUID: 新しいリンクの作成場所とする親フォルダのGUID。
オプションのサービス・パラメータ
$fileMeta: リンクに割り当てるメタデータ。
ファイル名の制限
ファイル名の先頭と末尾には空白は使用できません。
ファイル名は250文字以内にする必要があります。
制限付き文字
制限付き文字列:
ドキュメントを指す新しいリンク・オブジェクトを作成するためのフォルダ・フォームを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fParentGUID: 新しいリンクの作成場所とする親フォルダのGUID。
fFileType: 作成するリンクのタイプ。
dDocName: リンクのターゲットのドキュメント名。
オプションのサービス・パラメータ
fApplication: フォルダを作成するフォルダ・アプリケーション。デフォルトはframeworkです。
$fileMeta: リンクのデフォルトのメタデータ値。
結果
ResultSets:
ParentInfo: 親フォルダに関する情報。
parentPath: (文字列)親フォルダのフルパス。
フォルダ内にフォルダを作成するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fParentGUID: 新しいフォルダの作成場所とする親フォルダのGUID。
オプションのサービス・パラメータ
$folderMeta: フォルダに割り当てるメタデータ。
フォルダ名の制限
フォルダ名の先頭と末尾には空白は使用できません。
フォルダ名は250文字以内にする必要があります。
制限付き文字
制限付き文字列:
新しいフォルダの作成用にフォルダを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fParentGUID: 新しいフォルダの作成場所とする親フォルダのGUID。
オプションのサービス・パラメータ
fApplication: フォルダを作成するフォルダ・アプリケーション。デフォルトはframeworkです。
fFolderType: 作成するフォルダのタイプ。デフォルトはownerです。
$folderMeta: フォルダのデフォルトのメタデータ値。
fTargetGUID: fFolderType値がsoftの場合、これはターゲット・フォルダのGUIDにする必要があります。
結果
結果セット:
ParentInfo: 親フォルダに関する情報。
TargetInfo: ターゲット・フォルダに関する情報(ターゲット・フォルダがある場合)。
parentPath: (文字列)親フォルダのフルパス。
targetPath: (文字列)ターゲットのフルパス(ターゲットがある場合)。
ユーザーがFramerwork Folders階層から1つ以上のアイテムを削除できるようにするサービス。これによって、ごみ箱にまだ移動されていないアイテムでもただちに削除されます。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
item1: 削除対象のアイテム。この操作で複数のアイテムを削除する場合は、item2, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。各アイテムは次のいずれかの形式で指定する必要があります。
path:$PATH
fFolderGUID:$FOLDER_GUID
fFileGUID:$FILE_GUID
オプションのサービス・パラメータ
constructDialog: (ブール値)FLD_DELETE操作の結果、またはこの操作が失敗した可能性がある場合にはその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されるようにするには、このパラメータを1に設定します。
結果
ResultSets:
TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報。
didBackgroundTask: (ブール)一部またはすべてのタスクがバックグラウンドで実行された場合は1に設定されます。
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
mainTasksComplete: (ブール)サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は1に設定されます。これは、削除後のチェックはまだ完了していなくても、アイテムの削除は完了していることを知るために役立ちます。
フォルダ内のドキュメントへのリンクを編集するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFileGUID: 編集対象のリンクのID。
オプションのサービス・パラメータ
$fileMeta: 編集対象のリンクに割り当てるメタデータ。
フォルダ内のドキュメントへのリンクを編集するためのフォームを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFileGUID: 編集対象のリンクのGUID。
結果
$fileMeta: 編集対象のリンクに現在割り当てられているメタデータ値。
folderPath: (文字列)編集対象のリンクのフルパス。
フォルダ内のフォルダを編集するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: 編集対象のフォルダのID。
オプションのサービス・パラメータ
$folderMeta: 編集対象のフォルダに割り当てるメタデータ。
フォルダ内のフォルダを編集するためのフォームを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: 編集対象のフォルダのGUID。
結果
ResultSets:
$folderMeta: 編集対象のフォルダに現在割り当てられているメタデータ値。
folderPath: (文字列)編集対象のフォルダのフルパス。
targetPath: (文字列)ターゲットのフルパス(編集対象のフォルダがショートカットの場合)。
TargetInfo: ターゲットに関する情報(編集対象のフォルダがショートカットの場合)。
フォルダ内のフォルダに割り当てられたメタデータ・ルールを編集するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: 編集対象のフォルダのGUID。
$fieldName: 指定フィールドの値。
オプションのサービス・パラメータ
$fieldName:isDefault: (ブール)指定フィールドを編集対象のフォルダのすべての子に強制する場合は1に設定します。
$fieldName:isForced: (ブール)指定フィールドを編集対象のフォルダのすべての子に強制する場合は1に設定します。
$fieldName:isRecursiveForced: (ブール)指定フィールドを編集対象のフォルダのすべての子、さらにその子に強制する場合は1に設定します。
$fieldName:inhibitPropagation: (ブール)指定フィールドを編集対象のフォルダの子に伝播可能にする場合は1に設定します。
フォルダ内のフォルダに割り当てられたコンテンツ・メタデータ・デフォルトを編集するためのフォームを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: 編集対象のフォルダのGUID。
結果
ResultSets:
FolderInfo: 編集されたフォルダに関する情報。
$fieldName: (文字列)指定フィールドの値。
$fieldName:isDefault: (ブール)指定フィールドにデフォルト値が関連付けられている場合は1に設定されます。
$fieldName:isForced: (ブール)指定フィールドがフォルダのすべての子に強制される場合は1に設定されます。
$fieldName:isRecursiveForced: (ブール) 指定フィールドがフォルダのすべての子、さらにその子に強制される場合は1に設定されます。
$fieldName:inhibitPropagation: (ブール)指定フィールドがフォルダの子に伝播可能な場合は1に設定されます。
folderPath: (文字列)フォルダのフルパス。
dpTriggerField: (文字列)プロファイル・トリガー・フィールド(存在する場合)。
dpTriggerValue: (文字列)現在のプロファイル・トリガー値(存在する場合)。
dpDisplayLabel: (文字列)現在のプロファイル表示ラベル(存在する場合)。
Folders_gレガシー・フォルダ・データをFrameworkFoldersデータ構造に移行するためのダイアログを表示するサービス。移行の履歴と、現在進行中の移行のステータスが表示されます。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
フォルダ内のフォルダを検索し、結果を返すサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
QueryTest: 検索問合せのテキスト。
SortField: 検索結果をソートするフィールド。
SortOrder: 検索結果のソート順。次のいずれかを使用します。
asc
desc
結果
ResultSets:
SEARCH_RESULTS: 検索の結果。
フォルダ内のフォルダを検索するためのフォームを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
フォルダでの移動またはコピー操作時に移動またはコピー先を選択するためのダイアログを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
action: 実行するアクションに応じてmoveまたはcopyに設定します。
item1: コピー対象のアイテム。この操作で複数のアイテムを処理する場合は、item5, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。各アイテムは次のいずれかの形式で指定する必要があります。
path:$PATH
fFolderGUID:$FOLDER_GUID
fFileGUID:$FILE_GUID
結果
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
フォルダ内の既存のコンテンツ・アイテムへのリンクを作成するためのダイアログを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fParentGUID: リンクの作成場所とするフォルダのGUID。これかまたはdDocNameのいずれかを設定する必要があります。
dDocName: 新しいリンクのターゲット・ドキュメント。これかまたはfParentGUIDを設定する必要があります。
fFileName: 作成するリンクのタイプ。
結果
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
フォルダ内の既存のフォルダへのショートカットを作成するためのダイアログを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fTargetGUID: ショートカットのターゲット・ドキュメントID。
fParentGUID: ショートカットの作成場所とする親フォルダのID。
結果
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
フォルダ内のファイルの名前変更に使用されるダイアログを取得するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFileGUID: 名前を変更するファイルのGUID。
結果
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
フォルダ内のフォルダの名前変更に使用されるダイアログを取得するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: 名前を変更するフォルダのGUID。
結果
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
フォルダ内の特定のフォルダまたはファイルに関する情報を返すサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
path: 情報のリクエスト対象のフォルダまたはファイルのパス。fFolderGUIDまたはfFileGUIDパラメータをいずれも指定していない場合は、このパラメータを指定する必要があります。
fFolderGUID: 情報のリクエスト対象のフォルダのGUID。pathまたはfFileGUIDパラメータをいずれも指定していない場合は、このパラメータを指定する必要があります。
fFileGUID: 情報のリクエスト対象のファイルのGUID。pathまたはfFolderGUIDパラメータをいずれも指定していない場合は、このパラメータを指定する必要があります。
結果
ResultSets:
FileInfo: ドキュメント(ファイル)へのリンクに関する情報。また、ドキュメント自体に関連付けられたメタデータ。
FolderInfo: フォルダに関する情報。
TargetInfo: ターゲット(ショートカット)に関する情報。
filePath: (文字列)アイテムのフルパス(アイテムがドキュメント・リンクの場合)。
folderPath: (文字列)アイテムのフルパス(アイテムがフォルダの場合)。
targetPath: (文字列)ターゲット・アイテムのフルパス(アイテムがショートカットの場合)。
フォルダ内の特定のコンテンツ・アイテムを参照するすべてのソフト・リンクをロードするサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
dDocName: コンテンツ・アイテムの名前。
dID: コンテンツ・アイテムの識別子。
オプションのサービス・パラメータ
constructSoftLinkTableRows: (ブール)ソフト・リンク表の行のHTMLを構成するかどうか。デフォルトは1(TRUE)です。
結果
ResultSets:
softLinks: コンテンツ・アイテムのソフト・リンク。
softLinkTableRows: (文字列)ソフト・リンク表の行を表示するHTML。
Folders_gレガシー・フォルダ・データをFrameworkFoldersデータ構造に移行するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
フォルダで1つ以上のコンテンツ・アイテムをフォルダ内の別の場所に移動するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
destination: すべてのアイテムの移動先。移動先が既存のフォルダである場合は、移動対象のすべてのアイテムがそのフォルダに移動されます。単一ファイルを移動する場合は、ファイルの移動先の場所(新しいファイル名を含む)を指すことができます。この識別子は、path:$PATHまたはfFolderGUID:$FOLDER_GUIDの形式で指定します。
item1: 移動対象のアイテム。この操作で複数のアイテムを移動する場合は、item2, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。次のいずれかの形式にする必要があります。
path:$PATH
fFolderGUID:$FOLDER_GUID
fFileGUID:$FILE_GUID
オプションのサービス・パラメータ
overwrite: (ブール) 1に設定すると、ネーミングの競合が発生した場合に既存の移動先が上書きされます。上書きされたアイテムはごみ箱に移動されます。
constructDialog: (ブール) 1に設定すると、移動操作の結果、または移動が失敗した可能性がある場合はその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されます。
結果
ResultSets:
ItemsRequiringOverwrite: overwriteフラグが設定されていないときに、移動先に競合するアイテムが存在する場合、このResultSetが返され、どのような競合が存在するかが示されます。競合がある場合は、どのアイテムも移動されません。これによって、競合の可能性に対する迅速なサーバー・レスポンスが可能になり、クライアント・アプリケーションが上書きに関する確認をユーザーに求めることができます。
TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報。
dialogMarkup: (文字列)ダイアログのHTML。
dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。
didBackgroundTask: (文字列)一部またはすべてのタスクがバックグラウンドで実行された場合は、これが1に設定されます。
mainTasksComplete: (文字列)サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は、これが1に設定されます。これは、移動後の健全性チェックはまだ完了していなくても、アイテムの移動は完了していることを知るために役立ちます。
コンテンツ・アイテムのチェックイン前にメタデータ入力ダイアログをユーザーに表示する必要があるかどうかをリクエスト元のクライアントが判断できるようにするための情報を提供するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: CONTENTSのアイテムのベース・フォルダID。fFolderPATHを設定していない場合は、このパラメータを使用する必要があります。
fFolderPath: CONTENTSのアイテムのベース・フォルダ・パス。fFolderGUIDを設定していない場合は、このパラメータを使用する必要があります。
CONTENTS: (ResultSet)ベース・フォルダを基準にした、フォルダおよびコンテンツ・アイテムの相対パスのセット。指定したパスの末尾が/ (スラッシュ)文字の場合、パスはフォルダを表すとみなされます。それ以外の場合はコンテンツ・アイテムを表すとみなされます。
EXTRA_INFO_FIELDS: (ResultSet)アイテムごとに返す追加情報フィールドのリスト。追加情報フィールドのデータは既存のコンテンツ・アイテムの場合にのみ移入されます。リクエスト可能な有効フィールドは、REVISIONS、DOCMETAまたはDOCUMENTS表のいずれかの列か、getcontentlength、getcontenttype、getlastmodifiedまたはcreationdateフィールド(WebDAVの場合など)です。
オプションのサービス・パラメータ
allowPromptForExistingItem: (ブール) 1に設定すると、クライアント・リクエストで2番目のリビジョンに対してプロンプトを表示できるようになります。通常、プロンプトは最初のリビジョンに対してのみ発生します。
結果
ResultSet: REQUIRES_METADATA_PROMPT: 返されたこのResultSetには、CONTENTSの各行に対応した次のフィールドが含まれています。
FLAGフィールド:{flag1}{flag2}の2つのフラグ文字。flag1が1に設定されている場合、指定したパスがすでに存在します。1でない場合は存在しません。flag2が1に設定されている場合、クライアントは、このアイテムのメタデータの入力を求めるプロンプト・ダイアログを表示するようになります。
DP_TRIGGER_VALUE: このアイテム用に使用されたドキュメント・プロファイル。これには、EXTRA_INFO_FIELDSパラメータで指定したフィールドごとに1つの列が表示されます。
フォルダのフォルダ構造の下層にメタデータを伝播するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
$fieldName:isSelected: 1に設定すると、指定したフィールドが伝播されます。
$fieldName: 伝播対象のフォールドの値
オプションのサービス・パラメータ
propagateThroughSoftLinks: (ブール) 1に設定すると、ソフト・リンクが指すドキュメントにメタデータが伝播されます。
ユーザーがフォルダ内のフォルダのすべての子にメタデータを伝播できるようにするフォームを表示するサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: フォルダのID。
結果
ResultSets:
FolderInfo: フォルダに関する情報。
folderPath: フォルダのフルパス。
$fieldName: 伝播されるフィールドのデフォルト値。この値はメタデータ・ルールから取得されるか、またはフォルダ自体のメタデータから取得されます。
dpTriggerField: プロファイル・トリガー・フィールド(存在する場合)。
フォルダ内の特定のフォルダに含まれている、現在索引付けされているすべてのドキュメントの再索引付けを実行するサービス。このサービスはシステム管理者のみがコールできます。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
fFolderGUID: フォルダのGUID。
フォルダのFLD_BROWSEサービスによって返された子のドキュメントの容易なページングを可能にするサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
path: 現在のフォルダのフルパス。folderGUIDパラメータを指定していない場合は、このパラメータを使用する必要があります。
fFolderGUID: フォルダのGUID。現在のフォルダを参照するパスのかわりにこのパラメータを指定できます。
オプションのサービス・パラメータ
fldapp: 参照対象の場所のフォルダ・アプリケーション。
folderCount: 返すフォルダの数。デフォルトは50です。
folderStartRow: データを返す最初の行番号。レスポンスのページングに使用されます。デフォルトは0です。
constructListingMarkup: 追加フォルダのマークアップを返すかどうかを指定します。このパラメータは、このリクエストをAJAX環境で実行するときに役立ちます。デフォルトは1(TRUE)です。
結果
ResultSets:
FolderInfo: 現在参照しているフォルダに関する情報。
ChildFolders: このフォルダ内に存在するすべてのフォルダに関する情報。
FileListingHTML: 追加ドキュメントの表示に使用できるHTML。constructListingMarkupを1 (true)に設定したときにのみ返されます。
FileListingScript: 追加ドキュメントを表示するために実行する必要があるJavaScript。constructListingMarkupを1 (true)に設定したときにのみ返されます。
numFolders: ChildFolders ResultSet内のフォルダ数。
hasMoreChildFiles: リクエストですべての子のファイルが返されたわけではない場合、これは1 (true)です。これはfileCountに到達したときに発生します。返すことができる追加のドキュメントがあった可能性があります。
フォルダのFLD_BROWSEサービスによって返された子のフォルダの容易なページ区切りを可能にするサービス。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
path: 現在のフォルダのフルパス。folderGUIDパラメータを指定していない場合は、このパラメータを使用する必要があります。
fFolderGUID: フォルダのGUID。現在のフォルダを参照するパスのかわりにこのパラメータを指定できます。
オプションのサービス・パラメータ
fldapp: 参照対象の場所のフォルダ・アプリケーション。
folderCount: 返すフォルダの数。デフォルトは50です。
folderStartRow: データを返す最初の行番号。レスポンスのページングに使用されます。デフォルトは0です。
constructListingMarkup: 追加フォルダのマークアップを返すかどうかを指定します。このパラメータは、このリクエストをAJAX環境で実行するときに役立ちます。デフォルトは1(TRUE)です。
結果
ResultSets:
FolderInfo: 現在参照しているフォルダに関する情報。
ChildFolders: このフォルダ内に存在するすべてのフォルダに関する情報。
FolderListingHTML: 追加フォルダの表示に使用できるHTML。constructListingMarkupを1 (true)に設定したときにのみ返されます。
FolderListingScript: 追加フォルダを表示するために実行する必要があるJavaScript。constructListingMarkupを1 (true)に設定したときにのみ返されます。
numFolders: ChildFolders ResultSet内のフォルダ数。
hasMoreChildFolders: リクエストですべての子のフォルダが返されたわけではない場合、これは1 (true)です。これはfileCountに到達したときに発生します。返すことができる追加のフォルダがあった可能性があります。
ユーザーがフォルダ階層から1つ以上のアイテムのファイリングを解除できるようにするサービス。これによって、ターゲット・ドキュメントにいかなる影響も及ぼすことなく、リンク・オブジェクトがただちに削除されます。
サービス・クラス: intradoc.folders.FoldersService
場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm
必須のサービス・パラメータ
item1: ファイリング解除対象のアイテム。この操作で複数のアイテムのファイリングを解除する場合は、item2, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。各アイテムは、path:$PATHまたはfFileGUID:$FILE_GUIDの形式にする必要があります。
オプションのサービス・パラメータ
constructDialog: ファイリング解除の結果、またはファイリング解除が失敗した可能性がある場合にはその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されるようにするには、このパラメータを1に設定します。
結果
ResultSets:
TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報。
didBackgroundTask: 一部またはすべてのタスクがバックグラウンドで実行された場合は、これが1に設定されます。
mainTasksComplete: サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は、これが1に設定されます。これは、ファイリング解除後のチェックはまだ完了していなくても、アイテムのファイリング解除は完了していることを知るために役立ちます。
dialogMarkup: ダイアログのHTML。
dialogScript: ダイアログを表示するために必要なJavaScript。
