7 コントリビューション・フォルダ・サービス
この章の内容は、次のとおりです。
コントリビューション・フォルダ・サービスについて
コントリビューション・フォルダは、Folders_g機能と呼ばれた前のリリースのWebCenter Contentに与えれた名前です。コントリビューション・フォルダはWebCenter ContentのFolders_gコンポーネントによりサポートされます。コントリビューション・フォルダ・サービスは、現在のフォルダ機能で使用できません(「フォルダ・サービス」を参照)。
WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります
特定のコントリビューション・フォルダ・サービスの場所とサービス・タイプは、各サービス内にリスト表示されています。
ノート:
最も一般的に使用されるサービスには、より広範囲な説明があります。
COLLECTION_ADMIN_SELECT_COLLECTION DocService 56 COLLECTION_PROFILE_SELECT_COLLECTION null null !csCollectionUnableToRetrieveCollections 3:evaluate:<$isAdmin="true"$>::null 3:loadAdminQueryConfig:::null
この例の説明:
-
1行目にはサービス名(
COLLECTION_ADMIN_SELECT_COLLECTION
)を指定します。 -
2行目と3行目にはサービスの属性を指定します。
-
サービス・クラス:
DocService
。 -
アクセス・レベル:
54
。スクリプト作成可能、グローバルおよび管理権限を意味します。 -
テンプレート:
COLLECTION_PROFILE_SELECT_COLLECTION
-
サービス・タイプ:
null
-
通知された件名:
null
-
エラー・メッセージとエラー・メッセージで使用されるパラメータ:
コレクションを取得できません
-
-
エントリのこの他の部分では、各行に1つずつサービスのアクションを指定します。
-
アクション・タイプ: たとえば、
3
はJavaメソッドを示します。 -
アクション名: たとえば、
evaluate
-
アクション・パラメータ: たとえば、
<$isAdmin="true"$>
。パラメータを指定しない場合は、2つのコロン(::)
を指定します。 -
アクションの制御マスク: たとえば、
0
はエラーを無視すること、2
は存在する必要がある(少なくとも1つのレコードが問合せによって返される必要がある)ことを意味します。制御マスクを指定しない場合は、2つのコロン(::)
または0を指定します。 -
アクションのエラー・メッセージ:
アイテムはもはや履歴にありません
など、またはメッセージがない場合はnull。
-
サービス・アクションの各要素はコロン(:
)で区切ります。
ノート:
すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。
コントリビューション・フォルダ・サービス
COLLECTION_ADD
コントリビューション・フォルダを作成するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
リダイレクト場所: 新規作成するフォルダのCOLLECTION_DISPLAY。
追加の必須サービス・パラメータ
-
dCollectionName: 作成するコントリビューション・フォルダの名前。
親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasParentCollectionID: (Boolean) 親コントリビューション・フォルダIDを識別するためにdParentCollectionIDパラメータを使用するかどうかを指定します。
dParentCollectionID: 親コントリビューション・フォルダID。
-
hasParentCollectionPath: (Boolean) 親コントリビューション・フォルダへのパスを識別するためにdParentCollectionPathパラメータを使用するかどうかを指定します。
dParentCollectionPath: 親コントリビューション・フォルダへのパス。
-
hasParentCollection GUID: (Boolean) dParentCollectionGUIDパラメータを使用して、親コントリビューション・フォルダのGUIDを識別することを指定します。
dParentCollectionGUID: 親コントリビューション・フォルダGUID。
オプションのサービス・パラメータ
-
dCollectionOwner: コントリビューション・フォルダ所有者。xForceFolderSecurity=TRUEの場合、コントリビューション・フォルダ所有者は親コントリビューション・フォルダの所有者と同じです。それ以外の場合、デフォルトは現在のユーザーです。
この設定により、コレクション所有者として設定されたユーザーがオーバーライドされます。所有者は、他のセキュリティ基準が設定されていても、コントリビューション・フォルダにアクセスしたり、コントリビューション・フォルダを変更したりすることが可能です。
-
dCollectionCreator: コントリビューション・フォルダ作成者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。
-
dCollectionModifier: 最後のコントリビューション・フォルダ変更者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。
-
ignoreMaxFolderLimit: 親コントリビューション・フォルダに追加するサブフォルダ数を現在設定されている最大制限数より多くすることができます。デフォルト値はfalseです。
-
mark: コントリビューション・フォルダのdCollectionMarkを設定します。dCollectionMarkが設定されたコントリビューション・フォルダは、falseに設定されているCollectionReadOnlyMarkedFoldersを使用しないで変更することはできません(デフォルトのケースではない)。これらのマークされたコントリビューション・フォルダおよびその有効化/無効化状態は、「システム・フォルダの構成」ページで表示できます。「コントリビューション・フォルダ」および「ごみ箱」はマークされたフォルダです。
-
force: ルート・コントリビューション・フォルダの下にコントリビューション・フォルダを作成します(dParentCollectionID=-1)。デフォルト値はfalseです。
-
任意のシステムまたはカスタム・メタデータ・フィールド: 指定されたフィールドおよび値はコントリビューション・フォルダ用に設定され、コントリビューション・フォルダ内で作成されたコンテンツとコントリビューション・フォルダのデフォルト値として使用されます。
例
IdcService=COLLECTION_ADD hasParentCollectionID=true dCollectionName=Products dParentCollectionID=1 dCollectionOwner=bsmith
COLLECTION_ADD_LINK
コントリビューション・フォルダまたはコントリビューション・フォルダ内のコンテンツにショートカットを追加するサービス。このショートカットは、コントリビューション・フォルダIDを使用してコントリビューション・フォルダを参照します。
最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: install_dir/custom/Folders/resources/folders_service.htm
場所: IdcHomeDir
/components/folders_g/resources/folders_services.htm
追加の必須サービス・パラメータ
-
次のパラメータは、作成したショートカットの宛先親コントリビューション・フォルダを識別します。
-
tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダIDを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: ショートカットが参照するコントリビューション・フォルダID。
-
-
dDocID: コンテンツID。フォルダではなくコンテンツ・アイテムへのショートカットを作成するときに使用されます。
-
dLinkName: 作成するショートカットの名前。
-
dLinkType: 作成するショートカットのタイプ。COLLECTIONまたはCONTENTである必要があります。
-
COLLECTIONが指定される場合、hasdCollectionIDを指定する必要があります。
hasdCollectionID: (Boolean)コントリビューション・フォルダがコレクションIDを使用して参照されるかどうかを指定します。
dCollectionID: ショートカットによって参照される親コントリビューション・フォルダのコントリビューション・フォルダID。
-
CONTENTが指定される場合、dRevClassIDを指定する必要があります。
dRevClassID: ショートカットがポイントするコンテンツ・アイテムのリビジョン・クラスID。
-
例
IdcService=COLLECTION_ADD_LINK tohasCollectionID=true todCollectionID=999999999999000633 dLinkName=Shortcut dLinkType=COLLECTION hasdCollectionID=true dCollectionID=999999999999004533
dCollectionID=194
dLinkType=COLLECTION
tohasCollectionID=false
todCollectionID=" "
COLLECTION_BROWSE
定義済コントリビューション・フォルダ・メタデータおよびコントリビューション・フォルダのパスをロードするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_interface_service.htm
追加の必須サービス・パラメータ
-
dCollectionID: ショートカットによって参照される親コントリビューション・フォルダのコントリビューション・フォルダID(たとえば、="+id+")。
-
hasCollectionID: (Boolean)コントリビューション・フォルダに割当て済のコレクションIDがあるかどうかを指定します。
-
changeToUser: コントリビューション・フォルダを別のユーザーに再割り当てします。
例
IdcService=COLLECTION_BROWSE dCollectionID="+id+" hasCollectionID=true changeToUser=bsmith
COLLECTION_CHECKIN_NEW
コントリビューション・フォルダに新しいコンテンツをチェックインするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_CHECKIN_REVISION
既存のコントリビューション・フォルダへのリビジョンをチェックインするサービス。
このサービスは、ブラウザまたは「リポジトリ・マネージャ」アプリケーションを介したチェックイン時にコールされる同じサブサービスである、次のサブサービスのいずれかにチェックイン・リクエストを送信します。(これらのサブサービスは、バッチ・ローダーまたはアーカイブのインポート中にはコールされません。)
-
COLLECTION_CHECKIN_SEL_SUB
-
CHECKIN_SEL_FORM
-
COLLECTION_SEARCH_CONTENT
-
CHECKOUT_BY_NAMENULL
-
COLLECTION_LOCKNULL
-
DELETE_REVNULL
このサービスは、セキュリティをチェックして、ユーザーがコントリビューション・フォルダのチェックインを実行するための十分な権限を持っているかどうかを判断します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folder/resources/folders_service.htm
COLLECTION_CHECKIN_SEL_SUB
特定の条件下で、既存のコントリビューション・フォルダへのリビジョンをチェックインするサービス。コントリビューション・フォルダがシステムに存在するが有効なリビジョンが指定されていないか、またはコンテンツ・アイテムがチェックアウトされた(しかし、ワークフロー内にない)場合に使用されます。
最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_COPY_ALL
指定されたコントリビューション・フォルダにあるすべてのコンテンツを宛先コントリビューション・フォルダにコピーするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_COPY_COLLECTION
指定されたコントリビューション・フォルダをコピーし、そのコピーを異なるコントリビューション・フォルダに配置するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
コピー済コントリビューション・フォルダの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダIDを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダID。
-
tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダへのパスを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。
-
tohasCollection GUID: (Boolean) 宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダGUID。
コピーされるソース・コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
fromhasCollectionID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionIDパラメータを使用するかどうかを指定します。
fromdCollectionID: ソース・コントリビューション・フォルダID。
-
fromhasCollectionPath: (Boolean)ソース・コントリビューション・フォルダへのパスを識別するためにfromdCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: ソース・コントリビューション・フォルダへのパス。
-
fromhasCollectionGUID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionGUIDパラメータを使用するかどうかを指定します。
fromdCollectionGUID: ソース・コントリビューション・フォルダGUID。
-
fromisLink: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdLinkIDパラメータを使用するかどうかを指定します。
fromdLinkID: ソース・コントリビューション・フォルダのコントリビューション・フォルダ・ショートカットID。
-
fromCollectionislink: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionLinkIDパラメータを使用するかどうかを指定します。
fromdCollectionLinkID: ソース・コントリビューション・フォルダのコレクション・ショートカットID。
例
IdcService=COLLECTION_COPY_COLLECTION tohasCollectionID=true todCollectionID=999999999999000633 fromhasCollectionID=true fromdCollectionID=999999999999000633
COLLECTION_COPY_ITEM
コントリビューション・フォルダの単一のコンテンツ・アイテムをコピーし、それを宛先コントリビューション・フォルダに配置するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: ファイル・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
dDocName: コピーするコンテンツ・アイテムのコンテンツID。
宛先コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先コントリビューション・フォルダのID。
-
tohasCollectionPath: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先コントリビューション・フォルダへのパス。
-
tohasCollectionGUID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先コントリビューション・フォルダのGUID。
-
tolevel0: 宛先親コントリビューション・フォルダのパスのベースの値を指定します(たとえば、
/Contribution Folders
)。tolevel1: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/t4
)。tolevel2: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/1
)。 -
AutoResolveDuplicates: このパラメータをtrueに設定すると、コピーする際に同じdOriginalNameの複数のファイルが存在できます。このパラメータがtrueに設定されたときに、同じ名前のファイルが存在する場合、コピーされるコンテンツのdOriginalNameに接頭辞「Copy(x)_of_」が付加されます。dOriginalNameの長さが255文字を超える場合、接頭辞はコンテンツのdDocNameが付加された「Copy(x)_of_CONTENTID_」に変わり、dOriginalNameに割り当てられます。
例
IdcService=COLLECTION_COPY_ITEM tohasCollectionPath=true todCollectionPath=/Contribution Folders/t4/1 dDocName=000660
COLLECTION_COPY_LOT
コンテンツ・アイテム、コントリビューション・フォルダ、コンテンツ・アイテムへのショートカット、コントリビューション・フォルダへのショートカットを含むアイテムのセットをコピーするサービス。コピーされたアイテムは単一の指定されたコントリビューション・フォルダに配置されます。
最も発生しがちなエラーは、パラメータに不整合があるか、指定のコントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
リダイレクト場所: コピー済アイテムの宛先フォルダのCOLLECTION_DISPLAY。
追加の必須サービス・パラメータ
コピー済アイテムの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダID。
-
tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。
-
tohasCollection GUID: (Boolean) 宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダGUID。
コンテンツ・アイテムを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。
-
contentselect{n}: (Boolean)コンテンツ・アイテムをコピーするかどうかを指定します。コンテンツ・アイテムをコピーするには、値はtrueである必要があります。
-
fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。コンテンツ・アイテムを指定するには、値は
0
である必要があります。 -
fromdDocName{n}: コピーするコンテンツ・アイテムのコンテンツID。
コンテンツ・アイテムへのショートカットを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。
-
contentselect{n}: (Boolean)コンテンツ・アイテムをコピーするかどうかを指定します。コンテンツ・アイテムをコピーするには、値はtrueである必要があります。
-
fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は
1
である必要があります。 -
fromdDocName{n}: ショートカットによってポイントされるコンテンツ・アイテムのコンテンツID。
コントリビューション・フォルダを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。
-
collectionselect{n}: (Boolean)コントリビューション・フォルダをコピーするかどうかを指定します。コントリビューション・フォルダをコピーするには、値はtrueである必要があります。
-
fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。コントリビューション・フォルダを指定するには、値は
0
である必要があります。 -
fromdCollectionID{n}: コピーされるコントリビューション・フォルダのdCollectionID。
-
fromhasCollectionID{n}: コントリビューション・フォルダをコピーするには、値は
1
である必要があります。
コントリビューション・フォルダへのショートカットを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。
-
collectionselect{n}: (Boolean)コントリビューション・フォルダへのショートカットをコピーするかどうかを指定します。ショートカットをコピーするには、値はtrueである必要があります。
-
fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は
1
である必要があります。 -
fromCollectiondLinkID{n}: コピーされるショートカットのリンクID。
-
fromdCollectionID{n}: ショートカットによってポイントされるコントリビューション・フォルダのdCollectionID。
-
fromhasCollectionID{n}: コントリビューション・フォルダへのショートカットをコピーするには、値は
1
である必要があります。
例
IdcService=COLLECTION_COPY_LOT tohasdCollectionID=true todCollectionID=999999999999000633 contentselect=true fromContentisLink=0 fromdDocName=PHL11GX010033
COLLECTION_DELETE
コントリビューション・フォルダを削除するサービス。「ごみ箱」が有効な場合、コントリビューション・フォルダは「ごみ箱」に移動され、直接削除されません。
最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
リダイレクト場所: 削除するフォルダの親フォルダのCOLLECTION_DISPLAY。
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: 削除するコントリビューション・フォルダのコントリビューション・フォルダID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: 削除するコントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: 削除するコントリビューション・フォルダのGUID。
例
IdcService=COLLECTION_DELETE hasCollectionPath=true dCollectionPath=/Contribution Folders/dept/hr
COLLECTION_DELETE_ALL
コントリビューション・フォルダにあるすべてのコンテンツを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_DELETE_COLLECTION
指定されたコントリビューション・フォルダを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_DELETE_ITEM
コントリビューション・フォルダの単一のコンテンツ・アイテムを削除するサービス。「ごみ箱」が有効な場合、アイテムは「ごみ箱」コントリビューション・フォルダに移動され、直接削除されません。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
dDocName: 削除されるコンテンツ・アイテムのコンテンツID。
例
IdcService=COLLECTION_DELETE_ITEM dDocName=000660
COLLECTION_DELETE_LOT
コンテンツ・アイテム、コントリビューション・フォルダ、コンテンツ・アイテムへのショートカット、コントリビューション・フォルダへのショートカットを含むアイテムのセットを削除するサービス。「ごみ箱」が有効な場合、アイテムは「ごみ箱」に移動され、直接削除されません。
最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
リダイレクト場所: 削除するアイテムの親フォルダのCOLLECTION_DISPLAY。
追加の必須サービス・パラメータ
コンテンツ・アイテムを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。
-
contentselect{n}: (Boolean)コンテンツ・アイテムを削除するかどうかを指定します。コンテンツ・アイテムをコピーするには、値はtrueである必要があります。
-
fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。コンテンツ・アイテムを指定するには、値は
0
である必要があります。 -
fromdDocName{n}: 削除するコンテンツ・アイテムのコンテンツID。
コンテンツ・アイテムへのショートカットを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。
-
contentselect{n}: (Boolean)ショートカットを削除するかどうかを指定します。ショートカットを削除するには、値はtrueである必要があります。
-
fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は
1
である必要があります。 -
fromContentdLinkID{n}: ショートカットのリンクID。
-
fromdDocName{n}: ショートカットによってポイントされるコンテンツ・アイテムのコンテンツID。
コントリビューション・フォルダを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。
-
collectionselect{n}: (Boolean)コントリビューション・フォルダを削除するかどうかを指定します。コントリビューション・フォルダを削除するには、値はtrueである必要があります。
-
fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。コントリビューション・フォルダを指定するには、値は
0
である必要があります。 -
fromdCollectionID{n}: 削除するコントリビューション・フォルダのdCollectionID。
-
fromhasCollectionID{n}: コントリビューション・フォルダを削除するには、値は
1
である必要があります。
コントリビューション・フォルダへのショートカットを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。
-
collectionselect{n}: (Boolean)コントリビューション・フォルダへのショートカットを削除するかどうかを指定します。ショートカットを削除するには、値はtrueである必要があります。
-
fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は
1
である必要があります。 -
fromCollectiondLinkID{n}: 削除するショートカットのリンクID。
-
fromdCollectionID{n}: ショートカットによってポイントされるコントリビューション・フォルダのdCollectionID。
-
fromhasCollectionID{n}: コントリビューション・フォルダへのショートカットを削除するには、値は
1
である必要があります。
-
tohasCollectionID: コレクションがコレクションIDを使用して参照されるかどうかを定義します(true/false)。trueに設定すると、todCollectionIDを定義する必要があります。
-
todCollectionID: ショートカットが参照するフォルダID。
-
todCollectionPath: フォルダのURLパス。
例
IdcService=COLLECTION_DELETE_LOT collectionselect=true fromCollectionisLink=0 fromdCollectionID=999999999999004955 fromhasCollectionID=1
tohasCollectionID=true
todCollectionID=194
todCollectionPath=""
COLLECTION_DISPLAY
コンテンツ・アイテム、コントリビューション・フォルダおよびショートカットを含む、コントリビューション・フォルダ内に格納されているアイテムのリストを返すサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_interface_service.htm
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: コントリビューション・フォルダのコレクションID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: コントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIGUIDパラメータを使用することを指定します。
dCollectionGUID: コントリビューション・フォルダのコレクションGUID。
-
orderby: ソートの基準に使用する列を定義します。
-
direction: 降順(DESC)または昇順(ASC)を定義します。
オプションのサービス・パラメータ
-
CollectionDisplayResultSetSize: COLLECTIONSおよびCONTENTS ResultSetsで返されるアイテム数を制限し、ページ・サイズを確立します。
-
showCollections: COLLECTIONS ResultSetを表示するように、Web UIプレゼンテーションに知らせるフラグ。これは、CollectionDisplayResultSetSizeおよびPageNumberを使用している場合に有効です。
-
showContent: CONTENTS ResultSetを表示するように、Web UIプレゼンテーションに知らせるフラグ。これは、CollectionDisplayResultSetSizeおよびPageNumberを使用している場合に有効です。
-
PageNumber: 整数値1以上の場合は、CONTENTSまたはCOLLECTIONS ResultSetsからデータの正しいページ・サイズ・サブセットを表示します。ページ・サイズはCollectionDisplayResultSetSizeにより設定されます。
-
CollectionReleasedOnly:
-
0 (デフォルト): フォルダに対するアクセス権がある場合、フォルダにチェックインされたドキュメント、つまりリリース済およびリリースされていないドキュメントの両方を表示することができます。
-
1: フォルダに対するアクセス権がある場合、リリース済ドキュメントまたはユーザーが作成者になっているドキュメントを表示することができます。CollectionReleasedOnlyIgnoreAuthorフラグをCollectionReleasedOnly = 1とともに渡すと、リリース済コンテンツのみを表示します。
-
結果
-
ResultSets: (コントリビューション・フォルダへのショートカットを含む、コントリビューション・フォルダによって直接格納されている各コントリビューション・フォルダ・アイテムのコントリビューション・フォルダ・メタデータを持つ行を含む)
-
CONTENTS
-
COLLECTIONS
-
METAMAPPING
-
COLUMNS
-
Fields
-
METADATA_OVERRIDE
-
PATH
-
metadata
-
例
IdcService=COLLECTION_DISPLAY hasCollectionPath=true dCollectionPath=%2fContent%20Server%20Folders%2f
orderby=dName
direction=ASC
COLLECTION_EDIT
コントリビューション・フォルダを編集するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・タイプ: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
hasCollectionID: (Boolean)コントリビューション・フォルダに割当て済のコレクションIDがあるかどうかを指定します。trueに設定される場合、dCollectionIDが定義される必要があります。
-
dCollectionID: 親コントリビューション・フォルダのコントリビューション・フォルダID。
COLLECTION_GET_ADMIN_CONFIG
コントリビューション・フォルダ階層に対して定義された現在のグローバル値を取得するサービス。特定のコレクションは渡されません。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_ADMIN_INHERIT_CONFIG
要求されるときに伝搬される現在のメタデータ・フィールドを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_ADMIN_MARKED_CONFIG
特別なコントリビューション・フォルダおよびその無効/有効ステータスを取得するサービス。無効なコントリビューション・フォルダは階層で表示されません。有効なコントリビューション・フォルダにはアクセスできます。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_ADMIN_META_CONFIG
定義されたコントリビューション・フォルダの管理メタデータResultSetからフィールドを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_ADMIN_METADATA_DEFAULTS
カスタム・フィールド、デフォルト・メタデータおよびコントリビューション・フォルダ構成の管理メタデータのオプション・リストを取得するサービス(フィールドのデフォルト値を取得)。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_ADMIN_MOUNTED_CONFIG
ローカル・コントリビューション・フォルダのコントリビューション・フォルダ・システム構成を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_mounted_service.htm
COLLECTION_GET_ARCHIVE
指定されたコントリビューション・フォルダのアーカイブ済コントリビューション・フォルダ構造をダウンロードするサービス。このサービスは、コントリビューション・フォルダのコンテンツをダウンロードしません。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ファイル・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_BRANCH
指定されたコントリビューション・フォルダおよびそのサブフォルダの構造を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_COLLECTION
指定されたコントリビューション・フォルダのすべてのサブフォルダを取得するサービス。COLLECTION_GET_COLLECTIONSと比較してください。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_COLLECTIONS
コントリビューション・フォルダを取得するサービス。COLLECTION_GET_COLLECTIONと比較してください。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
例
階層コレクションのリストを取得するには、必須パラメータは次のとおりです。
hasCollectionID=1
dCollectionID=collectionnumber
COLLECTION_GET_CONTENT_FILE
(リビジョンを除き)渡されたアイテムのメタデータに一致する、指定されたコントリビューション・フォルダ・コレクションの最初のコンテンツ・アイテムをダウンロードするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ファイル・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_CONTENTS
指定されたコントリビューション・フォルダに直接格納されているコンテンツ・アイテムの情報を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: コントリビューション・フォルダのコントリビューション・フォルダID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: コントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。
結果
-
ResultSets:
-
CONTENTS(コントリビューション・フォルダに格納されている各コンテンツ・アイテムのコンテンツ・メタデータを持つ行を含む)
-
例
IdcService=COLLECTION_GET_CONTENTS hasCollectionID=true dCollectionID=999999999999000633
COLLECTION_GET_FILE
指定されたアイテムのタイプを判断し、そのコンテンツをダウンロードするサービス。このアイテムはコンテンツ・アイテムの場合もあれば、そうでない場合もあります。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ファイル・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_INFO
ローカル・コントリビューション・フォルダのコントリビューション・フォルダ情報を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用するかどうかを指定します。
dCollectionID: コントリビューション・フォルダのコントリビューション・フォルダID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: コントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。
結果
-
ResultSets:
-
PATH (コントリビューション・フォルダのパスの各コントリビューション・フォルダのコントリビューション・フォルダ・メタデータを持つ行を含む)
-
例
IdcService=COLLECTION_GET_INFO hasCollectionID=true dCollectionID=999999999999000633
COLLECTION_GET_LINKS
コンテンツ・アイテムまたはコントリビューション・フォルダへの、指定されたショートカット(dLinkID)に関する情報を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、アイテムまたはコントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
dLinkID: コンテンツ・アイテムまたはコントリビューション・フォルダへのショートカットのリンクID。
オプションのサービス・パラメータ
-
resultSetName: 返されたResultSetの名前を設定します。デフォルト値はLINKSです。
結果
-
ResultSets:
-
$resultSetName$ (コンテンツ・アイテムまたはコントリビューション・フォルダのショートカット情報を含むResultSet)
-
COLLECTION_GET_META_MAPPING
指定されたコントリビューション・フォルダの、WebDAV等価のプロパティを取得するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_PROFILE_METADATA_DEFAULTS
特定のユーザーのデフォルト情報のフィールド構成を取得するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS
特定のユーザーのリビジョン情報のフィールド構成の値を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_REFERENCE
コントリビューション・フォルダ階層内のアイテムが存在するかどうか、およびそのアイテムが存在する場合は、それがコントリビューション・フォルダ、コンテンツ・アイテムまたはショートカットであるかどうかを判断するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
パスを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionPath: (Boolean)親コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: 親コントリビューション・フォルダのパス。
-
level0: 親コントリビューション・フォルダのプライマリ・レベル。
level1: 親コントリビューション・フォルダのセカンダリ・レベル。
level2: コントリビューション・フォルダ内のコンテンツ・アイテム。
オプションのサービス・パラメータ
-
RevisionHistory: (Boolean)コンテンツ・アイテムが選択されている場合に、REVISION_HISTORY結果セットを含むかどうかを指定します。デフォルト値はfalseです。
結果
-
isCollection: (Boolean)参照されるパスがコントリビューション・フォルダを表している場合はtrueです。
-
isContent: (Boolean)参照されるパスがコンテンツ・アイテムを表している場合はtrueです。isCollectionとisContentの両方がfalseの場合、アイテムは指定されたパスに存在しません。
-
isLink: (Boolean)参照されるパスがショートカットを表している場合はtrueです。指定されない場合は、falseとみなされます。
-
ResultSets:
-
REVISION_HISTORY (RevisionHistoryおよびisContentパラメータがtrueの場合にのみ含まれます)
-
バインダのローカル・データの参照アイテムの部分アイテム情報が返されます(ドキュメント情報またはコントリビューション・フォルダ情報)。
COLLECTION_GET_SEARCH_FORM
コントリビューション・フォルダ固有の検索フォームを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
検索タイプ: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_SYSTEM_FILE
通常、リクエスト時に動的に構築され、システム上に対応するものがないファイルを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ファイル・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_GET_USER_CONFIG
コントリビューション・フォルダ構造の表示および動作に対するユーザー固有の構成を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所; IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_INFO
この特定のコントリビューション・フォルダに関連したメタデータを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用するかどうかを指定します。
dCollectionID: ショートカットによって参照されるコントリビューション・フォルダのコントリビューション・フォルダID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: コントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用するかどうかを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。
結果
-
canReadCollection: (Boolean)コントリビューション・フォルダのリクエスト・ユーザーが読取り権限を持っている場合はtrueです。
-
canWriteCollection: (Boolean)コントリビューション・フォルダのリクエスト・ユーザーが書込み権限を持っている場合はtrueです。
-
canAdminCollection: (Boolean)コントリビューション・フォルダのリクエスト・ユーザーが管理者権限を持っている場合はtrueです。
-
ResultSets:
-
PATH (コントリビューション・フォルダのパスのすべてのコントリビューション・フォルダのコントリビューション・フォルダ情報を持つ行を含む)
-
DocFormats
-
ClbraProjectsAccessLists
-
DocTypes
-
metadata
-
COLLECTION_ISVALID_META
コントリビューション・フォルダを指定されたメタデータのアイテムによって追加できることを確認するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_LOCK
名前(dDocName)別にコントリビューション・フォルダをチェックアウトし、コントリビューション・フォルダをロックするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_MOVE_ALL
指定されたコントリビューション・フォルダのすべてのコンテンツを別のコントリビューション・フォルダに移動するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
移動するアイテムの現在のソース・コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
fromhasCollectionID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionIDパラメータを使用するかどうかを指定します。
fromdCollectionID: ソース・コントリビューション・フォルダID。
-
fromhasCollectionPath: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: ソース・コントリビューション・フォルダへのパス。
-
fromhasCollectionGUID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionGUIDパラメータを使用するかどうかを指定します。
fromdCollectionGUID: ソース・コントリビューション・フォルダGUID。
宛先コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダのID。
-
tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。
-
tohasCollectionGUID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダのGUID。
-
tolevel0: 宛先親コントリビューション・フォルダのパスのベースの値を指定します(たとえば、
/Contribution Folders
)。tolevel1: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/t4
)。tolevel2: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/1
)。
例
IdcService=COLLECTION_MOVE_ALL fromhasCollectionPath=true fromdCollectionPath=/Contribution Folders/B/1 tohasCollectionPath=true todCollectionPath=/Contribution Folders/t4/1
COLLECTION_MOVE_COLLECTION
フォルダを別のコントリビューション・フォルダに移動するサービス。COLLECTION_MOVE_ALLと比較してください。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
移動するコントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
fromhasCollectionID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionIDパラメータを使用することを指定します。
fromdCollectionID: ソース・コントリビューション・フォルダID。
-
fromhasCollectionPath: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: ソース・コントリビューション・フォルダへのパス。
-
fromhasCollectionGUID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionGUIDパラメータを使用するかどうかを指定します。
fromdCollectionGUID: ソース・コントリビューション・フォルダGUID。
宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダのID。
-
tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。
-
tohasCollectionGUID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダのGUID。
-
tolevel0: 宛先親コントリビューション・フォルダのパスのベースの値を指定します(たとえば、
/Contribution Folders
)。tolevel1: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/t4
)。tolevel2: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/1
)。
例
IdcService=COLLECTION_MOVE_COLLECTION fromhasCollectionID=true fromdCollectionID=257 tohasCollectionID=true todCollectionID=218
COLLECTION_MOVE_ITEM
指定されたコントリビューション・フォルダから宛先コントリビューション・フォルダに、単一のコンテンツ・アイテム(またはリンク)を移動するサービス。同じファイル名のアイテムがターゲット・コントリビューション・フォルダに存在する場合、移動は失敗します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
宛先コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先コントリビューション・フォルダのID。
-
tohasCollectionPath: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先コントリビューション・フォルダへのパス。
-
tohasCollectionGUID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionGUIIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先コントリビューション・フォルダのGUID。
-
tolevel0: 宛先コントリビューション・フォルダのパスの最初の値を指定します(たとえば、
/Contribution Folders
)。tolevel1: 宛先コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/t4
)。tolevel2: 宛先コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、
/1
)。
-
-
移動するコンテンツ・アイテムを識別するには、次のパラメータ・セットのいずれかが必要です。
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
fromhasCollectionPath: (Boolean)コンテンツ・アイテムのコントリビューション・フォルダを識別するためにfromhasCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: コンテンツ・アイテムのコントリビューション・フォルダへのパス。
-
isLink: (Boolean)コンテンツ・アイテムへのショートカットを識別するためにdLinkIDパラメータを使用するかどうかを指定します。
dLinkID: コンテンツ・アイテムへのショートカットのリンクID。
-
オプションのサービス・パラメータ
-
toContentName: 移動されたアイテムの新しいファイル名。
-
destMustExist: 移動するアイテムまたはリンクの宛先が存在している必要があるかどうかを定義します(true/false)。このパラメータがfalseであるか存在せず、かつ宛先コントリビューション・フォルダが指定されていない場合、アイテムはその現在のコントリビューション・フォルダから削除されます(xCollectionIDが0に設定されます)。
例
IdcService=COLLECTION_MOVE_ITEM tohasCollectionID=true todCollectionID=218 dDocName=TG000570 toContentName=moved_name.txt
COLLECTION_MOVE_LOT
コントリビューション・フォルダ、コンテンツ・アイテム、コントリビューション・フォルダおよびコンテンツ・アイテムへのショートカットを含むアイテムのセットを単一の宛先コントリビューション・フォルダに移動するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
リダイレクト場所: 移動するアイテムの宛先フォルダのCOLLECTION_DISPLAY。
追加の必須サービス・パラメータ
移動済アイテムの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: コントリビューション・フォルダ・コレクションID。
-
tohasCollectionPath: (Boolean)宛先コントリビューション・フォルダへのパスを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先コントリビューション・フォルダへのパス。
-
tohasCollectionGUID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先コントリビューション・フォルダのGUID。
コンテンツ・アイテムを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。
-
contentselect{n}: (Boolean)コンテンツ・アイテムを移動するかどうかを指定します。アイテムを移動するには、値は(true)である必要があります。
-
fromContentisLink{n}: (Boolean)アイテムがコンテンツ・アイテムで、ショートカットではない場合、値は0である必要があります。
-
fromdDocName{n}: 移動するアイテムのコンテンツID。
コンテンツ・アイテムへのショートカットを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。
-
contentselect{n}: (Boolean)ショートカットを移動するかどうかを指定します。ショートカットを移動するには、値はtrueである必要があります。
-
fromContentisLink{n}: (Boolean)これがショートカットであり、コンテンツ・アイテムでないかどうかを指定します。アイテムがショートカットである場合、値は1である必要があります。
-
fromContentdLinkID{n}: 移動するショートカットのリンクID。
-
fromdDocName{n}: ショートカットによってポイントされるコンテンツ・アイテムのコンテンツID。
コントリビューション・フォルダを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。
-
collectionselect{n}: (Boolean)コントリビューション・フォルダを移動するかどうかを指定します。ショートカットを移動するには、値はtrueである必要があります。
-
fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであり、ショートカットではないかどうかを指定します。これがコントリビューション・フォルダである場合、値が0である必要があります。
-
fromdCollectionID{n}: 移動するコントリビューション・フォルダのdCollectionID。
-
fromhasCollectionID{n}: コントリビューション・フォルダを移動するには、値が1である必要があります。
コントリビューション・フォルダへのショートカットを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。
-
collectionselect{n}: (Boolean)ショートカットを移動するかどうかを指定します。ショートカットを移動するには、値はtrueである必要があります。
-
fromCollectionisLink{n}: (Boolean)これがショートカットであり、コントリビューション・フォルダではないかどうかを指定します。これがショートカットである場合、値が1である必要があります。
-
fromdCollectiondLinkID{n}: = 移動するショートカットのリンクID。
-
fromdCollectionID{n}: ショートカットによってポイントされるコントリビューション・フォルダのdCollectionID。
-
fromhasCollectionID{n}: コントリビューション・フォルダ・ショートカットを移動するには、値が1である必要があります。
例
IdcService=COLLECTION_MOVE_LOT tohasCollectionID=true docCollectionID=999999999999000633 contentselect1=true fromContentisLink1=0 fromdDocName1=PHL11GX010033
todCollectionID=194
todCollectionPath=""
COLLECTION_NEW
新しいコントリビューション・フォルダを作成するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
hasParentCollectionID: (Boolean)コントリビューション・フォルダが親コントリビューション・フォルダとして追加されるかどうかを指定します。trueに設定される場合、dParentCollectionIDが定義される必要があります。
-
dParentCollectionID: (Boolean)親コントリビューション・フォルダのコントリビューション・フォルダIDであるかどうかを指定します。hasParentCollectionIDがtrueに設定されている場合に使用されます。
-
dCollectionInherit: (Boolean)コントリビューション・フォルダ・メタデータを継承するかどうかを指定します。
例
IdcService=COLLECTION_NEW hasParentCollectionID=true dParentCollectionID=1 dCollectionInherit=0
COLLECTION_PROFILE_GET_COLUMNS
ユーザー階層列情報およびメタデータ・フィールド情報を返すサービス。パラメータはありません。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
返されるデータ
-
ResultSets:
-
COLUMNS(ユーザー固有の列セット。)リクエスト・ユーザーが列を選択していない場合は、返されるデフォルト列は次のとおりです。
-
dFileSize
-
dDocType
-
dDocAuthor
-
dSecurityGroup
-
-
metadata(システムおよびカスタム・メタデータ・フィールドに関する情報)
-
COLLECTION_PROFILE_UPDATE_COLUMNS
ユーザー階層列を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_RESTORE_COLLECTION
現在「ごみ箱」フォルダにあるコントリビューション・フォルダをその元の場所にリストアするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_RESTORE_ITEM
現在「ごみ箱」フォルダにあるアイテムをその元の場所にリストアするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_SEARCH_CONTENT
コンテンツ・アイテムに対して渡されるメタデータのすべてに一致するすべてのコンテンツを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_SEARCH_RESULTS
検索基準を満たすコントリビューション・フォルダの検索結果を表示するサービス。検索オペランドに使用されるフィールドは、COLMETAおよびCOLLECTIONS表のフィールドです。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加のオプション・サービス・パラメータ
-
ResultCount: SearchResuls結果セットに返されるアイテム数を制限します。デフォルトは25です。
-
SortField: ソート・キーとして使用されるフィールド。デフォルトはdCollectionNameです。
-
SortOrder: ソート方向。デフォルトはASC(昇順)です。
-
fieldname: 文字列検索条件の一部として使用されるフィールドの名前。例:
dSecurityGroup=true
-
opfieldname: 文字列検索条件で使用される、名前フィールドに対して相対的な演算子。例:
opdSecurityGroup=hasAsSubstring
-
comparefieldname: 文字列検索条件で使用される、名前フィールドに対して相対的な値。例:
comparedSecurityGroup=public
-
fieldnameLEまたはfieldnameGE: 日付検索条件で使用されるフィールドおよび値。例:
dCreateDatedateLE=2008-03-01 00:01:00
結果
-
ResultSets:
-
SearchResults(検索条件に一致するメタデータを持つコントリビューション・フォルダのリスト)
-
例
-
startsWith search:
dCollectionName=true&opdCollectionName=beginsWith&comparedCollectionName=a
-
endsWith search:
dCollectionName=true&opdCollectionName=endsWith&comparedCollectionName=12
-
exact string match search:
dCollectionName=true&opdCollectionName=equals&comparedCollectionName=A-EZ-9
-
field not empty search:
dDocTitle=true&opdDocTitle=hasAsSubstring&comparedDocTitle=%
-
boolean field search:
xBooleanTestField=true&opxBooleanTestField=equals&comparexBooleanTestField=1
-
later than search:
dCreateDatedateGE=2009-10-01 00:01:00
-
earlier than search
dCreateDatedateLE=2008-03-01 00:01:00
COLLECTION_SET_ARCHIVE
アップロードされたアーカイブを取得し、それをシステムに適用するサービス。このサービスはアーカイブと競合しているコントリビューション・フォルダを削除します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/olders_service.htm
COLLECTION_SET_USER_CONFIG
フォルダ構造の表示および動作のユーザー構成を設定するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UNLOCK
コンテンツ・アイテムのチェックアウトを元に戻し、それを使用可能にするサービス。このサービスはCOLLECTION_LOCK後にコンテンツを解放します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE
コントリビューション・フォルダのフィールド・データを変更するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
リダイレクト場所: 変更するフォルダのCOLLECTION_DISPLAY。
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用するかどうかを指定します。
dCollectionID: コントリビューション・フォルダID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: コントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用するかどうかを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。
-
hasParentCollectionID: フォルダを親フォルダとして追加するかどうかを定義します(true/false)。trueに設定される場合、dParentCollectionIDが定義される必要があります。
-
dParentCollectionID: 親フォルダのフォルダID。hasParentCollectionIDがtrueに設定されている場合に使用されます。
オプションのサービス・パラメータ
-
dCollectionName: コントリビューション・フォルダのコレクションID。
-
dCollectionMark:
-
dCollectionEnabled:
-
dPromptForMetadata:
-
dCreateDate: コンテンツ・アイテムが作成された日付。
-
dInDate: コンテンツのリリース日。
-
dOutDate: コンテンツの有効期限。
-
dReleaseDate: リリース状態(リビジョンのWeb状態を示すために使用されます)。
-
dLastModifiedDate: コンテンツ・アイテムに対して最後に変更が行われた日付。
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dDocType: コンテンツ・アイテムのタイプ。
-
dDocTitle: コンテンツ・アイテムのタイトル。
-
dDocAuthor: コンテンツ・アイテムの作成者
-
dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。
-
dSecurityGroup: PublicやSecureなどのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
-
dCollectionOwner: コントリビューション・フォルダ所有者。
-
dCollectionCreator: コントリビューション・フォルダ作成者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。
-
dCollectionModifier: 最後のコントリビューション・フォルダ変更者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。
-
x?????: DocMetaのカスタム・メタデータ・フィールドに正確に一致する必要がある、ColMeta表で定義されるフィールドのすべて。
例
IdcService=COLLECTION_UPDATE dCollectionName=Products dParentCollectionID=1 dCollectionOwner=bsmith
COLLECTION_UPDATE_ADMIN_CONFIG
コントリビューション・フォルダのシステム構成設定を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG
(メタデータが伝搬される)既存のコントリビューション・フォルダからメタデータを継承することにより、コントリビューション・フォルダ・システム構成設定を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS
コントリビューション・フォルダのシステム・メタデータ・フィールドのデフォルト・システム設定を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_ALL
コレクションのすべてのアイテムを更新し、定義されたメタデータを変更するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_ITEM
コレクションの特定のアイテムを更新し、定義されたメタデータを変更するサービス。コントリビューション・フォルダ関連サービス(表Folders_Services)。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_META
コントリビューション・フォルダから、すべての基礎となるコントリビューション・フォルダおよびコンテンツにメタデータ値を伝搬するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。
サービス・クラス: メタサービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: 親コントリビューション・フォルダのコントリビューション・フォルダID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: 親コントリビューション・フォルダのパス。
-
hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: 親コントリビューション・フォルダのGUID。
例
IdcService=COLLECTION_UPDATE_META hasCollectionGUID=true dCollectionGUID=5A2E5617-7F95-7356-D923-F6DA894D489C
COLLECTION_UPDATE_META_TABLE
コントリビューション・フォルダのメタデータ表を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: メタサービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS
プロファイル・メタデータ・フィールドのデフォルトを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS
リビジョンのプロファイル・メタデータ・フィールドのデフォルトを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources//folders_service.htm
COLLECTION_UPDATE_STRUCTURE
コントリビューション・フォルダ・キャッシュを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: メタサービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
COLLECTION_VERIFY_FOLDER_NAME
指定されたコントリビューション・フォルダ名がコントリビューション・フォルダの有効な名前であることを検証するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。
-
dCollectionName: コントリビューション・フォルダのコレクションID。
-
hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: 親コントリビューション・フォルダのパス。
オプションのサービス・パラメータ
-
CollectionSkipIllegalFolderValidation: csCollectionFolderHasNoNameを除いて、すべての検証をスキップすることができます。デフォルトは、falseです。
構成パラメータ
-
CollectionIllegalFolderCharacters: フォルダ名に使用する無効な文字を含む文字列。デフォルトは
/\:*?"<>¦
です -
dCollectionNameSize: コントリビューション・フォルダ名の最大文字数。デフォルトは
100
です。 -
CollectionIllegalFolderPattern_1: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
\\..*
です -
CollectionIllegalFolderPattern_2: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
.*\\.
です。 -
CollectionIllegalFolderPattern_3: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
com[\\d]
です。 -
CollectionIllegalFolderPattern_4: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
pt[\\d]
です。 -
CollectionIllegalFolderPattern_5: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
con
です。 -
CollectionIllegalFolderPattern_6: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
nul
です。 -
CollectionIllegalFolderPattern_7: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは
prn
です。
追加のCollectionIllegalFolderPattern_{n}変数を追加できます。順序どおりであるかぎり、サービス別に評価されます。
結果
-
ResultSets:
-
SUCCESS
-
FAILED (csCollectionFolderHasNoName)
-
FAILED (csCollectionInvalidCharacter:pos=最初の無効な文字の位置)
-
FAILED (csCollectionNameTooLong:フォルダ名,余分な文字数)
-
FAILED (csCollectionIllegalPatternMatch:フォルダ名,無効なフォルダ・パターン)
-
例
IdcService=COLLECTION_VERIFY_FOLDER_NAME hasCollectionPath=true dCollectionPath=/Contribution Folders/dept/hr CollectionSkipIllegalFolderValidation=true dCollectionNameSize=90
FOLDERSLOCAL_BUILD_MOUNT
指定されたローカル・コントリビューション・フォルダのファイルをリライトするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_mounted_service.htm
FOLDERSLOCAL_CREATE_MOUNT
コントリビューション・フォルダをローカル・ファイル・システムにマップするサービス。コントリビューション・フォルダが変更される場合には常に、マップされたディレクトリが更新されます。
このディレクトリにセキュリティはありません。
最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: SearchService
場所: IdcHomeDir
/components/Folders/resources/folders_mounted_service.htm
FOLDERSLOCAL_DELETE_MOUNT
指定されたローカル・コントリビューション・フォルダを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_mounted_service.htm
FOLDERSLOCAL_UPDATE_MOUNT
指定されたローカル・コントリビューション・フォルダのファイルを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: 検索サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_mounted_service.htm
GET_FOLDER_HISTORY_REPORT
コントリビューション・フォルダの履歴データを取得するサービス。リクエスト・ユーザーには管理ロールが必要です。
サービス・クラス: DocService
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
追加の必須サービス・パラメータ
-
actionDateGreaterThan: ODBC形式のデータ。この時間の2分前およびそれ以降のすべての履歴データが返されます。2分は負荷分散サーバー用のマージンです。デフォルト値は、現在の時間の5分前です。
結果
-
ResultSets
-
HistoryReport: 各行には、コントリビューション・フォルダ履歴イベントに関する情報(名前の変更、更新、移動、削除)が含まれます。
-
例
IdcService=GET_FOLDER_HISTORY_REPORT actionDateGreaterThan={ts '2010-09-09 18:04:06.293'}
GET_OPTION_LISTS
オプション・リストを取得するコントリビューション・フォルダ関連のサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: サービス(一般サービス)
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm
GOTO_COLLECTION
コントリビューション・フォルダを表示するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。
サービス・クラス: ドキュメント・サービス
場所: IdcHomeDir
/components/folders_g/resources/folders_service.htm