4 コアContent Serverサービス
この章では、Oracle WebCenter Content Serverに使用可能なコア・サービスについて説明します。サービスはサービス・クラスに従って分けられています。
この章の内容は、次のとおりです。
コアContent Serverサービスについて
Oracle WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります
特定のコアContent Serverサービスの場所は、各サービス内にリスト表示されています。
ノート:
最も一般的に使用されるサービスには、より広範囲な説明があります。
注意:
すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
REMOVE_METAFILE_SUB DocService 0 null SubService null !csDocumentNotDeleted(dDocName) 3:deleteRevFiles::0:!csUpdateFileDeleteFailed(dDocName) 2:Ddocument::0:null
この例の説明:
-
1行目にはサービス名(
REMOVE_METAFILE_SUB
)を指定します。 -
2行目にはサービスの属性を指定します。
-
サービス・クラス:
DocService
-
アクセス・レベル:
0
-
テンプレート:
null
(使用されない) -
サービス・タイプ:
SubService
-
通知された件名:
null
-
エラー・メッセージ:
ドキュメントが削除されません
-
-
エントリのこの他の部分では、各行に1つずつサービスのアクションを指定します。
-
アクション・タイプ: たとえば、
3
はJavaメソッドを示します。 -
アクション名: たとえば、
deleteRevFiles
-
アクション・パラメータ: パラメータを指定しない場合は、2つのコロン(
::)
を指定します。 -
アクションの制御マスク: たとえば、
0
は制御マスクなしを意味します。コロン2つのインジケータ(::
)も指定できます。 -
アクションのエラー・メッセージ、またはメッセージがない場合は
null
。
-
サービス・アクションの各要素はコロン(:
)で区切ります。
注意:
すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。
サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。
コラボレーション・サービス(コアContent Server)
次のコラボレーション・サービスはコアContent Serverソフトウェアとともに出荷されます。
-
ノート:
dClbraTypeは多数のサービスに対する必須パラメータです。このとき、basicはこのパラメータに対して唯一許容される値です。
ADD_COLLABORATION
ADD_COLLABORATION_FORM.からコールされるサービス。このサービスは、コラボレーション・プロジェクトを追加するためにADD_COLLABORATION_SUBをコールします。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
-
dClbraType: コラボレーション・プロジェクトのタイプ。
ADD_COLLABORATION_FORM
コラボレーションを追加するため、ユーザーにフォームを提供するために使用されるサービス。このフォームを送信した後で、ADD_COLLABORATIONサービスがコールされます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_COLLABORATION
コラボレーション・プロジェクトを削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
EDIT_CLBRA_ACCESS_LIST
コラボレーション・プロジェクトのメンバーを編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
-
dClbraType: コラボレーション・プロジェクトのタイプ。
EDIT_CLBRA_ACCESS_LIST_FORM
コラボレーション・プロジェクトのメンバーを編集するために使用されるフォームを提供するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
EDIT_COLLABORATION
既存のプロジェクト情報を更新するためにEDIT_COLLABORATION_SUBをコールするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
-
dClbraType: コラボレーション・プロジェクトのタイプ。
EDIT_COLLABORATION_FORM
コラボレーション・プロジェクトを編集するために使用されるフォームを提供するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
GET_CLBRA_DOCUMENTS
コラボレーション・プロジェクト内のコンテンツを取得するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
GET_CLBRA_INFO
特定のコラボレーション・プロジェクトに関する情報を取得するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dClbraName: プロジェクト名。
GET_COLLABORATION_LIST
すべてのコラボレーション・プロジェクトのリストを返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ドキュメント・サービス(コアContent Server)
ドキュメント・サービスは、チェックイン、チェックアウト、サブスクリプション・アクション、ドキュメント情報へのアクセスなど、ドキュメントに関するアクションを実行します。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、これらのサービスについて説明します。
ASSIGN_DOCINFO_FORM
DOCINFO_FORMを取得し、それをコンテンツに割り当てるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
CACHE_CHECKIN_NEW
プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをCHECKIN_NEWとして使用します。
空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1
場所: IdcHomeDir
/resources/core/tables/std_services.htm
CACHE_CHECKIN_SEL
プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをCHECKIN_SELとして使用します。
空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1
場所: IdcHomeDir
/resources/core/tables/std_services.htm
CACHE_SUBMIT_HTML_FORM
プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをSUBMIT_HTML_FORM.として使用します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
CACHE_WORKFLOW_CHECKIN
プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをWORKFLOW_CHECKINとして使用します。
コンテンツ・アイテム・ファイルが空の場合に、このサービスがエラーを返すようにするには、構成設定ValidatePrimaryFileNotEmpty=1
を使用します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
CHECKIN_ARCHIVE_NO_NOTIFY
クライアント・アプリケーションで使用される一般的なチェックイン・サービス。このサービスは一般的に、クライアント・アプリケーションが多数のファイルをチェックインしていることを認識し、チェックイン・アクティビティによってインデクサを開始しない場合に使用されます。
NO_NOTIFYは、チェックイン中に通常通知されるContent Serverサブジェクトをこのサービスが通知しないことを示します。このサービスは、インデクサを開始する、「リリースされたドキュメント」サブジェクトを非表示にします。
このサービスのユーザーは、NOTIFY_INDEXERサービスをコールすることによって作業を続行するために、インデクサ・サブジェクトに通知する必要があります。
このサービスは、アーカイバにより使用されません。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
追加のパラメータについては、「CHECKIN_ARCHIVE」を参照してください。
オプションのサービス・パラメータ
追加のパラメータについては、「CHECKIN_ARCHIVE」を参照してください。
例
IdcService=CHECKIN_ARCHIVE_NO_NOTIFY Action=insert dDocAuthor=user1 dDocName=test dDocTitle=new content dSecurityGroup=Public primaryFile=c:/test.txt doFileCopy=true
CHECKIN_BYNAME
コンテンツ・アイテム名またはコンテンツIDに基づいてコンテンツ・アイテムのリビジョンをチェックインするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ユーザーがセキュリティ・グループ(dSecurityGroup)、アカウント(dDocAccount)、または作成者(dDocAuthor)を変更するには、コンテンツ・アイテムのセキュリティ設定への管理者権限を持っている必要があります。
-
コンテンツ・アイテムがエンティティ・セキュリティを使用する場合、ユーザーがドキュメントに割り当てられているセキュリティ・グループに対する管理者権限を持っている場合を除き、ユーザーはそのエンティティにより少なくとも書込み権限を付与されている必要があります。
-
コンテンツ・アイテムがワークフローに存在している場合、ユーザーは現在のステップのレビューアまたはコントリビュータである必要があります。
-
メタファイルの生成が(AllowPrimaryMetaFileまたはAllowAlternateMetaFile環境変数、またはその両方を設定することにより)有効であり、メタファイル生成変数(createPrimaryMetaFile and createAlternateMetaFile)がtrueである場合、実際のファイルを現在のコンテンツ・アイテムに関連付けることはできません。コンテンツ・アイテムに関連付けることができるメタファイルは1つのみです。createPrimaryMetaFileがtrueの場合、createAlternateMetaFileはfalseである必要があります。その逆もまた同様です。
-
最も発生しがちなエラーは、リビジョンを挿入できないこと、またはリファイナリが正常に開始されないことです。
ノート:
コンテンツ・アイテム名またはコンテンツ・アイテムのリビジョンIDを指定する必要があります。
空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。
-
コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。
-
-
dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。
-
dDocTitle: コンテンツ・アイテムのタイトル。
-
dDocType: コンテンツ・アイテムのタイプ。
-
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
-
primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。
プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。
-
doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。
-
0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。
-
-
必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。
オプションのサービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
alternateFile: 変換のための代替ファイル。
-
各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
AutoNumberPrefix: これは構成エントリですが、パラメータとして指定できます。リビジョン・クラスIDの生成後およびメタデータ検証前に自動接頭辞スクリプトが評価されます。
-
createAlternateMetaFile: 代替メタファイルの生成を有効にするには、AllowAlternateMetaFile環境の値をtrueにし、パラメータcreateAlternateMetaFileをtrueにする必要があります。
-
createPrimaryMetaFile: プライマリ・メタファイルの生成を有効にするには、AllowPrimaryMetaFile環境の値をtrueにし、パラメータcreatePrimaryMetaFileをtrueにする必要があります。
-
dConversion: 変換アルゴリズムは、このパラメータで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。
ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。
-
dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。
-
dExtension: hcsf、doc、txtなどのファイル拡張子。
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
-
dInDate: コンテンツのリリース日。コンテンツ・アイテムがWebにリリースされる日付。デフォルトでは、これは現在の日付です。
コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。
-
dOutDate: コンテンツの有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。
コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。
-
dPublishState: パブリッシュ状態。コンテンツ・アイテムがシステムに存在している場合、dPublishStateは空である必要があります。
-
dReleaseState: リリース状態(リビジョンのWeb状態を示すために使用されます)。
-
dRevClassID: リビジョンのクラスID。
-
dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。
-
dWfType: 基本や基準などのワークフロー・タイプ。
-
IsAutoNumber: これは構成エントリですが、パラメータとして指定できます。構成変数IsAutoNumberがtrueに設定される場合、コンテンツID (dDocName)が自動プリフィックスをリビジョンのクラスID (dRevClassID、一意に区別されたコンテンツ・アイテムのカウンタ)と連結されることにより生成され、先行ゼロが6桁になるように事前入力されます。コンテンツID (dDocName)がすでに指定されている場合は、自動ナンバリングが実行されません。
-
IsEditRev: trueに設定される場合、このエントリは、コンテンツのリビジョンがワークフローに存在し、編集が有効であるかどうかをチェックします。
-
IsWorkflowInfo: これは構成エントリですが、パラメータとして指定できます。trueに設定された場合、このエントリはワークフロー情報を確認し、ワークフロー・ステップの許容されるアクションであるかどうかをチェックします。
-
webViewableFile: コンテンツ・アイテムがそれに関連付けられたWeb表示可能ファイルを持つ場合、変換形式はweb表示可能ファイルのフォーマット(パラメータwebViewableFile:format)で、拡張子はweb表示可能ファイルの拡張子(パラメータdWebExtension)です。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらの追加パラメータを設定することにより、ファイル・フォーマットおよび拡張子をオーバーライドできます。
-
オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。
例
IdcService=CHECKIN_BYNAME dDocName=test1000 dSecurityGroup=public dDocAuthor=sysadmin dDocType=ADENG dDocTitle=another test doFileCopy=true primaryFile=c:/test.txt
CHECKIN_CONFIRM_FORM
ブラウザから正常なチェックイン時に確認を返すサービス。
アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: コンテンツID。
-
dDocAuthor: ドキュメントの作成者。
-
dDocName: ドキュメント名。
-
dDocTitle: ドキュメントのタイトル。
結果
-
ローカル・データ:
-
dDocAuthor
-
dDocName
-
dDocTitle
-
dID
-
-
レスポンス・テンプレート: CHECKIN_CONFIRM (checkin_confirm.htm)
使用
-
リダイレクト・サービスの対象: CHECKIN_NEW、CHECKIN_SEL、CONTINUE_CHECKIN
CHECKIN_LIST
(チェックインまたは削除されない)チェックアウト・アイテムのリストを返すサービス。最も発生しがちなエラーは、チェックアウト・リストがデータベースから取得できないことです。
アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)
実行される問合せ: QcheckinCachesForUser
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加のオプション・サービス・パラメータ
-
userOnly: 1 (true)の場合、現在のユーザーにチェックアウトされたアイテムのみを返します。
-
MaxQueryRows: リストに返されるアイテム数を制御します。
結果
-
ResultSets:
-
CHECKIN_LIST(チェックアウトされたリビジョン用のRevisionsおよびDocMetaからのすべてのフィールド)
-
CHECKIN_CACHES (DatedCachesからのすべてのフィールド)
-
-
ローカル・データ:
-
copyAborted
-
DataSource
-
-
レスポンス・テンプレート: CHECKIN_LIST (checkin_list.htm)
使用
-
リソース・インクルード:
-
pne_nav_management_links
-
std_doc_man_pages
-
checkin_multiuploadapplet_processing_functions
-
-
標準ナビゲーション:
-
commonNav.js
-
commonBundle.js
-
-
その他:
-
SoapCustom:Wsdl:CheckIn:Services
-
リダイレクト・サービスの対象: DELETE_CHECKIN_CACHE
-
CHECKIN_NEW
新しいコンテンツ・アイテムをチェックインするサービス。このサービスはCHECKIN_NEW_SUBサブサービスをコールします。
アクセス・レベル: 書込み(2)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
-
作成者(dDocAuthor)を現在ログインしているユーザー以外のユーザーに設定しようとする場合、ドキュメントに割り当てられているセキュリティ属性に対して管理者権限を持っている必要があります。
-
コンテンツがエンティティ・セキュリティを使用する場合、ユーザーがドキュメントに割り当てられているセキュリティ・グループに対する管理者権限を持っている場合を除き、ユーザーは少なくともそのエンティティにより付与された書込み権限を持っている必要があります。
-
メタファイルの生成が(AllowPrimaryMetaFileまたはAllowAlternateMetaFile環境変数、またはその両方を設定することにより)有効であり、メタファイル生成変数(createPrimaryMetaFileおよびcreateAlternateMetaFile)がtrueである場合は、実際のファイルを現在のコンテンツ・アイテムに関連付けることはできません。1つのメタファイルは1つのコンテンツ・アイテムにのみ関連付けることができます: createPrimaryMetaFileがtrueの場合、createAlternateMetaFileはfalseである必要があります。その逆もまた同様です。
-
最も発生しがちなエラーは、コンテンツ・アイテムが適切に定義されていなかったことです。
-
このサービスはCHECKIN_NEW_SUBサブサービスを実行します。このサブサービスは、新しいコンテンツ・アイテムのリビジョンをチェックインします。
-
プライマリ・ファイルが必要です。プライマリ・ファイルをチェックインしないでメタデータのみをチェックインする場合は、追加のパラメータを含む必要があり、また、構成エントリをContent Serverに追加する必要があります。
-
空のファイルのチェックインを禁止するには、次を設定します:
ValidatePrimaryFileNotEmpty=1
必要な追加パラメータ(メタデータ・チェックイン):
createPrimaryMetaFile=true
必要なContent Server構成エントリ(メタデータ・チェックイン):
AllowPrimaryMetaFile=true
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。
-
コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。
-
-
dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。
-
dDocTitle: コンテンツ・アイテムのタイトル。
-
dDocType: コンテンツ・アイテムのタイプ。
-
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
-
primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。
プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。
-
必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。
-
オプションのサービス・パラメータ
-
alternateFile: 変換のための代替ファイル。
-
各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
-
AutoNumberPrefix: これは構成エントリですが、パラメータとして指定できます。リビジョン・クラスIDの生成後およびメタデータ検証前に自動接頭辞スクリプトが評価されます。
-
createAlternateMetaFile: 代替メタファイルの生成を有効にするには、AllowAlternateMetaFile環境の値をtrueに設定し、パラメータcreateAlternateMetaFileをtrueに設定する必要があります。
-
createPrimaryMetaFile: プライマリ・メタファイルの生成を有効にするには、AllowPrimaryMetaFile環境の値をtrueにし、パラメータcreatePrimaryMetaFileをtrueに設定する必要があります。
-
DirectReleaseNewCheckinDoc: Inbound Refinery、ワークフローおよび索引付けをバイパスするためにチェックインされるコンテンツ・アイテムをダイレクトします。デフォルトは0です。有効にするには、
DirectReleaseNewCheckinDoc=1
を設定します。このパラメータは、外部リポジトリからContent Serverストレージにコンテンツ・アイテムを転送する場合に高取込み率をサポートするために使用できます。この設定により、コンテンツ・チェックインの速度が向上するため、Content Serverが一度にサポート可能なチェックイン数が増加します。この機能は、多数のアイテムが一度にチェックインすることが期待されるアプリケーション(たとえば、スキャン・アプリケーションなど)では非常に好ましいです。
この設定を有効にする前に、次の重要な考慮事項を検討してください。
-
この方法でチェックインされたコンテンツ・アイテムはDATABASE.METADATAを検索することのみにより検出できます。ただし、他のコンテンツ・アイテムは通常のチェックインを行い、全文索引作成が行われます。
-
索引の再構築では、索引を作成するためにこのパラメータを使用してコンテンツをチェックインしません。
-
コンテンツの変更(新しいリビジョンの更新またはチェックイン)により、このパラメータを使用してチェックインされたドキュメントで索引付けが行われます。
-
DirectReleaseNewCheckinDoc構成エントリを使用して高速チェックイン・オプションでコンテンツ・サーバーを構成した場合、新しいコンテンツ・アイテムがチェックインされるときに検索キャッシュが更新されません。それらのアイテムが、以前キャッシュした検索の検索条件と一致する場合でも、検索結果に表示されません。インデクサがバイパスされるためこのような結果になります。この問題を解決するには、コンテンツ・サーバーを再起動するか、
UseSearchCache=false
を設定して検索キャッシュを無効にします。
-
-
dConversion: 変換アルゴリズムは、このパラメータで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。
ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。
-
dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。
-
dFormat: コンテンツ・アイテムのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
-
dInDate: リリース日。デフォルトでは、これは現在の日付です。コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。
-
dOutDate: 有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。
-
dProjectID: Content Serverによって生成されるContent PublisherプロジェクトID。
-
dPublishType: パブリッシュ・タイプ(Content Publisherによって作成されたコンテンツで使用される)。次の値を割り当てることができます。
-
H - ホーム
-
N - ナビゲーション
-
S - 問合せ結果ページ
-
P - ページ
-
G - ギャラリ・グラフィック
-
C - コントリビュータ埋込みグラフィック
-
O - 他のすべて
-
-
dRendition: コンテンツ・アイテムの追加のレンディションを指定するために使用されます。
-
dRevClassID: リビジョンのクラスID。
-
dRevisionLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。
-
IsAutoNumber: これは構成エントリですが、パラメータとして指定できます。構成変数IsAutoNumberがtrueに設定される場合、コンテンツID (dDocName)が自動プリフィックスをリビジョンのクラスID (dRevClassID、一意に区別されたコンテンツ・アイテムのカウンタ)と連結されることにより生成され、先行ゼロが6桁になるように事前入力されます。コンテンツID (dDocName)がすでに指定されている場合は、自動ナンバリングが実行されません。
-
webViewableFile: コンテンツ・アイテムがそれに関連付けられたWeb表示可能ファイルを持つ場合、変換形式はweb表示可能ファイルのフォーマット(パラメータwebViewableFile:format)で、拡張子はweb表示可能ファイルの拡張子(パラメータdWebExtension)です。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらの追加パラメータを設定することにより、ファイル・フォーマットおよび拡張子をオーバーライドできます。
-
オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。
結果
-
ローカル・データ:
-
dAction
-
dActionDate
-
dClbraName
-
dConversion(リファイナリによって処理される場合、変換の内容に関する情報が含まれます。)
-
dCreateDate
-
dDocAccount
-
dDocAuthor
-
dDocID
-
dDocName
-
dDocTitle
-
dDocType
-
dExtension
-
dFileSize
-
dFormat
-
dID: 新しいコンテンツ・アイテムのIDへの内部参照。
-
dInDate
-
dIsWebFormat
-
dIsPrimary
-
dLocation
-
dOriginalName
-
dOutDate
-
dpAction
-
dpEvent
-
dProcessingState
-
dPublishState
-
dPublishType
-
dRawDocID
-
dReleaseState
-
dRevClassID
-
dRevisionID
-
dRevLabel
-
dRevRank
-
dSecurityGroup
-
dStatus
-
dUser
-
dWorkflowState
-
isDocProfileUsed
-
isEditMode
-
isNew
-
isStatusChanged
-
prevReleaseState
-
primaryFile
-
StatusCode
-
StatusMessage
-
VaultfilePath
-
WebfilePath
-
xClbraAliasList
-
xClbraUserList
-
およびチェックインされるアイテムに関連するカスタム・メタデータ
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: CHECKIN_CONFIRM_FORM
-
使用
-
リソース・インクルード: std_doc_page_definitions
例
IdcService=CHECKIN_NEW dDocName=test1111 dDocTitle=test information dDocAuthor=john dSecurityGroup=public primaryFile=c:/test.txt
CHECKIN_NEW_FORM
ブラウザに新しいコンテンツ・アイテムのチェックイン・フォームを返すサービス。最も発生しがちなエラーは、コンテンツ・アイテムが適切に定義されていなかったことです。
アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)
場所: IdcHomeDir
/resources/core/templates//std_services.htm
結果
-
ResultSets:
-
DocFormats (dFormat、dConversion、dDescription)
-
dDocType (dDocType、dDescription、dGif)
-
-
レスポンス・テンプレート: CHECKIN_NEW_FORM (checkin_new.htm)
使用
-
アプレット:
-
リポジトリ・マネージャ
-
ワークフロー管理
-
ユーザー管理
-
構成マネージャ
-
-
リソース・インクルード:
-
pne_nav_management_links
-
pne_nav_bookmark_links
-
calculate_doc_profile_urls
-
std_doc_man_pages
-
-
標準ナビゲーション:
-
commonNav.js
-
commonBundle.js
-
CHECKIN_NEW_SUB
新しいコンテンツ・アイテムのリビジョンをチェックインするサブサービス。このサブサービスをコールするサービスによって、このコンテンツ・アイテムが基準ワークフローに属するかどうかを決定するなど、他の検証が実行されます。また、導出されたフィールドの計算、レンディションの追加およびリファイナリ処理の開始も含まれます。このサブサービスを実行する前に、グループおよびアカウントに対するセキュリティ・チェックを行う必要がある場合があります。
アクセス・レベル: サブサービス(N/A)
入力: コンテンツ・チェックインに必要なすべての標準フィールド、およびオプションのコンテンツ・メタデータを入力する必要があります。
実行される問合せ:
-
QnextRevID
-
UnextRevID
-
Irevision
-
Imeta
-
Idocument
-
IdocHistory
場所: IdcHomeDir
/resources/core/templates//std_services.htm
結果
-
ローカル・データ:
-
dAction
-
dActionDate
-
dClbraName
-
dConversion
-
dCreateDate
-
dDocAccount
-
dDocAuthor
-
dDocID
-
dDocName
-
dDocTitle
-
dDocType
-
dExtension
-
dFileSize
-
dFormat
-
dID
-
dInDate
-
dIsPrimary
-
dIsWebFormat
-
dLocation
-
dOriginalName
-
dOutDate
-
dpAction
-
dpEvent
-
dProcessingState
-
dPublishState
-
dPublishType
-
dRawDocID
-
dReleaseState
-
dRevClassID
-
dRevisionID
-
dRevLabel
-
dRevRank
-
dSecurityGroup
-
dStatus
-
dUser
-
dWorkflowState
-
isDocProfileUsed
-
isEditMode
-
isNew
-
isStatusChanged
-
prevReleaseState
-
primaryFile
-
StatusCode
-
StatusMessage
-
VaultfilePath
-
xClbraAliasList
-
xClbraUserList
-
WebfilePath
-
およびチェックインされるアイテムに関連するカスタム・メタデータ
-
使用
-
サービス: CHECKIN_NEW
CHECKIN_SEL
既存のコンテンツ・アイテムのリビジョンをチェックインするサービス。これはCHECKIN_SEL_SUBサブサービスをコールします。
アクセス・レベル: 書込み(2)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
-
このサービスを実行するには、コンテンツ・アイテムをチェックアウトする必要があります。
-
コンテンツ・アイテムがワークフローに存在している場合、ユーザーは現在のステップのレビューアまたはコントリビュータである必要があります。
-
ユーザーがセキュリティ・グループ(dSecurityGroup)、アカウント(dDocAccount)または作成者(dDocAuthor)を変更するには、コンテンツ・アイテムのセキュリティ設定に対して管理者権限を持っている必要があります。
-
メタファイルの生成が(AllowPrimaryMetaFileまたはAllowAlternateMetaFile環境変数、またはその両方を設定することにより)有効であり、メタファイル生成変数(createPrimaryMetaFile and createAlternateMetaFile)がtrueである場合、実際のファイルを現在のコンテンツ・アイテムに関連付けることはできません。コンテンツ・アイテムに関連付けることができるメタファイルは1つのみです。createPrimaryMetaFileがtrueの場合、createAlternateMetaFileはfalseである必要があります。その逆もまた同様です。
-
コンテンツ・アイテムはパブリッシュ状態にできません。
-
現在のユーザーはコンテンツ・アイテムの作成者であるか、またはリビジョンをチェックインするための管理者権限を持っている必要があります。
-
最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。
-
このサービスはCHECKIN_SEL_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックインします。
-
空のファイルのチェックインを禁止するには、次を設定します:
ValidatePrimaryFileNotEmpty=1
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。
-
コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。
-
-
dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。
-
dDocTitle: コンテンツ・アイテムのタイトル。
-
dDocType: コンテンツ・アイテムのタイプ。
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。
-
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
-
primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。
-
doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。
-
-
必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。
オプションのサービス・パラメータ
-
alternateFile: 変換のための代替ファイル。
-
各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
-
createAlternateMetaFile: 代替メタファイルの生成を有効にするには、AllowAlternateMetaFile環境の値をtrueに設定し、パラメータcreateAlternateMetaFileをtrueに設定する必要があります。
-
createPrimaryMetaFile: プライマリ・メタファイルの生成を有効にするには、AllowPrimaryMetaFile環境の値をtrueに設定し、パラメータcreatePrimaryMetaFileをtrueに設定する必要があります。
-
dConversion: 変換アルゴリズムは、パラメータdConversionで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。
-
ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。
-
dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
-
dInDate: コンテンツのリリース日。コンテンツ・アイテムがWebにリリースされる日付。デフォルトでは、これは現在の日付です。コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。
-
dOutDate: コンテンツの有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。
-
dProjectID: Content Serverによって生成されるContent PublisherプロジェクトID。
-
dPublishState: パブリッシュ状態。コンテンツ・アイテムがシステムに存在している場合、dPublishStateは空である必要があります。
-
dPublishType: パブリッシュ・タイプ(Content Publisherによって作成されたコンテンツで使用される)。次の値を割り当てることができます。
-
H - ホーム
-
N - ナビゲーション
-
S - 問合せ結果ページ
-
P - ページ
-
G - ギャラリ・グラフィック
-
C - コントリビュータ埋込みグラフィック
-
O - 他のすべて
-
-
dRevClassID: リビジョンのクラスID。
-
AutoNumberPrefix: これは構成エントリですが、パラメータとして指定できます。リビジョン・クラスIDの生成後およびメタデータ検証前に自動接頭辞スクリプトが評価されます。
-
IsAutoNumber: これは構成エントリですが、パラメータとして指定できます。構成変数IsAutoNumberがtrueに設定される場合、コンテンツID (dDocName)が自動プリフィックスをリビジョンのクラスID (dRevClassID、一意に区別されたコンテンツ・アイテムのカウンタ)と連結されることにより生成され、先行ゼロが6桁になるように事前入力されます。コンテンツID (dDocName)がすでに指定されている場合は、自動ナンバリングが実行されません。
-
IsWorkflowInfo: これは構成エントリですが、パラメータとして指定できます。trueに設定された場合、このエントリはワークフロー情報を確認し、ワークフロー・ステップの許容されるアクションであるかどうかをチェックします。
-
webViewableFile: コンテンツ・アイテムがそれに関連付けられたWeb表示可能ファイルを持つ場合、変換形式はweb表示可能ファイルのフォーマット(パラメータwebViewableFile:format)で、拡張子はweb表示可能ファイルの拡張子(パラメータdWebExtension)です。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらの追加パラメータを設定することにより、ファイル・フォーマットおよび拡張子をオーバーライドできます。
-
RedirectUrl: トピック・ファイルが変更された後で、別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
-
オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。
結果
-
ローカル・データ:
-
dConversion: リファイナリによって処理される場合、これには変換の内容に関する情報が含まれます。
-
dID: 新しいコンテンツ・アイテムの内部参照ID。
-
IsWorkflow: アイテムがチェックイン時にワークフローに入る場合は、1 (true)が返されます。
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: CHECKIN_CONFIRM_FORM
-
使用
-
リソース・インクルード: std_doc_page_definitions
例
IdcService=CHECKIN_SEL dDocName=test_000036 dDocTitle=my test dDocAuthor=sysadmin dDocType=ADENG dSecurityGroup=Public dID=49 dRevLabel=1 doFileCopy=1
CHECKIN_SEL_FORM
ブラウザに新しいコンテンツ・アイテムのリビジョンのチェックイン・フォームを返すサービス。このサービスは、アイテムの現在のコンテンツ情報をロードします。「フォーム」ページに古いメタデータ情報が表示されます。
最も発生しがちなエラーは、コンテンツ・アイテム名がシステムに存在しないこと、コンテンツ・アイテムに関する情報が見つからないこと、またはシステムがリビジョンのプロパティを確認できないことです。
アクセス・レベル: 書込み、スクリプト作成可能(34)
実行される問合せ: QdocID、Qrevisions、QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
オプションのサービス・パラメータ
-
dDocName
-
dWfName
結果
-
ResultSets:
-
DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
DocFormats (dFormat、dConversion、dDescription)
-
dDocType (dDocType、dDescription、dGif)
-
-
ローカル・データ:
-
CurRevCheckoutUser
-
CurRevID
-
CurRevIsCheckedOut
-
dDocAccount
-
dDocAuthor
-
dDocName
-
defaultAccount
-
dID
-
DocUrl
-
dPublishState
-
dReleaseState
-
dRevClassID
-
dRevLabel
-
dSecurityGroup
-
dStatus
-
dUser
-
dWorkflowState
-
isCurRevEmpty
-
IsNotLatestRev
-
IsWorkflow
-
latestID
-
およびすべてのDocMetaフィールド
-
-
レスポンス・テンプレート: CHECKIN_SEL_FORM (checkin_sel.htm)
使用
-
リソース・インクルード:
-
classic_info_page_content
-
workflow_action_popup
-
checkin_list_action_popup
-
legacy_checked_out_content_table
-
workflow_doc_action_links
-
docinfo_checkin_similar_option
-
setup_checked_out_content_action_popups
-
wf_reviewer_doc_action_links
-
-
テンプレート:
-
CHECKOUT_OK (chkook.htm)
-
WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
-
例
IdcService=CHECKIN_SEL_FORM dID=55
CHECKIN_SEL_SUB
チェックインされるコンテンツ・アイテムがすでに存在する場合、チェックアウトされている場合、またはワークフロー内に存在しない場合に使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
CHECKIN_SIMILAR_FORM
同様なコンテンツ・アイテムからのメタデータを入力して、ブラウザに新しいコンテンツ・アイテムのチェックイン・フォームを返すサービス。最も発生しがちなエラーは、コンテンツ・アイテムが適切に定義されていなかったことです。
アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)
実行される問合せ: QdocInfoSimilarCheckin
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
-
ResultSets:
-
DOC_INFO_SIMILAR (指定されたリビジョンのdDocTitle、dDocType、dSecurityGroup、dDocAccount)
-
DocFormats (dFormat、dConversion、dDescription)
-
dDocType (dDocType、dDescription、dGif)
-
-
ローカル・データ:
-
dDocAccount
-
dDocType
-
dSecurityGroup
-
-
レスポンス・テンプレート: CHECKIN_NEW_FORM (checkin_new.htm)
使用
-
リソース・インクルード:
-
search_results_action_popup
-
docinfo_checkin_similar_option
-
doc_file_checkin_similar
-
setup_search_results_action_popups
-
-
テンプレート: CHECKIN_CONFIRM (checkin_confirm.htm)
CHECKIN_UNIVERSAL
Content Serverによって制御されるチェックインを実行するサービス。
アクセス・レベル: 書込み(2)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
-
このサービスは、ブラウザまたは「リポジトリ・マネージャ」アプリケーションを介したチェックイン時にコールされる同じサブサービスである、次のサブサービスのいずれかにチェックイン・リクエストを送信します。(これらのサブサービスは、バッチ・ローダーまたはアーカイブのインポート中にはコールされません。)
-
CHECKIN_NEW_SUB - コンテンツ・アイテムがサーバーに存在しない場合。このサブサービスは、チェックイン・データを検証し、このコンテンツ・アイテムが基準ワークフローに属しているかどうかを判断します。
-
CHECKIN_SEL_SUB - コンテンツ・アイテムがシステムに存在し、コンテンツ・アイテムがチェックアウトされ、コンテンツ・アイテムがワークフロー内にない場合。
-
WORKFLOW_CHECKIN_SUB - コンテンツ・アイテムが存在し、ワークフロー内にある場合。
-
-
このサービスは、セキュリティをチェックして、ユーザーがコンテンツ・アイテムのチェックインを実行するための十分な権限を持っているかどうかを判断します。
-
コンテンツID (dDocName)をキーとして使用してデータベースに問合せを行うことにより、コンテンツ・アイテムが新規のものであるか、システムにすでに存在しているものであるかを判断します。
-
コンテンツ・アイテムがシステムに存在している場合、パブリッシュ状態(dPublishState)は空である必要があります。
-
アイテムが存在して、チェックアウトされる場合は、新しいリビジョンがチェックインされます。
-
最も発生しがちなエラーは、パラメータの不一致、またはコンテンツ・アイテムが正常にチェックインされなかったことです。
ノート:
すべてのパスがファイルの区切り文字としてスラッシュ(/)を使用します。これは、バックスラッシュ(\)がエスケープ文字であるからです。たとえば、primaryFile=d:/temp/myfile.txt。
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
コンテンツID自動生成が有効な場合、このパラメータは必要ありません。
-
dDocNameが指定され、Content Serverシステムに存在する場合、リビジョンがチェックインされます。dDocNameが指定され、Content Serverに存在しない場合、新しいコンテンツ・アイテムがチェックインされます。
-
コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。
-
-
dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。
-
dDocTitle: コンテンツ・アイテムのタイトル。
-
dDocType: コンテンツ・アイテムのタイプ。
-
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
-
primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。
-
doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。
-
-
必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。
-
オプションのサービス・パラメータ
-
alternateFile: 変換のための代替ファイル。
-
各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
-
プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。
-
-
dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。
-
dInDate: コンテンツのリリース日。コンテンツ・アイテムがWebにリリースされる日付。デフォルトでは、これは現在の日付です。コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。
-
dOutDate: コンテンツの有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。
-
dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。リビジョン・ラベル(dRevLabel)が指定された場合、このサービスは、そのコンテンツ・リビジョンがシステムに存在しているかどうかをチェックします。存在する場合は、例外がスローされます。
-
isFinished: これがワークフロー・チェックインであり、その編集が完了している場合は、true (1)に設定します。
-
追加情報については、「WORKFLOW_CHECKIN」を参照してください。
ノート:
コンテンツID (dDocName)と内部のコンテンツ・アイテム・リビジョン識別子(dID)を混同しないでください。dIDは、コンテンツ・アイテムの特定のレンディションへの、生成済の参照です。
結果
-
ローカル・データ:
-
dConversion: リファイナリによって処理される場合、これには変換の内容に関する情報が含まれます。
-
dID: 新しいコンテンツ・アイテムの内部参照ID。
-
IsWorkflow: アイテムがチェックイン時にワークフローに入る場合は、1 (true)が返されます。
-
使用
-
リソース・インクルード: std_doc_page_definitions
-
その他:
-
SoapCustom:Esdl:CheckIn:Services
-
SoapCustom:Wsdl:Workflow:Services
-
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=CHECKIN_UNIVERSAL dDocName=adsales dDocType=ADACCT dDocTitle=Advertising Sales dSecurityGroup=Secure dDocAuthor=user1 dRevLabel=1 dDocType=ADACCT primaryFile=c:/temp/docs/mydoc.txt doFileCopy=1 # If this is a workflow check-in and you have finished editing it, mark it as finished. #isFinished=true #Required depending on configuration dDocAccount=mainaccount #Optional fields: #dCreateDate= #dInDate= #dOutDate= #alternateFile= #Custom metadata fields: xComments= xLocation= xProjects=
-
HDA形式(コンテンツ・アイテムmyDocNameのチェックイン):
@Properties LocalData IdcService=CHECKIN_UNIVERSAL doFileCopy=1 dDocName=myDocName dDocTitle=My document title dDocType=ADACCT dSecurityGroup=Secure dDocAuthor=user1 primaryFile=c:/temp/docs/mydoc.txt dDocAccount=mainaccount xComments= xLocation= xProjects= @end
CHECKOUT
ブラウザからコンテンツ・アイテムの最新のリビジョンをチェックアウトするサービス。
-
コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがすでにチェックアウトされている場合、またはコンテンツ・アイテムをチェックアウトするのに十分な権限がユーザーにない場合、サービスは失敗します。
-
最も発生しがちなエラーは、コンテンツがシステムに存在しないこと、またはシステムがリビジョン情報を取得できないことです。
-
このサービスはCHECKOUT_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックアウトします。
アクセス・レベル: 書込み、スクリプト作成可能(34)
サブサービスのコール: CHECKOUT_SUB
実行される問合せ:
-
QdocID
-
Qrevisions
-
QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
このサービスは、コンテンツ・アイテムをロック済としてマークするだけです。ダウンロードは実行しません。
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
オプションのサービス・パラメータ
-
dDocTitle: コンテンツ・アイテムのタイトル。
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
結果
-
ローカル・データ:
-
CurRevCheckoutUser
-
CurRevIsCheckedOut
-
CurRevID
-
dAction
-
dActionDate
-
dActionMillis
-
dCheckoutUser
-
dClbraName
-
dDocName
-
dIsCheckedOut
-
dPublishState
-
dReleaseState
-
dRevClassID
-
dRevLabel
-
dSecurityGroup
-
dStatus
-
dWorkflowState
-
isCurRevEmpty
-
isFinished
-
IsNotLatestRev
-
IsWorkflow
-
latestID
-
prevReleaseState
-
RedirectParams
-
wfAction
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: CHECKOUT_OK
-
使用
-
アプレット:
-
リポジトリ・マネージャ
-
ワークフロー管理者
-
-
リソース・インクルード:
-
classic_search_result_item_checkout
-
clbra_active_doc_display
-
doc_file_checkout
-
docinfo_checkout_form
-
searchapi_result_table_content_end
-
search_results_action_popup
-
setup_search_results_action_popups
-
wf_reviewer_doc_action_links
-
wips_list_action_popup
-
workflow_action_popup
-
workflow_doc_action_links
-
workflow_docs_table
-
workflow_in_queue_table
-
work_in_progress_table
-
-
テンプレート: WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
-
その他: SoapCustom:Wsdl:CheckIn:Services
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=CHECKOUT dID=55
-
任意のパラメータを持つHDA形式:
@Properties LocalData IdcService=CHECKOUT dID=55 dDocTitle=Sample Title @end
CHECKOUT_BY_NAME
アプレットまたはアプリケーションからコンテンツ・アイテムをチェックアウトするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
-
コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがすでにチェックアウトされている場合、またはコンテンツ・アイテムをチェックアウトするのに十分な権限がユーザーにない場合、サービスは失敗します。
-
最も発生しがちなエラーは、コンテンツ・アイテム名がシステムに存在しないことです。
-
このサービスはCHECKOUT_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックアウトします。
ノート:
このサービスは、コンテンツ・アイテムをロック済としてマークするだけです。ダウンロードは実行しません。
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
オプションのサービス・パラメータ
-
dDocTitle: コンテンツ・アイテムのタイトル。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=CHECKOUT_BY_NAME dDocName=myDocument
-
任意のパラメータを持つHDA形式:
@Properties LocalData IdcService=CHECKOUT_BY_NAME dDocName=myDocument dDocTitle=Just a title @end
CHECKOUT_OK
ブラウザからコンテンツ・アイテムをチェックアウトし、チェックアウト確認ページを表示するサービスによるリダイレクト・サービスとしてコールされます。
アクセス・レベル: 書込み、スクリプト作成可能(34)
実行される問合せ: QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
-
最も発生しがちなエラーは、リビジョンが存在しないこと、またはシステムがリビジョン情報を取得できないことです。
-
このサービスはCHECKOUT_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックアウトします。
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
CurRevCheckoutUser: アイテムをチェックアウトしたユーザー。
オプションのサービス・パラメータ
-
CurRevID: 現在のリビジョンのID。通常はdIDと同じ。
結果
-
ResultSet: DOC_INFO(指定されたバージョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
レスポンス・テンプレート: CHECKOUT_OK (chkook.htm)
使用
-
その他: CHECKOUT、CHECKOUT_BY_NAMEのリダイレクト・サービス
例
IdcService=CHECKOUT_OK dID=48
CHECKOUT_SUB
コンテンツ・アイテムのリビジョンをチェックアウトするサブサービス。バインダに、コンテンツ・アイテム最新バージョンのQdocInfo(または同等)の結果を含むDOC_INFOという結果セットが含まれる必要があります。
アクセス・レベル: サブサービス(N/A)
実行される問合せ:
QworkflowDocInfo
-
IdocHistory
-
UcheckoutRevision
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
-
ローカル・データ:
-
CurRevCheckoutUser
-
dAction
-
dActionDate
-
dActionMillis
-
dCheckoutUser
-
dClbraName
-
dIsCheckedOut
-
hasUserAccessChanged
-
isCurRevEmpty
-
isFinished
-
IsNotLatestRev
-
prevReleaseState
-
wfAction
-
使用
-
サービス:
-
CHECKOUT
-
CHECKOUT_BY_NAME
-
FORM_PROCESS (processFormメソッドにより間接的に)
-
CONTINUE_CHECKIN
CACHE_CHECKIN_NEWまたはCACHE_CHECKIN_SELサービスで開始されたチェックインを完了するサービス。
プレビューが実行され、チェックイン・データがキャッシュされた後で、ユーザーはこのサービスを使用してチェックインを完了または続行することを決定できます。
正常なチェックインを実行するには、キャッシュされたデータがこのサービスに提供される必要があります。キャッシュおよびチェックイン動作をカスタマイズするためにフィルタが提供されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
CONTINUE_SUBMIT_HTML_FORM
CACHE_SUBMIT_HTML_FORMサービスで開始されたチェックインを完了するサービス。
プレビューが実行され、チェックイン・データがキャッシュされた後で、ユーザーはこのサービスを使用してチェックインを完了または続行することを決定できます。
正常なチェックインを実行するには、キャッシュされたデータがこのサービスに提供される必要があります。キャッシュおよびチェックイン動作をカスタマイズするためにフィルタが提供されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
COPY_REVISION
新しいリビジョン・クラスを作成するために、特定のドキュメントのリビジョンをコピーするサービス。元のリビジョンのドキュメント・メタデータのほとんどは引き継がれます。呼出し元では、リクエストのパラメータでメタデータ値を設定することにより、上書きすることもできます。
ユーザーに必要なのは、元のドキュメント・リビジョンへの読取り権限のみです。ただし、新しいリビジョンは元のメタデータを継承するため、ユーザーに元のリビジョンへの書込み権限がない場合、新しいセキュリティ・メタデータの値を設定する必要があります。
このサービスはContent Serverの構成でGetCopyAccessがTRUEに設定されていることを仮定しています。
サービス・クラス: DocService
場所: IdcHomeDir
/resources/core/tables/std_services.htm
必須のサービス・パラメータ
-
dID: (整数)コピーするドキュメント・リビジョンのID。
-
dDocName: コピーするドキュメント・リビジョンのコンテンツID。適切なエラー・メッセージに使用されます。
オプションのサービス・パラメータ
-
newDocName: 新しいリビジョン・クラスのdDocName。これを指定せず、自動ナンバリングが有効な場合、dDocNameは自動的に生成されます。
結果
-
ResultSets:
-
NewDocInfo: 新しく作成されたドキュメントについての情報。
-
OriginalDocInfo: コピーされた元のドキュメントについての情報。
-
CREATE_SUBSCRIPTION_TYPE
新しいサブスクリプション・タイプを作成するサービス。最も発生しがちなエラーは、サブスクリプション・タイプ名が一意でないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
scpType: サブスクリプションのタイプ。
-
scpDescription: サブスクリプションの説明。
-
scpEnabled: 1 (true): サブスクリプション通知が有効です。0 (false): サブスクリプション通知が無効です。
-
scpFields: サブスクリプション条件を定義するメタデータ・フィールド。たとえば、
dDocAuthor
、dDocType
。
例
IdcService=CREATE_SUBSCRIPTION_TYPE scpType=subscription_test scpFields=dDocType scpDescription=testing the subscription scpEnabled=1
DELETE_BYCLASS
特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_BYNAME
特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_BYREV
特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_CHECKIN_CACHE
特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_DOC
コンテンツ・アイテム全体とすべてのリビジョンを削除するサービス。ユーザーはコンテンツ・アイテムを削除する権限が必要です。最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムID。
-
dDocName: ドキュメントのdocumentID。実際のコンテンツID。
例
IdcService=DELETE_DOC dID=48 dDocName=test1000
DELETE_REV
ブラウザから既存のコンテンツ・アイテムのリビジョンを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、コンテンツ・アイテムがシステムに存在しないこと、またはコンテンツ・アイテムがワークフローの一部であることです。
アクセス・レベル: 読取り、書込み(3)
サブサービスのコール: DELETE_BYREV_REVISION
実行される問合せ: QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
結果
-
ResultSets: DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
ローカル・データ:
-
Content Server:
-
currentReleaseState
-
dAction (「リビジョンの削除」を返します)
-
dReleaseState
-
isAllRevisionsDeleted (アイテムの最新リビジョンが削除されたときにtrueを返します)
-
isCurRevEmpty
-
newReleaseState
-
prevID
-
-
削除されるアイテムが現在ワークフロー内にある場合、オペレーションは失敗し、次のワークフロー情報が返されます。
-
dWfCurrentStepID
-
dWfDocState
-
dWfID
-
dWfName
-
dWfStatus
-
dWfStepDescription
-
dWfStepID
-
dWfStepIsAll
-
dWfStepName
-
dWfStepType
-
dWfStepWeight
-
dWfType
-
dWorkflowState
-
IsWorkflow
-
wfStepCheckinType
-
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: DOC_INFO
-
使用
-
リソース・インクルード:
-
delete_rev_form
-
delete_revision_form
-
例
IdcService=DELETE_REV dID=51
DELETE_REV_EX
アプレットまたはアプリケーションから既存のコンテンツ・アイテムのリビジョンを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、コンテンツ・アイテムがシステムに存在しないこと、またはコンテンツ・アイテムがワークフローの一部であることです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
例
IdcService=DELETE_REV_EX dID=56
DELETE_SUBSCRIPTION_TYPE
既存のサブスクリプション・タイプを削除するサービス。最も発生しがちなエラーは、サブスクリプション・タイプがシステムに存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
scpType: サブスクリプションのタイプ。
例
IdcService=DELETE_SUBSCRIPTION_TYPE scpType=subscription_test
DOC_FORMATS_WIZARD
コンテンツ・アイテムの形式の拡張子を取得するサービス。コンテンツ・アイテム構成情報をロードし、デフォルトのコンテンツ・アイテムの形式拡張子を設定するために使用されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DOC_INFO
コンテンツ・アイテムの特定のリビジョンのコンテンツ・アイテム情報を取得するサービス。コンテンツ・アイテムのそのリビジョンに関連付けられているすべてのメタデータを返します。最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。
REVISION_HISTORY結果セットから他のリビジョンの限定情報が提供されます。
このサービスは、サブスクリプション情報、およびアイテムがワークフロー内にある場合はワークフロー情報を返します。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ:
-
QdocInfo
-
QdocFormats
-
QisSubscribed
-
QrevHistory
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: コンテンツ・アイテムのリビジョンID。
-
dDocName: コンテンツ・アイテムID。
オプションのサービス・パラメータ
-
includeFileRenditionsInfo: このパラメータはデフォルトでfalseに設定されています。結果セットでRENDITIONS_INFO表およびレンディション表を取得するリクエストでは「true」に設定します。
結果
-
ResultSets:
-
DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
REVISION_HISTORY(すべての非削除リビジョンのdFormat、dInDate、dOutDate、dStatus、dProcessingState、dRevLabel、dID、dDocName、dRevisionID)
-
アイテムがワークフロー内にある場合: WF_INFO(指定されたリビジョンのWorkflowsおよびWorkflowDocumentsからのすべてのフィールド)
-
RENDITIONS_INFO: この結果セットは、includeFileRenditionsInfo = 1の場合に返されます。コンテンツ・アイテムのすべてのレンディションについてのデータが含まれます。次のような列があります。
-
レンディション: この列には次の値のいずれかが入ります。
プライマリ: チェックイン・ファイル用の行を示します。
Web: Web表示可能ファイル用の行を指定します。
レンディション:<dRendition1フラグ>: dRendition1のレンディションのタイプを示します。
レンディション:<dRendition2フラグ>: dRendition2のレンディションのタイプを示します。
-
isExtRendition: レンディションが添付かどうかを示します(コア行、つまり、プライマリ、Web、レンディション:<dRendition1フラグ>およびレンディション:<dRendition2フラグ>行では「false」で、それ以外の場合は「true」です)。
-
isAvailable: このフィールドは常に「true」です。
-
isStaticAvailable: このフィールドはコア・レンディションとは関連がありません(isExtRendition = 0の場合、コア行、つまり、プライマリ、Web、レンディション:<dRendition1フラグ>およびレンディション:<dRendition2フラグ>行では「false」です)。このフィールドは、レンディションまたは添付にリストされたレンディションの静的URLが使用可能かどうかをチェックします。レンディションがファイル・システムに存在する場合は「true」で、レンディションがファイル・システムにない場合は「false」です。
-
-
Renditions: この結果セットはincludeFileRenditionsInfo = 1の場合に返されます。アプリケーション開発フレームワーク(ADF) UIにアクセス可能なManifest表およびMediaRenditions表からのデータを含みます。Renditions表には次の列があります。
-
rendName: レンディション名。このフィールドは可能な場合にはローカライズされます。
-
rendDescription: レンディションが定義されている場合、レンディションの説明を提供します。このフィールドは可能な場合にはローカライズされます。ビデオ・レンディションはこのフィールドを使用しません。
-
rendType: レンディションのタイプを指定します。レンディションには次の4つの静的タイプがあります。
プライマリ: チェックイン・ファイル。
Web: Web表示可能ファイル。
dc: ネイティブUIの動的変換(dc)ルールに従います。このフィールドが表示されるようにDynamicConveterを構成します。
video: レンディションは、MediaRenditions表にリストされている場合またはマニフェストのextRenditionTypeと一致する場合はビデオとみなされます。
-
rendUrl: レンディションの絶対URL。
-
rendFormat: レンディションのフォーマット、たとえば、MIMEタイプ。
-
rendFileSize: レンディションのファイル・サイズ。
-
rendImgDimensions: h x w フォーマットのイメージ・レンディションのディメンション。
-
rendImgResolution: nnn dpi フォーマットのイメージ・レンディションの解像度。
-
rendVidFrameRate: nn fps フォーマットのビデオ・レンディションのフレーム・レート。
-
rendVidDuration: 秒単位に四捨五入したビデオ・レンディションの時間の長さ、たとえば、14秒、1分10秒など 。
-
rendVidBitrate: nn bpsフォーマットのビデオ・レンディションのビット・レート。
-
rendParams: ビデオのMediaRenditions.mediaRendParamsフィールドのコピーまたはイメージのmanifest.extRenditionParamsフィールドのコピーを含みます。
ノート:
各レンディションではRenditions表にリストされているすべてのフィールドを使用しない可能性があり、使用されていないレンディションは「該当なし」とマークされます 。
-
-
-
ローカル・データ:
-
Content Server:
-
AuthorAddress
-
dDocFormats
-
dDocTitle
-
dID
-
DocUrl
-
dStatus
-
dSubscriptionAlias
-
dSubscriptionID
-
dSubscriptionType
-
dUser
-
-
アイテムがワークフロー内にある場合:
-
dWfCurrentStepID
-
dWfDocState
-
dWfID
-
dWfName
-
dWfStatus
-
wfStepCheckinType
-
dWfStepDescription
-
dWfStepID
-
dWfStepIsAll
-
dWfStepName
-
dWfStepType
-
dWfStepWeight
-
dWfType
-
IsWorkflow
-
-
-
文字列: DocURL (このリビジョンに関連付けられたweblayoutファイルへの完全URL)
-
レスポンス・テンプレート: DOC_INFO (doc_info.htm)
使用
-
リソース・インクルード:
-
checkin_list_action_popup
-
checkin_multiuploadapplet_processing_functions
-
classic_doc_rev_info
-
clbra_active_doc_display
-
clbra_wf_doc_list
-
dam_result_table_content_row
-
doc_info_action_image
-
docinfo_page_title
-
doc_rev_info
-
doc_revisions_table
-
email_docinfo_body_by_id
-
email_docinfo_body_by_name
-
legacy_basic_subscriptions_table
-
legacy_checked_out_content_table
-
legacy_expired_content_table
-
legacy_work_in_progress_table
-
my_view_result_table_cells
-
searchapi_result_doc_href_start
-
searchapi_result_table_content_end
-
search_result_info_button
-
search_results_action_popup
-
setup_checked_out_content_action_popups
-
setup_search_results_action_popups
-
setup_subscription_action_popups
-
setup_work_in_progress_action_popups
-
slim_result_table_content_row
-
subscription_action_popup
-
trays_search_result_section
-
wf_in_queue_display
-
wf_reviewer_mail_link
-
wips_list_action_popup
-
-
テンプレート:
-
CHECKIN_CONFIRM (checkin_confirm.htm)
-
DOCUMENT_PROBLEMREPORTS (doc_problemreports.htm)
-
DOC_SUB_LIST (doc_sub_list.htm)
-
PR_CONTRIBUTOR_MAIL (pr_contributor_mail.htm)
-
PROBLEMREPORT_INFO (pr_info.htm)
-
QUERY_NOTIFICATION (query_notification_mail.htm)
-
SUBSCRIPTION_MAIL (subscription_mail.htm)
-
WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
-
WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)
-
-
その他:
-
LC変数のリンク: wwCommentOnRevision
-
SoapCustom:Wsdl:DocInfo:Services
-
SoapCustom:Wsdl:DocInfo:Service:DocInfoByID:ResponseParams
-
SoapCustom:Wsdl:DocInfo:Service:DocInfoByName:ResponseParams
-
SoapCustom:Wsdl:GetFile:Service:GetFileByID:ResponseParams
-
-
リダイレクト・サービスの対象:
-
DELETE_REV
-
RESUBMIT_FOR_CONVERSION
-
SUBSCRIBE
-
UNDO_CHECKOUT
-
UNSUBSCRIBE
-
UPDATE_DOCINFO_BYFORM
-
例
IdcService=DOC_INFO dID=54321
DOC_INFO_BY_NAME
DOC_INFOサービスによって必要とされるリビジョン固有のdIDパラメータではないパラメータとしてコンテンツID (dDocName)に基づいたコンテンツ・アイテムの最新リビジョンに関する情報を取得するサービス。RevisionSelectionMethodパラメータは、固有のリビジョンに関する情報を返すため、specificに設定できます。
デフォルトで、このサービスは、リリースされるかどうかにかかわらず、最新リビジョンの情報を返します。あるアイテムはワークフロー外となるまでリリースされません。指定されたリビジョンに対して返される結果は、DOC_INFOサービスの結果と同じです。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ:
-
QdocInfo
-
QdocFormats
-
QisSubscribed
-
QrevHistory
-
QlatestIDByName (RevisionSelectionMethodが空であるかまたは「最新」である場合)
-
QlatestReleasedIDByName (RevisionSelectionMethodが「LatestReleased」である場合)
場所: ucm_home/shared/config/resources/std_services.htm
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
コンテンツ・アイテム名(dDocName)が指定されるか、またはRevisionSelectionMethodパラメータを持つコンテンツID(dDocName)が指定される必要があります。
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテム名。
オプションのサービス・パラメータ
-
RevisionSelectionMethod: 最新のバージョンを取得するにはLatest、最新のリリース・バージョンを取得するにはLatestReleasedまたはSpecific (Specificに設定する場合、dIDを指定する必要があります)に設定できます。Specificに設定された場合、特定のバージョンをポイントするため、dDocNameではなくdIDを使用できます。
-
includeFileRenditionsInfo: このパラメータはデフォルトでfalseに設定されています。結果セットでRENDITIONS_INFO表およびレンディション表を取得するリクエストでは「true」に設定します。
結果
-
ResultSets:
-
DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
REVISION_HISTORY(すべての非削除リビジョンのdFormat、dInDate、dOutDate、dStatus、dProcessingState、dRevLabel、dID、dDocName、dRevisionID)
-
アイテムがワークフロー内にある場合: WF_INFO(指定されたリビジョンのWorkflowsおよびWorkflowDocumentsからのすべてのフィールド)
-
RENDITIONS_INFO: この結果セットは、includeFileRenditionsInfo = 1の場合に返されます。コンテンツ・アイテムのすべてのレンディションについてのデータが含まれます。次のような列があります。
-
レンディション: この列には次の値のいずれかが入ります。
プライマリ: チェックイン・ファイル用の行を示します。
Web: Web表示可能ファイル用の行を指定します。
レンディション:<dRendition1フラグ>: dRendition1のレンディションのタイプを示します。
レンディション:<dRendition2フラグ>: dRendition2のレンディションのタイプを示します。
-
isExtRendition: レンディションが添付かどうかを示します(コア行、つまり、プライマリ、Web、レンディション:<dRendition1フラグ>およびレンディション:<dRendition2フラグ>行では「false」で、それ以外の場合は「true」です)。
-
isAvailable: このフィールドは常に「true」です。
-
isStaticAvailable: このフィールドはコア・レンディションとは関連がありません(isExtRendition = 0の場合、コア行、つまり、プライマリ、Web、レンディション:<dRendition1フラグ>およびレンディション:<dRendition2フラグ>行では「false」です)。このフィールドは、レンディションまたは添付にリストされたレンディションの静的URLが使用可能かどうかをチェックします。レンディションがファイル・システムに存在する場合は「true」で、レンディションがファイル・システムにない場合は「false」です。
-
-
Renditions: この結果セットはincludeFileRenditionsInfo = 1の場合に返されます。アプリケーション開発フレームワーク(ADF) UIにアクセス可能なManifest表およびMediaRenditions表からのデータを含みます。Renditions表には次の列があります。
-
rendName: レンディション名。このフィールドは可能な場合にはローカライズされます。
-
rendDescription: レンディションが定義されている場合、レンディションの説明を提供します。このフィールドは可能な場合にはローカライズされます。ビデオ・レンディションはこのフィールドを使用しません。
-
rendType: レンディションのタイプを指定します。レンディションには次の4つの静的タイプがあります。
プライマリ: チェックイン・ファイル。
Web: Web表示可能ファイル。
dc: ネイティブUIの動的変換(dc)ルールに従います。このフィールドが表示されるようにDynamicConveterを構成します。
video: レンディションは、MediaRenditions表にリストされている場合またはマニフェストのextRenditionTypeと一致する場合はビデオとみなされます。
-
rendUrl: レンディションの絶対URL。
-
rendFormat: レンディションのフォーマット、たとえば、MIMEタイプ。
-
rendFileSize: レンディションのファイル・サイズ。
-
rendImgDimensions: h x w フォーマットのイメージ・レンディションのディメンション。
-
rendImgResolution: nnn dpi フォーマットのイメージ・レンディションの解像度。
-
rendVidFrameRate: nn fps フォーマットのビデオ・レンディションのフレーム・レート。
-
rendVidDuration: 秒単位に四捨五入したビデオ・レンディションの時間の長さ、たとえば、14秒、1分10秒など 。
-
rendVidBitrate: nn bpsフォーマットのビデオ・レンディションのビット・レート。
-
rendParams: ビデオのMediaRenditions.mediaRendParamsフィールドのコピーまたはイメージのmanifest.extRenditionParamsフィールドのコピーを含みます。
ノート:
各レンディションではRenditions表にリストされているすべてのフィールドを使用しない可能性があり、使用されていないレンディションは「該当なし」とマークされます 。
-
-
-
ローカル・データ:
-
Content Server:
-
AuthorAddress
-
dDocFormats
-
dDocTitle
-
dID
-
DocUrl
-
dStatus
-
dSubscriptionAlias
-
dSubscriptionID
-
dSubscriptionType
-
dUser
-
-
アイテムがワークフロー内にある場合:
-
dWfStatus
-
dWfCurrentStepID
-
dWfDocState
-
dWfID
-
dWfName
-
dWfStepDescription
-
dWfStepID
-
dWfStepIsAll
-
dWfStepName
-
dWfStepType
-
dWfStepWeight
-
dWfType
-
IsWorkflow
-
wfStepCheckinType
-
-
-
レスポンス・テンプレート: DOC_INFO (doc_info.htm)
使用
-
リソース・インクルード:
-
email_docinfo_body_by_id
-
email_docinfo_body_by_name
-
setup_workflow_action_popups
-
workflow_action_popup
-
-
テンプレート: PR_PUBLISHER_MAIL (pr_publisher_mail.htm)
-
その他: SoapCustom:Wsdl:DocInfo:Services
DOC_INFO_LATESTRELEASE
リリースされたコンテンツ・アイテムの最新のリビジョンのみの情報を取得するサービス。コンテンツ・アイテムにリリース・バージョンがない場合、このサービスは対応するStatusMessage値とともに、StatusCode -1を返します。DOC_INFO結果セット(リビジョン、ワークフロー、またはサブスクリプション情報なし)のみを返します。テンプレートがないため、生データのみを返します。
最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ: QlatestReleasedIDByName、QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのドキュメント名。
結果
-
ResultSets: DOC_INFO(リリースされた最新リビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
ローカル・データ:
-
AuthorAddress
-
dDocName
-
dID
-
dUser
-
例
IdcService=DOC_INFO_LATESTRELEASE dDocName=PublicDoc1_ia3c488971
DOC_INFO_SIMPLE
ワークフローまたはサブスクリプション情報なしに特定のコンテンツ・アイテムに関する情報を返すサービス。Documents表およびRevisions表からの特定のフィールドの選択肢ではないRevisions表からの行の単純なリストとしてリビジョン情報を返します。これらの相違により、このサービスは標準のDOC_INFOサービスより安価なオペレーションになります。
テンプレートがないため、生データのみを返します。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ: QdocInfo、QdocName
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: コンテンツ・アイテムのコンテンツID。
結果
-
ResultSets:
-
DOC_INFO(特定のリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
DocRevisions(すべての非削除リビジョンのRevisionsからのすべてのフィールド)
-
-
ローカル・データ:
-
AuthorAddress
-
dID
-
dUser
-
DOC_INFO_SIMPLE_BYREV
リビジョン番号に基づいたコンテンツ・アイテムに関する情報を返すサービス。このサービスは、必須パラメータとしてコンテンツID (dDocName)とリビジョン番号(dRevLabel)の組合せを必要とする点が他のサービスと異なります。他のすべてのリビジョン固有のdoc_infoサービスにはdIDが必要です。
このサービスは、DOC_INFO結果セットを返します。DOC_INFO_SIMPLEは、リビジョン情報も返します。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ: QdocRev、QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのドキュメント名。
-
dRevLabel: コンテンツ・アイテムのリビジョン番号。
結果
-
ResultSets:
-
DOC_INFO(特定のリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
-
ローカル・データ:
-
dUser
-
dRevLabel
-
dID
-
AuthorAddress
-
dDocName
-
DOC_SUBS_LIST
特定のサブスクリプションのコンテンツ・アイテムのリストを返すサービス。
条件ベースのサブスクリプションの場合、条件に一致するアイテムを返します。基本サブスクリプションの場合、サブスクリプションIDに一致する名前を持つアイテムを返します。
アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)
実行される問合せ: QuserSubscription
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dSubscriptionID: サブスクリプションID。基本サブスクリプションの場合、これはコンテンツIDです。条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。
たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1が作成者であるパブリック・コンテンツ・アイテムの値はPublic,user1となります。
-
dSubscriptionType: サブスクリプション・タイプ。Basicまたはカスタム名のいずれか。基本サブスクリプションの場合は、基本に設定する必要があります。
オプションのサービス・パラメータ
-
dSubscriptionAlias: エイリアスまたはユーザー名を渡すために使用します。エイリアスに設定される場合、有効なエイリアスを使用する必要があります。 ユーザーに設定される場合、有効なユーザー名が必要です。無効なエイリアスまたはユーザー名が使用されると、エラーが発生します。空のままの場合、デフォルト値はユーザーで、現在のユーザー(dUser)に設定されます。
-
dSubscriptionAliasType: dSubscriptionAliasの値として想定されるサービスを決定します。有効な値はエイリアスまたはユーザーです。
-
unsubscribeService: ユーザーがサブスクライブ解除できるリンクを提供する(このサービスのデフォルト・テンプレートなど)「レスポンス」ページの場合、値はパラメータとして渡される必要があります。省略されると、エラーは表示されませんが、「レスポンス」ページの「サブスクライブ解除」リンクをクリックすると、エラーが生成されます(標準の値はUNSUBSCRIBEである必要があります)。
-
subscribeService: ユーザーがサブスクリプションにサブスクライブされていない場合はサブスクライブするためのリンクが提供される場合を除いて、unubscribeServiceパラメータと同じ(標準の値はSUBSCRIBEである必要があります)。
-
MaxQueryRow: DOCUMENT_LIST結果セットに対して返される行数を切り捨てます。
結果
-
ResultSets:
-
DOCUMENT_LIST: サブスクリプション条件に一致するアイテムのRevisionsおよびDocMetaからのすべてのフィールド。このデータは、ユーザーが指定されたサブスクリプションにサブスクライブされるかどうかにかかわらず返されます。
-
USER_SUBSCRIPTION: 指定されたサブスクリプションをユーザー/エイリアスに割り当てる行のSubscriptionsからのすべてのフィールド。ユーザー/エイリアスが指定されたサブスクリプションにサブスクライブされていない場合、結果セットは空です。
-
-
ローカル・データ:
-
dataSource
-
dSubscriptionAlias
-
dSubscriptionAliasType
-
dSubscriptionID
-
dSubscriptionType
-
dUser
-
MaxQueryRows
-
resultName
-
scpDescription
-
scpEnabled
-
whereClause
-
-
レスポンス・テンプレート: DOC_SUB_LIST (doc_sub_list.htm)
使用
-
アプレット: リポジトリ・マネージャ
-
リソース・インクルード:
-
criteria_subscription_info_image
-
legacy_criteria_subscriptions_table
-
setup_subscription_action_popups
-
subscription_action_popup
-
-
テンプレート:
-
SUBSCRIBE_FORM (subscribe_form.htm)
-
UNSUBSCRIBE_FORM (unsubscribe_form.htm)
-
例
IdcService=DOC_SUBS_LIST dSubscriptionType=my_subscription dSubscriptionID=ADENG
EDIT_DOC_FORMATS
既存のファイル・フォーマットを変更するサービス。このサービスは、コンテンツ・アイテムのフォーマットおよびファイル拡張子情報を更新します。このサービスはInbound Refineryによってブラウザ・インタフェースで実行されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
-
dDescription: フォーマットの説明。
-
dConversion: 変換アルゴリズムは、このパラメータで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。
ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。
-
extensions: doc、txt、pdfなどのファイル拡張子。
例
IdcService=EDIT_DOC_FORMATS dFormat=application/msword extensions=doc dConversion=PASSTHRU dDescription=adding the description
FORM_PROCESS
送信用のPDFフォームを処理するサービス。このサービスは、FORM_SUBMITによりコールされます。自動生成されたClientIdパラメータを使用します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
このサービスはIdcコマンドで実行することはできません。
FORM_SUBMIT
PDFフォームを送信するサービス。このサービスは、送信前にPDFフォームを処理するために、FORM_PROCESSサービスをコールします。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
このサービスはIdcコマンドで実行することはできません。
GET_CACHED_CHECKIN_INFO
CACHE_CHECKIN_NEWなどのキャッシュ・チェックイン用のキャッシュされたデータを表示するために使用されるサービス。このサービスはチェックアウト・コンテンツ・リストから利用できます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
GET_DOC_CONFIG_INFO
Content Server構成情報を返すサービス。サーバー環境フォーム外部アプリケーションのダンプを取得します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
プロパティ情報、セキュリティ・グループ・オプション・リストおよびこれらのResultSetを返します。
-
DOC_DEFAULT_INFO
-
DocMetaDefinition
-
DocTypes
-
DocFormats
例
-
IdcCommandコマンド・ファイル・フォーマット:
#Retrieves content item configuration information IdcServer=GET_DOC_CONFIG_INFO
-
HDA形式:
@Properties LocalData IdcService=GET_DOC_CONFIG_INFO @end
GET_DOC_SUBSCRIBERS
特定のコンテンツ・アイテムへのサブスクライバのリストを返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
例
IdcService=GET_DOC_SUBSCRIBERS dDocName=test_000036
GET_DOCUMENT_HISTORY_REPORT
キャッシュ・サービスおよび他の目的によって使用されるDocumentHistory表における変更を返すサービス。
サービス・クラス: DocService
場所: IdcHomeDir
/resources/core/tables/std_services.htm
オプションのサービス・パラメータ
-
actionDateGreaterThan: DocumentHistory表に対する問合せに使用されるODBCフォーマットのデータ。時間がわずかにずれるクラスタ・サーバーを想定して、2分が自動的にこの日付から減算されます。このパラメータは、デフォルトでは現在の時間の5分前です。
結果
-
ResultSets:
-
HistoryReport: 各行には、ドキュメント履歴イベントに関する情報(名前の変更、更新、移動、削除)が含まれます。
-
例
IdcService=GET_DOCUMENT_HISTORY_REPORT actionDateGreaterThan={ts '2012-11-19 15:58:00.100'}
GET_ENVIRONMENT
Content Server環境の構成値の設定を取得するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
オプションのサービス・パラメータ
-
startTime: インスタンスが起動した時間(ミリ秒単位)。
GET_EXPIRED
期限切れ予定のアイテムおよび期限切れアイテムのリストを取得するために使用されるサービス。オプションのisExpiredQueryパラメータをtrueに設定すると、このサービスはすでに期限切れになったアイテムのみをリストします。
このパラメータがない場合、リストにはendDateおよびstartDateによって指定される日付範囲内に期限切れになるようにスケジュールされるアイテムも含まれます。これには、開始日が現在のシステム時間よりも前の場合にすでに期限切れになっているアイテムが含まれる場合があります。
アクセス・レベル: 読取り、書込み、グローバル(18)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
オプションのサービス・パラメータ
-
endDate: この日付よりも前に期限切れ予定のアイテムが表示されます。
-
isExpiredQuery: このパラメータを1 (true)に設定すると、期限切れのアイテムのみが検索されます。trueに設定され、終了日が指定されない場合、現在のシステム時間がデフォルトの終了日として使用されます。これは、特定の開始日によって制限される場合を除き、すでに期限切れになっているコンテンツをリストします。
-
0 (false)に設定され、開始日が空の場合、現在のシステム時間がデフォルトの開始日として使用されます。これは、指定された終了日によって制限される、将来に期限切れになるコンテンツ・アイテムをリストします。
その他のすべての状況において、空の開始日または終了日は空として処理され、問合せ時に対応する制約が課されることはありません。
-
startDate: この日付よりも後に期限切れ予定のアイテムが表示されます。
結果:
-
結果セット: EXPIRED_LIST(日付およびisExpiredQueryパラメータによって定義される期限切れまたは期限切れ予定のアイテムのRevisionsおよびDocMetaからのすべてのフィールド。)
-
ローカル・データ:
-
dataSource
-
endDate
-
expiredQuery
-
isExpiredQuery
-
isQueryResult
-
MaxQueryRows
-
orderClause
-
resultName
-
startDate
-
userDefinedEndDate
-
userDefinedStartDate
-
whereClause
-
-
レスポンス・テンプレート: EXPIRED_PAGE (expired_page.htm)
使用
-
リソース・インクルード:
-
pne_nav_management_links
-
std_doc_man_pages
-
-
テンプレート: EXPIRED_PAGE (expired_page.htm)
-
標準ナビゲーション: commonNav.js
GET_PACKAGE_ENVIRONMENT_PAGE
環境のパッケージ化を開始するページを取得するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_UPDATE_FORM
既存のコンテンツ・アイテムの情報更新フォームを生成するために使用されるサービス。
最も発生しがちなエラーは、コンテンツ・アイテムの名前がシステムに存在しないことです。
アクセス・レベル: 書込み、スクリプト作成可能(34)
実行される問合せ: QdocInfo
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
結果
-
ResultSets:
-
DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
DocFormats (DocFormatsデータベース表のすべての行およびフィールド)
-
DocTypes (DocTypesデータベース表のすべての行およびフィールド)
-
-
ローカル・データ:
-
dDocAccount
-
dDocName
-
dDocType
-
defaultAccount
-
dID
-
dSecurityGroup
-
dUser
-
-
レスポンス・テンプレート: UPDATE_DOC_INFO (update_docinfo.htm)
例
IdcService=GET_UPDATE_FORM dID=59
NOTIFY_INDEXER
作業が実行されることをインデクサに通知するために使用されるサービス。このサービスは、通常はチェックインがインデクサに通知するか、またはインデクサが独自のタイマーを持っていて、5分ごとに「すべき作業」を確認するため、使用されません。
このサービスは、NO_NOTIFYチェックインが実行されているか、クライアント・アプリケーションが通常の索引作成サイクルを待機しない場合にのみ使用される必要があります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ODMA_DOC_INFO_SIMPLE
指定されたコンテンツ・アイテムに対するコンテンツ情報を取得するためにODMAクライアント・アプリケーションによって使用されるサービス。
このサービスは現在使用されていません。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: アイテム・リビジョンの一意のID。
PACKAGE_ENVIRONMENT
Content Server環境ファイルを含むパッケージ化されたzipファイルを作成するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
REMOVE_METAFILE_SUB
ドキュメント・メタ情報を変更するためにコールされるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
REPLACE_METAFILE_SUB
ドキュメント・メタ情報を置き換えるためにコールされるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
RESTORE_REVISION
新しい(最新)リビジョンとして指定されたdIDに対応するドキュメントのリビジョンをリストアするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
必須のサービス・パラメータ
-
dID: 最新リビジョンとしてリストアするアイテムのドキュメントID。
結果
-
dID: 作成された新しいリビジョンのID。
-
dDocName: 作成された新しいリビジョンのドキュメント名。
-
dDocTitle: 作成された新しいリビジョンのドキュメントのタイトル。
RESUBMIT_FOR_CONVERSION
初期変換試行に失敗した場合に、変換用にコンテンツ・アイテムを再送信するサービス。最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。
このサービスは、成功した変換と失敗した変換を再送信できます。
アクセス・レベル: 書込み(2)
実行される問合せ: QdocInfo、QlatestID、Qdocuments
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
オプションのサービス・パラメータ
-
RedirectUrl: リダイレクトされたサービスに使用されるURL。
-
AlwaysResubmit: 1 (true)に設定されると、このサービスは正常に変換されたアイテムで使用できます。それ以外の場合は、このサービスは失敗した変換でのみ操作を行います。
結果
-
ローカル・データ:
-
dConversion
-
dCurRevID
-
dDocID
-
dExtension
-
dFileSize
-
dFormat
-
dID
-
dOriginalName
-
dProcessingState
-
dPublishState
-
dRawDocID
-
dReleaseState
-
dRevClassID
-
dStatus
-
dWorkflowState
-
IsNotLatestRev
-
isStatusChanged
-
prevReleaseState
-
RedirectParams
-
VaultfilePath
-
WebfilePath
-
wfAction
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: DOC_INFO
-
使用
-
アプレット: リポジトリ・マネージャ
-
リソース・インクルード:
-
classic_info_page_content
-
docinfo_resubmit_option
-
std_docinfo_error_msg
-
例
IdcService=RESUBMIT_FOR_CONVERSION dID=62
REV_HISTORY
コンテンツ・アイテムのリビジョンに対するリビジョン履歴を返すサービス。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ: QdocInfo、QrevHistoryReleased
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
結果
-
ResultSets:
-
DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
REVISIONS(次のフィールドを含むすべてのアイテムのリリース済リビジョンをリストする行: dDocAccount、dDocName、dDocType、dFormat, dID、dInDate、dProcessingState、dReleaseState、dRevLabel、dRevisionID、dSecurityGroup、dStatus、dWebExtension)
-
-
ローカル・データ: dID
-
レスポンス・テンプレート: REV_HISTORY (rev_history.htm)
使用
-
リソース・インクルード:
-
classic_search_result_item_revision
-
searchapi_result_table_content_end
-
例
IdcService=REV_HISTORY dID=62
SELECTDOC
コンテンツ・アイテム情報を返し、ODMAを使用してコンテンツ・アイテムを選択するときにユーザーのセキュリティ・レベルを評価するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
例
IdcService=SELECTDOC dID=62
SUBMIT_HTML_FORM
処理のためにHCSPまたはHCSFフォームを送信するサービス。これらはHTMLベースのビジネス・フォームを処理するために使用される動的サーバー・ページです。このサービスはintradoc.server.FormHandler.retrieveHtmlFormState()メソッドからJavaコードでコールされる、GET_FILEサブサービスをコールします。
通常、HTMLフォームを送信するために、自動コンテンツID機能が有効にされています。有効ではない場合、送信されたフォームごとに一意のコンテンツIDを割り当てる必要があります。
最も発生しがちなエラーは、HTMLフォームが存在しないことです。
アクセス・レベル: 書込み(2)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。指定されたリビジョンはHTMLフォームである必要があります。
オプションのサービス・パラメータ
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
-
isFormFinished: HCSPファイルで使用。これが1 (true)に設定される場合、HCSPを再送信できません。
-
テキスト・フィールド: フォームのテキスト・フィールドをオプション・パラメータとして送信し、そのフィールドに値を渡すことができます。フォームがProductと呼ばれるテキスト・フィールドを持つ場合、文字列値publisherをそのフィールド(
Product=publisher
)に割り当てることができます。
結果
-
ResultSets:
-
DocTypes
-
DocFormats
-
-
ローカル・データ:
-
dDocTitle
-
dID
-
-
レスポンス・テンプレート:
-
null
-
デフォルトのリダイレクト・サーバー(GET_DOC_PAGE: HOME_PAGE)
-
使用
-
リソース・インクルード: std_html_form_submit_start
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=SUBMIT_HTML_FORM dID=44
-
オプションのパラメータを持つHDA形式(値をテキスト・フィールドに割り当てます)。
@Properties LocalData IdcService=SUBMIT_HTML_FORM dID=44 Product=publisher @end
SUBSCRIBE
コンテンツ・アイテムまたはアイテムのグループにユーザーをサブスクライブするサービス。最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。サブスクリプションを作成するために、認証が必要であることに注意してください。
アクセス・レベル: 読取り(1)
実行される問合せ:
-
QdocInfo
-
QuserSubscription
-
Quser
-
UuserEmail
-
Isubscription
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dSubscriptionEmail: サブスクリプションの電子メール・アドレス。このサービスは、ユーザー・プロファイルでユーザーの電子メールをオーバーライドするための値を使用します。値がこのパラメータに対して渡されない場合、プロファイルは更新されません。本質的に、このサービスが実行されるたびに、ユーザーの電子メール・アドレスが更新されます。
-
dSubscriptionType: サブスクリプションのタイプ。オプションでカスタム・サブスクリプションの名前を提供できます。このパラメータが使用される場合、このサービスは指定されたカスタム・サブスクリプションの条件フィールドがdIDパラメータから指定されたアイテムの対応するメタデータの値に一致する条件ベースのサブスクリプションにユーザーをサブスクライブします。dSubscriptionTypeが空白のままの場合、「基本」サブスクリプションがデフォルトで使用されます。
オプションのサービス・パラメータ
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
結果
-
ローカル・データ:
-
dID
-
dName
-
dSubscriptionAlias
-
dSubscriptionAliasType
-
dSubscriptionCreateDate
-
dSubscriptionID
-
dSubscriptionType
-
dUser
-
-
レスポンス・テンプレート:
-
DOC_INFO
-
デフォルトのリダイレクト・サービス: DOC_INFO
-
使用
-
リソース・インクルード:
-
docinfo_subscription_form
-
doc_subscription_unsubscription
-
-
その他: SoapCustom:Wsdl:Subscription:Services
例
これらのパラメータは、このコマンドを実行するために、ブラウザ環境で渡されます。
<input type=hidden name=IdcService value="SUBSCRIBE"> <input type=hidden name=dID value="63"> <input type=hidden name=dSubscriptionType value=my_subscription> <input type=hidden name=dSubscriptionEmail value=sysadmin@example.com>
SUBSCRIBE_DOC_USER
ユーザーがコンテンツ・アイテムをサブスクライブする(サブスクリプション・ページを構築する)際にブラウザ環境で使用されるサービス。
このサービスは、ユーザーがドキュメントをサブスクライブする(検索を実行し、「サブスクライブ」をクリックする)と実行されます。システムに複数のサブスクリプション・タイプがある場合、ユーザーは異なる条件をサブスクライブできる「サブスクリプション」ページにリダイレクトされます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
ノート:
ユーザーがコンテンツ・アイテムをサブスクライブする際に追加のパラメータが渡されます(次の例を参照してください)。
例
これらのパラメータは、このコマンドを実行するために、ブラウザ環境で渡されます。
<form name=SubscriptionForm action="/cs/idcplg"method="GET""> <input type=hidden name=dID value="63"> <input type=hidden name=dDocName value="test_000045"> <input type=hidden name=IdcService value="SUBSCRIBE_DOC_USER"> <input type=hidden name=subscribeService value=SUBSCRIBE> <input type=hidden name=exitUrl value="/cs/idcplg?IdcService=DOC_INFO&dID=63&dDocName=test_000045"> <input type=hidden name=title value="Subscriptions"> <input type=hidden name=unsubscribeService value=UNSUBSCRIBE> <input type=submit value="Subscriptions"> </form>
SUBSCRIBE_EX
サブスクリプションにユーザーまたはエイリアスを追加するためにリポジトリ・マネージャで使用されるサービス。このタイプをサブスクライブしたユーザーおよびエイリアスのリストを返します。最も発生しがちなエラーは、指定されたサブスクリプションのエイリアス・タイプまたはサブスクリプションのエイリアスが存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dSubscriptionAlias: サブスクリプションのエイリアス。
-
dSubscriptionAliasType: ユーザーのタイプ。この値はuserまたはaliasを指定できます。この値はdSubscriptionAliasで定義された値を参照します。
-
dSubscriptionEmail: サブスクリプションの電子メール・アドレス。
-
dSubscriptionID: サブスクリプションID。
-
基本サブスクリプションの場合、これはコンテンツIDです。
-
条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。
-
たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ値は Public,user1となります。
-
dSubscriptionType: アプレットで定義されているサブスクリプション・タイプの名前。サブスクリプション・タイプはフィールドのリストで構成されます。サブスクリプション・タイプをサブスクライブする場合、ユーザーはサブスクリプション・タイプを構成する各フィールドの値を指定する必要があります。
オプションのサービス・パラメータ
サブスクライブしているユーザーに関する情報を返すには、このサービスには次のパラメータが必要です。
-
dataSource: データソース。
-
resultName: ResultSet名。
-
whereClause: プログラム句。
例
IdcService=SUBSCRIBE_EX dSubscriptionID=user20 dSubscriptionAlias=sysadmin dSubscriptionAliasType=user dSubscriptionType=test dSubscriptionEmail=user20@example.com resultName=USER_LIST dataSource=Subscriptions whereClause=dSubscriptionType='test'
SUBSCRIBE_FORM
コンテンツ・アイテム・サブスクリプションに使用されるサブスクリプション・フォームを取得するサービス。
このサービスは、それが返すテンプレートを除いて、UNSUBSCRIBE_FORMサービスと同じです。
アクセス・レベル: 読取り(1)
実行される問合せ: QdocInfo, QSubscribed
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
unsubscribeService: ユーザーがサブスクライブ解除できるリンクを提供する(このサービスのデフォルト・テンプレートなど)「レスポンス」ページの場合、値はパラメータとして渡される必要があります。省略されると、エラーは表示されませんが、「レスポンス」ページの「サブスクライブ解除」リンクをクリックすると、エラーが生成されます(標準の値はUNSUBSCRIBEである必要があります)。
-
subscribeService: ユーザーがサブスクリプションにサブスクライブされていない場合はサブスクライブするためのリンクが提供される場合を除いて、unubscribeServiceパラメータと同じ(標準の値はSUBSCRIBEである必要があります)。
結果
-
ResultSets:
-
DOC_INFO (dIDで指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
SUBSCRIPTION_LIST (Subscription表からのすべてのフィールドおよびすべての定義されたサブスクリプションの追加フィールド(scpFields、scpDescription、scpEnabledおよびnotSubscribed))
-
-
ローカル・データ:
-
dID
-
dSubscriptionAlias
-
dSubscriptionID
-
dSubscriptionType
-
dUser
-
-
レスポンス・テンプレート: SUBSCRIBE_FORM (subscribe_form.htm)
使用
-
リソース・インクルード:
-
docinfo_subscription_form
-
doc_subscription_unsubscription
-
SUBSCRIPTION_LIST
特定のユーザーのためのすべてのサブスクライブ済コンテンツ・アイテムのリストを返すサービス。
ユーザーがサブスクリプションを持つエイリアスに属している場合にも、このサービスによってエイリアス・ベースのサブスクリプションは返されません。
アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)
実行される問合せ: QdocNameSubscription、QnotDocNameSubscriptions
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dUser: 現在ログインしているユーザーのユーザー名。
結果
-
ResultSets: SUBSCRIPTION_LIST(各行には、各現在のユーザーのサブスクリプションに対応するSubscription表からのすべてのフィールドが含まれます。また、基本サブスクリプションの場合、各行には、サブスクライブされたアイテムの最新リビジョンのSubscription表(メタデータ)からのすべてのフィールドが含まれます。)
-
ローカル・データ: dUser
-
レスポンス・テンプレート: SUBSCRIPTION_LIST (subscription_list.htm)
使用
-
リソース・インクルード: pne_nav_userprofile_links
-
テンプレート:
-
DOC_SUB_LIST (doc_sub_list.htm)
-
USER_INFO (user_info.htm)
-
-
標準ナビゲーション: commonNav.js
-
その他:
-
SoapCustom:Wsdl:Subscription:Services
-
SoapCustom:Wsdl:Subscription:Service:SubscriptionList:ResponseParams
-
リダイレクト・サービスの対象: UNSUBSCRIBE_FROM_LIST
-
例
IdcService=SUBSCRIPTION_LIST dUser=sysadmin
UNDO_CHECKOUT
ブラウザからコンテンツ・アイテムのチェックアウトを基に戻すサービス。コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがチェックアウトされていない場合、またはチェックアウトを元に戻すのに十分な権限がユーザーにない場合、サービスは失敗します。
アクセス・レベル: 書込み(2)
-
実行される問合せ:
-
QdocID
-
Qrevisions
-
QdocInfo
-
IdocHistory
-
QdocWebFormat
-
Uuncheckout
-
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
オプションのサービス・パラメータ
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
結果
-
ローカル・データ:
-
CurRevCheckoutUser
-
CurRevID
-
CurRevIsCheckedOut
-
dAction
-
dCheckoutUser
-
dClbraName
-
dDocAccount
-
dDocName
-
dID
-
dIsCheckedOut
-
dReleaseState
-
dRevClassID
-
dRevLabel
-
dSecurityGroup
-
dStatus
-
dUser
-
isFinished
-
IsWorkflow
-
latestID
-
noDocLock
-
prevReleaseState
-
wfAction
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: GET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)
-
使用
-
アプレット:
-
リポジトリ・マネージャ
-
ワークフロー
-
-
リソース・インクルード:
-
checkin_list_action_popup
-
doc_file_checkout
-
docinfo_undo_checkout_form
-
setup_checked_out_content_action_popups
-
setup_workflow_action_popups
-
wf_reviewer_doc_action_links
-
workflow_action_popup
-
-
テンプレート: WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
-
その他: SoapCustom:Wsdl:CheckIn:Services
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UNDO_CHECKOUT dID=44
-
HDA形式:
@Properties LocalData IdcService=UNDO_CHECKOUT dID=44 @end
UNDO_CHECKOUT_BY_NAME
アプレットまたはアプリケーションからコンテンツ・アイテムのチェックアウトを元に戻すサービス。コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがチェックアウトされていない場合、またはチェックアウトを元に戻すのに十分な権限がユーザーにない場合、サービスは失敗します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
オプションのサービス・パラメータ
-
dDocTitle: コンテンツ・アイテムのタイトル。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UNDO_CHECKOUT_BY_NAME dDocName=myDocument
-
任意のパラメータを持つHDA形式:
@Properties LocalData IdcService=UNDO_CHECKOUT_BY_NAME dDocName=myDocument dDocTitle=Just a title @end
UNSUBSCRIBE
基本サブスクリプションが定義されている場合にのみコンテンツ・アイテムのサブスクリプションを取り消すサービス。このサービスは、「コンテンツ情報」ページの「サブスクライブ解除」ボタンをクリックすることにより実行されます。
このサービスは、主にそれが返すデータ内容においてUNSUBSCRIBE_FROM_LISTサービスとは異なります。UNSUBSCRIBEは、dIDで指定されたアイテムのコンテンツ情報をロードするように、デフォルトで「コンテンツ情報」ページにリダイレクトします。UNSUBSCRIBE_FROM_LISTは、ユーザーのサブスクリプションを表示するために必要なデータをロードするように、デフォルトでサブスクリプション・リストのページにリダイレクトします。
アクセス・レベル: 読取り(1)
実行される問合せ: QdocInfo、Dsubscription
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dSubscriptionID: サブスクリプションID。
-
基本サブスクリプションの場合、これはコンテンツIDです。
-
条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。
-
たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。
-
dSubscriptionType: サブスクリプションのタイプ。
オプションのサービス・パラメータ
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
-
dSubscriptionAlias: 条件サブスクリプションのユーザーまたはエイリアス(dSubscriptionAliasTypeの値によって、有効なユーザー名またはエイリアスに設定されます)。
-
dSubscriptionAliasType: サブスクリプション・タイプのエイリアス。有効な値はuserまたはaliasです。
現在のユーザーに管理者権限がある場合は、dSubscriptionAliasTypeとともにdSubscriptionAliasパラメータを使用して、サブスクリプションから別のユーザーまたはエイリアスをサブスクライブ解除できます。これらのパラメータが省略される場合、このサービスはデフォルトでuserのdSubscriptionAliasTypeに設定され、dSubscriptionAliasの値に現在のユーザー(dUser)を使用します。これらのパラメータが含まれるが、現在のユーザーに管理者権限がない場合、これらは無視されます。
結果
-
ローカル・データ:
-
dCheckoutUser
-
dDocAccount
-
dDocName
-
dID
-
dRevClassID
-
dSecurityGroup
-
dUser
-
-
レスポンス・テンプレート:
-
DOC_INFO
-
デフォルトのリダイレクト・サービス: DOC_INFO
-
使用
-
リソース・インクルード:
-
docinfo_subscription_form
-
doc_subscription_unsubscription
-
-
その他: SoapCustom:Wsdl:Subscription:Services
例
IdcService=UNSUBSCRIBE dID=66 dSubscriptionType=test dSubscriptionID=test_000048
UNSUBSCRIBE_FORM
コンテンツ・アイテムからサブスクライブ解除する場合に使用されるフォームを取得するサービス。
このサービスは、それが返すテンプレートを除いて、SUBSCRIBE_FORMサービスと同じです。
アクセス・レベル: 読取り(1)
実行される問合せ: QdocInfo、QisSubscribed
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
subscribeService: ユーザーにサブスクライブ解除できるリンクを提供する(このサービスのデフォルト・テンプレートなど)「レスポンス」ページの場合、値はパラメータとして渡される必要があります。省略されると、エラーは表示されませんが、「レスポンス」ページの「サブスクライブ解除」リンクをクリックすると、エラーが生成されます(標準の値はUNSUBSCRIBEである必要があります)。
結果
-
ResultSets:
-
DOC_INFO (dIDで指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
-
SUBSCRIPTION_LIST (Subscription表からのすべてのフィールドおよびすべての定義されたサブスクリプションの追加フィールド(scpFields、scpDescription、scpEnabledおよびnotSubscribed))
-
-
ローカル・データ:
-
dID
-
dSubscriptionAlias
-
dSubscriptionID
-
dSubscriptionType
-
dUser
-
-
レスポンス・テンプレート: UNSUBSCRIBE_FORM (unsubscribe_form.htm)
使用
-
リソース・インクルード:
-
docinfo_subscription_form
-
doc_subscription_unsubscription
-
UNSUBSCRIBE_FROM_LIST
複数のサブスクリプションが定義されている場合に、ブラウザからコンテンツ・アイテムのサブスクリプションを取り消すサービス。
このサービスは、「サブスクライブ解除」リンクをクリックするか、そのコンテンツ・アイテムの「サブスクリプション情報」リンクをクリックしてから「サブスクリプション情報」ページの「サブスクライブ解除」をクリックすることにより、「サブスクリプション」ページから実行されます。
このサービスは、主にそれが返すデータ内容においてUNSUBSCRIBEサービスとは異なります。UNSUBSCRIBE_FROM_LISTは、ユーザーのサブスクリプションを表示するために必要なデータをロードするように、デフォルトでサブスクリプション・リストのページにリダイレクトします。UNSUBSCRIBEは、dIDで指定されたアイテムのコンテンツ情報をロードするように、デフォルトで「コンテンツ情報」ページにリダイレクトします。
アクセス・レベル: 読取り、グローバル(17)
実行される問合せ:
-
Dsubscription
-
QdocNameSubscription
-
QnotDocNameSubscriptions
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dSubscriptionID: サブスクリプションID。基本サブスクリプションの場合、これはコンテンツIDです。条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。
たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。
-
dSubscriptionType: サブスクリプションのタイプ。
-
オプションのサービス・パラメータ
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
-
dSubscriptionAlias: dSubscriptionAliasTypeの値によって、有効なユーザー名またはエイリアスに設定される、条件サブスクリプションのユーザーエイリアス。
-
dSubscriptionAliasType: userまたはaliasに設定される、サブスクリプション・タイプのエイリアス。
-
現在のユーザーに管理者権限がある場合は、dSubscriptionAliasTypeとともにdSubscriptionAliasパラメータを使用して、サブスクリプションから別のユーザーまたはエイリアスをサブスクライブ解除できます。これらのパラメータが省略される場合、このサービスはデフォルトでuserのdSubscriptionAliasTypeに設定され、dSubscriptionAliasの値に現在のユーザー(dUser)を使用します。これらのパラメータが含まれるが、現在のユーザーに管理者権限がない場合、これらは無視されます。
結果
-
ResultSet: SUBSCRIPTION_LIST。各行には、各現在のユーザーのサブスクリプションに対応するSubscription表からのすべてのフィールドが含まれます。また、基本サブスクリプションの場合、各行には、サブスクライブされたアイテムの最新リビジョンのSubscription表(メタデータ)からのすべてのフィールドが含まれます。
-
ローカル・データ:
-
dID
-
dSubscriptionAlias
-
dSubscriptionAliasType
-
dUser
-
-
レスポンス・テンプレート:
-
SUBSCRIPTION_LIST
-
デフォルトのリダイレクト・サービス: SUBSCRIPTION_LIST
-
使用
-
アプレット: リポジトリ・マネージャ
-
リソース・インクルード: pne_nav_userprofile_links
-
テンプレート:
-
DOC_SUB_LIST (doc_sub_list.htm)
-
USER_INFO (user_info.htm)
-
-
標準ナビゲーション: commonNav.js
例
IdcService=UNSUBSCRIBE_FROM_LIST dSubscriptionType=test dSubscriptionID=test_000046
UNSUBSCRIBE_FROM_LIST_EX
サブスクリプション・タイプからユーザーまたはエイリアスを削除するために「リポジトリ・マネージャ」アプレットで使用されるサービス。ユーザーまたはエイリアスの追加の詳細は、「SUBSCRIBE_EX」を参照してください。
このサービスは通常、「リポジトリ・マネージャ」アプレットのサブスクリプションからユーザーを削除することにより実行されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dSubscriptionAlias: アプレットで定義されているサブスクリプション・タイプの名前。
-
dSubscriptionAliasType: ユーザーのタイプ。この値はuserまたはaliasを指定できます。この値はdSubscriptionAliasで定義された値を参照します。
-
dSubscriptionID: サブスクリプションID。
-
基本サブスクリプションの場合、これはコンテンツIDです。
-
条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。
-
たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。
-
dSubscriptionType: サブスクリプションのタイプ。
オプションのサービス・パラメータ
サブスクライブしているユーザーに関する情報を返すには、このサービスには次のパラメータが必要です。
-
dataSource: データソース。
-
resultName: ResultSet名。
-
whereClause: プログラム句。
例
sysadminによってチェックインされるコンテンツからuser20をサブスクライブ解除します。
IdcService=UNSUBSCRIBE_FROM_LIST_EX dSubscriptionID=sysadmin dSubscriptionAlias=user20 dSubscriptionAliasType=user dSubscriptionType=test dSubscriptionEmail=sysadmin@example.com resultName=USER_LIST dataSource=Subscriptions whereClause=dSubscriptionType='test'
UPDATE_BYREV
特定のパラメータに基づいてコンテンツ・アイテムをチェックインするために使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
UPDATE_DOCINFO
アプレットまたはアプリケーションからコンテンツ・アイテムのメタデータを更新するサービス。このサービスは、リポジトリ・マネージャによって使用され、UPDATE_DOCINFO_SUBサブサービスを実行します。
このサービスは、テンプレートを表示するためにリダイレクトするオプションを提供する、UPDATE_DOCINFO_BYFORMサービスとは異なります。UPDATE_DOCINFOは表示オプションを提供しません。
アクセス・レベル: 書込み(2)
サブサービスのコール:
-
UPDATE_DOCINFO_SUB。このサブサービスでは、REMOVE_METAFILE_SUB、REPLACE_METAFILE_SUBおよびUPDATE_DOCINFO_STATUSをコールすることも可能です。
実行される問合せ(サブサービス内で実行されるすべての問合せ):
-
QdocInfo
-
QlatestID
-
Qdocuments
-
Ddocument
-
Idocument
-
Urevision2
-
Umeta
-
IdocHistory
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。
-
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
オプションのサービス・パラメータ
-
メタデータ・フィールド: メタデータ・フィールドをオプション・パラメータとして送信し、そのフィールドに値を渡すことができます。
-
SkipIndexingForUpdate: trueに設定されると、コンテンツ・アイテムは更新の一環として索引付けされません。(アイテムが更新後に再度索引付けされる通常の動作。)いずれの場合も、コンテンツ・アイテムは全索引の再構築において、索引付けされません。
結果
-
ローカル・データ:
-
Content Server:
-
dAction
-
dActionDate
-
dClbraName
-
dCreateDate
-
dDocAccount
-
dDocType
-
dDocName
-
dExtension
-
dID
-
dOriginalName
-
dOutDate
-
dpAction
-
dpEvent
-
dPublishState
-
dPublishType
-
dReleaseState
-
dRevClassID
-
dRevLabel
-
dSecurityGroup
-
dStatus
-
dUser
-
isCurRevEmpty
-
isDocProfileUsed
-
isEditMode
-
IsNotLatestRev
-
IsUpdate
-
IsUpdateMetaOnly
-
prevReleaseState
-
updateSideEffectServices
-
-
ワークフロー:
-
dCurRevID
-
dWfComputed
-
dWfCurrentStepID
-
dWfDirectory
-
dWfDocState
-
dWfID
-
dWfName
-
dWfStatus
-
dWfStepDescription
-
dWfStepID
-
dWfStepIsAll
-
dWfStepName
-
dWfStepType
-
dWfStepWeight
-
dWfType
-
dWorkflowState
-
IsWorkflow
-
wfAction
-
wfCurrentStepPrefix
-
wfEditFinished
-
wfMessage
-
wfQueueActionState
-
wfStepCheckinType
-
-
およびすべてのカスタム・ドキュメント・メタフィールド
-
-
レスポンス・テンプレート: null
使用
-
アプレット: リポジトリ・マネージャ
-
その他: SoapCustom:Wsdl:CheckIn:Services
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UPDATE_DOCINFO dID=66 dDocName=test_000048 dSecurityGroup=Secure dRevLabel=2
-
追加およびオプションのパラメータを持つHDA形式(値をメタデータ・フィールドに割り当てます)。
@Properties LocalData IdcService=UPDATE_DOCINFO dID=66 dDocName=test_000048 dSecurityGroup=Secure dRevLabel=2 dDocAccount=mainaccount xComments=Preliminary @end
UPDATE_DOCINFO_BYFORM
ブラウザからコンテンツ・アイテムのコンテンツ情報を更新するサービス。このサービスはUPDATE_DOCINFO_SUBサブサービスを実行します。このサブサービスはコンテンツ・アイテム情報を更新します。
このサービスとUPDATE_DOCINFO間の相違は、このサービスはテンプレートを表示するためにリダイレクトするオプションを提供することです。
アクセス・レベル: 書込み(2)
サブサービスのコール:
-
UPDATE_DOCINFO_SUBは、REMOVE_METAFILE_SUB、REPLACE_METAFILE_SUBおよびUPDATE_DOCINFO_STATUSもコールできます。
実行される問合せ(サブサービス内で実行されるすべての問合せ):
-
QdocInfo
-
QlatestID
-
Qdocuments
-
Ddocument
-
Idocument
-
Urevision2
-
Umeta
-
IdocHistory
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。
-
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
-
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
オプションのサービス・パラメータ
-
メタデータ・フィールド: メタデータ・フィールドをオプション・パラメータとして送信し、そのフィールドに値を渡すことができます。たとえば、システムがxCommentsと呼ばれるメタデータ・フィールドを持つ場合、文字列値Preliminaryをそのフィールド(
xComments=Preliminary
)に割り当てることができます。 -
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
結果
-
ローカル・データ:
-
Content Server:
-
dAction
-
dActionDate
-
dClbraName
-
dCreateDate
-
dDocAccount
-
dDocName
-
dDocType
-
dExtension
-
dID
-
dOriginalName
-
dOutDate
-
dpAction
-
dpEvent
-
dPublishState
-
dPublishType
-
dReleaseState
-
dRevClassID
-
dRevLabel
-
dSecurityGroup
-
dStatus
-
dUser
-
isCurRevEmpty
-
isDocProfileUsed
-
isEditMode
-
IsNotLatestRev
-
IsUpdate
-
IsUpdateMetaOnly
-
prevReleaseState
-
updateSideEffectServices
-
-
ワークフロー:
-
dCurRevID
-
dWfComputed
-
dWfCurrentStepID
-
dWfDirectory
-
dWfDocState
-
dWfID
-
dWfName
-
dWfStatus
-
dWfStepDescription
-
dWfStepID
-
dWfStepIsAll
-
dWfStepName
-
dWfStepType
-
dWfStepWeight
-
dWfType
-
dWorkflowState
-
IsWorkflow
-
wfAction
-
wfCurrentStepPrefix
-
wfEditFinished
-
wfMessage
-
wfQueueActionState
-
wfStepCheckinType
-
-
およびすべてのカスタム・ドキュメント・メタフィールド
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: DOC_INFO
-
使用
-
リソース・インクルード: std_doc_page_definitions
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UPDATE_DOCINFO_BYFORM dID=66 dSecurityGroup=Secure dDocName=test_000048 dRevLabel=2
-
追加およびオプションのパラメータを持つHDA形式(値をメタデータ・フィールドに割り当てます)。
@Properties LocalData IdcService=UPDATE_DOCINFO_BYFORM dID=66 dSecurityGroup=Secure dDocName=test_000048 dRevLabel=2 dDocAccount=mainaccount xComments=Preliminary @end
UPDATE_SUBSCRIPTION_NOTIFY
コアContent Serverソフトウェアで現在は使用されていません。
通知タイムスタンプを更新し、ユーザーをRedirectUrlパラメータで指定されたページにリダイレクトするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
UPDATE_SUBSCRIPTION_TYPE
「条件」サブスクリプションを更新するサービス。最も発生しがちなエラーは、指定されたサブスクリプション・タイプが存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
scpType: サブスクリプションのタイプ。
オプションのサービス・パラメータ
-
scpDescription: サブスクリプションの説明。
-
scpEnabled:
-
1 (true): サブスクリプション通知が有効になっています。
-
0 (false): サブスクリプション通知が無効になっています。
-
-
scpFields: サブスクリプション条件を定義するメタデータ・フィールドのカンマ区切りのリスト。たとえば:
dDocAuthor,dDocType
。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UPDATE_SUBSCRIPTION_TYPE scpType=my_subscription
-
HDAファイル・フォーマット(作成者のサブスクリプションを変更し、そのサブスクリプションを無効にします)。
@Properties LocalData IdcService=UPDATE_SUBSCRIPTION_TYPE scpType=my_subscription scpFields=dDocAuthor scpDescription=updating subscription scpEnabled=false @end
UPDATE_SUBSCRIPTION_USED
サブスクリプション通知からコンテンツ・アイテムにアクセスする場合にユーザーのサブスクリプション・レコードを更新するサービス。このサービスは、Subscriptionデータベース表のdSubscriptionUsedDate列のデータを更新します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dSubscriptionAlias: 条件サブスクリプションのユーザーのエイリアス。
-
dSubscriptionAliasType: エイリアスのサブスクリプション・タイプ。
-
dSubscriptionID: サブスクリプションID。
-
基本サブスクリプションの場合、これはコンテンツIDです。
-
条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。
-
たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。
-
dSubscriptionType: サブスクリプションのタイプ。
例
IdcService=UPDATE_SUBSCRIPTION_USED dSubscriptionType=test_subscription dSubscriptionID=sysadmin dDocName=test_000056 dSubscriptionAlias=global dSubscriptionAliasType=user
VALIDATE_DOCINFO
ヘビー・クライアントのメタデータ専用チェックインに使用されるサービス(InternalUpload = 1)。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
WORK_IN_PROGRESS
GENWWWまたはDONEステータスのすべてのコンテンツ・アイテムのリストを返すサービス。現在ワークフロー内のアイテムは表示されません。
アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
オプションのサービス・パラメータ
-
orderClause: リストのソート先にフィールド名を提供するために使用されます。
-
MaxQueryRows: リストに返されるアイテム数を制御するために使用します。
結果
-
ResultSets: DOC_LIST (RevisionsおよびDocMetaからのすべてのフィールド)
-
ローカル・データ:
-
copyAborted
-
dataSource
-
MaxQueryRows
-
-
レスポンス・テンプレート: WIPS (wips_list.htm)
使用
-
リソース・インクルード:
-
pne_nav_management_links
-
std_doc_man_pages
-
-
標準ナビゲーション:
-
commonBundle.js
-
commonNav.js
-
ドキュメント・プロファイル・サービス(コアContent Server)
次のサービスは、ドキュメント・プロファイルを作成、維持または削除する際に使用されます。
ADD_DOCPROFILE
ドキュメント・プロファイルを追加するために使用されるサービス。このサービスは、コンテンツ・プロファイル・リストにプロファイルと説明を追加し、渡されるデータからプロファイル定義ファイルを生成します。
ノート:
このサービスに提供されるデータはプロファイル定義になります。プロファイルを編集する(EDIT_DOCPROFILEを使用する)際には、最初にGET_DOCPROFILEを使用してプロファイル定義を参照してから目的の値を追加または変更する必要があります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpName: プロファイルの名前。この名前は一意である必要があります。
-
dpDescription: 新しいプロファイルの説明。
-
dpTriggerValue: プロファイルに関連付けられたトリガー値。
-
dpDisplayLabel: プロファイルの表示ラベル。
オプションのサービス・パラメータ
-
isValidateTrigger: trueに設定すると、トリガー値が存在することを検証します。値が存在しない場合、サービスは失敗します。falseに設定すると、トリガーを検証せずにプロファイルが追加されます。
ADD_DOCRULE
新しいコンテンツ・プロファイル・ルールを作成するために使用されるサービス。このサービスは、コンテンツ・ルール・リストへルールを追加し、ルール定義ファイルを作成します。このサービスに提供されるデータはルール定義になります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpRuleName: 新しいルールの名前。この名前は一意である必要があります。
-
dpRuleDescription: ルールの説明。
DELETE_DOCPROFILE
プロファイル・リストからドキュメント・プロファイルを削除し、コンテンツ・プロファイル定義ファイルを削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpName: プロファイルの名前。
DELETE_DOCRULE
ルール・リストからコンテンツ・ルールを削除し、システムからコンテンツ・ルール定義ファイルを削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpRuleName: ルールの名前。
DOCPROFILE_PREVIEW
コンテンツ・プロファイルの使用をシミュレートするために、「構成マネージャ」アプレットで使用されるサービス。プレビューは必要なコンテキストで実行され、データ・バインダに結果データを返します。コンテキストはイベント(送信、リクエストまたはインポート)およびアクション(検索、チェックインなど)で構成されます。必要に応じて、ユーザー名およびコンテンツ・アイテムも含まれます。データには、各フィールドの表示情報および各フィールドの表示を決定したルールが含まれます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpName: プレビューで使用されるルールの名前。
-
dpTriggerValue: プレビューに使用するトリガー値。
EDIT_DOCPROFILE
ドキュメント・プロファイルを編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpName: 編集されるプロファイルの名前。
-
dpDescription: プロファイルの新しい説明。
-
dpTriggerValue: プロファイルの新しいトリガー値。
-
dpDisplayLabel: 新しい表示ラベル。
EDIT_DOCPROFILE_TRIGGER
コンテンツ・プロファイルのトリガー・フィールドとして使用されるメタデータ・フィールドを変更するサービス。
ノート:
メタデータ・フィールドを変更すると、すべての既存のプロファイルが無効になる可能性があります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpName: 編集されるプロファイルの名前。
-
dpTriggerField: プロファイルに使用される新しいトリガー・フィールド。トリガーを空(
dpTriggerfield=
)に変更すると、すべてのプロファイルが無効になります。
EDIT_DOCRULE
ドキュメント・ルールの説明を変更するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpRuleName: 編集されるルールの名前。
-
dpRuleDescription: ルールの新しい説明。
GET_DOCPROFILE
指定されたルールのプロファイル定義ファイルを返すサービス。返されたデータは、データ・バインダ内にあり、プロファイルを定義するために使用されるすべての情報が含まれます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dpName: 使用されるプロファイルの名前。
GET_DOCPROFILES
コンテンツ・プロファイルのリスト・ファイルを返すサービス。リスト・ファイルには、各プロファイルの名前、説明、トリガー値および表示ラベルが含まれます。
場所: IdcHomeDir/resources/core/tables/std_services.htm
GET_DOCRULE
指定されたルールのルール定義ファイルを返すサービス。返されたデータは、データ・バインダに戻され、ルールを定義するために使用されるすべての情報が含まれます。
場所: IdcHomeDir
/resources/core/tables/std_services.ht
m
追加の必須サービス・パラメータ
-
dpRuleName: 使用されるプロファイルの名前。
Elasticsearchサービス(コアContent Server)
Elasticsearchサービスは次のとおりです:
ES_GET_CONFIG_STATUS
このサービスは、Elasticsearchサーバーの現在の構成を表示したり、その詳細を提供するように設計されています。
場所: IdcHomeDir/components/ElasticSearch/resources/elasticsearch_service.htm
ES_UPDATE_CONFIG_STATUS
追加の必須サービス・パラメータ
このサービスは、Elasticsearchサーバーの構成を更新または変更するように設計されています。
-
ES_CONNECTION_STRINGS: クラスタのElasticsearchマスター候補ノードのカンマ区切りリスト。
-
ES_CONNECTION_USERNAME: Elasticsearchに接続するユーザー名。
-
ES_CONNECTION_PASSWORD: ユーザー・パスワード
-
ES_SECURED_CERT_PATH: クラスタの保護に使用する証明書の絶対パス。
-
ES_SECURED_CERT_PASSWORD: 証明書パスワード。
ES_SEARCH_INDEX_MIGRATION
追加の必須サービス・パラメータ
このサービスは、検索索引のElasticsearchへの移行の開始、一時停止、再開、取消しまたは再試行を行うように設計されています。
-
Action: 実行する移行アクション。このエントリは、次の値に設定できます。
-
Start: 移行プロセスを開始します。
-
Pause: 移行プロセスを一時停止し、将来の再開を許可します。
-
Resume: 一時停止の実行後に移行プロセスを再開します。
-
Cancel: 移行プロセスを停止し、将来の再開を許可しません。
-
Retry: 以前に失敗した移行を再試行します(ドキュメントの移行に失敗した場合のみ)。
-
-
dMigrationIndex: データの移行元の索引。
Action=start
の場合は、これを設定する必要があります。このエントリは次の値に設定できます:Metadata/ots1/ots2/IdcColl1/IdcColl2
-
dMigrationBatchSize:
dMigrationIndex
パラメータから取得されたドキュメントのバッチ・サイズ。Action=start
の場合は、これを設定する必要があります。このエントリには1から100までの値を指定できます。デフォルトは25です。 -
dMigrationRun:
Action=Retry
の場合、これを設定する必要があります。再試行する移行の実行。
ES_GET_MIGRATION_STATUS
このサービスは、検索索引のElasticsearchへの移行を表示したり、その詳細を提供するように設計されています。
場所: IdcHomeDir/components/ElasticSearch/resources/elasticsearch_service.htm
ES_CONFIG_INDEX_SETTINGS_FORM
このサービスは、ElasticSearchサーバーで構成される各索引のshards,replicas
設定を指定するページをロードします。
場所: IdcHomeDir/components/ElasticSearch/resources/elasticsearch_service.htm
ES_VIEW_INDEX_SETTINGS_FORM
このサービスは、ElasticSearchサーバーから問い合せたshard, replica
数とともに索引を表示するページをロードします。
場所: IdcHomeDir/components/ElasticSearch/resources/elasticsearch_service.htm
ES_UPDATE_INDEX_SETTINGS
追加の必須サービス・パラメータ
このサービスは、すべての索引の索引設定を更新します。更新は、次の完全再構築/再索引付けサイクルの後、またはユーザーが別のSearchEngineから切り替えている場合は移行後にのみ反映されます。
-
<groupName in lower case>ShardCount
- セキュリティ・グループの対応するElasticsearch索引に設定されるShardCount。Ex:publicShardCount=5 (Should be an integer [5-300])
-
<groupName in lower case>ReplicaCount
- セキュリティ・グループの対応するelasticsearch索引に設定されるReplicaCount。Ex:publicReplicaCount=1 (Should be an integer [1-2])
ファイル・サービス(コアContent Server)
ファイル・サービスは、動的変換やリソース・ファイルなど、ファイルを操作するサービスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
次のファイル・サービスは、この項で説明します。
ADD_WEB_APP
内部Tomcatエンジンで使用されます。
TomcatエンジンにWARファイルを追加し、含まれるJSPページを有効にするために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
pathToWAR: WARファイルへの完全なパス。
APPEND_FILE_CACHING_INFO
「システム監査情報」ページの情報を返すためにGET_SYSTEM_AUDIT_INFOで使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_DYNAMIC_CONVERSION
Dynamic Converterによって変換されるHTMLまたはXMLファイルとしてコンテンツ・アイテムを返すサービス。これは、Dynamic Converterコンポーネントがインストールされ、有効な場合に使用できます。
dIDまたはdDocNameおよびRevisionSelectionMethodパラメータを指定すると、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。最も発生しがちなエラーは、パラメータに不整合があるか、存在しないコンテンツ・アイテムに対するリクエストがあることです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
-
dDocNameは、リクエスタがdDocNameを認識しているコンテンツ・アイテムのすべてのリクエストに含まれる必要があります。Content Serverシステムのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。
-
GET_DYNAMIC_CONVERSIONがプログラミングによりRIDC over HTTP(S)を使用して起動されるとき、XML/HTML形式で動的変換コンテンツを取得するためには、リクエスト・バインダの
IsJava
を0に設定する必要があります。このパラメータが設定されないと、RIDC over HTTP(S)がIsJava=1
をリクエスト・バインダに暗黙に追加するため、サーバーがサービス・レスポンス・データをHDA形式で返すようになります。
追加の必須サービス・パラメータ
ノート:
コンテンツ・アイテムのリビジョンID (dID)が指定されているか、RevisionSelectionMethodパラメータを持つコンテンツID (dDocName)が指定されている必要があります。
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。
-
このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、値Specificを持つ場合は、そのレンディションが返されます。
-
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。
-
RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。
-
-
RevisionSelectionMethod: リビジョン選択メソッド。
-
これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。
-
値がSpecificである場合、dDocNameパラメータは無視され、dIDが要求され、これを使用してリビジョンが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。
-
オプションのサービス・パラメータ
-
conversionTemplate: 変換テンプレート。このパラメータは、テンプレート変換条件ページをオーバーライドするためにサービスに渡すことできます。
-
DCViewFormat: 変換および表示されるファイル: 通常は、Native、AlternateまたはWebViewable。
-
UseConversionCache: コンテンツ・アイテムの動的変換をリクエストする際にキャッシュ変換を無視します。単一リクエストにのみ適用されます。このパラメータを使用して、変換の問題をテストまたはトラブルシューティングをする際に強制的に動的変換させることができます。このパラメータを使用するには、コンテンツ・サーバーのURLに追加します。
http://server_name/cs/idcplg?IdcService=GET_DYNAMIC_CONVERSION &dDocName=aTest&RevisionSelectionMethod=LatestReleased&UseConversionCache=false
-
conversionRule: 変換ルールを変換ルール基準により選択できるようにするのではなく、使用する変換ルールを指定します。
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Retrieve a web-viewable revision IdcService=GET_DYNAMIC_CONVERSION dDocName=corporatereport RevisionSelectionMethod=LatestReleased DCViewFormat=WebViewable
-
HDA形式:
@Properties LocalData IdcService=GET_DYNAMIC_CONVERSION dID=54321 @end
GET_DYNAMIC_CONVERSION_SUB
GET_DYNAMIC_CONVERSIONで使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_DYNAMIC_URL
/weblayout
ディレクトリにマップされるかどうかを決定するために、Web表示可能URLから情報を抽出するために内部で使用されるサービスです。マップされない場合は、例外をスローします。
このサービスは通常、動的ページを取得するために使用されます。このサービスは動的コンテンツWeb表示可能ファイルを配信するためにWebサーバーからコールされます。サービスに対するレスポンス・ページを動的に変更するためにコアでコールされます。
アクセス・レベル: 読取り、スクリプト作成可能(33)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
fileUrl: アイテムの相対URL。これには、Content Serverのチェックイン・アイテム、SchemaまたはLayout Manager用Javaスクリプト・ファイル、
/images
ディレクトリからのイメージファイルを指定できます。
結果
-
ResultSets:
-
DocFormats
-
DocTypes
-
-
ローカル・データ:
-
ref:dDocAccount
-
ref:dDocName
-
ref:dDocType
-
ref:dExtension
-
ref:dSecurityGroup
-
ref:hasDocInfo
-
ref:isLatestRevision
-
SourceID
-
HCSP/Fメタデータ(idcbegindataとidcenddataタグ間のカスタムXMLデータを含む)
-
-
レスポンス・テンプレート: null (fileUrlパラメータでリクエストされたファイルを返します。)
GET_EXTERNAL_DYNAMIC_CONVERSION
外部コレクションに存在するドキュメントを動的に変換するために使用されるサービス。これはGET_DYNAMIC_CONVERSIONと同じですが、外部のVerity検索コレクションからアイテムのコンテンツ情報を取得する点が異なります。VerityはContent Serverと組み合せて使用するために購入できるアドオン製品です。
場所: IdcHomeDir/resources/core/templates/std_services.htm
追加の必須サービス・パラメータ
-
VdkVgwKey: Verityの参照キー。
-
sCollectionID: 外部Verityコレクションの識別子。
GET_TEMPLATE_CONVERSIONS
変換中に使用されるテンプレートのリストを取得するためにDynamic Converterで使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_WEB_APP_STATUS
内部Tomcatエンジンで使用されます。
内部Tomcatエンジンのステータスを返すサービス。内部使用専用。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LOAD_RESOURCE_FILE
リソース・ファイルを返すサービス。
dIDまたはdDocNameおよびRevisionSelectionMethodパラメータを指定すると、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。
最も発生しがちなエラーは、パラメータになんらかの不整合があるか、存在しないリビジョンまたはレンディションに対するリクエストであることです。
ノート:
リクエスタがdDocNameを認識している場合、dDocNameがコンテンツ・アイテムのすべてのリクエストに含まれるようにすることをお薦めします。Content Serverシステムのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
ノート:
コンテンツ・アイテムのリビジョンID (dID)が指定されているか、コンテンツ・アイテム名(dDocName)とRevisionSelectionMethodパラメータが指定されている必要があります。
オプションのサービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。
-
このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、値Specificを持つ場合は、そのレンディションが返されます。
-
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。
-
RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。
-
RevisionSelectionMethod: リビジョン選択メソッド。
-
これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。
-
値がSpecificである場合、dDocNameは無視され、dIDが要求され、これを使用してレンディションが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。
-
-
Rendition: コンテンツ・アイテムのレンディション。このパラメータは、コンテンツ・アイテムのレンディションを指定するもので、Primary、WebまたはAlternateに設定できます。Renditionが指定されない場合、デフォルトでPrimaryが設定されます。
-
値がPrimaryである場合、選択されたリビジョンのプライマリ・レンディションが返されます。
-
値がWebである場合、選択されたリビジョンのWeb表示可能レンディションが返されます。
-
値がAlternateである場合、選択されたリビジョンの代替レンディションが返されます。
-
例
IdcService=LOAD_RESOURCE_FILE dID=456
REMOVE_WEB_APP
内部Tomcatエンジンで使用されます。
このサービスは内部Tomcatエンジンとの併用からWARファイルを削除するために使用されます。内部使用専用。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
一般サービス(コアContent Server)
一般サービスはContent Server全体にわたって使用され、特定の機能に関連付けられることはほとんどありません。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、これらのサービスについて説明します。
ADD_DOC_ACCOUNT
新しいアカウントを作成するために使用されるサービス。最も発生しがちなエラーは、アカウント名が一意ではないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
(元の場所)場所: IdcHomeDir/resources/core/templates/std_services.htm
追加の必須サービス・パラメータ
-
dDocAccount: コンテンツ・アイテムのセキュリティ・アカウント。
例
IdcService=ADD_DOC_COLLECTION dDocAccount=newaccount
ADD_DOCEXTENSION
既存のファイルにファイル拡張子を追加するサービス。最も発生しがちなエラーは、その拡張子を持つ一致するファイルがすでにシステムに存在することです。
追加の必須サービス・パラメータ
-
dExtension: hcsf、doc、txtなどのファイル拡張子。
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
例
IdcService=ADD_DOCEXTENSION dExtension=doc dFormat=application/doc
ADD_DOCFORMAT
新しいファイル・フォーマットを作成するサービス。最も発生しがちなエラーは、ファイル・フォーマットがシステムにすでに存在することです。
場所: IdcHomeDir
3
追加の必須サービス・パラメータ
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
-
dConversion: 変換アルゴリズムは、パラメータdConversionで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。
ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。
-
dDescription: ファイル・フォーマットの説明。
例
IdcService=ADD_DOCFORMAT dFormat=application/doc dDescription=msword dConversion=PASSTHRU
ADD_DOCTYPE
新しいコンテンツ・アイテムのタイプを作成するために使用されるサービス。最も発生しがちなエラーは、コンテンツ・アイテムのタイプ名が一意でないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocType: 新しいコンテンツ・アイテムのタイプ。
-
dDescription: 新しいタイプの説明。
-
dGif: 新しいドキュメント・タイプを表すためのアイコンとして表示されるGIFイメージのファイル名。.gif拡張子を含めます。
例
IdcService=ADD_DOCTYPE dDocType=MYTEST dDescription=My Description. dGif=adeng.gif
APPLET_DOCINFO
コンテンツ・アイテムの情報を取得するサービス。最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
例
IdcService=APPLET_DOCINFO dID=47
CONFIG_INFO
Content Serverの管理サーバーから構成情報を取得するサービス。現在アクティブなコンポーネントの構成情報を取得するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_DOC_ACCOUNT
既存のアカウントを削除するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocAccount: アカウント名。
例
IdcService=DELETE_DOC dDocAccount=mainaccount
DELETE_DOCEXTENSION
既存のファイル拡張子を削除するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dExtension: hcsf、doc、txtなどのファイル拡張子。
例
IdcService=DELETE_DOCEXTENSION dExtension=hcsf
DELETE_DOCFORMAT
既存のドキュメント形式を削除するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dFormat: MIMEフォーマットの名前。たとえば、application/hcsfまたはapplication/doc.。
例
IdcService=DELETE_DOCFORMAT dFormat=application/hcsf
DELETE_DOCTYPE
既存のコンテンツ・アイテムのタイプを削除するサービス。最も発生しがちなエラーは、指定されたファイル・タイプが存在しないか、そのタイプのファイルがシステムに存在することです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocType: コンテンツ・アイテムのタイプ。
例
IdcService=DELETE_DOCTYPE dDocType=TEST
EDIT_DOCEXTENSION
既存のファイル拡張子を変更するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dExtension: doc、txt、pdfなどのファイル拡張子。
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
例
IdcService=EDIT_DOCEXTENSION dExtension=hcsf dFormat=application/hcsf
EDIT_DOCFORMAT
既存のコンテンツ・アイテムのフォーマットを変更するサービス。このサービスは「構成マネージャ」アプレットからコールされます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。
-
dDescription: フォーマットの説明。
-
dConversion: 変換アルゴリズムは、このパラメータで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。
ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。
例
IdcService=EDIT_DOCFORMAT dFormat=application/hcsf dDescription=hypercontent dConversion=PASSTHRU
EDIT_DOCTYPE
既存のコンテンツ・アイテムのタイプを変更するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocType: コンテンツ・アイテムのタイプ。
-
dDescription: タイプの説明。
-
dGif: タイプを表すためのアイコンとして表示されるGIFイメージのファイル名。.gif拡張子を含めます。
例
IdcService=EDIT_DOCTYPE dDocType=MY_TEST dDescription=edit testing dGif=admkt.gif
EDIT_TRACE_OPTIONS
「システム監査情報」ページのトレース・オプションを取得するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_DATARESULTSET
このサービスでは、「問合せの選択」をデータベースに対して実行します。問合せはdataSourceパラメータから構築されます。このサービスは次の情報を返します。
-
問合せの結果を含む結果セット。
-
結果が切り捨てられたかどうかを示すもの。dataSourceが最大行数を超えられないように定義されている場合、および問合せが許可されている最大数を超える数を返す場合、copyAbortedキーは1 (true)に設定されます。これは返された結果セットが問合せのサブセットのみを含むことを示します。
特定のコアContent Serverの表に対して選択しようとする問合せには、セキュリティ句が適用されています。特に、ドキュメント、リビジョン、ユーザーなどの表にはその他のセキュリティ句が適用されています。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dataSource: コール元によって提供される潜在的なWHERE句およびORDER BY句を持つSelect問合せ。dataSourceは、DataSources表で定義される、Content Serverリソースです(dataSourcesの標準リストのresource.htmファイルを参照。)
オプションのサービス・パラメータ
-
whereClause: Select問合せへのWHERE句。
-
orderClause: trueに設定されると、句別に問合せをソートします。
-
resultName: 問合せの結果セットに使用する名前を指定します。
GET_DOCEXTENSIONS
すべてのコンテンツ・アイテムの拡張子と各拡張子のマップ先のファイル・フォーマットのリストを返すサービス。プロパティ情報およびExtensionFormatMap ResultSetを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_DOCFORMATS
すべてのコンテンツ・アイテムのフォーマットとそれに関連した変換メソッドと説明のリストを返すサービス。プロパティ情報およびDocFormats ResultSet.を返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_DOCTYPES
すべてのコンテンツ・アイテムのタイプ、その説明および関連するGIFイメージのリストを返すサービス。プロパティ情報およびDocTypes ResultSetを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_FIELD_LENGTHS
長さが制限されたフィールドの最大長の情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
オプションのサービス・パラメータ
-
tableNames: 調査対象となる表のコンマで区切られたリスト。リストを指定しない場合、tableNamesはドキュメントおよびフォルダ表のリスト(DocMeta,Documents,Revisions,FolderFolders,FolderFiles)に設定されます。
結果
-
ResultSet:
-
FIELD_LENGTH: フィールドの最大文字数を含む結果セット。このResultSetには2つの列があります。
-
fieldName: フィールドの名前。
-
fieldLength: フィールドに許可されている文字の最大数。
-
-
GET_FILELIST
指定されたフィルタに一致する、ディレクトリにリストしているファイルを取得する管理サービス。ディレクトリはユーザーではなく、IDにより指定されます。このサービスはIDをディレクトリにマップします。
実際には、このサービスは構成マネージャ・アプレットに対するコンテンツ・タイプのGIFリストを取得するためにのみ使用されます。このリストは、/weblayout/images/docgifs
ディレクトリにあります。結果は、オプション・リストとしてfileListNameパラメータで指定された値で返されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
directoryID: ディレクトリ識別子。使用可能な値は、docgifs、mages、templates、resourcesです。
-
fileFilter: ファイルを選択するために使用するワイルド・カード・フィルタ。
-
fileListName: 返された値を保持するオプション・リスト。
GET_METADEFS
すべてのカスタム・メタデータ・フィールドとその属性のリストを返すサービス。プロパティ情報およびMetaFieldInfo ResultSetを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_RESULT_OPTIONS
検索結果テンプレートから情報を返すサービス。
ノート:
バージョン3.5.3では、Content Serverはこのサービスを使用していません。これは下位互換性を維持するために、レガシー・コードとしてstd_services.htm
ファイルに残っています。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SYSTEM_AUDIT_INFO
Content Serverのシステム監査情報を取得するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_TABLE
HDAファイルの結果セットにデータベース表をエクスポートするサービス。
指定された表が見つからない場合、サービスは失敗します。HDAデータを受信して、後で使用するためにこの結果セットを格納するのは、コール元プログラムです。
最も発生しがちなエラーは、表名が存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
tableName: エクスポートする表の名前。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=GET_TABLE tableName=Users
-
HDA形式:
@Properties LocalData IdcService=GET_TABLE tableName=Users @end
GET_USER_METADEFS
すべてのユーザー情報フィールドとその属性のリストを返すサービス。プロパティ情報およびResultSetを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LM_BUILD_WEB_STRING_FILES
文字列を静的.js
ファイルにパブリッシュするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LM_LOAD_LAYOUTS
DomainHome
/ucm/cs/weblayout/common/layouts
ディレクトリからユーザー・インタフェース・レイアウトをロードするサービス。LM_LOAD_LAYOUTS_SUBをコールします。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LM_LOAD_LAYOUTS_SUB
DomainHome
/ucm/cs/weblayout/common/layouts
ディレクトリからレイアウトをコールするために使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LOAD_DOC_ENVIRONMENT
このサブサービスは、コンテンツ・アイテム環境用のテンプレート・ページ構成情報をロードします。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LOGIN
強制的にログインし、HTMLページ・リクエストを実行するサービス。これは、ユーザーをWebサーバーで認証するための様々な方法の1つです。
アクセス・レベル: N/A (0)
場所: IdcHomeDir
/resources/core/templates/std_services.htm
追加の必須サービス・パラメータ
-
Action: 実行するアクション。通常GetTemplatePage。
-
Page: ページ・テンプレートの名前。
-
Auth: ブラウザ・インタフェースからログインする場合にのみ必要。たとえば:
Auth=Internet
他の考えられる値はIntranet
で、NTLMログインに使用されます。
結果
-
ローカル・データ:
-
dUser
-
RedirectParams
-
StatusMessage
-
-
レスポンス・テンプレート: null(デフォルトでHOME_PAGEにリダイレクトします)
使用
-
リソース・インクルード:
-
pne_nav_userprofile_links
-
subscription_action_script
-
home_page_static_content
-
-
テンプレート:
-
QUERY_NOTIFICATION (query_notification_mail.htm)
-
SELF_REGISTER_PROMPT_LOGIN (self_register_prompt_login.htm)
-
(std_home_page.htm)
-
-
標準ナビゲーション: commonNav.js
例
Content Serverにログインする際のホーム・ページを表示します。
IdcService=LOGIN
Action=prepareRedirect Page=HOME_PAGE
MERGE_TABLE
結果セットを既存のデータベース表にマージするサービス。エラーはすべてContent Serverのログに記録されます。
ノート:
デフォルトでは、このサービスはエラー・トレラントではなく、トランザクションでマージを実行しません。したがって、isErrorTolerantまたはisTransactionalオプション・パラメータがtrueに設定されず、かつこのサービスでエラーが発生すると、エラーが発生した場所で終了し、すでに更新され挿入された行はロールバックされません。この場合、制約を指定しないで、マージ表を再実行すると、制約違反により、Microsoft SQL ServerおよびContent Serverではマージが失敗します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
tableName: マージするデータベース表の名前。結果セットはこの表と同じ名前を持つ必要があります。
ノート:
挿入または更新する行を含む表のResultSet定義も指定する必要があります。
オプションのサービス・パラメータ
-
constraintKeys: 一意の識別子として使用される、カンマで区切られた列名のリストを指定します。このサービスは、最初にこれらの制約を調べます。行が見つかる場合、サービスは更新を行います。それ以外の場合は、新しい行が挿入されます。
パラメータが定義されていない場合、サービスは行を挿入しようとします。
-
isDeleteTable: trueの場合、サービスはマージしようとする前に表を削除します。isTransactionalがtrueに設定される場合、マージを伴うトランザクションで削除が実行されます。デフォルトで、この値はfalseです。
-
isErrorTolerant: trueの場合、マージ中にエラーが発生すると終了しません。デフォルトで、この値はfalseです。
-
isTransactional: trueの場合、トランザクションでマージが実行されます。マージ中にエラーが発生して、isErrorTolerantがfalseの場合、マージが終了し、すべての変更がロールバックされます。デフォルトで、この値はfalseです。
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Merge new entries into the Alias table IdcService=MERGE_TABLE tableName=Alias constraintKeys=dAlias # Rows to be updated or inserted @ResultSet Alias 2 dAlias dAliasDescription MyAlias Just a test alias @end <<EOD>> # Delete the alias table and insert new rows, do a rollback if something fails. IdcService=MERGE_TABLE tableName=Alias isTransactional=true isDeleteTable=true # Rows to be updated or inserted @ResultSet Alias 2 dAlias dAliasDescription MyAlias Just a test alias @end <<EOD>>
-
HDA形式(例1):
@Properties LocalData IdcService=MERGE_TABLE tableName=Alias constraintKeys=dAlias @end @ResultSet Alias 2 dAlias dAliasDescription MyAlias Just a test alias @end
-
表名およびResultSetを定義し、新しい行をデータベースに挿入する(新しい行をUsers表に挿入する)HDA形式:
@Properties LocalData IdcService=MERGE_TABLE tableName=Users @end @ResultSet Users 2 dName dUserAuthType user15 LOCAL @end
PING_SERVER
Content Serverインスタンスへの接続が存在し、ステータス情報を返すかどうかを評価するサービス。ユーザーがログインしていない場合には、強制的にログインするように促します。
ノート:
Content Serverインスタンスへの接続が確立されており、コマンドの実行権限を持つユーザーとしてログインしていることを確認するために、他のサービスをコールする前にPING_SERVERリクエストを実行します。
アクセス・レベル: N/A (0)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
-
ローカル・データ:
-
dUser
-
StatusMessage
-
-
レスポンス・テンプレート: null
使用
-
アプレット:
-
バッチ・ローダー
-
構成マネージャ
-
ページ・ビルダー
-
-
テンプレート:
-
SUBSCRIBE_FORM (subscribe_form.htm)
-
SUBSCRIPTION_LIST (subscription_list.htm)
-
UNSUBSCRIBE_FORM (unsubscribe_form.htm)
-
例
HDA形式:
@Properties LocalData IdcService=PING_SERVER IsJava=1 Auth=Internet @end
サンプルの戻り情報:
Content-type: text/html Content-Length: 421 <?hda version="6.0 SNAP-020207" jcharset=Cp1252 encoding=iso-8859-1?> @Properties LocalData dUser=sysadmin blFieldTypes=StatusMessage message refreshSubMonikers= StatusMessage=You are logged in as 'sysadmin'. loadedUserAttributes=1 blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM changedSubjects= refreshSubjects= Auth=Internet refreshMonikers= changedMonikers= IdcService=PING_SERVER IsJava=1 @end
QUERY_DOC_ACCOUNTS
Content Serverのすべてのアカウントのリストを返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
インデクサ・サービス(コアContent Server)
インデクサ・サービスは、検索索引の制御に使用されます。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、次のサービスについて説明します。
CONTROL_SEARCH_INDEX
検索索引を更新または再構築するサービス。更新および再構築は、バックグラウンド・スレッドで自動的に実行されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
検索索引を再構築することは、メタデータ・フィールドを変更または追加する場合に必要です。ファイルの数とサイズによって、このプロセスには、数日かかる場合があります。再構築はシステム集約型です。そのため、システム使用率がピーク以外の時間帯に再構築を実施するように計画してください。
-
このサービスは、「リポジトリ・マネージャ: インデクサ」タブで提供される「自動更新サイクル」および「コレクション再構築サイクル」オプションに変更が行われる場合にコールされます。
-
「自動更新サイクルの構成」または「コレクション再構築サイクルの構成」画面で定義されるオプションは次のパラメータにマップします。
-
1度のインデクサ・バッチで処理されるコンテンツ・アイテム数(MaxCollectionSize)
-
チェックポイントごとのコンテンツ・アイテム数(IndexerCheckpointCount)
-
インデクサのデバッグ・レベル(SearchDebugLevel)
-
インデクサの自動更新(sEnableAutoUpdate)
-
追加の必須サービス・パラメータ
-
cycleID: 索引のサイクル・タイプ。
-
更新: 索引データベースを追加的に更新します。
-
再構築: 検索索引が完全に再構築され、再構築が完了すると古い索引コレクションは新しい索引コレクションに置き換えられます。
-
-
action: 実行するアクション。このエントリは、次の値に設定できます。
-
開始: 更新または再構築サイクルを開始します。
-
取消: 更新または再構築サイクルを停止し、今後の再開を許可しません。
-
一時停止: 更新または再構築サイクルを停止し、今後の再開を許可します。
-
再開: 一時停止が実行された後で、更新または再構築サイクルを再開します。
-
setConfiguration: 更新サイクルを有効または無効にする際に使用されます。この値を設定すると、チェックポイント(IndexerCheckpointCount)、バッチ・サイズ(MaxCollectionSize)、デバッグ・レベル(SearchDebugLevel)および自動更新(sEnableAutoUpdate)オプションを調整できます。
-
追加のオプション・サービス・パラメータ
このサービスには実行するアクションに応じて、次のパラメータが必要な場合があります(次の例を参照してください)。
-
GetCurrentIndexingStatus: このパラメータを1 (true)に設定すると、インデクサ・サイクルのステータスを返します。
-
アイドル: インデクサ・サイクルが完了しています。
-
アクティブ: インデクサ・サイクルは現在実行中です。
-
割込み: 索引付けサイクルが急に終了する、予期しないイベント。たとえば、処理能力、データベースまたはファイル・システムの障害。
-
中断: 索引付けが制御された方法で停止されます。たとえば、「リポジトリ・マネージャ: インデクサ」タブの「中断」ボタンを使用するなど。
-
再開: 中断されたサイクルが再び開始されます。中断されたサイクルを再開している場合は、中断の原因となった問題を解決していることを確認してください。
-
取消: 索引付けサイクルが再開することなく停止されます。
-
-
fastRebuild: このパラメータを1 (
true
)に設定すると、検索エンジンは、コレクションの完全な再構築を行わなくても検索コレクションに新しい情報を追加できます。このパラメータは、OracleTextSearchおよびElasticsearchとの組合せでのみ機能します。
- esFullRebuild: このパラメータは、Elasticsearchとの組合せでのみ機能します。
fastRebuild
パラメータの値を0 (false)
に設定し、esFullRebuild
パラメータの値を1 (true)
に設定すると、テキスト抽出を含むコレクションの完全な再構築が実行されます。fastRebuild
パラメータを0 (false)
に設定し、esFullRebuild
パラメータを0 (false)
に設定すると、Elasticsearchサーバーでの再索引付け操作によりコレクションの再構築が実行されます。ノート:
fastRebuild
パラメータとesFullRebuild
パラメータの両方を同時にtrue
に設定することはできません。fastRebuild
パラメータの値を1
に設定し、esFullRebuild
パラメータの値を0
に設定すると、fastRebuild操作が実行されます。fastRebuild esFullRebuild Action 0 1 テキスト抽出を含むコレクションの完全な再構築 0 0 Elasticsearch再索引付け 1 0 高速再構築 1 1 無効な組合せであるため、設定しないでください
-
getStatus: このパラメータを1 (true)に設定すると、インデクサ設定およびステータス情報が返されます。
-
PerformProcessConversion: インデクサ再構築プロセスの開始または再開時に処理変換を有効にします。
-
1 (true): 処理変換が実行されます。
-
0 (false): 処理変換が実行されません。
-
-
IndexerCheckpointCount: 各索引付け状態を一度に通過するファイルの数。
-
チェックポイントごとに、複数のファイル・バッチを索引付けできます。
-
このエントリを更新するには、アクションを
setConfiguration
に設定する必要があります。
-
-
MaxCollectionSize: 検索索引で同時に処理されるファイルの最大数。
-
デフォルトが25の場合、25ファイルがまとめて索引付けされた後、次の25ファイルが索引付けされます。
-
サイズの大きい複雑なファイルを検索エンジンで索引付けすることに伴う問題が発生している場合には、この設定を1に変更できます。ただし、システム性能が低下する原因になる場合があります。
-
このエントリを更新するには、アクションを
setConfiguration
に設定する必要があります。
-
-
SearchDebugLevel: インデクサのデバッグ・レベル。
-
サーバー・ウィンドウ内にリストされたデバッグ情報が多いほど、索引付けの速度は下がります。
-
このエントリを更新するには、アクションを
setConfiguration
に設定する必要があります。 -
次にデバッグ・レベルを(デバッグ情報の少ない順に)示します。
-
なし: アクセスされた各ファイルの情報は表示されません。
-
詳細: アクセスされた各ファイルの情報が表示されます。「索引付け」、「無視」、「失敗」のいずれかが示されます。
-
デバッグ: 中レベルの情報が表示されます。
-
トレース: 最低レベルの情報が表示されます。
-
すべて: 最高レベルの情報が表示されます。
-
-
-
sEnableAutoUpdate: このエントリを更新するには、アクションを
setConfiguration
に設定する必要があります。-
1 (true): 自動更新サイクルが有効になっています。
-
0 (false): 自動更新サイクルが無効になっています。
-
例
次に別のプロセスからインデクサを制御するための例を示します。
-
定義された設定およびステータス情報を返すためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX getStatus=1 @end
-
更新サイクルを有効にするためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX MaxCollectionSize=500 sEnableAutoUpdate=1 cycleID=update action=setConfiguration SearchDebugLevel=none IndexerCheckpointCount=5000 GetCurrentIndexingStatus=1 @end
-
更新サイクルを無効にするためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX MaxCollectionSize=500 sEnableAutoUpdate=0 cycleID=update action=setConfiguration SearchDebugLevel=none IndexerCheckpointCount=5000 GetCurrentIndexingStatus=1 @end
-
インデクサ再構築を開始するためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=start getStatus=1 GetCurrentIndexingStatus=1 PerformProcessConversion=1 @end
-
インデクサ再構築を取り消すためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=cancel getStatus=1 GetCurrentIndexingStatus=1 @end
-
インデクサ再構築を中断するためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=suspend getStatus=1 GetCurrentIndexingStatus=1 @end
-
インデクサ再構築を中断後に再開するためのHDA形式:
@Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=restart getStatus=1 GetCurrentIndexingStatus=1 PerformProcessConversion=1 @end
GET_FILE
ブラウザにコンテンツ・アイテムのリビジョンの特定のレンディションを返すサービス。チェックアウトを実行せずにファイルのコピーを取得します。
-
dIDまたはdDocNameおよびRevisionSelectionMethodパラメータを指定すると、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。
-
最も発生しがちなエラーは、パラメータになんらかの不整合があるか、存在しないリビジョンまたはレンディションに対するリクエストであることです。
ノート:
リクエスタがdDocNameを認識している場合、dDocNameがコンテンツ・アイテムのすべてのリクエストに含まれるようにすることをお薦めします。Content Serverインスタンスのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。
アクセス・レベル: 読取り、スクリプト作成可能(33)
実行される問合せ:
-
QdocInfo
-
QlatestIdByName
-
QlatestReleasedIDByName
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
ノート:
コンテンツ・アイテムのリビジョンID(dID)が指定されているか、コンテンツID(dDocName)とRevisionSelectionMethodパラメータが定義されている必要があります。
-
dID: 生成済のコンテンツ・アイテムのリビジョンID。
-
dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。
-
このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、値Specificを持つ場合は、そのレンディションが返されます。
-
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。
-
RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。
-
オプションのサービス・パラメータ
-
-
allowInterrupt: 1 (true)に設定されると、ユーザーがファイルのダウンロードを取り消す場合エラーが表示されません。
-
RevisionSelectionMethod: リビジョン選択メソッド。
-
これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。
-
値がSpecificである場合、dDocNameは無視され、dIDが要求され、これを使用してレンディションが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。
-
-
Rendition: コンテンツ・アイテムのレンディション。このパラメータは、コンテンツ・アイテムのレンディションを指定するもので、Primary、WebまたはAlternateに設定できます。Renditionが指定されない場合、デフォルトでPrimaryが設定されます。
-
値がPrimaryである場合、選択されたリビジョンのプライマリ・レンディションが返されます。
-
値がWebである場合、選択されたリビジョンのWeb表示可能レンディションが返されます。
-
値がAlternateである場合、選択されたリビジョンの代替レンディションが返されます。
-
-
IsXml: trueまたは1に設定されると、一部のHCSP、HCSTおよびHCSFページに存在するXMLデータ・アイランドを返します。必要に応じて、追加の情報を渡すために変更可能な、std_html_form_xml_wrapperインクルード内でラップされるデータ・アイランドを返します。
結果
-
レスポンス・テンプレート: null(リクエストされたファイルのみが返されます。)
使用
-
アプレット: 構成マネージャ
-
リソース・インクルード:
-
doc_file_get_copy
-
doc_odma_select_get
-
download_form_fields
-
email_docinfo_body_by_id
-
email_docinfo_body_by_name
-
legacy_workflow_in_queue_table
-
subscription_info_cell
-
subscription_info_cells
-
wf_in_queue_display
-
wf_review_cannot_view_msg
-
-
テンプレート:
-
CHECKOUT_OK (chkook.htm)
-
DOWNLOAD_OK (dwnldok.htm)
-
QUERY_NOTIFICATION (query_notification_mail.htm)
-
REDIRECTION_FILE_TEMPLATE (redirectionfile_template.htm)
-
REV_HISTORY (rev_history.htm)
-
SELECTDOC_OK (slctdcok.htm)
-
WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
-
WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)
-
-
その他: SoapCustom:Wsdl:GetFile:Services
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Retrieve a web-viewable revision IdcService=GET_FILE dDocName=corporatereport RevisionSelectionMethod=LatestReleased Rendition=Web
-
HDA形式:
@Properties LocalData IdcService=GET_FILE dID=54321 @end
START_SEARCH_INDEX
検索索引を更新または再構築するサービス。このサービスは非同期であり、アクションは、バックグラウンド・スレッドで実行されます。このサービスは、Content Serverインスタンスのコンテキストでのみ実行することができ、Content Serverインスタンスに接続された場合にのみ正常に完了します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
オプションのサービス・パラメータ
-
IsRebuild: 索引付けプロセスの範囲を設定します。
-
1 (true): インデクサが検索索引の完全な再構築を実行します。0 (false): インデクサが検索索引の増分更新を実行します。
-
デフォルトは0 falseです。
-
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Rebuild the entire search index IdcService=START_SEARCH_INDEX IsRebuild=true
-
HDA形式(検索索引を再構築します)。
メタサービス(コアContent Server)
メタサービスは、Content Serverシステムでメタデータを管理および変更するために使用されます。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、次のサービスについて説明します。
ADD_METADEF
新しいメタデータ・フィールドを作成するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
ノート:
詳細は、「UPDATE_META_TABLE」および「START_SEARCH_INDEX」を参照してください。これらのサービスは、新しいメタデータ・フィールドのデータを格納するために実行される必要があります。OptionListsデータベース表の更新の詳細は、「UPDATE_OPTION_LIST」も参照してください。
追加の必須サービス・パラメータ
-
dName: フィールドの内部名。
-
dCaption: 「コンテンツ・サーバー」ページでフィールドをラベル付けするために使用されるユーザー表示可能キャプション。
-
dIsRequired: フィールドに値が含まれない場合、ファイルがチェックインされないようにします。値は1(必須)または0(必須ではない)。デフォルトは0です。
-
dIsEnabled: 「ユーザー・インタフェース」ページに表示されるフィールドを有効にします。値は1(有効)または0(無効)です。デフォルトは1です。
-
dIsSearchable: 索引付けし、検索可能なフィールドを有効にします。値は1(検索可能)または0(検索不可)です。デフォルトは1です。
-
dIsOptionList: 「コンテンツ・サーバー」ページのユーザーが選択可能なオプション・リストの使用を許可します。値は1(有効)または0(無効)です。デフォルトは0です。1が使用される場合は、dOptionListKeyも必要です。
-
dOptionListKey: 使用されるオプション・リストの名前。
-
dOptionListType: 使用されるオプション・リストのタイプを指定します。値は
choice
(Vタイプの選択リスト)、chunval
(NVタイプの選択リスト)、combo
(リストから1項目選択、もしくは項目の追加選択)、multi2
(複数選択リスト)またはmulti
(複数値選択リスト)のいずれかになります。 -
dType: フィールドのタイプ。値は、Text(テキスト)、BigText(ロング・テキスト)、Int(整数)、Date(日付)、Memo(メモ)のいずれかになります。デフォルト: Text。
-
dOrder: フィールドが「コンテンツ・サーバー」ページに表示される順序。デフォルト値は、既存のフィールドの現在の最高値+1。
-
dDefaultValue: 作成されるメタデータ・フィールドのデフォルト値。
例
IdcService=ADD_METADEF dIsRequired=0 dOptionListKey=Web_SectionList dOptionListType=choice dIsOptionList=1 dOrder=5 dName=xWeb_Section dIsSearchable=1 dIsEnabled=1 dType=Text FieldName=Web_Section dCaption=Web Section
DEL_METADEF
既存のカスタム・メタデータ・フィールドを削除するサービス。dDocName、dSecurityGroupなど、標準メタデータ・フィールドを削除できません。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: 「x」接頭辞を含む、メタデータ・フィールド名。
例
IdcService=DEL_METADEF dName=xCustomField
EDIT_METADEF
既存のカスタム・メタデータ・フィールドを変更するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: 「x」接頭辞を含む、メタデータ・フィールド名。たとえば、xDepartmentです。
-
dCaption: メタデータ・フィールドのキャプション。
-
dType: Text、BigText、Memo、Date、Integerなど、メタデータ・フィールドのタイプ。
-
dOrder: 表示順序。
-
dIsRequired: 1 (true): このフィールドは必須です。0 (false): このフィールドはオプションです。
-
dIsEnabled: 1 (true): このフィールドはユーザー・インタフェースで有効になっています。0 (false): このフィールドはユーザー・インタフェースで無効になっています。
-
dIsSearchable: 1 (true): このフィールドは検索可能です。0 (false): このフィールドは検索不可です。
-
dDefaultValue: メタデータ・フィールドのデフォルト値。
-
dIsOptionList: 1 (true): このフィールドはオプション・リストを持ちます。0 (false): このフィールドはオプション・リストは持ちません。
-
dOptionListKey: オプション・リスト・キー。
-
dOptionListType: オプション・リストのタイプ。
例
IdcService=EDIT_METADEF dName=xDepartment dType=BigText dIsRequired=1 dIsEnabled=1 dIsSearchable=1 dCaption=Caption_Changed dIsOptionList=1 dDefaultValue=two dOptionListKey=xDepartmen_fieldList dOptionListType=chunval dOrder=4
GET_DISPLAY_FIELDS
別のContent Serverページのカスタム・メタデータ・フィールドに関するメタデータ情報を返すサービス。この情報はフロントエンドのクライアントがカスタム・メタデータ・フィールドをレンダリングするために使用できます。
このサービスでは、特定のContent Serverページへマップするアクションが必要です。これによりそのページのメタデータ情報が返されます。
また、このサービスでは、動的選択リスト(DCL)のオプションや動的ツリーを生成するサポートも提供しています。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
必須のサービス・パラメータ
-
dpAction: Content Serverのアクションを示します。有効なアクションは次のとおりです。
-
CheckinNew
-
CheckinSel
-
CheckinSimilar
-
Info
-
Update
-
Search
-
FLDMetadataUpdate
-
FLDMetadataInfo
-
条件によって必要なるサービス・パラメータ
-
dID: dpActionがCheckinSel、CheckinSimilar、InfoまたはUpdateの場合に必要。
-
fFolderGUID: dpActionがFLDMetadataUpdateまたはFLDMetadataInfoの場合に必要。
オプションのサービス・パラメータ
-
dpTriggerValue: プロファイルのロードに使用されるトリガー値を示します。
結果
-
ResultSets:
-
DisplayFieldInfo: 個々のカスタム・メタデータ・フィールドに関する情報が含まれます。次の列を保持します。
-
fieldName: フィールドの名前。
-
fieldType: フィールドのタイプ。たとえば: Text、BigText、Memo、Data、Int、Decimal、File。
-
fieldLabel: フィールドの表示ラベル。
-
isHidden: フィールドを非表示のフォーム・フィールドにする必要があるかどうかを示します。
-
isReadOnly: フィールドを非入力フォーム・フィールドにする必要があるかどうかを示します。
-
isRequired: フィールドを必須のフォーム・フィールドにする必要があるかどうかを示します。
-
defaultValue: フィールドのデフォルト値。
-
displayValue: 該当するデフォルト値に使用される表示値。
-
isOptionList: これがドロップダウンオプションリストかどうかを示します。
-
optionList: isOptionListが1に設定された場合に、この列にはオプションを含んだ追加の結果セットの名前が含まれ、ドロップダウン・リストを作成するために使用する必要があります。
-
optionListType: オプション・リストのタイプ。たとえば: choice、chunval、combo、multi2およびmulti。
-
isDependent: フィールドがDCLに含まれるかどうかを示します。このフィールドの値は、他のフィールドに依存します。
-
dependentOnField: このフィールドの値を取得するフィールドの名前を示します。
-
isPadMultiselectStorage: multi*タイプのオプション・リストによって使用されます。
-
multiselectDisplaySeparator: multi*タイプのオプション・リストによって使用されます。
-
multiselectStorageSeparator: multi*タイプのオプション・リストによって使用されます。
-
isStoreSelectionPath: 動的ツリーによって使用されます(詳細は、動的ツリーを参照)。
-
treeNodeDisplaySeparator: 動的ツリーによって使用されます。
-
treeNodeStorageSeparator: 動的ツリーによって使用されます。
-
order : フィールドの順序。
-
decimalScale
-
isError: フィールドに関する情報の取得時にエラーが発生したかどうかを示します。
-
errorMsg: エラー・メッセージ。
-
-
DisplayGroupInfo: 特定のカスタム・メタデータ・フィールドをグループにまとめる必要があるかどうかを示します。次の列を保持します。
-
parentField: グループで最初に表示される必要があるフィールドの名前。
-
groupFieldList: 親フィールドと一緒に表示される必要があるフィールドのリスト。
-
groupHeader: グループの名前。
-
defaultHide: デフォルトでグループを縮小する必要があるかどうかを示します。
-
-
xFieldName.options: 特定のフィールドにドロップダウン・リストを作成するために使用するオプションが含まれます。
-
dOption: オプションの内部値。
-
dDescription: オプションの表示値。
-
-
サポートされるdpActionリスト
-
CheckinNew: CHECKIN_NEW_FORMへのマップ。
-
CheckinSet: CHECKIN_SEL_FORMへのマップ。
-
CheckinSimilar: CHECKIN_SIMILAR_FORMへのマップ。
-
Info: DOC_INFOへのマップ。
-
Update: GET_UPDATE_FORMへのマップ。
-
Search: GET_SEARCH_FORMへのマップ。
-
FLDMetadataUpdate: FLD_EDIT_METADATA_RULES_FORMへのマップ。
-
FLDMetadataInfo: FLD_GET_METADATA_RULESへのマップ。
Dynamic Choice List
GET_DISPLAY_FIELDSサービスでは、Dynamic Choice List (DCL)を生成するサポートも提供しています。次のパラメータが使用されます。
-
dFieldName: (必須)DCLフィールドの名前。
-
dParentValue: (オプション)ドロップダウン・オプションを絞り込むために使用される親の値。
dParentValueを使用しない場合、いずれのオプション・リスト・フィールドにもすべてのオプションが返されます。
DisplayFieldInfo ResultSetのisDependentおよびdependentOnField列は、DCLを生成するために使用されます。これらの列は、フィールドが他のフィールドに依存するかどうか、および依存先のフィールドを指定します。
たとえば、CityフィールドがStateフィールドに依存し、StateフィールドがCountryフィールドに依存する場合、GET_DISPLAY_FIELDSサービスはCountryのすべてのオプションを返しますが、StateとCityのオプションは返しません。StateおよびCityが、依存フィールドであるとDisplayFieldInfo ResultSetで示すのみです。ResultSetでは、isDependentがStateとCityの両方に対して1に設定され、dependentOnFieldは、Stateに対してCountryおよびCityに対してStateと設定されます。
たとえば、Stateに対する依存値を取得する場合は、dFieldNameパラメータをStateに設定し、dParentValueパラメータをCountryの値に設定してGET_DISPLAY_FIELDSをコールします。StateおよびCountryに渡されたすべてのオプションが返されます。
動的ツリー
GET_DISPLAY_FIELDSサービスでは、動的ツリーを生成するサポートも提供しています。次のパラメータが使用されます。
-
dFieldName: (必須)DCLフィールドの名前。
-
dParentValue: (オプション)ドロップダウン・オプションを絞り込むために使用される親の値。
ツリー・オプション・リストを使用しているフィールドでは、DisplayFieldInfo ResultSetのoptionListType列にtree://
が格納されます。レスポンス・バインダには、xTreeField.optionsなどのfieldName.optionsを持つその他のResultSetが含まれます。
xTreeField.options ResultSetには、ツリーの最初のレベルを表すオプションが含まれます。
ツリーの任意のレベルのオプションを取得するには、GET_DISPLAY_FIELDSをdFieldNameおよび該当するdParentValueパラメータを使用してコールします。
GET_DISPLAY_FIELDSから返されたDisplayFieldInfo ResultSetには次の4つの新しい列も含まれます。
-
isShowSelectionPath: フルパスで表示するかどうかを示します。このフルパスはInfoページに表示されます。
-
isStoreSelectionPath: データベースにフルパスを格納するかどうかを示します。
-
treeNodeDisplaySeparator: 区切り文字を表示するために使用する必要がある記号を示します。
-
treeNodeStorageSeparator: パスをデータベースに保存するときに区切り文字として使用する必要がある記号を示します。
Search
dpActionがSearchの値でGET_DISPLAY_FIELDSがコールされる場合、レスポンス・バインダに追加情報が加えられます。
-
DisplayFieldInfo ResultSetには2つの追加の列が含まれます。
-
defaultOperator: フィールドのデフォルト演算子を示します。
-
searchOperatorsRSName: このフィールドに適用可能なすべての検索演算子を含むResultSetの名前を示します。
-
また、このサービスは、レスポンス・バインダに追加のResultSetsを加えます。これらのResultSetには、各種フィールド・タイプの検索演算子が含まれます。
-
SearchTextField: Text、Big TextおよびMemoフィールドの検索演算子が含まれます。
-
SearchDateField: Dateフィールドの検索演算子が含まれます。
-
SearchIntegerField: Integerフィールドの検索演算子が含まれます。
-
SearchBooleanField: Booleanフィールドの検索演算子が含まれます。通常は存在しません。
これらのResultSetには次の列も含まれます。
-
dOperator: 演算子の名前。
-
dOperatorDisplay: 演算子のローカライズされた表示の文字列。
-
dOperatorExpression: 問合せテキストを作成するために使用する必要がある構文。
GET_DOC_METADATA_INFO
DocMetaDefinition表からのカスタム・メタデータ・フィールドのリスト、および結果セットとして使用可能なDocTypesの情報のリストを返すサービス。ユーザーがアクセス可能なリストのみを表示するためにフィルタされる、SecurityGroupsおよびAccountに使用可能な値の2つのオプション・リストも返します。SOAP取得およびその他のリモート・アプリケーションとともに使用されます。
アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
-
ResultSets:
-
DocMetaDefinition (DocMetaDefinitionデータベース表からのすべての行およびフィールド)
-
Doctypes (DocTypesデータベース表からのすべての行およびフィールド)
-
-
オプション・リスト:
-
SecurityGroups(ユーザーの権限に基づいてフィルタされたセキュリティ・グループのオプション・リスト)
-
Accounts(ユーザーの権限に基づいてフィルタされたアカウントのオプション・リスト)
-
-
ローカル・データ:
-
isAutoNumber
-
useAccounts
-
使用
-
その他: SoapCustom:Wsdl:MetaData:Services
GET_OPTION_LIST
すべてのオプション・リストの表を返すサービス。一般的なキー値、オプションの値および各オプション・リストの順序を返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_USER_METADATA_INFO
ユーザーのメタデータ情報を返すサービス。SOAP取得とともに使用されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
MOVE_METADEF
リストのメタデータ・フィールドを上下に移動するために構成マネージャで使用されるサービス。リストでメタデータを移動すると、「チェックイン」、「更新」、「情報」、「検索」ページで表示されるデフォルトの順序が変更されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: 移動するメタデータ・フィールドの名前。
オプションのサービス・パラメータ
-
isMoveUp: デフォルトはfalseです。trueに設定すると、フィールドを下ではなく、上に移動します。
UPDATE_USER_META_TABLE
データベースのユーザー情報フィールドを更新するサービス。このサービスは、列を追加、変更および削除することによって、データベースを変更します。
-
デフォルトで、フィールドは追加または変更のみ可能です。削除することはできません。ユーザー情報フィールドを削除するには、オプション・パラメータMetaFieldsToDeleteで明記する必要があります。
-
このサービスは、「ユーザー管理」アプレットのユーザー情報フィールドを追加または削除し、「データベース設計の更新」ボタンをクリックするときに実行されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
注意:
列が削除される場合は、データが消失する可能性があります。このサービスは注意深く使用してください。
オプションのサービス・パラメータ
-
MetaFieldsToDelete: 削除するデータベース列のカンマ区切りのリストを指定します。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UPDATE_USER_META_TABLE
-
HDA形式(データベースから2つのフィールドを削除します):
@Properties LocalData IdcService=UPDATE_USER_META_TABLE MetaFieldsToDelete=xUserLocation,xDivision @end
UPDATE_META_TABLE
データベースのメタデータ・フィールドを更新するサービス。
このサービスは、DocMetaDefinition表に準拠するためにDocMeta表の列を追加、変更および削除することによってデータベースを変更します。デフォルトで、フィールドは追加または変更のみ可能です。削除することはできません。メタデータ・フィールドを削除するには、オプション・パラメータMetaFieldsToDeleteで明記する必要があります。
このサービスは、「構成マネージャ」アプレットのメタデータ・フィールドを追加または削除し、「データベース設計の更新」ボタンをクリックするときに実行されます。
注意:
列が削除される場合は、データが消失する可能性があります。このサービスは注意深く使用してください。
オプションのサービス・パラメータ
-
MetaFieldsToDelete: DocMeta表から削除するためにデータベース列のカンマ区切りのリストを指定します。
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Synchronize the DocMeta table with the design in the DocMetaDefinition table IdcService=UPDATE_META_TABLE
-
HDA形式(データベースから2つのフィールドを削除します):
@Properties LocalData IdcService=UPDATE_META_TABLE MetaFieldsToDelete=xInteger,xMemo @end
UPDATE_OPTION_LIST
メタデータ・フィールドのオプション・リストを追加または更新するサービス。OptionListsデータベース表のオプション・リストを更新または追加します。
注意:
OptionListStringパラメータで指定されたオプション・リスト値は既存の値を置き換えます。既存の値を保持するには、新しい値とともに既存の値を含める必要があります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dKey: オプション・リスト・キー。
-
OptionListString: \nエスケープ・シーケンスで区切られるオプションのリスト。
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Add the new options list 'LocationList' and # Add values Madrid, Tokyo, London, Washington IdcService=UPDATE_OPTION_LIST dKey=LocationList OptionListString=Madrid\nTokyo\nLondon\nWashington
-
HDA形式(Madrid、Tokyo、London、Washingtonの値でオプション・リストLocationListを追加します):
@Properties LocalData IdcService=UPDATE_OPTION_LIST dKey=LocationList OptionListString=Madrid\nTokyo\nLondon\nWashington @end
その他のサービス(コアContent Server)
この項のサービスは、バッチ・ロードの使用、ページの取得、アップロード用ファイルのチャンク化など、様々なタスクに使用されます。この項では、次のサービスについて説明します。
CHUNKED_UPLOAD
このサービスでは、非常に大きなContent Serverサービスをコールするためのサポートを追加します。このサービスはリクエストをチャンク化します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DOWNLOAD_LISTBOX_ITEMS
UsersまたはAlias表に先行入力機能を提供するSelectUserアプレットで使用されるサービス。このサービスは、問合せの結果を含む結果セットListBoxServiceItemsを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dataSource: 使用するデータソースの名前(たとえば、問合せスタブの選択)。
オプションのサービス・パラメータ
-
limit: ダウンロードするアイテム数。デフォルトは100です。
-
op: WHERE句を作成する際に使用する演算子。
ページ・ハンドラ/ページ・リクエスト・サービス(コアContent Server)
ページ・リクエスト・サービスはHTMLページを取得します。ページ・ハンドラ・サービスは、Webレイアウト・エディタによって作成されるライブラリWebページを管理します。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、次のサービスについて説明します。
DELETE_RESULT_TEMPLATE
既存の検索結果テンプレートを削除するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
name: 検索結果テンプレート名。
例
IdcService=DELETE_RESULT_TEMPLATE name=test_template
GET_ADMIN_PAGE
ブラウザで「管理」ページを返すサービス。このサービスは、サーバーの構成をロードしません。ユーザーが「管理者」ロールを割り当てられない場合、このサービスはエラー・メッセージを返します。
アクセス・レベル: N/A (0)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
PageName: ページ・テンプレートの名前。
オプションのサービス・パラメータ
-
Action: 実行するアクション。通常
GetTemplatePage
に設定されます。
結果
-
ローカル・データ:
-
TemplateType
-
TemplateClass
-
TemplateFilePath
-
-
レスポンス・テンプレート: Pageパラメータの値として渡されたテンプレートを返します。標準の使用では、これはADMIN_LINKS (admin.htm)です。
使用
-
リソース・インクルード:
-
pne_nav_admin_links
-
std_admin_pages
-
-
テンプレート:
-
ADMIN_LINKS (admin.htm)
-
IDC_ADMIN_PAGE (idc_admin_page.htm)
-
std_home_page.htm
-
-
標準ナビゲーション: commonNav.js
例
標準の管理ページを取得するには:
IdcService=GET_ADMIN_PAGE Page=ADMIN_LINKS Action=GetTemplatePage
GET_DOC_PAGE
HTMLページ・リクエストを実行するサービス。このサービスは通常、ブラウザ・インタフェースからコールされます。LOAD_DOC_ENVIRONMENTサブサービスを実行します。
アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)
サブサービスのコール: LOAD_DOC_ENVIRONMENT
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
PageName: ページ・テンプレートの名前。
オプションのサービス・パラメータ
-
Action: 実行するアクション。通常
GetTemplatePage
に設定されます。
結果
-
ResultSets:
-
DocFormats (DocFormatsデータベース表のすべての行およびフィールド)
-
DocTypes (DocTypesデータベース表のすべての行およびフィールド)
-
-
ローカル・データ:
-
TemplateClass
-
TemplateFilePath
-
TemplateType
-
-
レスポンス・テンプレート: Pageパラメータの値として渡されたテンプレートを返します。
使用
-
リソース・インクルード:
-
calculate_doc_profile_urls
-
determine_wf_review_rendition_url
-
home_page_static_content
-
pne_nav_bookmark_links
-
pne_nav_shared_links
-
search_template_user_info_settings
-
std_js_bootstrap_vars
-
std_main_page_begin
-
std_query_page_link_args
-
xui_searchapi_results_action_form
-
-
テンプレート:
-
PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)
-
PNE_PORTAL_PERSONAL_URLS_PAGE (pne_portal_personal_urls_page.htm)
-
PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)
-
PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)
-
PREVIEW_FRAMES (preview_frames.htm)
-
USER_INFO (user_info.htm)
-
-
標準ナビゲーション:
-
commonNav.js
-
Trays/layout.js
-
Trays/search_tray_tabs.htm
-
-
その他:
リダイレクト・サービスの対象: SUBMIT_HTML_FORM、LOGIN, EDIT_USER_PROFILE、CONTINUE_SUBMIT_HTML_FORM,、UPLOAD_NEW_COMPONENT、CANCEL_COMPONENT_INSTALL、UPDATE_COMPONENT_CONFIG、UNINSTALL_COMPONENT、SAVE_USER_TOPICS、PUBLISH_SCHEMA、EDIT_SCHEMA_VIEW_VALUES
例
-
ホーム・ページを取得するには、パラメータは次のとおりです。
IdcService=GET_DOC_PAGE Page=HOME_PAGE Action=GetTemplatePage
-
標準の問合せページを取得するには、パラメータは次のとおりです。
IdcService=GET_DOC_PAGE Page=STANDARD_QUERY_PAGE Action=GetTemplatePage
GET_DYNAMIC_PAGE
動的アセンブリのライブラリ・ページを返すサービス。このサービスは、次の2通りの方法で使用できます。
-
Content Serverシステムで直接表示するために、ライブラリ・ページをロードする。
-
ライブラリ・ツリー表示でノードを動的に生成または更新するために非表示フレームでバックグラウンドで使用される。
DIRECTORY_PAGEサービス(dir_page.htm)で使用されるデフォルトのテンプレートは、サービスの2つの使用法の一方または他方を実行するために、lmXMLの値に基づいてブランチされます。lmXMLが1 (true)に設定される場合、テンプレートはHTMLページではなく、XMLオブジェクトを生成し、libraryNodeLoadSequenceを起動して、ライブラリ・ナビゲーション・ツリーを更新します。
アクセス・レベル: 読取り、スクリプト作成可能(33)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
PageName: ページ・テンプレートの名前。
結果
-
ResultSets:
-
PageMap(このライブラリ・ノード内に含まれるローカル・ページを含む結果セット。フィールド: PageName、PageParent)
-
LinkList(このライブラリ・ノード内に含まれるリンクのリストを含む結果セット。フィールド: LinkType、LinkData、LinkTitle、LinkDescription)
-
-
ローカル・データ:
-
dSecurityGroup
-
HeaderText
-
LinkSelectedIndex
-
LocationInfo
-
OutOfDate
-
PageFunction
-
PageLastChanged
-
PageName
-
PageParent
-
PageTitle
-
PageType
-
PageUrl
-
restrictByGroup
-
TemplatePage
-
-
レスポンス・テンプレート: null(サービスの実行中に、TemplatePageの値がDIRECTORY_PAGE (dir_page.htm)に設定されます)。
使用
-
アプレット: インストーラ
-
リソース・インクルード:
-
calculate_all_doc_profile_urls
-
home_page_static_content
-
pne_nav_shared_links
-
std_main_page_begin
-
std_page_nav_bar
-
-
標準ナビゲーション: commonNav.js
例
索引ページを取得するには、必須パラメータは次のとおりです。
IdcService=GET_DYNAMIC_PAGE PageName=index Action=GetTemplatePage
GET_PERSONALIZED_JAVASCRIPT
特定のユーザーのページのナビゲーション情報を配信するサービス。ブラウザが最適にJavaScriptをキャッシュする場合、これにより、ブラウザはすべてのページ・ロード時にURLをリクエストできなくなります。ナビゲーション・データが変更される場合、URLの最後に追加される数値IDは変更され、ブラウザはそのページを再ロードします。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_PORTAL_PAGE
「ポータル・デザイン」ページを表示するサービス。最も発生しがちなエラーは、構成情報のロード中、オプション・リストの取得中や参照されるHTMLページが見つからない場合にエラーが発生することです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
Action: 実行するアクション。通常は、GetTemplatePage。
-
PageName: ページ・テンプレートの名前。次の標準ページは、このパラメータを使用して表示されます。
-
「ポータル・デザイン」ページ
PNE_PORTAL_DESIGN_PAGE
-
「システム・リンク」ページ
PNE_PORTAL_SYSTEM_LINKS_PAGE
-
「保存済問合せ」ページ
PNE_PORTAL_SAVED_QUERIES_PAGE
-
「パーソナルURL」ページ
PNE_PORTAL_PERSONAL_URLS_PAGE
-
例
-
「ポータル・デザイン」ページを取得するには、パラメータは次のとおりです。
IdcService=GET_PORTAL_PAGE Action=GetTemplatePage Page=PNE_PORTAL_DESIGN_PAGE
-
「保存済問合せ」ページを取得するには、パラメータは次のとおりです。
IdcService=GET_PORTAL_PAGE Action=GetTemplatePage Page=PNE_PORTAL_SAVED_QUERIES_PAGE
GET_SECURE_PAGE
セキュアなHTMLページ・リクエストを実行するサービス。このサービスは通常、ブラウザ・インタフェースからコールされ、少なくとも1つのグループに対する書込み権限を持つユーザーに制限されます。最も発生しがちなエラーは、参照されるHTMLページが見つからないことです。
このサービスは、このサービスが少なくとも1つのセキュリティ・グループへの書込み権限が必要な場合を除いて、GET_DOC_PAGEでは読取りアクセス権のみが必要です。
このサービスはLOAD_DOC_ENVIRONMENTサブサービスを実行します。
アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)
サブサービスのコール: LOAD_DOC_ENVIRONMENT
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
Page: ページ・テンプレートの名前。
オプションのサービス・パラメータ
-
Action: 実行するアクション。通常は、GetTemplatePage。
結果
-
ResultSets:
-
DocFormats (DocFormatsデータベース表のすべての行およびフィールド)
-
DocTypes (DocTypesデータベース表のすべての行およびフィールド)
-
-
ローカル・データ:
-
TemplateClass
-
TemplateFilePath
-
TemplateType
-
-
レスポンス・テンプレート: Pageパラメータの値として渡されたテンプレートを返します。
使用
-
リソース・インクルード: pne_nav_management_links
-
テンプレート: std_home_page.htm
例
コンテンツ管理ページを取得するには、パラメータは次のとおりです。
IdcService=GET_SECURE_PAGE Page=DOC_MANAGEMENT_LINKS Action=GetTemplatePage
LOAD_GLOBALINCLUDES
ポータル・ページ・コンテンツを返すサービス。このサービスは動的ページのページ・アセンブリ・プロセス中に使用されます。「Webレイアウト・エディタ」アプレットを使用して、「オプション」→「ポータルの更新」を選択します。この画面に表示されるコンテンツは、このサービスを実行する場合に、Content Serverから返されるコンテンツです。
場所: IdcHomeDir
/resources/core/templates//std_services.htm
PAGE_HANDLER
Webレイアウト・エディタで定義される静的Webレイアウト構造を再構築するサービス。HDA形式でページ・リスト全体を返します。このサービスは非同期であり、アクションは、バックグラウンド・スレッドで実行されます。このサービスは、Content Serverインスタンスのコンテキストでのみ実行することができ、Content Serverインスタンスに接続された場合にのみ正常に完了します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
IsRebuild: 再構築を有効にします。
-
Webレイアウト・ページを再構築するには、サーバーに対してtrue (1)に設定する必要があります。
-
デフォルトはfalse (0)です。
-
-
PageFunction:
GetPageList
に設定する必要があります。
例
-
IdcCommandコマンド・ファイル形式(Webレイアウト・ページを再構築):
# Rebuild the entire search index IdcService=PAGE_HANDLER PageFunction=GetPageList IsRebuild=1
-
HDA形式(Webレイアウト・ページを再構築):
@Properties LocalData IdcService=PAGE_HANDLER PageFunction=GetPageList IsRebuild=1 @end
PNE_SAVE_QUERY
現在のユーザーのユーザー・プロファイルに検索問合せを保存するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
このパラメータは動的HTML定義query_save_for_personalization_list_form_common_fieldsのstd_page.htm
で示されます。パラメータは次のとおりです。
-
queryText
-
queryTitle
-
sortField
-
ResultCount
PNE_UPDATE_PERSONAL_URLS
現在のユーザーのユーザー・プロファイルで個人用URLを更新するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
Action: 実行するアクション。通常
GetTemplatePage
に設定されます。 -
Page: ページ・テンプレートの名前。
-
titleEd: ポータル・ナビゲーション・バーに表示されるリンク名。
-
websiteEd: リンクとして保存されるURL。
例
IdcService=PNE_UPDATE_PERSONAL_URLS Page=PNE_PORTAL_PERSONAL_URLS_PAGE Action=GetTemplatePage titleEd=Company websiteEd=http://www.example.com
PNE_UPDATE_PORTAL_INFO
現在のユーザーのユーザー・プロファイルでシステム・リンクを更新するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
Action: 実行するアクション。通常GetTemplatePageに設定されます。
-
PageName: ページ・テンプレートの名前。
例
IdcService=PNE_UPDATE_PORTAL_INFO Page=PNE_PORTAL_DESIGN_PAGE Action=GetTemplatePage
SAVE_GLOBALINCLUDES
動的ページのページ・アセンブリ・プロセス中に使用されるすべてのグローバル・インクルードを保存するサービス。このサービスは、Webレイアウト・エディタからポータル・ページを更新する際に実行されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
IsRebuild: ポータル・ページの再構築を有効にします。
-
ポータル・ページを更新するには、Content Serverシステムに対して1 (true)に設定する必要があります。
-
デフォルトは0 falseです。
-
-
PageFunction:
GetPageList
に設定する必要があります。
例
IdcService=SAVE_GLOBALINCLUDES PageFunction=GetPageList IsRebuild=1
UPDATE_RESULT_TEMPLATE
検索結果テンプレートを更新するサービス。
「Webレイアウト・エディタ」アプレットを起動して、「オプション」→「問合せ結果ページ」を選択し、「追加」、「削除」または「編集」をクリックし、テンプレート情報を入力して、「OK」をクリックすると、このサービスが実行されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
注意:
HDA形式で新しい問合せ結果テンプレートを追加するために必要なエントリの次の例を参照してください。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=UPDATE_RESULT_TEMPLATE
-
HDAファイル形式(my_research_templateと呼ばれる新しい問合せ結果テンプレートを追加します)。
@Properties LocalData IdcService=UPDATE_RESULT_TEMPLATE @end @ResultSet ResultPageUpdates 6 name formtype filename outfilename flexdata description my_research_template ResultsPage Text2<$dDocAuthor$><$dSecurityGroup$>Text1<$dDocTitle$> testing the update template sevice @end
ノート:
ResultsPageエントリとText2エントリ間に2つの空行があることに注意してください。これは、filenameおよびoutfilenameに値がないため必要です(空行は空の値を定義します)。
プロバイダ・マネージャ・サービス(コアContent Server)
プロバイダ・マネージャ・サービスは、外部エンティティへの接続を確立するプロバイダを処理します。この項では、次のサービスについて説明します。
ADD_EDIT_PROVIDER
新しいプロバイダを作成するサービス。最も発生しがちなエラーは、プロバイダ名が一意でないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
pName: プロバイダ名。
-
ProviderClass: プロバイダ・クラス。
-
pDescription: プロバイダの説明。
-
pType: プロバイダのタイプ。
-
データベース: 接続および通信用のAPIを提供する情報リポジトリ・サーバー。これは、情報を取得し、情報をデータベースで変更できるようにします。このタイプの例は、システム・データベースおよびLDAPです。
-
受信: ブラウザまたはクライアント・アプリケーションのような、外部エンティティから開始された接続。サーバーはリスニングを行い、受信接続を認識します。
-
送信: 外部エンティティに対して開始された接続。このタイプを使用して、コンテンツ・サーバー・インスタンス間の通信ができます。
-
プレビュー: DTM server for HTML PreviewとContent Categorizerのように、Content Serverとプレビュー・テクノロジ間の接続を確立するAPI。
-
LDAP: Lightweight Directory Access Protocol。
-
例
IdcService=ADD_EDIT_PROVIDER pName=admin_provider pType=Database pDescription=provider description ProviderClass=providerclass
APPEND_DATABASE_AUDIT_INFO
「システム監査情報」ページの情報を返すためにGET_SYSTEM_AUDIT_INFOで使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_PROVIDER
既存のプロバイダを削除するサービス。最も発生しがちなエラーは、プロバイダ名がシステムに存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
pName: プロバイダ名。
例
IdcService=DELETE_PROVIDE pName=Proxied_2_on_test13
ENABLE_DISABLE_PROVIDER
既存のプロバイダの状態の有効化/無効化を元に戻すサービス。プロバイダが有効な場合、サービスはその状態を無効にします。プロバイダが無効な場合、サービスはその状態を有効にします。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
pName: プロバイダ名。
-
pDescription: プロバイダの説明。
-
pType: プロバイダのタイプを作成するために使用されます。どのコンポーネントもその独自のプロバイダ・タイプを追加できます。現在、次のタイプが承認されています。
-
データベース: 接続および通信用のAPIを提供する情報リポジトリ・サーバー。これは、情報を取得し、情報をデータベースで変更できるようにします。このタイプの例は、システム・データベースおよびLDAPです。
-
受信: ブラウザまたはクライアント・アプリケーションのような、外部エンティティから開始された接続。サーバーはリスニングを行い、受信接続を認識します。
-
送信: 外部エンティティに対して開始された接続。このタイプを使用して、コンテンツ・サーバー・インスタンス間の通信ができます。
-
プレビュー: DTM server for HTML PreviewとContent Categorizerのように、Content Serverとプレビュー・テクノロジ間の接続を確立するAPI。
-
LDAP: Lightweight Directory Access Protocol。
-
オプションのサービス・パラメータ
-
IsEnabled: プロバイダの必要な状態、trueまたはfalse。
例
IdcService=ENABLE_DISABLE_PROVIDER pName=Proxied_2_on_test13 pType=outgoing
GET_ADD_EDIT_PROVIDER_FORM
ブラウザでプロバイダを追加または編集するためのフォームを返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
isEdit: 1 (true): 既存のプロバイダが編集されます。0 (false): 新しいプロバイダが追加されます。
-
pName: プロバイダ名。プロバイダを編集する場合にのみ必要。
-
pType: プロバイダのタイプ。
-
データベース: 接続および通信用のAPIを提供する情報リポジトリ・サーバー。これは、情報を取得し、情報をデータベースで変更できるようにします。このタイプの例は、システム・データベースおよびLDAPです。
-
受信: ブラウザまたはクライアント・アプリケーションのような、外部エンティティから開始された接続。サーバーはリスニングを行い、受信接続を認識します。
-
送信: 外部エンティティに対して開始された接続。このタイプを使用して、コンテンツ・サーバー・インスタンス間の通信ができます。
-
プレビュー: DTM server for HTML PreviewとContent CategorizerのようにContent Serverとプレビュー・テクノロジ間の接続を確立するAPI。
-
LDAP: Lightweight Directory Access Protocol。
-
-
ResourceTemplate: フォームのリソース・テンプレート。プロバイダを追加する場合にのみ必要。
例
-
プロバイダを追加する場合は、渡すパラメータは次のようになります。
IdcService=GET_ADD_EDIT_PROVIDER_FORM pType=preview ResourceTemplate=PROVIDER_ADD_PREVIEW isEdit=0
-
プロバイダを編集する場合は、渡すパラメータは次のようになります。
IdcService=GET_ADD_EDIT_PROVIDER_FORM pType=outgoing pName=Proxied_2_on_server02 isEdit=1
GET_PROVIDER_INFO
プロバイダに関する情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
pName: プロバイダ名。
-
ResourceTemplate: ページ表示のリソース・テンプレート。ブラウザ・インタフェースからサービスを実行する場合にのみ必要。たとえば:
ResourceTemplate=DATABASE_PROVIDER_INFO
例
IdcService=GET_PROVIDER_INFO pName=SystemDatabase
NOTIFY_CHANGE
送信プロバイダ経由で変更のContent Serverインスタンスを別のContent Serverインスタンスに通知するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
IDC_Name: 通知されるContent Serverインスタンスの名前。
例
IdcService=NOTIFY_CHANGE IDC_Name=Master_on_server01
REQUEST_SECURITYINFO
Content Serverインスタンスからすべてのセキュリティおよびユーザー情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
スキーマ・サービス(コアContent Server)
これらのサービスは、オプション・リストなど、データベース表のJavaScriptファイルのサーバー側の公開を管理します。この項では、次のサービスについて説明します。
ADD_SCHEMA_FIELD
スキーマ表にフィールドを追加するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schFieldName: 含めるフィールドの名前。
ADD_SCHEMA_RELATION
既存のスキーマにリレーションを追加するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schRelationName: 含めるリレーションの名前。
ADD_SCHEMA_VIEW
スキーマに新しいビューを追加するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 追加されるビューの名前。
-
schViewType: 追加されるスキーマ・ビューのタイプ。
-
schTableName: ビューを関連付ける表の名前。
ADDOREDIT_SCHEMA_TABLE
スキーマで使用される表を追加または編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
DELETE_SCHEMA_FIELD
スキーマ表からフィールドを削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schFieldName: 削除されるフィールドの名前。
DELETE_SCHEMA_RELATION
スキーマからリレーションを削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schRelationName: 削除されるリレーションの名前。
DELETE_SCHEMA_TABLE
スキーマから表を削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schTableName: 削除されるリレーションの名前。
DELETE_SCHEMA_VIEW
スキーマからビューを削除するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 削除されるビューの名前。
EDIT_SCHEMA_FIELD
スキーマでフィールドを編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schFieldName: 編集されるフィールドの名前。
EDIT_SCHEMA_NODE
スキーマでノードを編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
editViewValueAction: ノードに使用されるアクション。
-
schViewName: ノードに使用されるビューの名前。
EDIT_SCHEMA_RELATION
スキーマ・リレーションを編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schRelationName: 編集されるリレーションの名前。
-
schTablenTable: リレーションに使用される表の番号(たとえば、Table1、Table2)。この値が提供されない場合、リレーションの表は使用されません。
EDIT_SCHEMA_VIEW
スキーマ・ビューを編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewType: 編集されるビューのタイプ。
-
schViewName: 編集されるビューの名前。
-
schTableName: スキーマに関連付けられている表の名前。
EDIT_SCHEMA_VIEW_VALUES
スキーマ・ビューで値を編集するために使用されるサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 使用されるビューの名前。
GET_SCHEMA_FIELD_INFO
特定のスキーマ・フィールドに関する情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schFieldName: 使用されるフィールドの名前。
GET_SCHEMA_FIELDS
スキーマで使用されるフィールドに関する情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SCHEMA_RELATIONS
スキーマとともに使用されるリレーションに関する情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SCHEMA_STATS
「システム監査情報」ページの「アクティブなコンソール出力トレース・レポートの編集」スキーマの使用に関する統計を収集するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SCHEMA_TABLE_INFO
スキーマで使用されるすべての表に関する情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SCHEMA_TABLES
表に関する情報およびスキーマで使用される表の情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SCHEMA_VIEW_EDIT_INFO
スキーマ・ビューの編集可能な情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 使用されるビューの名前。
GET_SCHEMA_VIEW_FRAGMENT
スキーマベースのオプション・リストのフラグメントを返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 使用されるビューの名前。
オプションのサービス・パラメータ
-
schRelationName: このフィールドがDependent Choice List (DCL)である場合、これはリスト結果をフィルタするために使用されるスキーマ・リレーションの名前です。
-
schParentValue: このフィールドがDCLである場合、これはリストをフィルタするために使用される親フィールドの値です。
GET_SCHEMA_VIEW_INFO
指定されたビューの表および他の情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 使用されるビューの名前。
GET_SCHEMA_VIEW_VALUES
指定されたビューで値を表示するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
schViewName: 使用されるビューの名前。
検索サービス(コアContent Server)
検索サービスは、Content Serverシステム内の検索を管理するために使用されます。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、次のサービスについて説明します。
APPEND_SEARCH_AUDIT_INFO
「システム監査情報」ページの情報を返すためにGET_SYSTEM_AUDIT_INFOで使用されるサブサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_EXTERNAL_DOC_INFO
外部Verityコレクションからのコンテンツ情報を取得するサービス。LightlyManagedContentコンポーネントとともに使用されます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
sCollectionID: コレクションを検索するために、Content Serverシステムによって使用されるコレクションID。
例
IdcService=GET_EXTERNAL_DOC_INFO dDocName=adminform113
GET_EXTERNAL_HIGHLIGHT_INFO
外部コレクションのコンテンツ・アイテムのPDFまたはHTML強調表示情報を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
HighlightType: 強調表示のタイプ。
-
PDFの場合は、
PdfHighlight
を使用します。 -
HTMLの場合は、
HtmlHighlight
を使用します。
-
-
QueryText: 全文検索表現。
-
SortField: ソートの基準となるメタデータ・フィールドの名前。
-
例: dInDate、dOutDate、alternateFile。
-
デフォルトはDocIdです。
-
SortOrder: ソート順序。使用できる値は、ASC (昇順)およびDESC (降順)です。
-
例
IdcService=GET_EXTERNAL_HIGHLIGHT_INFO dDocName=test113 HighlightType=PdfHighlight QueryText=test SortField=dInDate SortOrder=Desc
GET_EXTERNAL_XML_HIGHLIGHT_INFO
外部コレクションのコンテンツ・アイテムのXML強調表示情報を返すサービス。このサービスは、ユーザーがブラウザ環境でPDFドキュメントの全文検索を実行している場合にコールされます。これは、ユーザーが結果ページのPDFのリンクを選択し、PDFで強調表示された単語を表示する場合に行われます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
HighlightType: 強調表示のタイプ。
-
PDFの場合は、
PdfHighlight
を使用します。 -
HTMLの場合は、
HtmlHighlight
を使用します。
-
-
QueryText: 全文検索表現。
-
SortField: ソートの基準となるメタデータ・フィールドの名前。
-
例: dInDate、dOutDate、alternateFile。
-
デフォルトはDocIdです。
-
-
SortOrder: ソート順序。使用できる値は、ASC (昇順)およびDESC (降順)です。
例
IdcService=GET_EXTERNAL_XML_HIGHLIGHT_INFO dDocName=test113 HighlightType=PdfHighlight QueryText=test SortField=dInDate SortOrder=Desc
GET_HIGHLIGHT_INFO
コンテンツ・アイテムのPDFまたはHTML強調表示情報を返すサービス。
このサービスは、全文検索を実行し、検索結果ページでコンテンツIDまたはサムネイルをクリックする場合にブラウザ・インタフェースから実行されます。表示されたページで、検索した単語が強調表示されます。HTMLドキュメントの場合、単語は太字で表示され、PDFドキュメントの場合、単語は強調表示されます。
最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがセキュリティ・チェックに失敗することです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
QueryText: 全文検索表現。
-
SortField: ソートの基準となるメタデータ・フィールドの名前。
-
例: dInDate、dOutDate、alternateFile。
-
デフォルトはDocIdです。
-
-
SortOrder: ソート順序。使用できる値は、ASC (昇順)およびDESC (降順)です。
オプションのサービス・パラメータ
-
dWebExtension: Web表示可能コンテンツのファイル拡張子。たとえば、html、pdf、またはtxt。
-
HighlightType: 強調表示のタイプ。
-
PDFの場合は、
PdfHighlight
を使用します。 -
HTMLの場合は、
HtmlHighlight
を使用します。
-
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=GET_HIGHLIGHT_INFO dDocName=test_000043 QueryText=service SortField=dInDate SortOrder=Desc
-
任意のパラメータを持つHDA形式:
@Properties LocalData IdcService=GET_HIGHLIGHT_INFO dDocName=test_000043 QueryText=service SortField=dInDate SortOrder=Desc HighlightType=HtmlHighlight dWebExtension=html @end
GET_SEARCH_RESULTS
特定の検索条件に一致するコンテンツ・アイテムのリストを返すサービス。
アクセス・レベル: 読取り(1)
サブサービスのコール: SUB
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
QueryText: 全文検索表現。
QueryTextパラメータにTitleやContent IDなどの値を添付して、このサービスで返される結果を絞り込むことができます。
オプションのサービス・パラメータ
-
ResultCount: 返される結果の数。デフォルトは25です。
-
SearchEngineName: 使用される検索エンジンの名前。デフォルトは、
config/config.cfg
ファイルで指定された値です。値は、
databasefulltext
またはdatabase
を指定できます。database
またはdatabasefulltext
に設定される場合、この例のように、QueryTextパラメータでSQLを渡す必要があります。dDocTitle like 'test'
これは、Verity問合せと同等です。
dDocTitle <substring> 'test'
-
SortField: ソートの基準となるメタデータ・フィールドの名前。
-
例: dInDate、dDocTitle、Score。
-
デフォルトはdInDateです。
-
-
SortOrder: ソート順序。使用できる値は、ASC (昇順)およびDESC (降順)です。
-
SortSpec: 複数のフィールドのソートを可能にします。このパラメータを次の順序に設定します。
<sort field> <sort order> <sort field> <sort order>...
たとえば、
SortSpec=dDocTitle ASC dInDate DESC
。-
StartRow: 検索結果表示を開始する行。たとえば、ResultCount=25の場合、StartRow=26に設定すると、結果の2番目のページが表示されます。
-
EndRow: 検索結果表示を終了する行。
-
-
vcrContentType: 検索可能なコンテンツ・タイプの名前。サーバーは、そのタイプのドキュメントに結果を制限するために、検索の問合せテキストを変更します。たとえば、指定されたコンテンツ・タイプがプロファイルを記述するタイプである場合、プロファイル・トリガー値がそのプロファイルの値と一致するユーザーに返されるドキュメントに制限するために、検索の問合せが変更されます。
-
vcrAppendObjectClassInfo: trueに設定される場合、サーバーはvcrObjectClassというSearchResults ResultSetに列を追加します。この列は、結果の各ドキュメントに関連付けられているコンテンツ・タイプをリストします。デフォルトはtrueです。
例
IdcService=GET_SEARCH_RESULTS QueryText=benefits
GET_SEARCH_RESULTS_FORCELOGIN
検索結果を取得する前に、ユーザーを強制的にログインさせるサービス。このサービスはGET_SEARCH_RESULTSと同じです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_XML_HIGHLIGHT_INFO
コンテンツ・アイテムのXML強調表示情報を返すサービス。
このサービスは、ユーザーがブラウザ環境でPDFドキュメントの全文検索を実行している場合にコールされます。ユーザーが結果ページのPDFのリンクを選択し、PDFで強調表示された単語を表示する場合。
最も発生しがちなエラーは、コンテンツ・アイテム名が存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dDocName: コンテンツ・アイテムのコンテンツID。
-
HighlightType: 強調表示のタイプ。
-
PDFの場合は、
PdfHighlight
を使用します。 -
HTMLの場合は、
HtmlHighlight
を使用します。
-
-
QueryText: 全文検索表現。
-
SortField: ソートの基準となるメタデータ・フィールドの名前。
-
例: dInDate、dOutDate、alternateFile。
-
デフォルトはDocIdです。
-
-
SortOrder: ソート順序。使用できる値は、ASC (昇順)およびDESC (降順)です。
例
IdcService=GET_XML_HIGHLIGHT_INFO dDocName=test13 QueryText=service SortField=dInDate SortOrder=Desc dDocName=TEST13 HighlightType=PdfHighlight
PNE_GET_SEARCH_RESULTS
検索結果を取得するために使用されるサービス。その表示は、ユーザーの環境設定(つまり、PNE設定)によって制御されます。
このサービスのQueryTextは、定義された検索エンジンを対象としており、そういうものとして、GET_SEARCH_RESULTSサービスに利用可能なすべてのパラメータを使用できます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
QueryText: 全文検索表現。
例
IdcService=PNE_GET_SEARCH_RESULTS QueryText=benefits
VIEW_DOC
強調表示情報を返すサービス。
-
コンテンツ・アイテム名が指定されると、このサービスはセキュリティ情報を評価し、コンテンツ・アイテム強調表示情報を表示します。
-
通常、このサービスは、Content Server検索コレクションではなく外部コレクションを持つ場合に使用されます。ただし、いずれの場合も、検索コレクションはVerity検索エンジンによって作成される必要があります。たとえば、外部コレクションで検索を実行する場合、コレクションがContent Serverインスタンスによって検索できるように、VdkVgwKeyおよびsCollectionIDパラメータを提供する必要があります。
-
通常、VdkVgwKeyはdDocNameです。Verityは各コンテンツ・アイテムに一意のIDを提供し、Content ServerシステムはそのVerity ID (VdkVgwKey)をdDocName (Content ID)とともにマップします。
-
場所:
IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
QueryText: 全文検索表現。
-
sCollectionID: コレクションを検索するために、Content Serverシステムによって使用されるコレクションID。
-
SortField: ソートの基準となるメタデータ・フィールドの名前。
-
例: dInDate、dOutDate、alternateFile。
-
デフォルトはdocIDです。
-
-
SortOrder: ソート順序。使用できる値は、Asc(昇順)およびDesc(降順)です。
オプションのサービス・パラメータ
-
ViewType: 表示形式。このパラメータが定義されていない場合、ViewTextがデフォルトで使用されます。
-
ViewText
に設定すると、Textとして表示されます。 -
ViewHtml
に設定すると、HTMLとして表示されます。
-
例
IdcService=VIEW_DOC IsCollectionID=external SortField=dInDate SortOrder=Desc QueryText=test ViewType=ViewText
ユーザー・サービス(コアContent Server)
ユーザー・サービスは、アカウント、エイリアス、ロールを追加するなど、ユーザー関連のアクティビティの管理を支援します。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、次のサービスについて説明します。
ADD_ALIAS
新しいエイリアスを作成するために使用されます。最も発生しがちなエラーは、パラメータに不整合があること、ユーザーまたはエイリアスがシステムにすでに存在することです。
「ユーザー管理」アプレットを使用してエイリアスを追加する場合、少なくとも1人のユーザーを追加する必要があります。ただし、IdcCommandまたはIdcCommandXを使用してユーザーを追加する必要はありません。IdcCommandまたはIdcCommandXを使用してユーザーを追加するには、オプション・パラメータAliasUsersStringを含む必要があります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dAlias: エイリアス。
-
dAliasDescription: エイリアスの説明。
オプションのサービス・パラメータ
-
AliasUsersString: エイリアスまたはユーザー。複数のユーザーを追加するには:
-
HDA形式で: この例のようにHDA形式を使用する場合は、各ユーザー名の間に
\n
エスケープ・シーケンスを使用します。 -
AliasUsersString=sysadmin\nuser1
-
SOAP形式を使用する場合は、エンコードされていない行送りをXMLに直接挿入するか、または行送りを
( )
としてエンコードします。
-
例
-
エイリアスを作成し、ユーザーを追加するには、必須パラメータは次のとおりです。
IdcService=ADD_ALIAS dAlias=my_alias dAliasDescription=admin users AliasUsersString=sysadmin
-
HDA形式で、AliasUsersStringパラメータを指定してユーザーを追加します。
@Properties LocalData IdcService=ADD_ALIAS dAlias=my_alias dAliasDescription=admin users AliasUsersString=sysadmin @end
-
HDA形式で、AliasUserMapおよびAlias結果セットを指定してユーザーを追加します。
@Properties LocalData IdcService=ADD_ALIAS changedSubjects=aliases,1008291537850 dAliasDescription=Test Alias refreshSubjects= blFieldTypes=StatusMessage message blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM loadedUserAttributes=1 dUser=sysadmin IsJava=1 changedMonikers= refreshSubMonikers= refreshMonikers= dAlias=NewAlias @end @ResultSet AliasUserMap 2 dAlias 6 30 dUserName 6 50 YourAlias Gillian @end @ResultSet Alias 2 dAlias 6 30 dAliasDescription 6 50 MyAlias This is a test of adding an alias NewAlias Test Alias YourAlias Test Alias @end
ADD_GROUP
新しいセキュリティ・グループを作成するサービス。最も発生しがちなエラーは、セキュリティ・グループ名が一意でないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dGroupName: セキュリティ・グループ名。
-
dDescription: セキュリティ・グループの説明。
-
dPrivilege: 権限の設定。
この値が0に設定され、管理者ロールがセキュリティ・グループに対してRWDA権限を持つ場合、他のロールはそのセキュリティ・グループにアクセスできません。値が15に設定される場合、すべてのロールがセキュリティ・グループに対するRWDA権限を取得します。権限の詳細は、『Oracle WebCenter Contentの管理』の権限に関する項を参照してください。
例
IdcService=ADD_GROUP dGroupName=NEW_GROUP dPrivilege=15 dDescription=admin privileges
ADD_ROLE
新しいロールを作成するサービス。ロールは、各セキュリティ・グループに対する一連の権限(読取り、書込み、削除、管理者)です。
このサービスは、すべての既存のセキュリティ・グループのRoleDefinition表に行を追加します。最も発生しがちなエラーは、ロール名が一意でないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dRoleName: ロール名。
-
dPrivilege: 権限の設定。
この値が0に設定される場合、管理者ロールのみがセキュリティ・グループに対するRWDA権限を持ちます。他のロールはセキュリティ・グループにアクセスできません。値が15に設定される場合、すべてのロールがセキュリティ・グループに対するRWDA権限を取得します。権限の詳細は、『Oracle WebCenter Contentの管理』の権限に関する項を参照してください。
例
IdcService=ADD_ROLE dRoleName=specialuser dPrivilege=15
ADD_USER
新しいユーザーを作成するために使用されるサービス。最も発生しがちなエラーは、ユーザー名が一意でないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: ユーザー名。
-
dUserAuthType: ユーザーの認可タイプ。この値は、LocalまたはGlobalのいずれかに設定する必要があります。
オプションのサービス・パラメータ
-
dFullName: ユーザーのフルネーム。
-
dPassword: ユーザーのパスワード。
-
dEmail: ユーザーの電子メール・アドレス。
オプションの属性情報
オプションの属性情報は、ユーザーの属性情報を含み、ユーザーが属するロールおよびユーザーがアクセス権を持つアカウントを参照する結果セットで指定されます。属性情報は、3つのカンマ区切りの文字列のリストで構成されます。最初の文字列は、属性のタイプを示し、2番目の文字列は属性の名前を示し、3番目の文字列はアカウントのアクセス番号またはロールのデフォルトのエントリを示します。
ノート:
ユーザー属性情報は、事前定義されていません。デフォルトでは、新しいユーザーはロールまたはアカウントに属さず、システム内のゲストになります。
-
属性のタイプ: ロールを定義するとき、最初の文字列ではこれがrole属性であることを指定し、2番目の文字列はロールの名前、3番目の文字列はデフォルト・エントリの15になります。
アカウントを定義するとき、最初の文字列ではこれがaccount属性であることを指定し、2番目の文字列はアカウントの名前、3番目の文字列はアクセス・レベルになります。
-
role属性の場合、情報は次のようなフォームになります。
-
role,contributor,15
-
account属性の場合、情報は次のようなフォームになります。
-
account,books,1
-
-
属性名: ユーザーは、複数のロールおよびアカウントに属することができます。そのため、属性情報列に、カンマで区切られた複数のロールおよびアカウント情報文字列が存在する可能性があります。ユーザーが管理者ロールを持つようにする場合、ユーザー属性情報は次のとおり定義します。
@ResultSet UserAttribInfo 2 dUserName AttributeInfo jsmith role,contributor,15 @end
ユーザーがコントリビュータとエディタの両方のロールに属し、かつ会計帳簿の読取り権限を持つようにする場合、ユーザー属性情報は次のように定義します。
@ResultSet UserAttribInfo 2 dUserName AttributeInfo jsmith role,contributor,15,role,editor,15,account,books,1 @end
-
アクセス番号: ユーザーに次のアクセス番号を割り当てることができます。
-
1: 読取り専用
-
3: 読取りと書込み
-
7: 読取り、書込み、削除
-
15: 管理者権限
-
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=ADD_USER dName=specialuser dUserAuthType=LOCAL
-
任意のパラメータを持つHDA形式:
@Properties LocalData IdcService=ADD_USER dName=jsmith dUserAuthType=LOCAL dFullName=Jennifer Smith dPassword=password dEmail=jsmith@example.com @end @ResultSet UserAttribInfo 2 dUserName AttributeInfo jsmith role,admin,15,role,contributor,15 @end
CHANGE_USER_AUTH_TYPE
ユーザーの認可タイプ(グローバル、ローカルまたは外部)を変更するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
curUserAuthType: 現在のユーザーの認可タイプ。
-
dUserAuthType: 新しいユーザーの認可タイプ。
CHECK_USER_CREDENTIALS
ユーザーの資格証明をチェックするサービス。このサービスを使用して、ユーザーに関する情報(たとえば、ロールやアカウント)を取得し、それを使用してユーザー/パスワードのペアをチェックし、それらが一致することを確認できます。このサービスは認可プロセス中にコールされます。データはキャッシュされ、すべてのサービス・リクエストに対してコールされないようにします。
このサービスは、Content ServerインスタンスがADSIを使用するように構成される場合は、Microsoft Active Directory管理対象ユーザー用のユーザー・データを返しません。ローカル・ユーザーおよび外部LDAP管理対象ユーザー用のユーザー・データを返します。
アクセス・レベル: N/A (0)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
userName: ユーザー名
オプションのサービス・パラメータ
-
getUserInfo: 0 (false): 拡張されたユーザー情報を取得しません。1 (true): 拡張されたユーザー情報を取得します(フルネーム、電子メール・アドレス、ロケールおよびユーザー・タイプ)
-
hasSecurityInfo: 0 (false): ユーザー・アカウントを取得します。1 (true): ユーザー・アカウントを取得しません。
-
authenticateUser: 0 (false): ユーザーを認可しません(ユーザー/パスワードのペアが一致することを検証します)。1 (true): ユーザーを認可します(ユーザー/パスワードのペアが一致することを検証します)。この場合、userPasswordパラメータを指定する必要があります。
-
userPassword: 指定したユーザー名のパスワード。authenticateUserパラメータが含まれ、1 (true)に設定される場合、userPasswordパラメータを指定する必要があります。
-
userExtendedInfo: このパラメータは、getUserInfoパラメータと組み合せて、データ・バインダにユーザーのアカウントとグループを返します。0 (false): 情報を取得しません。1 (true): 情報を取得します。
結果
-
ローカル・データ:
-
extendedInfo: ユーザー情報フィールドを含むHDAエンコード文字列(ndUserLocale、nblFieldTypes、ndEmail、nblDateFormat、ndFullName、ndUserType、ndUserAuthType、ndUserChangeDate、ndUserTimeZoneおよびndUserArriveDate)。オプション・パラメータ「getUserInfo」が1 (true)の場合にのみ返されます。
-
accounts: ユーザーのアカウントのカンマ区切りリスト。オプション・パラメータhasSecurityInfoが0 (false)の場合にのみ返されます。
-
roles: ユーザーのロールのカンマ区切りリスト。オプション・パラメータhasSecurityInfoが0 (false)の場合にのみ返されます。
-
hasSecurtyInfo: セキュリティ情報がレスポンスに存在する場合は、1 (true)を返します。
-
isAuthenticated: オプション・パラメータauthenticateUserが1 (true)に設定され、オプション・パラメータuserPasswordがuserNameに対応するパスワードに一致する場合は、1 (true)を返します。
-
isPromptLogin: userPasswordがuserNameに対応しない場合は1 (true)を返します。この状況では他のデータは返されません。
-
例
次は、ユーザーに関する情報を取得するためのCHECK_USER_CREDENTIALSサービス・コールの例です。
@Properties LocalData IdcService=CHECK_USER_CREDENTIALS userName=user1 getUserInfo=1 @end
次は、ユーザー情報を取得するためにこのサービス・コールによって返される結果の例です(アカウントが返されることに注意してください)。
Content-type: text/plain <?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?> @Properties LocalData dUser=user1 blFieldTypes= dUserOrgPath= refreshSubMonikers= accounts=#none,prj(RWD) blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago StatusCode=0 dUserSourceOrgPath= hasSecurityInfo=1 roles=contributor refreshSubjects= changedSubjects= dName=user1 refreshMonikers= changedMonikers= extendedInfo=\@Properties LocalData\nu9=\nu8=\nu7=\ndUserArriveDate= {ts '2003-02-11 08:34:35'}\nu6=\ndUserTimeZone=\nu5=\nu4=\nu3=\nu2= \ndUserAuthType=LOCAL\nu1=\ndUserType=\ndUserChangeDate={ts '2003-04-03 11:57:29'} \nuPhone=\nuCompany=\ndUserLocale=English-US\nblFieldTypes=\nu24=\nu23=\nu22= \nu21=\nu20=\ndFullName=user1\nblDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago\ndEmail=\nu19=\nu18=\nu17=\nu16=\nu15=\nu14=\nu13=\nu12= \nu11=\nu10=\n\@end\n\n @end
次は、ユーザー情報を取得するためにこのサービス・コールによって返される結果の例です(アカウントが返されないことに注意してください)。
Content-type: text/plain <?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?> @Properties LocalData dUser=user1 blFieldTypes= refreshSubMonikers= blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago StatusCode=0 changedSubjects= refreshSubjects= dName=user1 changedMonikers= refreshMonikers= extendedInfo=\@Properties LocalData\nu9=\nu8=\nu7=\ndUserArriveDate= {ts '2003-02-11 08:34:35'}\nu6=\ndUserTimeZone=\nu5=\nu4=\nu3=\nu2= \ndUserAuthType=LOCAL\nu1=\ndUserType=\ndUserChangeDate={ts '2003-04-03 11:57:29'}\nuPhone=\nuCompany=\ndUserLocale=English-US\nblFieldTypes=\nu24=\nu23= \nu22=\nu21=\nu20=\ndFullName=user1\nblDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago\ndEmail=\nu19=\nu18=\nu17=\nu16=\nu15=\nu14=\nu13=\nu12= \nu11=\nu10=\n\@end\n\n @end
次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためのCHECK_USER_CREDENTIALSサービス・コールの例です。
@Properties LocalData IdcService=CHECK_USER_CREDENTIALS userName=user1 authenticateUser=1 userPassword=idc @end
次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためにこのサービス・コールによって返される結果の例です(ユーザー名およびパスワードが一致していること、キーの戻り値がisAuthenticated=1であることに注意してください)。
Content-type: text/plain <?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?> @Properties LocalData dUser=user1 blFieldTypes= refreshSubMonikers= blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago StatusCode=0 changedSubjects= refreshSubjects= dName=user1 changedMonikers= refreshMonikers= isAuthenticated=1 @end
次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためのCHECK_USER_CREDENTIALSサービス・コールの別の例です。
@Properties LocalData IdcService=CHECK_USER_CREDENTIALS userName=user1 authenticateUser=1 userPassword=pppp @end
次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためにこのサービス・コールによって返される結果の例です(ユーザー名およびパスワードが一致していないこと、isAuthenticated=1ではなく、isPromptLogin=1が返されることに注意してください)。
Content-type: text/plain <?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?> @Properties LocalData dUser=user1 blFieldTypes= refreshSubMonikers= blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago StatusCode=0 isPromptLogin=1 changedSubjects= refreshSubjects= dName=user1 changedMonikers= refreshMonikers= @end
DELETE_ALIAS
既存のエイリアスを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、エイリアスがワークフローで使用されないこと、またはシステムがエイリアスまたはユーザーを削除できないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dAlias: エイリアス。
例
IdcService=DELETE_ALIAS dAlias=admin_alias
DELETE_GROUP
既存のセキュリティ・グループを削除するサービス。最も発生しがちなエラーは、このグループに関連付けられているコンテンツ・アイテムまたはワークフローがシステムに存在することです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dGroupName: セキュリティ・グループ名。
例
IdcService=DELETE_GROUP dGroupName=admingroup
DELETE_ROLE
既存のロールを削除するサービス。最も発生しがちなエラーは、指定されたロールが存在しないか、ユーザーがこのロールを割り当てられていることです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dRoleName: ロール名。
例
IdcService=DELETE_ROLE dRoleName=test_role
DELETE_USER
既存のユーザーを削除するサービス。最も発生しがちなエラーは、ユーザーがエイリアスに割り当てられていることです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: ユーザー名。
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=DELETE_USER dName=jsmith
-
HDA形式:
@Properties LocalData IdcService=DELETE_USER dName=jsmith @end
EDIT_ALIAS
既存のエイリアスを変更するサービス。ユーザーを編集および追加するには、AliasUsersStringパラメータを含める必要があります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
注意:
エイリアスを編集すると、エイリアスからすべての既存のデータ(説明およびユーザー)が削除されます。既存のデータを保持するには、新しいデータとともに既存のデータを含める必要があります。
追加の必須サービス・パラメータ
-
dAlias: エイリアス。
-
dAliasDescription: エイリアスの説明。
-
AliasUsersString: エイリアスまたはユーザー。複数のユーザーを追加するには:
-
HDA形式で: この例のようにHDA形式を使用する場合は、各ユーザー名の間に
\n
エスケープ・シーケンスを使用します。AliasUsersString=sysadmin\nuser1
-
SOAP形式を使用する場合は、エンコードされていない行送りをXMLに直接挿入するか、または行送りを
( )
としてエンコードします。
-
例
-
エイリアスの編集:
IdcService=EDIT_ALIAS dAlias=my_alias dAliasDescription=new user AliasUsersString=sysadmin\nuser1
-
HDA形式では、AliasUsersStringパラメータを指定してユーザーを追加します。
@Properties LocalData monitoredTopics=appcommongui,1000382277000 IdcService=EDIT_ALIAS dAliasDescription=Test Alias blFieldTypes= blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM watchedMonikers= monitoredSubjects=usermetaoptlists,1008541017549,aliases,1008541017549, userlist,1008541017549,users,1008541017549,metadata,1008541017549,config,100854 1017549,accounts,1008541017549 AliasUsersString=Gillian\nMonique\nsysadmin\n dAlias=YourAlias @end
-
HDA形式では、AliasUserMapおよびAlias結果セットを指定してユーザーを追加します。
@Properties LocalData refreshMonikers= IsJava=1 refreshSubMonikers= refreshSubjects=aliases,1008541017551 dAlias=YourAlias refreshTopics= AliasUsersString=Gillian\nMonique\nsysadmin\n ClientEncoding=Cp1252 dUser=sysadmin blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM monitoredSubjects=usermetaoptlists,1008541017549,aliases,1008541017549, userlist,1008541017549,users,1008541017549,metadata,1008541017549,config, 1008541017549,accounts,1008541017549 loadedUserAttributes=1 dUserName=sysadmin watchedMonikers= IdcService=EDIT_ALIAS blFieldTypes=StatusMessage message changedMonikers= dAliasDescription=Test Alias changedSubjects= monitoredTopics=appcommongui,1000382277000 @end @ResultSet AliasUserMap 2 dAlias 6 30 dUserName 6 50 YourAlias Gillian YourAlias Monique YourAlias sysadmin @end @ResultSet UpdatedUserTopics 3 topicName topicValue topicTS @end @ResultSet Alias 2 dAlias 6 30 dAliasDescription 6 50 MyAlias This is a test of adding an alias NewAlias Test Alias YourAlias Test Alias @end
EDIT_GROUP
既存のセキュリティ・グループを変更するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dGroupName: セキュリティ・グループ名。
-
dDescription: セキュリティ・グループの説明。
-
dPrivilege: 権限の設定。
この値が0に設定される場合、管理者ロールのみがグループに対するRWDA権限を持ちます。他のロールはグループにアクセスできません。値が15に設定される場合、すべてのロールがグループにおけるRWDA権限を取得します。
例
IdcService=EDIT_GROUP dGroupName=MY_GROUP dPrivilege=0 dDescription=admin privileges
EDIT_ROLE
既存のロールを変更するサービス。ロールは、各セキュリティ・グループに対する一連の権限(読取り、書込み、削除、管理者)です。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dRoleName: 既存のロール名。
-
dGroupName: セキュリティ・グループの名前。
オプションのサービス・パラメータ
-
dPrivilege: 権限の設定。
この値が0に設定される場合、管理者ロールのみがグループに対するRWDA権限を持ちます。他のロールはグループにアクセスできません。値が15に設定される場合、すべてのロールがグループにおけるRWDA権限を取得します。権限の詳細は、『Oracle WebCenter Contentの管理』の権限に関する項を参照してください。
例
IdcService=EDIT_ROLE dRoleName=test_role dGroupName=MY_GROUP dPrivilege=15
EDIT_USER
既存のユーザーを変更するサービス。最も発生しがちなエラーは、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないこと、またはユーザーが存在しないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
注意:
ユーザーを編集すると、すべての既存のユーザー属性(ロールおよびアカウント権限)が削除されます。既存の属性を保持するには、新しいデータまたは変更したデータとともに既存の属性を含める必要があります。ユーザー属性が定義されていない場合、ユーザーは、ロールまたはアカウントに属さず、システム内のゲストになります。
ノート:
指定されたユーザーが存在しない場合、Content Serverはユーザーを追加します。
追加の必須サービス・パラメータ
-
dName: ユーザー名。
-
dUserAuthType: ユーザーの認可タイプ。この値は、LocalまたはGlobalのいずれかに設定する必要があります。
オプションのサービス・パラメータ
-
dFullName: ユーザーのフルネーム。
-
dPassword: ユーザーのパスワード。
-
dEmail: ユーザーの電子メール・アドレス。
-
dUserLocale: ロケールの指定(English-US、English-UK、Deutsche、FrançaisまたはEspañol)。
-
dUserType: ユーザーのタイプ。
オプションの属性情報
オプションの属性は、ユーザーの属性情報を含み、ユーザーが属するロールおよびユーザーがアクセス権を持つアカウントを指定する結果セットとして指定されます。属性情報は、3つのカンマ区切りの文字列のリストで構成されます。最初の文字列は、属性のタイプを示し、2番目の文字列は属性の名前を示し、3番目の文字列はアカウントのアクセス番号またはロールのデフォルトのエントリを示します。
-
属性のタイプ: ロールを定義するとき、最初の文字列はこれがrole属性であることを指定し、2番目の文字列はロールの名前、3番目の文字列はデフォルトのエントリ15になります。アカウントを定義するとき、最初の文字列ではこれがaccount属性であることを指定し、2番目の文字列はアカウントの名前、3番目の文字列はアクセス・レベルになります。
-
role属性の場合、情報は次のようなフォームになります。
role,contributor,15
-
account属性の場合、情報は次のようなフォームになります。
account,books,1
-
-
属性名: ユーザーは、複数のロールおよびアカウントに属することができます。そのため、属性情報列に、カンマで区切られた複数のロールおよびアカウント情報文字列が存在する可能性があります。ユーザーが管理者ロールを持つようにする場合、ユーザー属性情報は次のように定義します。
@ResultSet UserAttribInfo 2 dUserName AttributeInfo jsmith role,contributor,15 @end
ユーザーがコントリビュータとエディタの両方のロールに属し、かつ会計帳簿の読取り権限を持つようにする場合、ユーザー属性情報は次のように定義します。
@ResultSet UserAttribInfo 2 dUserName AttributeInfo jsmith role,contributor,15,role,editor,15,account,books,1 @end
-
アクセス番号: ユーザーに次のアクセス番号を割り当てることができます。
-
1: 読取り専用
-
3: 読取りと書込み
-
7: 読取り、書込み、削除
-
15: 管理者権限
-
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=EDIT_USER dName=user20 dUserAuthType=Local
-
任意のパラメータおよび属性情報を持つHDA形式:
@Properties LocalData IdcService=EDIT_USER dName=jsmith dFullName=Jennifer Smith dUserAuthType=Local dPassword=password dEmail=jsmith@example.com dUserType=MKT dUserLocale=English-US @end @ResultSet UserAttribInfo 2 dUserName AttributeInfo jsmith role,admin,15,role,contributor,15 @end
EDIT_USER_PROFILE
既存のユーザーのユーザー・プロファイルを変更し、プロファイル設定を保存するサービス。これはユーザーのセキュリティ資格証明を変更するために使用することはできません。
アクセス・レベル: 読取り、グローバル(17)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
-
Users表のフィールドはいずれも(dNameを除く)このサービスによって更新できます。
-
このサービスを使用して、データベースに格納されていないパーソナライズ情報を編集できます。ユーザーの情報の一部はデータベースに格納され、一部はパーソナライズ・データ
.hda
ファイルに格納されます。 -
データベースの情報については、単に対応するフィールド名と値が渡され、フィールドが更新されます。
-
パーソナライズ・データについては、エンコードされたトピック文字列を使用する必要があります(たとえば、
topicString1=updateKeys:pne_portal:lm_Layout:Trays
)。 -
パスワード値はプロキシ・ユーザーに対して更新することはできません。
-
このサービスが失敗する最も発生しがちなエラーは、ユーザー(dName)がシステムで見つからないこと、dNameで渡されたユーザー名が現在のユーザーに一致しないことです。
追加の必須サービス・パラメータ
-
dName: ユーザー名。
オプションのサービス・パラメータ
-
dFullName: ユーザーのフルネーム。
-
dPassword: ユーザーのパスワード。
-
dEmail: ユーザーの電子メール・アドレス。
-
dUserLocale: ロケールの指定(English-US、English-UK、Deutsche、FrançaisまたはEspañol)。
-
dUserType: ユーザーのタイプ。
-
emailFormatList: HTMLベースの電子メールの場合は、HTMLに設定し、テキストベースの電子メールの場合は、textに設定します。
-
numTopics: このリクエストの追加のパーソナライズ・トピックの数。
-
topicString1: 更新するパーソナライズ・トピックのエンコードされた文字列。
-
numTopics: 渡されるトピック文字列の合計数。
-
User表からのすべてのフィールド(dNameを除く): dFullName、dEmail、dPasswordEncoding、dPassword、dUserType、dUserAuthType、dUserOrgPath、dUserSourceOrgPath、dUserSourceFlags、dUserArriveDate、dUserChangeDate、dUserLocale、dUserTimeZone。
-
topicString1: パーソナライズ・トピック編集オペレーションを定義するためにエンコードされた文字列数。
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
Content Serverバージョン7.0以降のオプション・パラメータ:
-
レイアウト: 使用するAPI(たとえば、トップ・メニュー、トレイ)。
-
スキン: 使用するスキン(たとえば、ウィンドウ)。
-
XuiSearchTemplate: ユーザーのパーソナライズされた「検索結果」ページに使用するテンプレート。
結果
-
ResultSets: UserTopicEdits(パーソナライズ・データが編集された場合にのみ返されます。トピックの編集が実行された内容に関する情報が含まれます。topicName、topicEditAction、topicKey、topicValueというフィールドがあります。topicValueはHDAエンコード文字列であることに注意してください。)
-
ローカル・データ:
-
changedSubjects
-
dUser
-
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: GET_DOC_PAGE (Page=HOME_PAGE)
-
使用
-
リソース・インクルード: user_info_submit_form
例
-
IdcCommandコマンド・ファイル・フォーマット:
IdcService=EDIT_USER_PROFILE dName=sysadmin
-
任意のパラメータを持つHDA形式:
@Properties LocalData IdcService=EDIT_USER_PROFILE dName=jsmith dFullName=Jennifer Smith dPassword=password dEmail=jsmith@example.com dUserType=MKT dUserLocale=English-US @end
GET_FILTER_ADMIN_PAGE
ブラウザで「Webサーバー・フィルタの構成」ページを取得するサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_SELF_REGISTER_PAGE
「自己登録」ページを返し、自己登録ユーザーのユーザー情報をロードするサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
GET_USERDOCPROFILES
現在のユーザーが使用可能なチェックインおよび検索プロファイルを返します。ユーザーが標準検索/チェックイン情報を使用できる場合、それらの情報も含められます。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
-
ResultSets:
-
SearchProfiles: 結果セットと検索プロファイル情報。この結果セットには5つの列が含まれます。
-
dpName: プロファイル名
-
dpDescription: プロファイルの説明
-
dpTriggerValue: プロファイルのトリガー値
-
dpDisplayLabel: プロファイルの表示ラベル
-
dpdDocClass: プロファイルに関連付けられたドキュメント・クラス
-
-
CheckInProfiles: 結果セットとチェックイン・プロファイル情報。この結果セットには5つの列が含まれます。
-
dpName: プロファイル名
-
dpDescription: プロファイルの説明
-
dpTriggerValue: プロファイルのトリガー値
-
dpDisplayLabel: プロファイルの表示ラベル
-
dpdDocClass: プロファイルに関連付けられたドキュメント・クラス
-
-
GET_USER_INFO
現在のユーザーの「ユーザー・プロファイル」ページを返すサービス。CHECK_USER_CREDENTIALSを使用して、ユーザーのロールおよびアカウントを検証します。
このサービスはパラメータをとらず、dUserサーバー変数の値に基づいた情報を導出します。
アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)
実行される問合せ: Quser
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果:
-
ResultSets:
-
USER_INFO(現在のユーザーのUsersデータベース表からのフィールド)
-
dName: ユーザーの名前。
-
dFullName: ユーザーのフルネーム。
-
dEmail: ユーザーの電子メール。
-
dUserTimeZone: ユーザータイムゾーン。
-
dUserLocale: ユーザーのユーザー・ロケール
-
dUserLanguageId: ユーザーのユーザー言語ID
-
-
UserLocaleLanguageMap(ユーザーが使用可能なロケール)
-
lcLocaleID: ロケールID
-
lcLanguageID: ロケールIDに対応する言語ID
-
-
UserMetaDefinition(データ・ディレクトリのusermeta.hdaファイルのコンテンツに一致する、ユーザー・メタ・フィールドのプロパティを定義する結果セット)
-
LmLayouts(使用可能なレイアウトの名前のリスト、フィールド: レイアウト)
-
LmLayout(すべての使用可能なレイアウト/スキンの組合せのリスト、フィールド: レイアウト、スキン)
-
-
返されるオプション・リスト: Users_UserLocaleList
-
ローカル・データ:
-
dName
-
dUser
-
-
レスポンス・テンプレート: USER_INFO (user_info.htm)
使用
-
リソース・インクルード: pne_nav_userprofile_links
-
テンプレート:
-
MY_VIEW_FORM (my_view_form.htm)
-
PNE_PORTAL_DESIGN_PAGE (pne_portal_design_page.htm)
-
PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)
-
PNE_PORTAL_PERSONAL_URLS_PAGE (pne_portal_personal_urls_page.htm)
-
PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)
-
PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)
-
std_home_page.htm
-
SUBSCRIPTION_LIST (subscription_list.htm)
-
-
標準ナビゲーション: commonNav.js
GET_USERS
すべてのユーザーおよびその属性のリストを返すサービス。プライマリ属性(ユーザー名、フル・ネーム、パスワード、電子メール・アドレス、ディレクトリ、タイプ、パスワード・エンコーディング)とともにシステムに登録されているすべてのユーザーのリストを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
LOAD_PNE_PORTAL
ユーザーの保存済問合せの標準パーソナライズ・プロパティおよび結果セット、カスタム・パーソナライズ・データを含む、ユーザーのPNEファイル(pne_portal.htm)からのすべてのデータをロードします。これはユーザーのパーソナライズ設定を取得するために、リモート・アプリケーションによって使用されます。
これはリモート・アプリケーション・サービスとして使用されます。これは関連したテンプレート表示を使用しない生データ・サービスです。
アクセス・レベル: 読取り、スクリプト作成可能(33)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
結果
-
ResultSets: ユーザーのpne_portal.htmファイルからのすべての結果セット。通常、これには、パーソナルURLおよび保存済問合せが含まれますが、特定の実装で使用されるカスタム・パーソナライズ結果セットも含めることができます。
-
ローカル・データ: ユーザーのpne_portal.hdaファイルからのすべてLocalDataプロパティ。これには、標準のパーソナライズ・プロパティ(XuiSearchTemplate、showDefaultQuery、defaultQueryRows、lm_Skin lm、Layout、portalDesignLink、quickSearchLink、defaultQuery、searchFormType、emailFormat)が含まれますが、特定の実装で使用されるカスタム・パーソナライズ・プロパティも含めることができます。
使用
-
その他: SoapCustom:Wsdl:PortalInfo:Services
LOAD_USER_TOPIC
選択したトピックに基づいたパーソナライズ・データをロードします。これらのトピックは、データは、DomainHome
/ucm/cs/data/users/profiles/
ディレクトリのHDAファイルに対応します。
これはリモート・アプリケーション・サービスとして使用されます。これは関連したテンプレート表示を使用しない生データ・サービスです。
アクセス・レベル: 読取り、スクリプト作成可能(33)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
userTopic: pne_portalやwf_in_queueなど、ユーザー・トピックの名前。
結果
-
ResultSets: 指定されたトピック・ファイルのすべての結果セット。
-
ローカル・データ: 指定されたトピック・ファイルのすべてのLocalDataプロパティ。
QUERY_GROUP
セキュリティ・グループの説明を返すサービス。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dGroupName: セキュリティ・グループ名。
例
IdcService=QUERY_GROUP dGroupName=Public
QUERY_USER_ATTRIBUTES
特定のユーザーのユーザー属性を返すサービス。
このサービスは、Content ServerインスタンスがADSIを使用するように構成される場合は、Microsoft Active Directory管理対象ユーザー用のユーザー・データを返しません。ローカル・ユーザーおよび外部LDAP管理対象ユーザー用のユーザー・データを返します。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: ユーザー名。
例
IdcService=QUERY_USER_ATTRIBUTES dName=jsmith
REGISTER_USER
ユーザーを登録するサービス。ユーザー名パラメータ(dName)のみが提供される場合、新しいユーザーはゲスト・ロールと空のパスワードを持つローカル・ユーザーです。
最も発生しがちなエラーは、ユーザー名が一意ではないことです。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dName: ユーザー名。
オプションのサービス・パラメータ
-
dFullName: ユーザーのフルネーム。
-
dPassword: ユーザーのパスワード。
-
dEmail: ユーザーの電子メール・アドレス。
-
dUserLocale: ロケールの指定(English-US、English-UK、Deutsche、FrançaisまたはEspañol)。
-
dUserType: ユーザーの認可タイプローカルまたはグローバルのいずれか。
例
IdcService=REGISTER_USER dName=user20
SAVE_USER_TOPICS
ユーザーのパーソナライズ情報を保存するために使用されるサービス。このサービスでは、7つのアクションを実行できます。このサービスの必須パラメータは、実行されるアクションによって異なります。
データの複雑さ、追加の必須パラメータ数のため、このサービス・リクエストを送信するには通常フォームを使用します。
アクセス・レベル: 読取り、グローバル(17)
場所: IdcHomeDir
/resources/core/tables/std_services.htm
アクション
次のアクションはtopicStringパラメータとともに使用されます。
-
updateKeys: 単一のLocalDataキー変数を更新します。topicStringパラメータは4つの値をとります: 最初の3つの必須の値、およびキー変数で配置されるリテラル文字列値を含む4番目の値です。
-
updateKeyByName: このアクションは、Content Serverバージョン10gR1の新機能です。updateKeysのように、このアクションは単一のLocalDataキー変数を更新します。これは、4つのtopicString値もとります。リテラル文字列を含むのではなく、4番目の値には、更新で使用される値を含む追加のフィールド/パラメータの名前が含まれます。
-
deleteKeys: 単一のキー変数を削除します。topicStringパラメータは、3つの必須の値のみをとります。
-
updateRows: このアクションは、単一のトピック文字列を使用して、1つ以上の結果セット行を追加または更新するために使用されます。topicStringパラメータは5つの値をとります: 最初の3つの必須の値、正しい順序のすべての結果セット列名のカンマ区切りリストを含む4番目の値、更新/追加される行の総数を示す数値を含む5番目の値。
列名に対応する名前を持つ追加のフィールド/パラメータのセットを、topicStringの5番目の値に示された行数に基づいて各データ行に対して提供する必要があります。ある行で開始し、topicStringで提供される総行数で終了する各行のデータ・セットのフィールドの列名に連番接尾辞が追加される必要があります(これらがいずれもない場合は、Content Serverがエラーをスルーします)。
更新データ行の最初の列の値(一意のキー)が結果セットの既存の行の値と一致する場合、既存の行が更新されます。それ以外の場合は、新しい行が結果セットの一番下に追加されます。
-
addMruRow: 名前の"Mru"はmost-recenly-usedの頭文字です。このアクションは、結果セットの一番上に単一行を追加します。結果セットの行数は、指定した最大値を超えることはできません。行の最大数をすでに含む結果セットに行が追加される場合、新しい行が追加されると同時に最後の行が削除されます(本質的に結果セットの最近使用したN行のみを保持します)。
行の最大数は、オプションのmruNumberパラメータを使用して指定できます。mruNumberパラメータが提供されない場合、最大のデフォルト値は10です。
topicStringパラメータは4つの値をとります: 最初の3つの必須の値、正しい順序のすべての結果セット列名のカンマ区切りリストを含む4番目の値。updateRowsと同様に、列名に対応する追加のフィールド/パラメータのセットを提供する必要がありますが、一度に1行のみ追加/更新されるため、名前に数値接尾辞は必要ありません。
最初の列の値(一意のキー)が既存の行の値と一致する場合、その行は新しい行を追加するのではなく、結果セットの一番上に更新されて移動されます。行数が変更されず、影響を受けた行は最近使用した行とみなされます。
-
deleteRows: 結果セットから1つ以上の行を削除します。topicStringパラメータは4つの値をとります: 最初の3つは必須の値で、4番目の値は、指定された結果セットの既存の行の最初の列のDATA VALUE(一意のキー)に対応する文字列のカンマ区切りのリストを含みます。
-
deleteSets: トピック・ファイルから1つ以上の結果セットを削除します。topicStringパラメータは3つの値のみをとりますが、この場合、3番目の値は単一のtopicStringを使用して削除される複数の結果セットを許可して、単一のキー名ではなく名前のカンマ区切りのリストとすることができます。
オプションのサービス・パラメータ
-
numTopics: 想定されるtopicStringsの数をサービスに伝えます。
-
topicKeys: 名前別にトピック文字列パラメータを識別します。トピック文字列を含むフィールドまたはパラメータに対応する1つ以上の名前のコロン区切りリストで構成されます。numTopics値は、トピック文字列値を識別する列挙メソッドを使用しない場合にも、このパラメータが使用されるときに存在している必要があります。(numTopicsにはすべての値を使用できます。)
-
topicStringn: コロンで区切られた、3つから5つの値で構成されます。トピック文字列の数は、numTopicsの値によって異なります。たとえば、numTopicsが2の場合、topicString1とtopicStringが必要です。
値は次のとおりです。
-
最初の値は、サービスによって実行されるアクションです。
-
2番目の値は使用されるトピック・ファイルの名前です。
-
3番目の値は変更されるアイテムのキー名です(LocalDataキー変数の名前かトピック・ファイルの結果セットの名前のいずれか)。
-
4番目の値には、追加または更新アクションのデータ情報が含まれます。データ文字列自体を含むか、またはデータ値を含む追加のフィールドまたはパラメータをポイントするかのいずれかです。
-
5番目の値は、送信されるデータの行数を示すためにupdateRowsアクションでのみ使用されます。
更新アクションのすべてが、指定された名前のキーが指定されたトピック・ファイルに見つからない場合に「追加」操作を実行します。2番目の値に指定される名前に一致するトピック・ファイルが存在するが、3番目の値に指定されるキー名に一致するキー(変数または結果セット)が含まれない場合、新しい変数または結果セットが更新操作のために提供されるデータを使用して作成されます。トピック・ファイル自体が見つからない場合は、それも作成されます。
-
-
RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。
-
mruNumber: addMruRow - 「最近使用した行の追加」アクションを使用する際に、結果セットの最大行数を指定するために使用されます。
結果
-
ResultSets: UserTopicEdits(行は、サービス・コールによって実行された各トピックの編集内容が示されます。行にはtopicName、topicEditAction、topicKey、topicValueというフィールドが含まれます。)
-
レスポンス・テンプレート:
-
REDIRECT_TEMPLATE (redirect_template.htm)
-
デフォルトのリダイレクト・サービス: GET_DOC_PAGE: HOME_PAGE
-
使用
-
リソース・インクルード: xui_searchapi_results_action_form
-
テンプレート:
-
-
MY_VIEW_FORM (my_view_form.htm)
-
PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)
-
PNE_PORTAL_PERSONAL_URLS_PAGE (pne_portal_personal_urls_page.htm)
-
PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)
-
PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)
-
WF_INQUEUE_LIST (workflow_queue.htm)
-
例
注意:
次の例は、Content Serverインスタンスのコア構成ではありません。これはカスタム機能の拡張で、Consulting Services、または当社のDeveloper Support Token Programをご購入いただくことによりサポートされます。すべてのカスタマイズと同様に、ソフトウェアをアップグレードする際には、カスタムの変更がオーバーライドされる可能性があります。
パーソナルURLを追加するには、次のパラメータおよび値を使用します。
numTopics=1 topicString1=updateRows:pne_portal:PersonalURLS:title,website:1
これらの値はpne_portal.hdaユーザー・トピックのPersonalURLS ResultSetに行を追加します。ResultSetの列はtitleとwebsiteで、トピック文字列の4番目の値から取得されます。最後の値(1)は、1行のデータが送信されることをサービスに伝えます。
行データを指定するために、サービスに追加のパラメータを使用する必要があります。これらのパラメータはtopicStringで指定されるtitleとwebsite列の名前から取得されます。複数の行データを指定できるため、サービスのパラメータ名を形成するために、数値接尾辞が各列名に追加されます。最初の行にはtitle1およびwebsite1パラメータが必要で、2番目の行にはtitle2およびwebsite2パラメータが必要です。
ホーム・ページへのリンクであるデータ行を追加するには、title1およびwebsite1パラメータの値をホームページおよびhttp://www.example.comに設定します。これらの値は、ブラウザのアドレス・バーのURLに直接追加する場合にはURLエンコードされる必要があります。データを送信するためにWebページのフォームを使用する場合は、エンコードが処理されます。フォームを使用した完全なサービス仕様は次のとおりです。
<FORM name='addPersonalUrlForm' method='POST' action='<$HttpCgiPath$>'> <INPUT type='hidden' name='IdcService' value='SAVE_USER_TOPICS'> <INPUT type='hidden' name='numTopics' value='1'> <INPUT type='hidden' name='topicString1' value='updateRows:pne_portal:PersonalURLS:title,website:1'> <INPUT type='hidden' name='title1' value='Company Home Page'> <INPUT type='hidden' name='website1' value='http://www.example.com'> <INPUT type='submit' value='Submit'> </FORM>
UPDATE_USEROPTION_LIST
ユーザー情報フィールドのオプション・リストを追加または更新するサービス。
注意:
OptionListStringパラメータで指定されたオプション・リスト値は既存の値を置き換えます。既存の値を保持するには、新しい値とともに既存の値を含める必要があります。
「ユーザー・タイプ」フィールドおよびすべてのカスタム・ユーザー・フィールドのオプション・リストはデータベースに格納されますが、useroptions.hda
ファイルでは、通常DomainHome
/ucm/cs/data/users/config/
ディレクトリにあります。
場所: IdcHomeDir
/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
-
dKey: オプション・リスト・キー。
-
OptionListString: \nエスケープ・シーケンスで区切られるオプションのリスト。
例
-
IdcCommandコマンド・ファイル・フォーマット:
# Add values NY, DC, CA to UserTypeList IdcService=UPDATE_USEROPTION_LIST dKey=Users_UserTypeList OptionListString=NY\nDC\nCA
-
HDA形式(NY、DCおよびCAの値をUserTypeListに追加します):
@Properties LocalData IdcService=UPDATE_USEROPTION_LIST dKey=Users_UserTypeList OptionListString=NY\nDC\nCA @end