10 レコード・サービス
この章の内容は、次のとおりです。
レコード・サービスについて
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パラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。
LIST_DISPOSITION_RECORDS Service 33 PENDING_REVIEW_LIST null null !csUnableToGetRecordsList 3:hasRmaRights:admin.performactions:0:null 3:checkRecordsFoldersMap::0:null 3:setLocalValuesAfterEval:dRequestedUser,<$dUser$>::null 3:setLocalValues:IsNavigation,1::null
この例の説明:
-
1行目にはサービス名(
LIST_DISPOSITION_RECORDS
)を指定します。 -
2行目にはサービスの属性を指定します。
-
サービス・クラス:
service
(一般サービス) -
アクセス・レベル:
33
-
テンプレート:
PENDING_REVIEW_LIST
-
サービス・タイプ:
null
-
通知された件名:
null
-
エラー・メッセージ:
レコード・リストを取得できません
-
-
エントリのこの他の部分では、各行に1つずつサービスのアクションを指定します。
-
アクション・タイプ: たとえば、
3
はJavaメソッドを示します。 -
アクション名: たとえば、
hasRmaRights
-
アクション・パラメータ: たとえば、
dRequestUser
。パラメータを指定しない場合は、::
を指定します。 -
アクションの制御マスク: たとえば、
1
はエラーを無視することを意味します。制御マスクを指定しない場合は、::
を指定します。 -
アクションのエラー・メッセージ、またはメッセージがない場合は
null
。
-
サービス・アクションの各要素はコロン(:)で区切ります。
すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。
ノート:
すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
GET_WORKFLOW WorkflowService 40 null null null!csWfRetrieveInfoError(dWfName) 5:QworkflowDocuments:WfDocuments:0:!csWfRetrieveInfoError(dWfName) 3:getWorkflowStepAliasesInfo::0:null 3:getWorkflowDesignInfo::0:null 3:getWorkflowDocumentInfo:WfDocuments:0:null
この例の説明:
-
1行目にはサービス名(
GET_WORKFLOW
)を指定します。 -
2行目にはサービスの属性を指定します。
-
サービス・クラス:
WorkflowService
-
アクセス・レベル:
40
-
テンプレート:
null
-
サービス・タイプ:
null
-
通知された件名:
null
-
エラー・メッセージとエラー・メッセージで使用されるパラメータ:
情報取得のエラー
-
-
エントリのこの他の部分では、各行に1つずつサービスのアクションを指定します。
-
アクション・タイプ: たとえば、
5
は「キャッシュ問合せの選択」です。これは、データベースから情報を取得して後で使用するために保存する問合せを指定します。 -
アクション名: たとえば、
QworkflowDocuments
-
アクション・パラメータ: たとえば、
WfDocuments
。パラメータを指定しない場合は、2つのコロン(::)
を指定します。 -
アクションの制御マスク: たとえば、
0
はエラーを無視することを意味します。制御マスクを指定しない場合は、2つのコロン(::)
または0
を指定します。 -
アクションのエラー・メッセージ、またはメッセージがない場合は
null
。
-
サービス・アクションの各要素はコロン(:
)で区切ります。
ノート:
すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。
レコード・サービス
レコード機能では次のサービスが使用されます。
ACTIVATE_SERVICE
このサービスは、「アクティブ化」処理アクション日の設定に使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理対象の処理アクションの一意の識別子。
APPROVE_DELETE_SERVICE
このサービスは、「削除の承認」処理アクション日の設定に使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理対象の処理アクションの一意の識別子。
BROWSE_CATEGORY_FORM
このサービスは、保存スケジュール内の保存カテゴリのコンテンツの参照に使用されるページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dCategoryID: 取得する保存カテゴリの一意の識別子。
BROWSE_FOLDER_FORM
このサービスは、保存スケジュール内のレコード・フォルダのコンテンツの参照に使用されるページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 取得するレコード・フォルダの一意の識別子。
BROWSE_SERIES_FORM
このサービスは、保存スケジュール内のシリーズのコンテンツの参照に使用されるページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dSeriesID: 取得するシリーズの一意の識別子。
CHECKIN_NEW_REVISION_SERVICE
このサービスは、コンテンツ・アイテムの最新のリビジョンを新規リビジョンとしてチェックインするために使用されます。通常、これはワークフローをトリガーするために使用されます。
CHECKIN_SIMILAR_FORM
このサービスは、「類似をチェックイン」ページを取得するために使用されます。これは、前のコンテンツ・アイテムのチェックインに基づいてメタデータ・フィールドにすでにデータが入力されているチェックイン・ページです。
追加の必須サービス・パラメータ
-
dID: すでにチェックインされているアイテムの一意のコンテンツID。
CLEAR_FOLDER_CANCELLED_DATE
このサービスは、取り消されたレコード・フォルダの日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
CLEAR_FOLDER_EXPIRATION_DATE
このサービスは、取り消されたレコード・フォルダの有効期限をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
CLEAR_FOLDER_OSBOLETE_DATE
このサービスは、レコード・フォルダが廃止される日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
CLEAR_FOLDER_RESCINDED_DATE
このサービスは、レコード・フォルダが廃棄される日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
CLEAR_FOLDER_REVIEW_DATE
このサービスは、レコード・フォルダが最後にレビューされた日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
CLEAR_RECORD_CANCELLED_DATE
このサービスは、コンテンツ・アイテムが取り消された日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のコンテンツの一意の識別子。
CLEAR_RECORD_EXPIRATION_DATE
このサービスは、アイテムが期限切れになった日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のアイテムの一意の識別子。
CLEAR_RECORD_OBSOLETE_DATE
このサービスは、アイテムが廃止される日付をクリアするために使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のアイテムの一意の識別子。
CLOSE_FOLDER
このサービスは、保存スケジュール内の既存のレコード・フォルダを閉じるするために使用されます。閉じたレコード・フォルダまたはそのサブフォルダへのコンテンツ・アイテムの追加チェックインは、ユーザーがフォルダの「開く/閉じる」権限を保有しているか、閉じたフォルダの作成者である場合にのみ可能です。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
CREATE_FOLDER
このサービスは、保存スケジュール内に新規レコード・フォルダを作成するために使用されます。このサービスは、通常、CREATE_FOLDER_FORMページからコールされます。
追加の必須サービス・パラメータ
-
dFolderID: 新規レコード・フォルダの一意の識別子。
-
dFolderName: 新規レコード・フォルダの名前。
-
dSecurityGroup: 新規レコード・フォルダに関連付けるセキュリティ・グループ。
-
dDocAuthor: 新規レコード・フォルダの作成者。
-
dCategoryID: レコード・フォルダに関連付ける保存カテゴリの一意の識別子。
DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE
このサービスは、最後のN個以外の全リビジョンの削除処理アクションを処理するために使用されます。変数nは、管理者が設定します。
追加の必須サービス・パラメータ
-
dDispositionID: 処理対象の処理アクションの一意の識別子。
DELETE_FOLDER
このサービスは、保存スケジュールから既存のレコード・フォルダを削除するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
DELETE_REVISION_SERVICE
このサービスは、コンテンツ・アイテムの最新バージョンを削除するために使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理対象の処理アクションの一意の識別子。
EDIT_FOLDER
このサービスは、保存スケジュール内の既存のレコード・フォルダの(変更された)プロパティを更新するために、EDIT_FOLDER_FORMによってコールされます。
追加の必須サービス・パラメータ
-
dFolderID: 編集するレコード・フォルダの一意の識別子。
-
dFolderName: 編集するレコード・フォルダの名前。
-
dSecurityGroup: レコード・フォルダに関連付けられているセキュリティ・グループ。
-
dDocAuthor: レコード・フォルダの所有者。
EDIT_FOLDER_FORM
このサービスは、保存スケジュール内のフォルダを編集するEDIT_FOLDERをコールするために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 編集するレコード・フォルダの一意の識別子。
FREEZE_FOLDER
このサービスは、保存スケジュール内の既存のレコード・フォルダを凍結するために使用されます。フォルダを凍結すると、UNFREEZE_FOLDERサービスがコールされるまで、そのフォルダに関連付けられている処理ルールの処理が一時的に停止されます。
追加の必須サービス・パラメータ
-
dFolderID: 凍結するレコード・フォルダの一意の識別子。
-
dCategoryID: レコード・フォルダに関連付けられている保存カテゴリの一意の識別子。
-
auditComments: 凍結名。
-
auditComments2: 凍結理由。
FREEZE_RECORD
このサービスは、既存のコンテンツ・アイテムを凍結するために使用されます。コンテンツ・アイテムを凍結すると、UNFREEZE_RECORDサービスがコールされるまで、そのコンテンツ・アイテムに関連付けられている処理ルールの処理が一時的に停止されます。
追加の必須サービス・パラメータ
-
dID: 凍結するコンテンツ・アイテムのコンテンツID。
-
auditComments: 凍結名。
-
auditComments2: 凍結理由。
INFO_CATEGORY_FORM
このサービスは、保存カテゴリの情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dCategoryID: 取得する保存カテゴリの一意の識別子。
INFO_FOLDER_FORM
このサービスは、保存スケジュール内のレコード・フォルダのメタデータ情報ページおよび関連コンテンツを取得するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 取得するレコード・フォルダの一意の識別子。
INFO_FOLDER_LIFECYCLE
このサービスは、レコード・フォルダのライフサイクル情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: レコード・フォルダの一意の識別子。
INFO_FOLDER_METADATA_HISTORY
このサービスは、レコード・フォルダのメタデータ履歴を取得するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: レコード・フォルダの一意の識別子。
INFO_FOLDER_REVIEW_HISTORY
このサービスは、レコード・フォルダのレビュー履歴を取得するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: レコード・フォルダの一意の識別子。
INFO_RECORD_LIFECYCLE
このサービスは、コンテンツ・アイテムのライフサイクル情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dID: アイテムのコンテンツID。
-
dCategoryID: アイテムに関連付けられている保存カテゴリの一意の識別子。
INFO_RECORD_METADATA_HISTORY
このサービスは、コンテンツ・アイテムのメタデータ履歴を取得するために使用されます。
追加の必須サービス・パラメータ
-
dID: コンテンツ・アイテムのコンテンツID。
INFO_RECORD_REVIEW_HISTORY
このサービスは、コンテンツ・アイテムのレビュー履歴を取得するために使用されます。
追加の必須サービス・パラメータ
-
dID: コンテンツ・アイテムのコンテンツID。
INFO_SERIES_FORM
このサービスは、保存スケジュール内のシリーズの情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
-
dSeriesID: シリーズの一意の識別子。
MARK_FOLDER_ACTIVATION_DATE
このサービスは、レコード・フォルダをアクティブ化する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: アクティブ化に使用する日付。
MARK_FOLDER_CANCELLED_DATE
このサービスは、レコード・フォルダを取り消す日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: 取消に使用する日付。
MARK_FOLDER_EXPIRATION_DATE
このサービスは、レコード・フォルダの有効期限とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: 期限切れに使用する日付。
MARK_FOLDER_OBSOLETE_DATE
このサービスは、レコード・フォルダを廃止する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: 廃止日として使用する日付。
MARK_FOLDER_RESCINDED_DATE
このサービスは、レコード・フォルダを廃棄する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: 廃棄日として使用する日付。
MARK_FOLDER_REVIEW_DATE
このサービスは、レコード・フォルダのレビューを行う日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: レビュー日として使用する日付。
MARK_FOLDER_REVIEW_DATE_ RECURSIVE
このサービスは、レコード・フォルダおよびそのすべての子のフォルダのレビューを行う日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
currentDate: レビュー日として使用する日付。
MARK_RECORD_CANCELLED_DATE
このサービスは、コンテンツを取り消す日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のコンテンツ・アイテムのコンテンツID。
-
currentDate: 取消日として使用する日付。
MARK_RECORD_EXPIRATION_DATE
このサービスは、アイテムが期限切れになる日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のアイテムのコンテンツID。
-
currentDate: 有効期限として使用する日付。
MARK_RECORD_OBSOLETE_DATE
このサービスは、アイテムを廃止するために使用する現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のアイテムのコンテンツID。
-
currentDate: 廃止日として使用する日付。
MARK_RECORD_RESCINDED_DATE
このサービスは、アイテムを廃棄する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のアイテムのコンテンツID。
-
currentDate: 廃棄日として使用する日付。
MARK_RECORD_REVIEW_DATE
このサービスは、コンテンツ・アイテムのレビューを行う日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のコンテンツ・アイテムのコンテンツID。
-
currentDate: レビュー日として使用する日付。
MOVE_FOLDER
このサービスは、保存スケジュール内のレコード・フォルダを別の場所に移動するために使用されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理対象のフォルダのフォルダID。
-
dCategoryID: フォルダのカテゴリ。
PREVIEW_RECORD_LIFECYCLE
このサービスは、コンテンツ・アイテムのライフサイクル・プレビューを取得するために使用されます。
追加の必須サービス・パラメータ
-
dID: 処理対象のコンテンツ・アイテムのコンテンツID。
RMA_CLOSE_SERVICE
このサービスは、フォルダに対する「閉じる」処理アクションを処理するために使用されます。このサービスはCLOSE_FOLDERサービスをコールします。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_CUTOFF_SERVICE
このサービスは、「カットオフ」処理アクションを処理するために使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_DESTROY_SERVICE
このサービスは、「破棄」処理アクションを処理するために使用されます。他の処理ルールが優先される場合を除いて、コンテンツまたはフォルダのすべてのリビジョンが破棄されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_EXPORT_ARCHIVE_SERVICE
このサービスは、レコード・アーカイブをContent Serverアーカイブに追加するために使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_NO_ACTION_SERVICE
このサービスは、「アクションなし」処理アクションを処理するために使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_OBSOLETE_SERVICE
このサービスは、「廃止」処理アクションを処理するために使用されます。このサービスはMARK_FOLDER_OBSOLETE_DATEまたはMARK_RECORD_OBSOLETE_DATEをコールします。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_SCRUB_SERVICE
このサービスは、レコード・フォルダまたはコンテンツ・アイテムを、リカバリできないように安全に削除するために使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
RMA_SUPERSEDE_SERVICE
このサービスは、「差替え」処理アクションを処理するために使用されます。
追加の必須サービス・パラメータ
-
dDispositionID: 処理アクションの一意の識別子。
UNCLOSE_FOLDER
このサービスは、保存スケジュール内の既存のレコード・フォルダの閉じたステータスを取り消すために使用されます。レコード・フォルダの閉じた状態を解除すると、そのフォルダおよびそのサブフォルダにコンテンツをチェックインできるようになります。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
UNFREEZE_FOLDER
このサービスは、保存スケジュール内の既存のレコード・フォルダの凍結を解除するために使用されます。フォルダの凍結を解除すると、関連付けられた処理ルールの処理に対してそのフォルダが解放されます。
追加の必須サービス・パラメータ
-
dFolderID: 処理するレコード・フォルダの一意の識別子。
-
auditComments: 凍結解除名。
-
auditComments2: 凍結解除理由。