この章の構成は、次のとおりです。
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パラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。
レコード機能では次のサービスが使用されます。
このサービスは、「アクティブ化」処理アクション日の設定に使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理対象の処理アクションの一意の識別子。
このサービスは、「削除の承認」処理アクション日の設定に使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理対象の処理アクションの一意の識別子。
このサービスは、保存スケジュール内の保存カテゴリのコンテンツの参照に使用されるページを取得するために使用されます。
追加の必須サービス・パラメータ
dCategoryID: 取得する保存カテゴリの一意の識別子。
このサービスは、保存スケジュール内のレコード・フォルダのコンテンツの参照に使用されるページを取得するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 取得するレコード・フォルダの一意の識別子。
このサービスは、保存スケジュール内のシリーズのコンテンツの参照に使用されるページを取得するために使用されます。
追加の必須サービス・パラメータ
dSeriesID: 取得するシリーズの一意の識別子。
このサービスは、コンテンツ・アイテムの最新のリビジョンを新規リビジョンとしてチェックインするために使用されます。通常、これはワークフローをトリガーするために使用されます。
このサービスは、「類似をチェックイン」ページを取得するために使用されます。これは、前のコンテンツ・アイテムのチェックインに基づいてメタデータ・フィールドにすでにデータが入力されているチェックイン・ページです。
追加の必須サービス・パラメータ
dID: すでにチェックインされているアイテムの一意のコンテンツID。
このサービスは、取り消されたレコード・フォルダの日付を消去するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、取り消されたレコード・フォルダの有効期限を消去するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、レコード・フォルダが廃止される日付を消去するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、レコード・フォルダが廃棄される日付を消去するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、レコード・フォルダが最後にレビューされた日付を消去するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、コンテンツ・アイテムが取り消された日付を消去するために使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のコンテンツの一意の識別子。
このサービスは、アイテムが期限切れになった日付を消去するために使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のアイテムの一意の識別子。
このサービスは、アイテムが廃止される日付を消去するために使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のアイテムの一意の識別子。
このサービスは、保存スケジュール内の既存のレコード・フォルダを閉じるするために使用されます。閉じたレコード・フォルダまたはそのサブフォルダへのコンテンツ・アイテムの追加チェックインは、ユーザーがフォルダの「開く/閉じる」権限を保有しているか、閉じたフォルダの作成者である場合にのみ可能です。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、保存スケジュール内に新規レコード・フォルダを作成するために使用されます。このサービスは、通常、CREATE_FOLDER_FORMページからコールされます。
追加の必須サービス・パラメータ
dFolderID: 新規レコード・フォルダの一意の識別子。
dFolderName: 新規レコード・フォルダの名前。
dSecurityGroup: 新規レコード・フォルダに関連付けるセキュリティ・グループ。
dDocAuthor: 新規レコード・フォルダの作成者。
dCategoryID: レコード・フォルダに関連付ける保存カテゴリの一意の識別子。
このサービスは、最後のN個以外の全リビジョンの削除処理アクションを処理するために使用されます。変数nは、管理者が設定します。
追加の必須サービス・パラメータ
dDispositionID: 処理対象の処理アクションの一意の識別子。
このサービスは、保存スケジュールから既存のレコード・フォルダを削除するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、コンテンツ・アイテムの最新バージョンを削除するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理対象の処理アクションの一意の識別子。
このサービスは、保存スケジュール内の既存のレコード・フォルダの(変更された)プロパティを更新するために、EDIT_FOLDER_FORMによってコールされます。
追加の必須サービス・パラメータ
dFolderID: 編集するレコード・フォルダの一意の識別子。
dFolderName: 編集するレコード・フォルダの名前。
dSecurityGroup: レコード・フォルダに関連付けられているセキュリティ・グループ。
dDocAuthor: レコード・フォルダの所有者。
このサービスは、保存スケジュール内のフォルダを編集するEDIT_FOLDERをコールするために使用されます。
追加の必須サービス・パラメータ
dFolderID: 編集するレコード・フォルダの一意の識別子。
このサービスは、保存スケジュール内の既存のレコード・フォルダを凍結するために使用されます。フォルダを凍結すると、UNFREEZE_FOLDERサービスがコールされるまで、そのフォルダに関連付けられている処理ルールの処理が一時的に停止されます。
追加の必須サービス・パラメータ
dFolderID: 凍結するレコード・フォルダの一意の識別子。
dCategoryID: レコード・フォルダに関連付けられている保存カテゴリの一意の識別子。
auditComments: 凍結名。
auditComments2: 凍結理由。
このサービスは、既存のコンテンツ・アイテムを凍結するために使用されます。コンテンツ・アイテムを凍結すると、UNFREEZE_RECORDサービスがコールされるまで、そのコンテンツ・アイテムに関連付けられている処理ルールの処理が一時的に停止されます。
追加の必須サービス・パラメータ
dID: 凍結するコンテンツ・アイテムのコンテンツID。
auditComments: 凍結名。
auditComments2: 凍結理由。
このサービスは、保存カテゴリの情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
dCategoryID: 取得する保存カテゴリの一意の識別子。
このサービスは、保存スケジュール内のレコード・フォルダのメタデータ情報ページおよび関連コンテンツを取得するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 取得するレコード・フォルダの一意の識別子。
このサービスは、レコード・フォルダのライフサイクル情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
dFolderID: レコード・フォルダの一意の識別子。
このサービスは、レコード・フォルダのメタデータ履歴を取得するために使用されます。
追加の必須サービス・パラメータ
dFolderID: レコード・フォルダの一意の識別子。
このサービスは、レコード・フォルダのレビュー履歴を取得するために使用されます。
追加の必須サービス・パラメータ
dFolderID: レコード・フォルダの一意の識別子。
このサービスは、コンテンツ・アイテムのライフサイクル情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
dID: アイテムのコンテンツID。
dCategoryID: アイテムに関連付けられている保存カテゴリの一意の識別子。
このサービスは、コンテンツ・アイテムのメタデータ履歴を取得するために使用されます。
追加の必須サービス・パラメータ
dID: コンテンツ・アイテムのコンテンツID。
このサービスは、コンテンツ・アイテムのレビュー履歴を取得するために使用されます。
追加の必須サービス・パラメータ
dID: コンテンツ・アイテムのコンテンツID。
このサービスは、保存スケジュール内のシリーズの情報ページを取得するために使用されます。
追加の必須サービス・パラメータ
dSeriesID: シリーズの一意の識別子。
このサービスは、レコード・フォルダをアクティブ化する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: アクティブ化に使用する日付。
このサービスは、レコード・フォルダを取り消す日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: 取消に使用する日付。
このサービスは、レコード・フォルダの有効期限とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: 期限切れに使用する日付。
このサービスは、レコード・フォルダを廃止する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: 廃止日として使用する日付。
このサービスは、レコード・フォルダを廃棄する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: 廃棄日として使用する日付。
このサービスは、レコード・フォルダのレビューを行う日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: レビュー日として使用する日付。
このサービスは、レコード・フォルダおよびそのすべての子のフォルダのレビューを行う日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
currentDate: レビュー日として使用する日付。
このサービスは、コンテンツを取り消す日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のコンテンツ・アイテムのコンテンツID。
currentDate: 取消日として使用する日付。
このサービスは、アイテムが期限切れになる日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のアイテムのコンテンツID。
currentDate: 有効期限として使用する日付。
このサービスは、アイテムを廃止するために使用する現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のアイテムのコンテンツID。
currentDate: 廃止日として使用する日付。
このサービスは、アイテムを廃棄する日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のアイテムのコンテンツID。
currentDate: 廃棄日として使用する日付。
このサービスは、コンテンツ・アイテムのレビューを行う日付とする現在の日付の設定に使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のコンテンツ・アイテムのコンテンツID。
currentDate: レビュー日として使用する日付。
このサービスは、保存スケジュール内のレコード・フォルダを別の場所に移動するために使用されます。
追加の必須サービス・パラメータ
dFolderID: 処理対象のフォルダのフォルダID。
dCategoryID: フォルダのカテゴリ。
このサービスは、コンテンツ・アイテムのライフサイクル・プレビューを取得するために使用されます。
追加の必須サービス・パラメータ
dID: 処理対象のコンテンツ・アイテムのコンテンツID。
このサービスは、フォルダに対する「閉じる」処理アクションを処理するために使用されます。このサービスはCLOSE_FOLDERサービスをコールします。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、「カットオフ」処理アクションを処理するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、「破棄」処理アクションを処理するために使用されます。他の処理ルールが優先される場合を除いて、コンテンツまたはフォルダのすべてのリビジョンが破棄されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、レコード・アーカイブをContent Serverアーカイブに追加するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、zipアーカイブを作成するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、アクションの完了をマークするために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、「アクションなし」処理アクションを処理するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、「廃止」処理アクションを処理するために使用されます。このサービスはMARK_FOLDER_OBSOLETE_DATEまたはMARK_RECORD_OBSOLETE_DATEをコールします。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、レコード・フォルダまたはコンテンツ・アイテムを、リカバリできないように安全に削除するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、「差替え」処理アクションを処理するために使用されます。
追加の必須サービス・パラメータ
dDispositionID: 処理アクションの一意の識別子。
このサービスは、保存スケジュール内の既存のレコード・フォルダの閉じたステータスを取り消すために使用されます。レコード・フォルダの閉じた状態を解除すると、そのフォルダおよびそのサブフォルダにコンテンツをチェックインできるようになります。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
このサービスは、保存スケジュール内の既存のレコード・フォルダの凍結を解除するために使用されます。フォルダの凍結を解除すると、関連付けられた処理ルールの処理に対してそのフォルダが解放されます。
追加の必須サービス・パラメータ
dFolderID: 処理するレコード・フォルダの一意の識別子。
auditComments: 凍結解除名。
auditComments2: 凍結解除理由。