このトピックでは、Content Engine API の全プロパティーをアルファベット順に示します。各プロパティーには、「参照」セクションがあります。ここには、各プロパティーが該当するクラスと、各クラスのプロパティー・リストへのリンクを示します。注: プロパティーのメタデータはクラス固有であるため、プロパティーのメタデータ情報については、クラス別のプロパティー・リストを参照してください。
このプロパティーは TempFileLifetime プロパティーと連携して、定期クリーンアップの一部として削除されるファイルを決定します。
このプロパティーは TempDBContentLifetime プロパティーと連携して、定期クリーンアップの一部として削除される一時コンテンツを決定します。
AccessPermission
では、アクセス許可で指定された被付与者に対し、あるオブジェクトに対するアクセス権が与えられます。AccessPermissionDescription
では、あるオブジェクトに対して付与できるアクセス権を表します。AccessPermission
オブジェクトに対してユーザーが持っているセキュリティー・アクセスのタイプ (許可または拒否) を示します。各 FileNet P8 Site
インスタンスは、1 つの DNS サイトにマッピングできますが、特定の DNS サイトにマッピングしなくてもかまいません。
FileNet P8 ドメインに複数のサイトが構成されており、これらのサイトが地理的に異なる場所にある場合は、アプリケーション・サーバーとディレクトリー・サーバー間の LDAP 通信が WAN 経由になり、パフォーマンスが低下する可能性があります。この問題を軽減するには、このプロパティーを設定して、API がそのサイトにあるあるドメインのドメイン・コントローラーをすべて検索するようにします。例えば、このプロパティーの値を "Chicago" に設定すると、"CN=Chicago,CN=Sites,CN=Configuration,DC=..." にあるあるドメインのドメイン・コントローラーが、接続試行によってすべてテストされます。この場合、最初に実行されるドメイン・コントローラーが選択されます。
ActiveMarking
オブジェクトのリスト。各 ActiveMarking
オブジェクトは、そのオブジェクトのプロパティーと関連付けられた MarkingSet
内のマーキングを表します。AddOnInstallationRecord
オブジェクトのリストを指定します。このプロパティーを使用すると、バックアップのための潜在的なコンテンツ・リストア・ポイントをセットアップできます。拡張ストレージ域から削除されたコンテンツは、この削除遅延時間が過ぎるまで、ストレージ・デバイスから削除されません。そのため、コンテンツは引き続き使用可能であり、それに関連付けられているドキュメント・オブジェクトは、この削除遅延時間が過ぎるまで、データベース・バックアップからリストアできます。
例えば、このプロパティーが 12 時間に設定されている場合、データベースの特定時点スナップショットで、削除された任意のドキュメントをリストアできる期間は 12 時間です。そのため、データベースの特定時点スナップショットが午前 10 時に取得された場合は、午前 10 時以降に削除されたすべてのコンテンツを引き続き取得できます。ただし、午前 10 時のスナップショットを復元するデータベース・リストアを、午後 10 時より前に実行する必要があります。 データベース・リストアが午後 10 時より後に実行された場合、このスナップショットの取得以降に削除されたコンテンツの一部は、基礎となるストレージ・デバイスからそのコンテンツが既に削除されていると、使用できなくなっていることがあります。
ReplicationDirection
定数。
IdList
オブジェクトを指定します。別名 ID は、所属先オブジェクトのタイプに応じて、別のプロパティー定義の PrimaryId か、別のプロパティー・テンプレートの Id か、別のオブジェクト・ストア内にある別のクラス定義の Id に設定されます。これにより、複数のオブジェクト・ストア検索において、2 つのプロパティーまたはクラスが同一のエンティティーとして扱われるようになります (「SearchScope
」クラスを参照)。EntireNetwork
オブジェクトに対する Realm
オブジェクトをすべてまとめたコレクション。このプロパティーの値が false である場合、Active Directory セキュリティー・プロバイダーは、ログイン・ユーザー名 (プリンシパル名) を解析して、その名前が UPN 形式であるかどうかを判別します。UPN 形式の名前には @ 文字が含まれ、その後に少なくとも 1 つのドット文字が続きます (例えば、jsmith@mydomain.com)。プリンシパル名が UPN 形式である場合、これは name@domain の形式をとるものと見なされます。ここで、name はユーザー名であり、domain は Administration Console for Content Platform Engine 内で構成された Active Directory ドメインの名前です。この特別な処理は、一部の大規模な Active Directory フォレストおよびドメインのセットアップでは役立ちますが、E メール・アドレスおよび特定の UPN をユーザー短縮名として使用できなくなります。
このプロパティーの値が true である場合、Active Directory セキュリティー・プロバイダーは、プリンシパル名を解析しないので、E メール・アドレスおよび UPN をユーザー短縮名として使用できます。このプロパティーを true に設定すると、ReturnNameAsDN
も true に暗黙指定されます。
このプロパティーはグローバルに作用します。したがって、1 つの Content Engine に対して定義されるすべての Active Directory 構成で同じ設定 (すべて true またはすべて false のいずれか) にする必要があります。このプロパティーがすべての構成で同じ設定になっていない場合、プロパティー値は false に暗黙指定されます。
このプロパティーは CmRetentionUpdateJob
クラス定義にのみ設定できます。
このプロパティーを変更するには、オブジェクト・ストアに対する MODIFY_RETENTION
権限が必要です。
false
に設定すると、最大文字列長を超える文字列値が含まれている場合は、検索が失敗します。デフォルト値は false
です。
VirtualServer
や ServerInstance
など) に Case Analyzer の処理が行われないようにできます。
IBM Content Foundation では、Case Analyzer はサポートされないため、このプロパティーは無視されます。
AnnotatedContentElement
値の解釈は、アプリケーションによって決まります。これは必須プロパティーではありません。
ドキュメントの ContentElementList
コレクション内の特定コンテンツ・エレメントの位置索引が変更される可能性があるため、このプロパティーには、コンテンツ・エレメントの位置索引ではなく、ElementSequenceNumber
プロパティーの値を取り込むことをお勧めします。代替の位置索引を使用する場合、アノテーションを適用するコンテンツ・エレメントの正しい索引を正しく反映することは、アプリケーションの責任です。
例えば、5 つのコンテンツ・エレメントを持つドキュメントがあり、その 3 番目のコンテンツ・エレメントの位置索引を AnnotatedContentElement プロパティーで指定している場合、2 番目のコンテンツ・エレメントを削除すると、結果的にこのプロパティーは間違ったコンテンツ・エレメントを参照することになります。
IndependentObject
オブジェクトを指定します。AnnotationSet
オブジェクトを指定します。
アペンダー名を指定しない場合は、デフォルトにより RollingFileAppender
が使用されます。このように、TraceLoggingEnabled
プロパティーを有効化し、TraceFlags
で適切なフィールドを設定するだけで、便利なトレース・ロギングを開始することができます。
注: エラー・ログ "filenet_error" (デフォルト) が更新され、構成されたアペンダーを参照します。基本のエラー・ログ・ファイルが "filenet_error" でない場合は、エラー・ログ・メッセージがトレース・ログに書き込まれません。
サポートされる出力先 (クラス名) は次のとおりです。
デフォルトのコンソール (System.out など) にトレース・ロギング・データを送信します。
OutputLocation
プロパティーで指定された場所にトレース・ロギング・データを送信します。
FileAppender のサブクラスです。スケジュールに従って、OutputLocation
プロパティーで参照されるディレクトリー内のトレース・ログをバックアップ (ロールオーバー) します。DatePattern は "yyyy-MM-dd" であり、バックアップ操作を毎日深夜に開始します。
FileAppender のサブクラスです。アペンダーが何も指定されない場合に使用されるデフォルトのアペンダーです。ファイルが最大サイズを超えると、OutputLocation
プロパティーで参照されるディレクトリー内のトレース・ログをバックアップします。
トレース・ログ・ファイルのデフォルトの最大サイズは 100 MB であり、バックアップ索引ファイルのデフォルト・サイズは 5 MB です。これらのデフォルト値を上書きするには、log4j のコマンド行プロパティー "MaxRollingFileSize" および "MaxRollingFileBackups" を使用します。
詳細については、「org.apache.log4j.FileAppender」を参照してください。
VersioningSecurityTemplate
の場合、状態は次のいずれかになります。ApplicationSecurityTemplate
の場合、状態はアプリケーションによって定義されます。
MBqhzSzhZJCQHE9U4RBK9ze3K7U=
。
PropertyTemplate
を参照します。
クラス内の監査されるソース・プロパティーは、Event テーブルの監査レコード内のイベント・プロパティーにマッピングされます。
デフォルトでは、AuditAs は null
に設定されています。
カスタム・プロパティーは、PropertyDefinition.AuditAs
を既存の PropertyTemplate
(これは、
通常、PropertyDefinition
の作成元のオブジェクトと同じオブジェクトです) に設定することで監査できます。
しかし、システム・プロパティーには既存のプロパティー・テンプレートがないため、監査が必要なシステム・プロパティーには
新規プロパティー・テンプレートを作成する必要があります。コード例については、「プロパティーの監査の構成」を参照してください。
AuditAs は、PropertyDefinition
に設定できますが、その PropertyDefinition
が既に AuditAs 値を継承している場合は設定できません。
いったん設定された値は、読み取り専用としてサブクラスに自動的に継承されます。
AuditAs プロパティーが参照する PropertyDefinition
が削除されると、その AuditAs プロパティーは、すべての直接のサブクラスで設定できるようになります。
例えば、ルート・クラス A に、監査対象となるプロパティー P、さらに直接のサブクラス A1 と A2 があるとします。
この場合、A1 の P と A2 の P (P1 および P2 と呼びます) は、A.P に設定されたものと同じ AuditAs 値を継承します。
ここで、A.P が削除されると、P1 と P2 は、それぞれ A1 と A2 の非継承プロパティーに昇格します。
非継承プロパティーとして、P1 と P2 がそれぞれ保持する AuditAs 値は、互いに別々のプロパティーを指すように変更することができるようになります。
PropertyDescription
では、AuditAs は読み取り専用です。
ObjectStore
オブジェクトに定義された監査廃棄ポリシーの列挙。
列挙内の各 CmAuditDispositionPolicy オブジェクトで、
廃棄 (削除) する監査レコードを識別する条件を定義します。
AuditDispositionBatchSize
のサイズと等しい値を入力してください。
CmTimeslot
オブジェクトのリスト。含まれる
オブジェクトは、それぞれ監査廃棄を実行する曜日、開始時刻、および期間を指定します。
注 あるクラスのすべての監査定義で、失敗した操作も成功した操作もログに記録しないよう指定されている場合は、そのクラスの監査が事実上無効になります。
ObjectStore
オブジェクトでこのプロパティーを設定します。ObjectStore
オブジェクトに定義された監査処理ブックマークの列挙。
列挙内の各 CmAuditProcessingBookmark オブジェクトは、
監査処理クライアントごとの監査ログ (Event テーブル) 内での前回処理ポイントを表します。
注 あるクラスのすべての監査定義で、失敗した操作も成功した操作もログに記録しないよう指定されている場合は、そのクラスの監査が事実上無効になります。
CenteraFixedContentDevice
オブジェクトに audited delete 関数を使用して C-Clip を削除する場合に使用する接頭部文字列を指定します。文字列を指定しないと、audited delete は呼び出されません (FPClip.Delete
が使用されます)。指定した文字列は、FPClip.AuditedDelete
に渡される削除理由の接頭部として使用されます (ドキュメント ID GUID が接頭部文字列に付加され、完全な削除理由テキストとなります)。Event
オブジェクトの EventSet
コレクション。このオブジェクトに対して発生した監査済みイベントが含まれます。null
でない場合、名前の先頭にはスラッシュ (/) またはアットマーク (@) を使用する必要があります。null
に設定されていない限り、テナント・ドメインの認証レルム名を null
に設定することはできません。CmAbstractSearchResult
サブクラス・インスタンスの検索結果に対応するバックグラウンド検索インスタンス。バックグラウンド検索インスタンスは、CmBackgroundSearch
サブクラスからインスタンス化されます。
CmBackgroundSearch
オブジェクトの現在の列挙を表す CmBackgroundSearchSet
オブジェクト。各 CmBackgroundSearch
オブジェクトは、実行されているバックグラウンド検索を表します。
CmTextSearchIndex
オブジェクトに関連付けられる基本クラスの ID。
サーバーは、RetentionDurationUpdate プロパティーの値を、BaseDatePropertyName プロパティーで指定される日付プロパティーの値に追加して、新しい保存日を計算します。RetentionDurationUpdate プロパティーの値は、RetentionPeriodUnits プロパティーで指定された単位で表わされます。
AllowRetentionReduction プロパティーが true に設定されている場合、BaseDatePropertyName プロパティーを使用して保存期間を短縮できます。BaseDatePropertyName プロパティーを CmRetentionDate プロパティー以外の日付プロパティーに設定します。次に、新しい保存日が保存可能オブジェクトの現在の CmRetentionDate プロパティー値より小さい値に計算されるように、RetentionDurationUpdate プロパティーおよび RetenionPeriodUnits プロパティーを設定します。
データベースのラウンド・トリップを 1 回実行したときに、インポート・エージェント・ディスパッチャーによってデータベースから選択されるバッチの最大数を示します。
FPTag.BlobRead
呼び出しで、コンテンツ BLOB 全体を読み取るかどうかを判断する際に使用される最大バッファー・サイズを指定します。コンテンツ・サイズがパラメーター値以下の場合は、1 回の呼び出しで BLOB 全体が読み取られ (コンテンツ・サイズのバッファーを割り振る必要があります)、要求に応じて呼び出し側データ・ストリームを介してデータが返されます。コンテンツ・サイズがパラメーター値よりも大きい場合は、FPTag.BlobReadPartial
が使用され、呼び出し側から要求されたサイズのデータのみが読み取られます (バッファーは作成されません)。CenteraFixedContentDevice
オブジェクトの衝突回避オプションを指定します。Centera コンテンツの作成時には、プロバイダーはこの値と FP_OPTION_CLIENT_CALCID_STREAMING を結合して、FPTag.BlobWrite
のオプション・パラメーターを形成します。使用できる値は次の 3 つです。VerityDomainConfiguration
オブジェクトが存在する必要があります。
Verity でサポートされる有効なロケール名であれば、どれでも使用できます。この値は VerityIndexArea
オブジェクトが作成される前に設定する必要があり、VerityIndexArea
オブジェクトが存在する間は変更できません。ロケールが "uni" の場合は、オプションでこの名前にデフォルトの言語コードを付加できます (例: フランス語の場合は "uni/fr")。言語コードを付加すると、単語のステミングなど言語固有の機能のデフォルト言語として、指定された言語が照会に使用されます。
ここでの言語コード指定は、デフォルトで使用される言語にのみ適用されます。言語コードを指定しても、オブジェクト・ストアに追加言語を使用することは可能です。同じオブジェクト・ストア内の Verity コレクションに複数の言語を索引付けすることができます。
true
に設定すると、Content Engine を使用してドキュメントからテキストが抽出されます。false
に設定すると、テキスト検索エンジンを使用してテキストが抽出されます。どちらの場合にも、テキスト検索エンジンは、抽出されたテキストを使用して CBR 索引を作成します。
Content Engine テキスト抽出機能がインストールされている場合にのみ、このプロパティー値を true
に設定してください。これらの機能がインストールされていない場合、Content Engine がドキュメントのテキストのフィルタリングを試行すると、「CBRPreFilter がデプロイされていません (CBRPreFilter is not deployed)」というエラーが FileNet P8 ログ・ファイルに記録されます。
Content Engine は、ドキュメントごとにテキストをフィルタリングするための個別のサブプロセスを作成します。場合によっては、誤った形式のドキュメントが原因でサブプロセスが不安定状態になり、そのテキスト抽出タスクがいつまでも完了できないことがあります。CBRPreFilterInitialTimeout JVM オプションを設定することにより、Content Engine がサブプロセスの実行を許可する時間の長さを構成できます。タイムアウトが発生すると、Content Engine はサブプロセスを強制終了し、別のサブプロセスを作成することによりフィルター操作を再試行できます。CBRPreFilterMaxRetryCount JVM オプションを使用して、再試行サブプロセスの最大数を指定します。これらの JVM オプションの説明を以下に示します。
subprocess n timeout interval = 2(n-1) * option value
ここで、n は最初のサブプロセスでは 1、2 番目の (再試行) サブプロセスでは 2、などの値になります。例えば、このオプションの値が 60 の場合、最初のサブプロセスのタイムアウト期間は 1 分 (60 秒)、2 番目のサブプロセスでは 2 分、3 番目のサブプロセスでは 4 分、などの長さになります。このオプションの値がゼロである場合、Content Engine は、タイムアウト間隔が無効であると見なします。
プロパティーの CBR 伝搬タイプを指定します。
このプロパティーは、CBRQueryOptimization プロパティーが DYNAMIC_SWITCHING
に設定され、かつ照会に SQL 最適化オプションが含まれていない場合にのみ適用されます。
このプロパティーが設定されていない場合は、CBR 検索が常に最初に実行されます。このプロパティーがゼロに設定されている場合は、DB 検索が常に最初に実行されます。
詳細については、『CBR 照会の最適化』を参照してください。
索引付けされたコンテンツに対する全文検索はコンテンツ・ベース・リトリーブ (CBR) 検索です。プロパティーに対するリレーショナル検索はデータベース (DB) 検索です。このプロパティーが NONE
(0 または NULL) に設定されている場合、常に Content Engine は最初に CBR 検索を実行し、2 番目に DB 検索 を実行します。
このプロパティーが DYNAMIC_SWITCHING
(1) に設定されている場合、Content Engine は、CBR 検索優先または DB 検索優先のいずれを実行するか動的に決定して、これらのタイプの検索のパフォーマンスを最適化します。
動的切り替えモードでは、Content Engine は CBR ヒットの推定数に基づいて CBR 優先から DB 優先に切り替えます。推定数は、CBRQueryDynamicThreshold プロパティーに設定されているしきい値と比較されます。
このプロパティーを DYNAMIC_SWITCHING
に設定する場合は、CBRQueryDynamicThreshold プロパティーも設定する必要があります。
動的切り替えモードでは、ランク順序を要求する CBR 検索により、CBR 優先動作を強制することができます。 動的切り替え動作を維持するには、CBRQueryRankOverride プロパティーを有効にする必要があります。
また、このプロパティーをオブジェクト・ストアのその他のプロパティーと組み合わせて設定することで、DB 優先検索動作を強制することもできます。 サーバーの特定の動作の構成、関係のあるトレードオフ、およびこのプロパティーをオーバーライドするための SQL 照会オプションについては、『CBR 照会の最適化』を参照してください。
DISABLED
(0 または null)。
この設定は、CBRQueryOptimization プロパティーが DYNAMIC_SWITCHING
に設定されている場合に、全文照会とデータベース (DB) のリレーショナル検索とを組み合わせる CBR 検索に適用されます。
動的切り替えモードでランク順序を要求する検索では、コンテンツ優先の検索 (CBR 優先検索) が実行された場合のみ、サーバーはランクで順序付けされた結果を計算できます。サーバーは、ランク順序の計算を伴うデータベース優先の検索 (DB 優先検索) を実行することはできません。
この設定により、ランク順序を要求する組み合わせ照会について CBR 優先検索のみが強制的に行われます。
サーバーは、ランク順序が要求された場合は DB 優先検索を実行しません。結果が常にランクで順序付けされるようにする場合は、このプロパティーを DISABLED
に設定します。
ENABLED
(1)。この設定は、CBRQueryOptimization プロパティーが DYNAMIC_SWITCHING
に設定されている場合に、全文照会とデータベース (DB) のリレーショナル検索とを組み合わせる CBR 検索に適用されます。
ランク順序を要求する組み合わせ検索の実行を最適化する場合は、このプロパティーを ENABLED
に設定します。
サーバーは CBR 優先と DB 優先の間を動的に切り替えて、CBR 優先検索をランク順で返します。
動的切り替えで DB 優先検索が選択された場合、サーバーはランク順序の要求を抑制します。
REQUIRED
(2)。この設定は、動的切り替えが有効かどうかにかかわらず、CBR 優先検索を含むすべての CBR 検索についてランク順序の要求を抑制します。
動的切り替えを使用しており設定が REQUIRED
の場合、サーバーは CBR 優先と DB 優先の間を動的に切り替え、DB 優先検索および CBR 優先検索のランク順序の要求を抑制します。
すべてのランク順序付けを削除すると、特に複数のコレクションに対して実行する検索の場合、パフォーマンスの向上に役立ちます。
詳細については、『CBR 照会の最適化』を参照してください。
ObjectStore.get_CBRSearchType
メソッドを呼び出して、値を検索します。
オブジェクト・ストアに対して CBR が使用可能でない場合、戻り値は NONE
です。それ以外の場合、この値は、現在構成されている検索エンジンを識別します。
(com.filenet.api.constants.CBRSearchType の関連定数を参照してください。)要約を生成する元になるテキスト索引に保持するテキストの最大サイズを指定します。
テキスト検索の結果に返される要約テキストの最大サイズを指定します。
テキスト検索の結果に使用できる要約テキストのタイプを定義します。
CFS と IBM Content Integrator の外部リポジトリーとの連携の詳細については、「IICEFixedContentDevice
」インターフェースを参照してください。
CMODApplicationGroupSet
オブジェクトを指定します。ここで CMODApplicationGroupSet
オブジェクトは、この CMOD 固定コンテンツ・デバイスに関連付けられた IBM® Content Manager OnDemand (CMOD) の外部リポジトリーで定義されたアプリケーション・グループのコレクションを含みます。page_cache<n>:<domain>:<organization>
の形式を取ります。
<domain>:<organization>
の値に対し、ローカルの CSM キャッシュ名を 1 つだけ指定してください。
例えば、ドメインが ntvaga
で、組織が FileNet
の場合、名前は
page_cache<n>:ntvaga:FileNet
の形式になります。ここで <n>
には 2 以上の符号なし 10 進整数が入ります。ドキュメント・サーバー上のデフォルト CSM キャッシュはページ・キャッシュ番号 1 です (例: page_cache1:ntvaga:FileNet
)。
このプロパティーは、Content Engine サーバーがこのオブジェクトの Site プロパティーで識別されたサイト内で稼働している場合に使用されます。
FileNet Image Services の固定コンテンツ・デバイスを FileNet P8 ドメイン内の複数のサイト間で使用できる場合は、ローカル CSM キャッシュを持つサイトごとに ImageServicesSiteSettings
オブジェクトを作成してください。この SiteSettings
オブジェクトは CSMCache プロパティーの値を上書きして、サイトが利用するローカル CSM キャッシュを有効化できるようにします。
有効な設定は次のとおりです。
OPEN
(デフォルト設定): アクティブ使用のキャッシュ域を有効化します。CLOSED
: アクティブ使用のキャッシュ域を無効化します。CLEARING
: アクティブ使用のキャッシュ域を無効化し、キャッシュのコンテンツをすべて削除し、すべてのキャッシュ統計プロパティーの値を初期化し、キャッシュ状況を以前の設定 (OPEN
または CLOSED
) に自動的にリセットします。このキャッシュ・クリア操作は、開始されたら必ず最後まで実行されます。この操作を停止したり、キャッシュ状況を CLEARING
から別の設定に手動で変更することはできません。クリア操作を実行し、キャッシュ状況がいつまでも CLEARING
に設定された状態にならないようにするには、少なくとも 1 つのサーバーをコンテンツ・キャッシュと同じサイトに関連付ける必要があります。コンテンツ・キャッシュとサイトの関連付けについては、「ContentCacheConfiguration」インターフェースを参照してください。Site
が転送された要求を受け入れるかどうかを決定します。Site
が転送された要求を受け入れる場合はこのプロパティーの値が true
、そうでない場合は false
(デフォルト) になります。ドメインを要求転送用に構成する場合は、このプロパティー値を明示的に true
に構成する必要があります。要求転送は (要求の転送と、転送された要求の受信の両方について) サイト・レベルで有効化する必要があります。また、転送された要求を受信できるようにするには、そのサイト内の仮想サーバーごとに有効な URI を EJBForwardingEndPoint プロパティーで指定する必要があります。
true
) 否か (false
) を指定します。値が true
の場合は、ドキュメントのライフ・サイクル状態を、ドキュメント・ライフ・サイクル・ポリシーで定義された以前の状態に変更することができます。Site
が要求を転送できる場合はこのプロパティーの値が true
、そうでない場合は false
(デフォルト) になります。ドメインを要求転送用に構成する場合は、このプロパティー値を明示的に true
に構成する必要があります。注: 値が false
の場合は、サイト内の どの 仮想サーバーからも要求を転送できません。
Cardinality
定数を指定します。Cardinality プロパティーを設定できるのは、新しいプロパティー・テンプレートの作成時のみです。プロパティー・テンプレートからプロパティー定義を作成すると、その Cardinality プロパティーに自動的に、ベースとなるプロパティー・テンプレートの Cardinality プロパティーと同じ値が指定されます。プロパティー定義が属するクラスからオブジェクトのインスタンスを作成すると、そのプロパティー定義によって定義されたプロパティーにカーディナリティーが指定されます。
PropertyDescription
および PropertyDefinition
オブジェクト・タイプの場合、このプロパティーは読み取り専用です。
PropertyDescriptionObject
および PropertyDefinitionObject
オブジェクトの場合のみ、プロパティーは任意の Cardinality
定数値 (SINGLE
、ENUM
、または LIST
) を持ちます。PropertyDescription
および PropertyDefinition
オブジェクト・タイプでは、プロパティーは SINGLE
または LIST
値を持ちます。
PropertyTemplate
オブジェクト・タイプの場合、このプロパティーは作成時に設定可能です。
PropertyTemplateObject
オブジェクトの場合のみ、プロパティーは SINGLE
または ENUM
の必要があります。単一または列挙カーディナリティーを持つカスタム・オブジェクト値プロパティーのみを作成できます。リスト・カーディナリティーは、システム・オブジェクト値プロパティーのみで許可されます。PropertyTemplate
オブジェクト・タイプでは、プロパティーは SINGLE
または LIST
値を持ちます。Cardinality プロパティーに指定できる値は次の表のいずれかです。
名前 | 値 | 説明 |
---|---|---|
ENUM |
1 | 列挙カーディナリティーを使用してプロパティーを指定します。列挙カーディナリティーのプロパティーは、セット・コレクションを返すオブジェクト値プロパティーです。セット・コレクションとは、固有で、順序付けされていない独立オブジェクトの読み取り専用コレクションで、シーケンシャルに処理する必要があります。クライアント・アプリケーションは、サーバーからページ単位で取得したエレメントのセット・コレクションのアイテムを反復処理できます。ただし、コレクションの反復処理中に、サーバー上でコレクションが変更された場合は、そのコレクションを指す参照が同じままでも、クライアント・コピー内のアイテムの数、順序、および値が変更される可能性があります。セット・コレクションは、独立オブジェクト以外のアイテムを保持することはできません。一方、リスト・コレクションは、独立オブジェクトを除く任意のデータ型のアイテムを保持できます。 |
LIST |
2 | リスト・カーディナリティーを使用してプロパティーを指定します。 リスト・カーディナリティーのプロパティーは、リスト・コレクションを返します。リスト・コレクションとは、変更可能 (アイテムの挿入、置換、または削除が可能) または読み取り専用の、順序付けされたアイテムのコレクションです。これらのアイテムは、固有の必要はなく、任意の順序で処理できます。サーバーからリスト・コレクションにアクセスすると、クライアント・アプリケーション上にその完全なコピーが作成され、一度に 1 エレメントずつ反復処理できます。リスト・コレクション内のアイテムはすべて同じデータ型にする必要があります。また、そのコレクションを返すプロパティーのデータ型と一致している必要もあります。リスト・コレクションを返すプロパティーがオブジェクト値プロパティーの場合は、そのリスト・コレクション内のすべてのオブジェクトが依存オブジェクトでなければなりません。リスト・コレクションには、任意のデータ型のアイテムを保持できます (ただし、各アイテムを同じデータ型にする必要があります)。ただし、リスト・コレクションがオブジェクトを保持する場合は、すべて依存オブジェクトにする必要があります。独立オブジェクトを保持できるのは、セット・コレクションのみです。リスト・カーディナリティーを使用してカスタム・プロパティーを作成することはできません。 |
SINGLE |
0 | 単一カーディナリティーのプロパティーを指定します。単一カーディナリティーを持つプロパティーは、そのプロパティーが保持できるデータ型の値を 1 つだけ返します。 |
ObjectStore
オブジェクトに関連付けられている変更プリプロセッサー・アクションのコレクション。
STATIC_CR
、DYNAMIC_CR
、または DYNAMIC_LABEL_CR
の場合に適用されます。それ以外のコンポーネント関係タイプでは、このプロパティーの値が null
になります。URI コンポーネント関係タイプの場合は、URIValue プロパティーを設定して子コンポーネントを指定します。関係タイプが STATIC_CR
の ComponentRelationship
オブジェクトの場合は、このプロパティーの値を特定のドキュメント・バージョンに設定して、親コンポーネントのドキュメントとバインドします。
関係タイプが DYNAMIC_CR
の ComponentRelationship
オブジェクトの場合は、子ドキュメントの一部のバージョンがバインド資格を持っている必要があります。そうしないと、ComponentRelationship
オブジェクトで save
メソッドを呼び出したときに例外が発行されます。例えば、バージョン・バインド・ルールでメジャー・バージョンしかバインドできないよう指定した場合は、ドキュメントのメジャー・バージョンが存在する必要があります。バージョン・バインド・ルールについては、「VersionBindType」プロパティーを参照してください。save
メソッドを呼び出すと、実際にバインドされているドキュメント・バージョンを反映して ChildComponent プロパティーが自動的に更新されます。
関係タイプが DYNAMIC_LABEL_CR
の ComponentRelationship
オブジェクトの場合は、子ドキュメントのどのバージョンもバインド資格を持つ必要はありません。save
メソッドを呼び出すと、ChildComponent プロパティーの値が自動的に null
または実際にバインドされているドキュメント・バージョンに更新されます。このバインドされたバージョンは、ComponentBindingLabel プロパティー値と LabelBindValue プロパティー値が一致するバージョン・バインド・ルールを満たす、子ドキュメントの最新バージョンとなります。ドキュメントのバインドの詳細については、「ComponentRelationshipType」プロパティーを参照してください。注: ChildComponent プロパティー値が null
に更新された場合は、ChildVersionSeries プロパティーを使用して、この関係の子ドキュメントを決定できます。
Document
オブジェクトを持つ DocumentSet
コレクション・オブジェクト。コレクションに収容されるのは、ユーザーが読み取り権限を持つ子ドキュメントのみです。このドキュメントを親コンポーネント・ドキュメントとして参照する ComponentRelationship
オブジェクトごとに、この親ドキュメントにバインドされた子コンポーネント・ドキュメントのバージョンがこのコレクションに収容されます。同じ子ドキュメントを複数回コレクションに含めることができます。コレクションの順序付けについては、「ComponentSortOrder」プロパティーを参照してください。
ComponentRelationship
オブジェクトを持つ ComponentRelationshipSet
コレクション・オブジェクト。コレクションの順序付けについては、「ComponentSortOrder」プロパティーを参照してください。
VersionSeries
オブジェクト。このプロパティーの値を取得することは、get_ChildComponent().get_VersionSeries()
を呼び出すことと同じです。このプロパティーは、ComponentRelationshipType プロパティーの設定が DYNAMIC_CR
または DYNAMIC_LABEL_CR
の場合に適用されます。そうでない場合は、プロパティー値が null
になります。Choice
オブジェクトの値。ChoiceList
オブジェクトを指定します。ChoiceList
オブジェクトのセットを持つ ChoiceListSet
オブジェクトを指定します。Choice
オブジェクトの値。Choice
オブジェクトが表すデータのタイプを決定する ChoiceType
定数を指定します。整数型の選択アイテム、文字列型の選択アイテム、整数型 Choice
オブジェクトのネスト・コレクション用のグループ・ノード、または文字列型 Choice
オブジェクトのネスト・コレクション用のグループ・ノードのいずれかになります。
ChoiceType プロパティーに指定できる値は次の表のいずれかです。
名前 | 値 | 説明 |
---|---|---|
INTEGER |
0 | 整数型の選択アイテムを表す Choice オブジェクトを指定します。 |
MIDNODE_INTEGER |
2 | 整数型 Choice オブジェクトのネスト・コレクション用のグループ・ノードとなる Choice オブジェクトを指定します。このコレクションに含まれる各 Choice オブジェクトは、整数型の選択アイテムまたは整数型 Choice オブジェクトのネスト・コレクション用のグループ・ノードを表している必要があります。 |
MIDNODE_STRING |
3 | 文字列型 Choice オブジェクトのネスト・コレクション用のグループ・ノードとなる Choice オブジェクトを指定します。このコレクションに含まれる各 Choice オブジェクトは、文字列型の選択アイテムまたは文字列型 Choice オブジェクトのネスト・コレクション用のグループ・ノードを表している必要があります。 |
STRING |
1 | 文字列型の選択アイテムを表す Choice オブジェクトを指定します。 |
ChoiceList
オブジェクト。これがプロパティーと関連付けられている場合、ChoiceValues
はそのプロパティーが保持できる使用可能値の個別セットを提供します。あるいは、ChoiceValues
が Choice
オブジェクトと関連付けられている場合は、選択リスト・グループに使用できる値のセットが定義されます。Class Definition
。注: このプロパティーを設定するために ClassDefinition
をフェッチする必要はありません。代わりに、この IndexJobClassItem
インスタンスで set_ClassDefinition(Factory.ClassDefinition.getInstance)
メソッドを呼び出します。ClassDescription
オブジェクトを指定します。ClassDescription
オブジェクトのコレクションを持つ ClassDescriptionSet
オブジェクトを指定します。ClassDescriptions
プロパティーは、あるオブジェクト・ストアに関する最新のクラス・メタデータの「スナップショット」を返します。クラスに変更を加えても、オブジェクト・ストアを更新しないと、ClassDescriptions
コレクションには変更が反映されません。ExternalClassDescription
オブジェクトの場合のみ、この文字列は固定で、外部クラス記述の属するリポジトリー内で固有です。
DocClassificationStatus
定数を指定します。ClassificationStatus プロパティーを使用すると、特定のドキュメントが自動分類の対象となるかどうか、また対象となる場合は操作が成功したかどうかをクライアント・アプリケーションが判断できるようになります。このプロパティーに使用できる値は次のとおりです。
CLASSIFICATION_COMPLETE
: ドキュメントの自動分類が正常に完了したことを示します。CLASSIFICATION_FAILED
: ドキュメントの自動分類が失敗したことを示します。CLASSIFICATION_PENDING
: ドキュメントの自動分類要求が保留中であることを示します。ドキュメントをチェックインし、checkin
メソッドの autoClassify
パラメーターを AUTO_CLASSIFY
に設定すると、サーバーによってこの値が自動的に設定されます。NOT_CLASSIFIED
: ドキュメントの自動分類が要求されていないことを示します。ドキュメントをチェックインし、checkin
メソッドの autoClassify
パラメーターを DO_NOT_AUTO_CLASSIFY
に設定すると、サーバーによってこの値が自動的に設定されます。コンテンツ圧縮を有効にした場合は、CmCompressionThresholdPercent プロパティーおよび CompressionBlockSize プロパティーを使用してデフォルトの操作設定を変更できます。
一部のデータ・フォーマット (JPEG や ZIP など) は適切に圧縮されず、このようなフォーマットのストレージ・スペースのわずかな節約のためにサーバー圧縮のオーバーヘッドを費やすことは価値がない場合があります。 このプロパティーを使用すると、データが圧縮されないしきい値を定義できます。 また、CompressionBlockSize プロパティーで設定して、圧縮されるコンテンツ・ストリームのブロック・サイズを定義することもできます。
このプロパティーでは、CmCompressionEnabled プロパティーで設定して、コンテンツ圧縮をオンにする必要があります。 管理者関連情報については、『コンテンツ圧縮』を参照してください。
ContentIntegrityOption 値のビット・マスクを使用したストレージ域に対するコンテンツ検証を指定します。指定されたオプションに応じて、サーバーは、コンテンツの作成時、コンテンツの取得時、および StorageArea
での validateContent メソッドの呼び出し時に、コンテンツを検証します。
拡張ストレージ域では、無効なコンテンツの自動修復のためのオプションが提供されます。
false の場合、この関係における先行タスクが必要です。つまり、後続タスクを進めることが許可されるように、先行タスクを完了する必要があります。 true の場合、この関係における先行タスクは不要ですが、より正確には、同じ後続タスクに関連付けられた複数の代替のグループ内の 1 つの代替として機能します。 代替の先行タスクのいずれかが完了すると、必要な先行タスクが完了したものとして、後続タスクを進めることが許可されます。
DeviceRetentionMode
定数。2 つの保存モードは、固定コンテンツ・デバイスにコンテンツが格納されているチェックイン・ドキュメントにのみ適用されます。
次の値から 1 つを指定できます。
ALIGNED
: 固定コンテンツ・デバイスに関連する調整を行うことを指定します。ALIGNED モードで固定ストレージ域にチェックインされたドキュメントには、Content Engine サーバーおよび固定コンテンツ・デバイスの両方によって適用される保存期間があります。このモードの場合、固定コンテンツ・デバイスは、ドキュメントの CmRetentionDate プロパティーの値で指定された保存期間をサポートする必要があります。そうしないと操作が失敗します。
ドキュメントのコンテンツ・データのソース・ロケーションが、ALIGNED モード中の固定コンテンツ・デバイス上にあると、ドキュメントの保存期間が期限切れになっている場合にのみ、そのコンテンツ・データを削除または移動できます。NOT_ALIGNED
: 固定コンテンツ・デバイスに関連する調整をしないことを指定します。このモードの場合、Content Engine サーバーのみで保存期間が適用されます。<namespace>::<name>
の形式である必要があります。ここで、<namespace>
と <name>
は両方とも、長さがゼロではなく、Content Engine シンボル名規則を順守し、他の検索関数名に対して固有である必要があります。
CmHoldRelationship
オブジェクトの列挙。
IndexingFailureCode
定数のビット・マスク。索引付け失敗がない場合、CmIndexingFailureCode プロパティーはゼロの値を返します。
ObjectStore
オブジェクトの IndexingFailureRecordingLevel プロパティーの値を PROPAGATE_TO_SOURCE
に設定すると、エラー情報はすべての CBR 対応オブジェクトの CmIndexingFailureCode プロパティーに伝搬されます。
true
の場合、オブジェクトは、ユーザーにより明示的に削除用のマークが付けられた元のオブジェクトです。あるいは、オブジェクトはオブジェクト値プロパティー (OVP) を介して元のオブジェクトにより参照されています。そのため、サーバーにより削除用のマークが付けられました。
削除用のマークを付けられたオブジェクトは、CmRecoveryItem
オブジェクトで表されます。このオブジェクトを使用して、削除用のマークを付けられたオブジェクトをリカバリーまたはパージ (オブジェクト・ストア・データベースから削除) できます。
プリプロセッサーによって生成されるテキスト抽出のコンテンツ・タイプを指定します。
変換を定義するコンテンツ変換設定サブクラスのクラス定義への参照によって、ハンドラーで生成される出力の変換を指定します。
null
の場合、このオブジェクトは保存中にホールドされず、オブジェクトを削除できる時期について制限はありません。
オブジェクトを作成すると、Content Engine サーバーは CmRetentionDate プロパティーを自動的にデフォルトの保存日時に設定します。Content Engine サーバーは、選択された期間単位 (オブジェクトのクラス定義の RetentionPeriodUnits プロパティー) で表される保存期間 (オブジェクトのクラス定義の DefaultRetentionPeriod プロパティー) をこのオブジェクトの作成日時に追加して、デフォルトの保存日時を計算します。 または、オブジェクトの CmRetentionDate プロパティーを特定の日時に設定してデフォルト値をオーバーライドできます。 オブジェクトが作成されると、CmRetentionDate プロパティーの値をさらに小さい値に変更することはできません。つまり、オブジェクトの保存期間を短縮することはできません。
保存中の関連オブジェクトが含まれるオブジェクトは、その関連オブジェクトがすべて削除されるまで削除できません。 例えば、アノテーションが付いたドキュメントは、そのドキュメントのすべてのアノテーションが削除されるまで削除できません。ドキュメントとそのアノテーションの保存日は互いに独立しています。
ドキュメントがチェックアウトされると、その CmRetentionDate プロパティー値は結果として生成される予約オブジェクトに適用されません。 予約オブジェクトの CmRetentionDate プロパティーを設定した場合、予約オブジェクトをチェックインすると、このプロパティー値は新しいドキュメント・バージョンに適用されます。予約オブジェクトの CmRetentionDate プロパティーを設定してもその予約オブジェクトの削除を防ぐことができないことに注意してください。予約オブジェクトのチェックイン時にその CmRetentionDate プロパティーを設定しない場合、新しいドキュメント・バージョンの CmRetentionDate プロパティーは自動的にデフォルトの保存日時に設定されます。
CmRetentionDate プロパティーは、特定の日時に設定できます。または、以下のいずれかの RetentionConstants
定数に設定できます。
INDEFINITE
: 不定の保存。CmRetentionDate プロパティーが有効期限日時に変更されており、かつその有効期限日時が過ぎている場合のみ、オブジェクトを削除できることを指定します。このプロパティーは、値が null
の場合にのみ INDEFINITE
に設定できます。このプロパティーが INDEFINITE
に設定されている場合、null
に設定することはできません。日時の値または PERMANENT
にのみ設定できます。PERMANENT
: 永続的な保存。このオブジェクトを削除できないことを指定します。CmRetentionDate プロパティー値をオブジェクトに対して設定するには、以下の権限がなければなりません。
StoredSearch
オブジェクトの XML 照会の指定に使用する保管済み検索スキーマ・バージョンを識別します。
開放状態の索引領域が満杯になると、Content Engine サーバーは最高の優先度を持つスタンバイ状態の索引領域を選択して開放状態に設定します。同じ優先度を持つ索引領域が 2 つ以上存在する場合、これらのスタンバイ状態の索引領域のいずれかがサーバーによりランダムに選択されます。
この機能を制御するには、JVM パラメーター com.filenet.engine.cbr.LegacyStandbyActivationPolicy をアプリケーション・サーバーに設定します。この JVM パラメーターのデフォルトは
コンテンツ・タイプのリスト。変換ハンドラーは、このリストにあるコンテンツ・タイプから、特定のターゲット・コンテンツ・タイプを生成できます。
このレプリカの数は、必要なレプリカの数より大きいか等しくなければならず、拡張ストレージ域に関連付けられている 1 次ストレージ・デバイスおよび 2 次ストレージ・デバイスの数を超えることはできません。
数が大きいほどドキュメントの即時冗長度は向上しますが、保存トランザクションを完了するために必要な時間も増加する場合があります。
『複製構成』を参照してください。
必要なレプリカの数は、拡張ストレージ域に関連付けられている 1 次ストレージ・デバイスおよび 2 次ストレージ・デバイスの数を超えることはできません。
数が大きいほどドキュメントの即時冗長度は向上します。数が小さいほど、デバイスで障害が発生してもドキュメントが正常に保存される可能性が高くなります。
『複製構成』を参照してください。
コンテンツ・タイプのリスト。変換ハンドラーは、このリストにあるコンテンツ・タイプからは、特定のターゲット・コンテンツ・タイプを生成できません。
Action
ベースのオブジェクトが呼び出されるときに実行される Java™ アクション・ハンドラー。CodeModule
オブジェクトは、Content Engine にチェックインされるユーザー実装の Java アクション・ハンドラーを表します。「CodeModule オブジェクトの作成」を参照してください。
ColumnDefinitionList
コレクション・オブジェクト。有効な設定は次のとおりです。
CASCADE_DELETE
: 親コンポーネント・ドキュメントが削除されると、子コンポーネント・ドキュメントも自動的に削除されます。ドキュメントの削除が成功するのは、カスケード削除に含まれるすべての子コンポーネントに対して削除権限 (AccessRight.DELETE
) を持っている場合のみです。そうでない場合は、(親コンポーネントも含め) どのコンポーネントも削除できません。例えば、2 つのコンポーネント関係オブジェクトによって、D1 が D2 の親ドキュメントとして指定され、D2 が D3 の親ドキュメントとして指定され、D1 と D2 間および D2 と D3 間のカスケード削除関係が定義されている場合は、3 つすべてのドキュメントに対して削除権限を持っていないと、D1 を削除できません。NO_CASCADE_DELETE
(デフォルト設定): 親コンポーネント・ドキュメントが削除されても、特にアクションは発生しません。有効な設定は次のとおりです。
ALLOW_BOTH_DELETE
(デフォルト設定): 親コンポーネントと子コンポーネントの両方のドキュメントの削除を許可します。PREVENT_BOTH_DELETE
: 親コンポーネントと子コンポーネントの両方のドキュメントの削除を禁止します。PREVENT_PARENT_DELETE
: 親コンポーネント・ドキュメントの削除を禁止します。PREVENT_CHILD_DELETE
: 親コンポーネント・ドキュメントが存在する場合に、子コンポーネント・ドキュメントの削除を禁止します。この ComponentRelationship
オブジェクトの ComponentCascadeDelete プロパティーが CASCADE_DELETE
(親の削除時に子も削除される) に設定されている場合は、この設定を使用すると親コンポーネント・ドキュメントの削除も禁止されます。有効な設定は次のとおりです。
STATIC_CR
(デフォルト設定): 親コンポーネント・バージョンを、明示的に指定された子コンポーネント・バージョンにバインドします。この設定で ComponentRelationship
オブジェクトを作成するには、必須プロパティーとして ParentComponent と ChildComponent を設定します。DYNAMIC_CR
: 親コンポーネント・バージョンを、バージョン・バインド・ルールを満たす最新の子コンポーネント・バージョンにバインドします。バージョン・バインド・ルールについては、「VersionBindType」プロパティーを参照してください。この設定では、バインド資格を持つ子コンポーネント・バージョンが存在する必要があります。この要件の詳細については、「ChildComponent」プロパティーを参照してください。この設定で ComponentRelationship
オブジェクトを作成するには、必須プロパティーとして ParentComponent、ChildComponent、および VersionBindType を設定します。DYNAMIC_LABEL_CR
: 親コンポーネント・バージョンを、ComponentBindingLabel プロパティー値と LabelBindValue プロパティー値が一致するバージョン・バインド・ルールを満たす、最新の子コンポーネント・バージョンにバインドします。このような子ドキュメント・バージョンが存在しない場合は、バインドが行われません。値の比較では、2 つのプロパティーが同じ値を持つとき、または LabelBindValue の値が null
で ComponentBindingLabel の値が null
以外のときに、両者が一致すると見なされます。バージョン・バインド・ルールについては、「VersionBindType」プロパティーを参照してください。この設定で ComponentRelationship
オブジェクトを作成するには、必須プロパティーとして ParentComponent、ChildComponent、VersionBindType、および LabelBindValue を設定します。URICR
: 親コンポーネント・ドキュメントと、URIValue プロパティーによって指定された URI ドキュメントの間のコンポーネント関係を作成します。この URI は、P8 Content Engine ドキュメントと、URI で参照できる他の任意の「ドキュメント」を指すことができます。この設定で ComponentRelationship
オブジェクトを作成するには、必須プロパティーとして ParentComponent と URIValue を設定します。ComponentRelationshipType プロパティーの設定を変更すると、以下に説明するように、一部のプロパティーに対して以前に設定された値が失われる可能性があることに注意してください。
URICR
設定に適用されます。それ以外の設定では、このプロパティー値は null
になります。STATIC_CR
、DYNAMIC_CR
、DYNAMIC_LABEL_CR
の各設定に適用されます。URICR
設定では、このプロパティー値は null
になります。DYNAMIC_CR
および DYNAMIC_LABEL_CR
設定に適用されます。それ以外の設定では、このプロパティー値は null
になります。DYNAMIC_LABEL_CR
設定に適用されます。それ以外の設定では、このプロパティー値は null
になります。ドキュメントのバインドの概要については、「ComponentRelationship」クラスを参照してください。
ComponentRelationship
オブジェクトの位置と、ChildDocuments コレクション内の子コンポーネント・ドキュメントの位置を決定する昇順のソート順番号。これらのコレクションは、親コンポーネント・ドキュメントに属します。他の任意のオブジェクトが同じソート順番号を持つ場合は、ComponentRelationship
オブジェクトの Id プロパティーのバイナリー値によって、このオブジェクトと関連する子コンポーネントの昇順のソート順位置が決定されます。このプロパティーを null
に設定することはできません。
コンポーネント・ソート順序が明示的に設定されていない新しい ComponentRelationship
オブジェクトの場合、オブジェクトの save
メソッドを呼び出すと、ChildRelationships
コレクション内の最も高いコンポーネント・ソート順序に 1000 を加算した値がこのプロパティーに割り当てられます。例えば、コレクション内の任意の ComponentRelationship
オブジェクトに対して明示的に ComponentSortOrder プロパティーを設定しなかった場合、ChildRelationships
コレクションに追加される最初のオブジェクトのコンポーネント・ソート順序は 1000、2 番目のオブジェクトでは 2000、3 番目のオブジェクトでは 3000、以降同様になります。
有効な設定は次のとおりです。
COMPOUND_DOCUMENT
: ドキュメントを複合ドキュメント内の親コンポーネントとして指定します。この親ドキュメントは、最初は子コンポーネントを持っていません。ComponentRelationship
オブジェクトの親コンポーネントにするには、ドキュメントを複合ドキュメントとして指定する必要があります。STANDARD_DOCUMENT
(デフォルト設定 - 4.0.x リリース): ドキュメントを標準ドキュメントとして指定します。この設定は、ドキュメントを複合ドキュメント内の親コンポーネントにすることを禁止します。ComponentRelationship
オブジェクトによって親コンポーネントとして参照される場合は、ドキュメントを標準ドキュメントとして指定できません。null
(デフォルト設定 - 3.5.x から 4.0.x へのアップグレード): ドキュメントを標準ドキュメントとして指定します。デフォルトにより、4.0.x にアップグレードされたオブジェクト・ストア内の既存ドキュメントは、STANDARD_DOCUMENT
ではなく null
値を返します。注: null
値を返すことはできますが、このプロパティーを null
に設定することはできません。このプロパティーでは、CmCompressionEnabled プロパティーで設定して、コンテンツ圧縮をオンにする必要があります。 管理者関連情報については、『コンテンツ圧縮』を参照してください。
GenericFixedContentDevice
オブジェクトの構成パラメーターを指定します。このプロパティーには、固定形式はありません。ただし、固定コンテンツ・プロバイダーのカスタム実装で認識および解析できる文字列にする必要があります。
あるドメインに対するドメイン・コントローラーのコレクションを取得する場合は、LDAP 接続要求でこのプロパティーを使用して、ドメイン内のあるドメイン・コントローラーが起動および実行中かどうかを判断してください。指定時間内にタイムアウトの例外が発生した場合は、そのドメイン・コントローラーが実行中でないと考えられます。この場合は、次のドメイン・コントローラーを試してください。
あるユーザーが、オブジェクトに対してマーキング関連の操作を実行するための適切な権限を持っていない場合は、そのオブジェクトに対するユーザーのアクセス権限から、マーキングの ConstraintMask
プロパティーで指定したアクセス権限が削除されます。
Document
オブジェクトを持つ DocumentSet
コレクション・オブジェクト。ReferentialContainmentRelationship
オブジェクトを持つ ReferentialContainmentRelationshipSet
コレクション・オブジェクト。ReferentialContainmentRelationship
オブジェクトを持つ ReferentialContainmentRelationshipSet
コレクション・オブジェクト。DynamicReferentialContainmentRelationship
または ReferentialContainmentRelationship
オブジェクトの場合は、関係内の Head
オブジェクトの名前となります。デフォルト値は次のように指定されます。
Head
オブジェクトに MimeType プロパティーがある場合 (つまり、Head
オブジェクトが Document
である場合)、
さらに、Head
オブジェクトの Name プロパティーと MimeType プロパティーの両方があり、長さがゼロでない場合、
デフォルト値は Name.FileExtension です。
Content Engine は、FileExtension を判別する mimetypes.properties
ファイルに基づいて、MIME タイプの Head
オブジェクトを 1 つのファイル拡張子に
マップします。
Name プロパティーの値にファイル拡張子が既に表示されている場合、
デフォルトは Head
オブジェクトの Name 値となります (FileExtension は付加されません)。MimeType プロパティーの値がどのファイル拡張子にも
マップしない場合、FileExtension は付加されません。どのような場合でも、無効文字 (以下のリストを参照) は Name 値から削除されます。
また、Name 値は 255 文字に切り捨てられます。Head
オブジェクトの Name 値がデフォルトとなります。無効文字 (以下のリストを参照) は Name 値から
削除されます。また、Name 値は 255 文字に切り捨てられます。Head
オブジェクトの ID 値が使用されます。次の文字は使用できません。
\ / : * ? " < > |
FileEvent
および UnfileEvent
クラスから生成される Event
オブジェクトの場合は、追加または削除された
Containable
オブジェクトの名前がこのプロパティーの値となります。
以下のシナリオでは、サーバーは命名の衝突を検索し、コンテナー名を固有にします。
AutoUniqueName.AUTO_UNIQUE
を設定した場合。「Class AutoUniqueName」の説明にあるように、この設定を使用する場合は注意してください。AutoUniqueName.AUTO_UNIQUE
が設定されている場合、または削除オブジェクトのマークが付けられたオブジェクトがリストアされた場合に、命名の衝突が検出されると、サーバーは以下のように固有の接尾部をコンテナー名に追加して競合を解決します。
DateContentLastAccessed
プロパティー (前回のコンテンツ・アクセス日時) の更新を記録する頻度を指定します。記録頻度としては、なし、即時、1 時間ごと、毎日のいずれかを指定できます。注 コンテンツ・アクセス記録を有効化 ("None" 以外のオプションに設定) すると、システム・パフォーマンスに影響を与えます。DateContentLastAccessed
プロパティーの更新を頻繁に行うほど、システムへの影響は大きくなります。
ドキュメントまたはアノテーションに対する DateContentLastAccessed
プロパティーは、あるオブジェクト・ストアの ContentAccessRecordingLevel
プロパティー値に基づいて更新されます。ドキュメントまたはアノテーションに対する ContentTransfer
オブジェクトのコンテンツがアクセスされると、必ず更新が行われます。ContentTransfer
オブジェクトのコンテンツがアクセスされたと見なされるのは、次のような場合です。
doc.refresh(new String[] {PropertyNames.DATE_CONTENT_LAST_ACCESSED, PropertyNames.ID, "Content", PropertyNames.CONTENT_ELEMENTS});
DateContentLastAccessed
プロパティーが更新されます。Document.accessContentStream
が呼び出される場合。次に例を示します。doc.refresh(new String[] {PropertyNames.DATE_CONTENT_LAST_ACCESSED, PropertyNames.ID, PropertyNames.CONTENT_ELEMENTS});
accessContentStream
メソッドによる) コンテンツ・アクセス操作中に DateContentLastAccessed
プロパティーが更新されます。注: 指定されたチャンク・サイズ (デフォルトまたはユーザー指定) よりもコンテンツが大きく、データベースまたはキャッシュに対してトリップが複数回実行される場合でも、DateContentLastAccessed
プロパティーは、そのコンテンツが最初にアクセスされた時刻に設定されます。
ContentCacheArea
オブジェクトをすべてまとめたコレクション。コンテンツ変換サブシステムのトレース設定。
ContentCacheArea
オブジェクトでは、サーバーがキャッシュ・ストレージ域に物理的にアクセスできず、CacheStatus プロパティーが Closed
に設定されている場合に、このプロパティーから null
が返されます。また、この統計とコンテンツ・エレメント・サイズ (ContentElementKBytes プロパティー) に関する統計は、電源障害が発生すると不正確になる可能性があります。障害のタイミングによっては、コンテンツの作成や削除と統計をサーバーが完全には同期できなくなります。キャッシュ・スイープを行うと 60 日ごとに統計情報が更新され、情報をある程度正確に保つことができます。
StorageArea
オブジェクトのコンテンツ圧縮がオンにされた場合、このプロパティーはコンテンツの圧縮サイズを反映します。
ContentCacheArea
オブジェクトでは、サーバーがキャッシュ・ストレージ域に物理的にアクセスできず、CacheStatus プロパティーが Closed
に設定されている場合に、このプロパティーから null
が返されます。また、この統計は不正確になる可能性があります。詳細については、「ContentElementCount」プロパティーを参照してください。
ContentElementList
オブジェクトを指定します。各コンテンツ・エレメントはコンテンツ・データを表します。このデータは、オブジェクト・ストアに対してローカルで、(ContentTransfer
オブジェクトによって表される) ファイル・ストアまたはデータベースに格納するか、オブジェクト・ストアの外部で、(ContentReference
オブジェクトによって表される) Content Engine サーバーの制御外にすることができます。ContentCacheArea
オブジェクトでは、キャッシュ・クリア操作によってこの数値が 0 (ゼロ) に初期化されます。キャッシュのクリアについては、「CacheStatus」プロパティーを参照してください。この数値が不正確になる可能性については、「ContentCacheArea」クラスを参照してください。
StringList
オブジェクトを指定します。ContentReference
オブジェクトで表されるコンテンツ・データを持つリソースの名前を URL 形式で指定します。このプロパティーは、旧バージョンとの互換性を確保するために保持されており、ドキュメントの CmRetentionDate プロパティーと同じ値がサーバーによって自動的に取り込まれます。
CmContentReplicationQueueEntry
でのプロパティーが非同期の (キューに入れられた) 複製スイープによって使用されます。
いずれかの署名検査オプションが CmContentIntegrityOptions プロパティーで設定されている場合は、ContentTransfer
でのプロパティーが StorageArea
によって使用されます。また、このプロパティーは、エンドツーエンドの取得検証のためにアプリケーションによって使用できます。
ContentTransfer
オブジェクトと関連付けられたコンテンツ・データのサイズをバイト単位で指定します。注: ドキュメントまたはアノテーションが複数のコンテンツ・エレメントを持つ場合は、すべてのコンテンツ・エレメントの合計がこのサイズとなります。全文検索 (CBR) を実行する場合は、ContentSummary 列を参照しないでください。このテキスト列を取得する場合、検索実行時間が長くなることがあります。
このプロパティーの値が null の場合、サーバーは FileNet 作業ディレクトリーを一時コンテンツのディレクトリー・ルートとして使用します。
特定のコンテンツ・エレメントを作成し、それをドキュメント・バージョンに添付する際には、そのエレメントの ContentType プロパティーを設定できます。ContentType プロパティーには値を指定する必要があります。
ContentReference
オブジェクトの ContentType プロパティーに値を指定しないと、エラーが発生します。対照的に、ContentTransfer
オブジェクトの ContentType プロパティーに値を指定しなかった場合、Content Platform Engine はコンテンツ・データの MIME タイプの検出を試行し、推定された MIME タイプ値に、このプロパティーを自動的に設定します。
ただし、Content Platform Engine が ContentTransfer
オブジェクトによって保持されているコンテンツ・データを常に正しく判別できるわけではありません。
したがって、コンテンツ・エレメントを追加する場合は常にこのプロパティーに正しい MIME タイプ値を設定しておくことをお勧めします。ContentType プロパティーの MIME タイプ値を指定しない場合、最低限でも ContentTransfer
オブジェクトの RetrievalName プロパティーによって指定されるパスに、コンテンツ・データのタイプに対応する正しいファイル名拡張子が含まれていることを確認してください。
Content Platform Engine はこのプロパティーの値の形式を強制しませんが、MIME 形式の文字列は、コンテンツ・タイプ、コンテンツ・サブタイプ、およびオプションのパラメーターで構成され、「content type/subtype[;parameter]」という形式 (例: 「text/html」) になります。 値の解釈は、取得側のアプリケーションが行います。
MIME では、次のコンテンツ・タイプが定義されます。
次の MIME タイプは FileNet 固有です。
ContentReference
コンテンツ・エレメントを持つオブジェクトバックグラウンドのコンテンツ変換ワーカーが終了するまでに許容される最大アイドル時間 (秒) を指定します。
Containable
オブジェクトによって調整されるタスクの列挙。
列挙内の各 CmTask
オブジェクトは、ビジネス・アクティビティーの単一のワークを表します。
Coordinator
プロパティーにこの Containable
オブジェクトが
設定された CmTask
オブジェクトが、このプロパティーの列挙値に追加されます。
Containable
オブジェクトへの参照。
このオブジェクトが調整するすべての関連タスクの列挙を返すには、Containable.get_CoordinatedTasks
を呼び出します。
このプロパティーを TRUE
に設定すると、ジョブのフィルター式の条件を満たす保存されたコンテンツと保存されないコンテンツがどちらもコンテンツ一括移動ジョブでコピーされます。
固定コンテンツ・デバイスから移動するコンテンツがこのジョブで削除されることはありません。
これは保存されているコンテンツと保存されていないコンテンツの両方に当てはまります。
コピーされたコンテンツは、その保存日を保持します。
Modify Retention 権限を持つユーザーだけがプロパティーを TRUE
に設定できます。
このプロパティーを FALSE
に設定すると、コンテンツ一括移動ジョブは、保存されないコンテンツのみを正常に別のストレージ域にコピーしてから、保存されないコンテンツをソースの固定コンテンツ・デバイスから削除します。
CopyRetainedContent プロパティーを使用してコピーされるコンテンツは、監査により追跡できます。
これを行うには、CmMoveContentEvent
に監査定義を追加します。
デバイスに保存されたコンテンツの CmMoveContentEvent
インスタンスで、SourceContentRetained プロパティーは TRUE
に設定されます。
PropertyDefinition
オブジェクトの場合は、このプロパティー定義によって定義されるプロパティー値を、チェックアウト時にソース・ドキュメントから新規作成された予約オブジェクトにコピーするかどうかを示す値となります。PropertyDescription
オブジェクトでは、CopyToReservation は読み取り専用です。
ComponentRelationship
オブジェクトの場合は、親コンポーネントのソース・ドキュメントのチェックアウト時に、新規作成された予約オブジェクトにこのオブジェクトをコピーするかどうかを示す値となります。予約オブジェクトは、この ComponentRelationship
オブジェクトの新規コピーに対する親コンポーネントとなります。結果的に、予約オブジェクトとソース・ドキュメントはどちらも、同じ子ドキュメントとの同等なコンポーネント関係を持つことになります。注: 予約オブジェクトは、複合ドキュメントのプロパティーと関係については他のドキュメントと同じように動作します。
大半のユーザーにとって、このプロパティーの設定は読み取り専用です。書き込みアクセス権限 (AccessRight.PRIVILEGED_WRITE
) が与えられているユーザーの場合は、作成時にのみこのプロパティーを設定できます。最初にオブジェクトを作成した後は、すべてのユーザーに対してこのプロパティーが読み取り専用となります。
DocumentState
オブジェクトの StateName プロパティー値と同じになります。-Xmx512m
に設定すると、追加の JVM メモリーを指定できます。DITARenditionEngineConnection
オブジェクトへの参照が含まれます。DITARenditionEngineConnectionSet
オブジェクトへの参照を含みます。TypeID
定数を指定します。
PropertyDescription
、PropertyDefinition
、および PropertyTemplate
オブジェクトの場合、このプロパティーは読み取り専用となり、オブジェクト・プロパティーが保持できる値のデータ型を示します。DataType プロパティーの値は、PropertyDescription
、PropertyDefinition
、または PropertyTemplate
オブジェクトの特定のオブジェクト・タイプに応じて Content Engine サーバーによって自動的に設定されるため、プロパティー・テンプレートやプロパティー定義の作成時に値を設定する必要はありません。例えば、PropertyDescriptionBinary
、PropertyDefinitionBinary
、または PropertyTemplateBinary
オブジェクトでは、サーバーが自動的に DataType プロパティーを BINARY
の値に設定します。
ChoiceList
オブジェクトの場合、このプロパティーは作成時に設定でき、LONG
または STRING
定数値にする必要があります。このプロパティーは、選択リストが整数型選択リスト (整数型の選択アイテムを保持する) か文字列型選択リスト (文字列型の選択アイテムを保持する) かを判断します。
ColumnDefinition
オブジェクトの場合、このプロパティーは読み取り専用となり、表現されるデータベース・テーブル列に格納されるオブジェクト・プロパティー値のデータ型を指定します。
CmIndexPartitionConstraint
オブジェクトの場合、このプロパティーは読み取り専用となり、索引パーティション制約のデータ型を
指定します。
以下に示す値のみが有効となります。
DATE
: 日付索引パーティション制約を指定します。STRING
: 文字列索引パーティション制約を指定します。DataType プロパティーには、次の表のいずれかの値が入ります。
名前 | 値 | 説明 |
---|---|---|
BINARY |
1 | Binary データ型を指定します。符号なし 8 ビット・バイトの配列を使用して、バイナリー・データを表します。 |
BOOLEAN |
2 | Boolean データ型を指定します。true または false の値を持つブール・データを表します。 |
DATE |
3 | DateTime データ型を指定します。ISO 8601 準拠の日付と時刻で、日時を表します。 |
DOUBLE |
4 | Double (Float64) データ型を指定します。IEEE 標準の 64 ビット浮動小数点数値を表します。値の範囲は -1.79769313486232e308 から +1.79769313486232e308 です。 |
GUID |
5 | GUID (ID) データ型を指定します。固有の 128 ビット数値となる GUID (Globally Unique Identifier) または UUID (DCE Universally Unique Identifier) を表します。括弧で囲まれた 32 文字の 16 進数からなる文字列、すなわち {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} の形式で表されます。例えば、{3F2504E0-4F89-11D3-9A0C-0305E82C3301} のようになります。 |
LONG |
6 | Integer データ型を指定します。符号付き 32 ビット整数を表します。値の範囲は -2,147,483,648 から +2,147,483,647 です。 |
OBJECT |
7 | Object データ型を指定します。Content Engine クラスからインスタンス生成されるオブジェクトを表します。 |
STRING |
8 | String データ型を指定します。16 ビット Unicode 文字のシーケンス・コレクションからなるテキストを表します。 |
CmDatabaseConnection
オブジェクトを、同じデータベースを共有するすべてのオブジェクト・ストア、イベント・エクスポート・ストア、およびアイソレート・リージョンに設定します。
アイソレート・リージョンの場合は、ObjectStore プロパティーが設定されると、サーバーはこのプロパティーおよび DatabaseSchemaName プロパティーを、オブジェクト・ストアにある同じ名前のプロパティーと同じ値に自動的に設定します。 このプロパティーまたは DatabaseSchemaName プロパティーの、オブジェクト・ストアから得られた値を変更することはできません。
アイソレート・リージョンが IBM Case Manager で使用されている場合は、ObjectStore プロパティーを設定する必要があります。レガシー・ワークフロー・システムを使用するアイソレート・リージョンの場合は、DatabaseConnection および DatabaseSchemaName を、レガシー・システムを参照する値に設定します。
ObjectStore
オブジェクトの場合、このプロパティーは、データベース内の場所を指定します。オブジェクト・ストアの作成時にこのプロパティーを設定した場合、Content Engine サーバーは、この値を使用して索引の配置場所を制御します。オブジェクト・ストア作成後のプロパティー値の変更は、変更後に追加される索引の場所にのみ影響を与えます。このプロパティー値を上書きするには、オブジェクト・ストアの作成中にカスタム・スキーマ・スクリプトを指定します。「Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)」を参照してください。
CmIndexDefinition
オブジェクトの場合、このプロパティーは、索引の配置場所であるテーブル・スペースまたはファイル・グループを指定します。このプロパティーの値が指定されていないと、サーバーは、この値を、対応する ObjectStore
プロパティー内で指定された索引保管場所 (設定されている場合) に設定します。この索引保管場所が設定されていない場合、保管場所は、基礎データベースによって指定されたデフォルトの索引保管場所に設定されます。
注: このプロパティーは DB2 for z/OS では無視されます。
固有値がデータベース接続の共有のために必要です。 同じ CmDatabaseConnection オブジェクトを使用するように 2 つ以上のオブジェクトが構成されると、データベース接続の共有が開始されます。
データベース接続を共有する複数のオブジェクトに関連付けられた同じ名前のテーブルの間で区別するには、大/小文字を区別しない固有値を入力します。 この値には、同じデータベース接続を使用する別のオブジェクトの DatabaseSchemaName 値を複製することはできません。 また、この値はデータベース・エンティティーの先頭に付加されます (例: <スキーマ名>.<テーブル名>)。
オブジェクト・ストアに対して値を設定しない場合、データベース・サーバーにより適用されるデフォルト・スキーマを使用してオブジェクト・ストアが初期化され、このプロパティーはそのデフォルト・スキーマ名に設定されます。ただし、同じ CmDatabaseConnection
オブジェクトを使用する別のオブジェクト・ストアによりそのスキーマ名がまだ使用されていないのが前提です。
アイソレート・リージョンの場合は、ObjectStore プロパティーが設定されると、サーバーはこのプロパティーおよび DatabaseConnection プロパティーを、オブジェクト・ストアにある同じ名前のプロパティーと同じ値に自動的に設定します。 このプロパティーまたは DatabaseConnection プロパティーの、オブジェクト・ストアから得られた値を変更することはできません。
アイソレート・リージョンが IBM Case Manager で使用されている場合は、ObjectStore プロパティーを設定する必要があります。レガシー・ワークフロー・システムを使用するアイソレート・リージョンの場合は、DatabaseConnection および DatabaseSchemaName を、レガシー・システムを参照する値に設定します。
注: このプロパティーは DB2 for z/OS では無視されます。
ObjectStore
の場合、このプロパティーは非推奨です。CmDatabaseConnection.DatabaseType を使用してください。
サーバーは、ドキュメントのチェックイン時にドキュメント・バージョン上にこのプロパティーを設定し、ドキュメント・バージョンの存続期間中そのまま設定が保持されます。ドキュメントがチェックアウトされると、サーバーはドキュメントの予約オブジェクト上のこのプロパティーを null に設定します。
大半のユーザーにとって、このプロパティーの設定は読み取り専用です。特権書き込みアクセス権限 (AccessRight.PRIVILEGED_WRITE
) を付与されたユーザーは、ドキュメントのチェックイン中にドキュメント上でこのプロパティーを設定できます。特権書き込みアクセス権限を持つユーザーにとってこのプロパティーの設定は SETTABLE_ONLY_BEFORE_CHECKIN
ですが、これらのユーザーは、チェックイン前にはドキュメント上でこのプロパティーを設定できません。ドキュメントのチェックイン中にのみ設定できます。
COMPLETE
状態に変更された日時。
ContentTransfer
オブジェクトで表される) が前回アクセスされた日付と時刻を指定します。Content Engine は、協定世界時 (UTC) を使用して日付と時刻を格納します。詳細については、「タイム・スタンプ」を参照してください。
このプロパティーで返される日付と時刻の記録細度は、オブジェクト・ストアの ContentAccessRecordingLevel プロパティーの設定によって決まります。ドキュメントまたはアノテーション・オブジェクトと関連付けられたコンテンツ・データは、次のいずれかのイベントが発生したときにアクセスされたと見なされます。
FilteredPropertyType.CONTENT_DATA
) を更新するために、プロパティー・フィルターを設定してオブジェクトの refresh
メソッドが呼び出された場合accessContentStream
メソッドが呼び出された場合大半のユーザーにとって、このプロパティーの設定は読み取り専用です。書き込みアクセス権限 (AccessRight.PRIVILEGED_WRITE
) が与えられているユーザーの場合は、作成時にのみこのプロパティーを設定できます。最初にオブジェクトを作成した後は、すべてのユーザーに対してこのプロパティーが読み取り専用となります。
大半のユーザーにとって、このプロパティーの設定は読み取り専用です。書き込みアクセス権限 (AccessRight.PRIVILEGED_WRITE
) が与えられているユーザーの場合は、このプロパティーの読み取り/書き込みが可能です。(これらのユーザーに対する読み取り/書き込み権限を変更できるのは、オブジェクト・ストア上の ACL を変更した場合のみです。この ACL は、オブジェクト・ストア内のオブジェクトに対する書き込みアクセス権限を持つユーザーを制御します。)
WORKING
状態に遷移した日時。
個々の E メール・キュー・エントリーの EmsFromName プロパティーの値 (設定されている場合) は、DefaultFromName プロパティーに設定された値をオーバーライドします。(E メール・キュー・エントリー・クラス EmsEmailQueueEntry
は、Email Services Extensions アドオンの一部としてインストールされます。)
有効な時間制限は、このプロパティーと MaxQueryTimeLimit プロパティーの最小値です。
照会の SQL Timelimit
オプションは DefaultQueryTimeLimit をオーバーライドします。この場合、有効な制限は Timelimit
オプションと MaxQueryTimeLimit プロパティーの最小値です。
Timelimit
オプションもプロパティーも設定されていない場合、照会時間は無制限です。
クライアント/サーバー間 RPC に影響を与える時間制限に加えて、データベース・レベルでの照会実行を制限する QueryDatabaseTimeout プロパティーを設定できます。
詳細については、『サーバー照会タイムアウトの動作』を参照してください。
個々の E メール・キュー・エントリーの EmsReplyToName プロパティーの値 (設定されている場合) は、DefaultReplyToName プロパティーに設定された値をオーバーライドします。(E メール・キュー・エントリー・クラス EmsEmailQueueEntry
は、Email Services Extensions アドオンの一部としてインストールされます。)
ReservationType
定数を指定します。新規作成されるオブジェクト・ストアの場合は、このプロパティーが EXCLUSIVE
に初期設定されます。)DefaultReservationType プロパティーに使用できる値は次のとおりです。
COLLABORATIVE
: コラボレーション型の予約を示します。これは、適切な権限を持つ任意のユーザーがチェックイン、変更、削除を実行できる予約です。EXCLUSIVE
: 排他型の予約を示します。これは、ドキュメントをチェックアウトしたユーザーのみがチェックイン、変更、削除を実行できる予約です。FixedStorageArea
オブジェクトのみ)RetentionPeriod
プロパティーが -2 に構成されている場合) のみ適用されます。一般に、プロバイダーは FP_RETENTION プール機能の値を検査し、機能の設定に応じて保存期間を明示的にゼロまたは無限に設定します。DefaultRetentionPassThrough が 1 に設定されている場合は、保存期間が RETENTION_PERIOD_DEFAULT に設定されます (すなわち、Clip には現行の Centera システム設定が使用されます。この設定を変更するには、システムのコンプライアンス・モードを変更します)。
保存期間の代わりに、DefaultRetentionPeriod プロパティーを以下のいずれかの RetentionConstants
定数に設定できます。
INDEFINITE
: 不定の保存期間。CmRetentionDate プロパティーが有効期限日時に変換されており、かつその有効期限日時が過ぎている場合のみ、このクラス定義で定義されるクラスのインスタンスを削除できることを指定します。PERMANENT
: 永続的な保存期間。このクラス定義で定義されるクラスのインスタンスを削除できないことを指定します。Site
クラスのシステム生成インスタンスです。このクラスには、現行のアプリケーション・サーバー・インスタンスの Virtual Server (および Server Instance) が保持されます。システム管理者権限を持つユーザーは、その後必要に応じて別のサイトをデフォルトに割り当てることができます。サイト関連オブジェクト (ObjectStore
オブジェクトなど) の作成時にサイトを指定しない場合は、作成されるオブジェクトの Site
プロパティーが DefaultSite
プロパティーの値に設定されます。
延期された回数は失敗の回数とは分けられ、最大失敗回数に影響を与えません。 延期は想定内の訂正可能な問題ですが、失敗は予期しない問題です。
延期されたアイテムは、5 分で再試行されるようスケジュールされています (具体的には、HeldUntilDate プロパティーが現行時刻 + 5 分に設定されています)。
拡張ストレージ域に接続されているそれぞれの拡張ストレージ・デバイスでは、このプロパティー設定が、拡張ストレージ域で設定された最小の削除レベルを満たす必要があります。すなわち、各デバイスの破棄機能のレベルは、拡張ストレージ域の DeletionMethod プロパティーで指定されたものと等しいか、またはそれよりも高くなければなりません。
例えば、拡張ストレージ域の削除方式設定が Purge
である場合、その拡張ストレージ域に接続されるすべてのデバイスは、パージの削除レベルをサポートする必要があります。拡張ストレージ域の削除方式設定が Standard
である場合は、その拡張ストレージ域に、標準またはそれ以上の削除レベルをサポートする任意のストレージ・デバイスを接続できます。
DocumentSet
コレクション・オブジェクトを指定します。DequeueHost
値が異なる場合があります。これは実際に処理したサーバーによって値が変化するためです。このテキストは、次のクラスを除き、取得するユーザーにとってロケール固有ではありません。
LocalizedString
オブジェクトのコレクションを持つ LocalizedStringList
オブジェクトを指定します。各 LocalizedString オブジェクトは、クラスまたはプロパティーに関する、ロケール固有でユーザーが判読可能な説明を表します。SourceDocument
プロパティーの反映的なプロパティーです。EMC Isilon 固定コンテンツ・デバイスの場合、URL は https://<isilon_cluster>:<port>/namespace/<access_point>/<resource_path>
の形式です。
OpenStack 対応のオブジェクト・ストレージ・サービスの場合、URL は www.softlayer.com
です。
CmIsilonFixedContentDevice
の場合、ユーザーには、RAN アクセス権が必要です。
DirectoryConfigurationList
オブジェクト。このコレクションは、サポートされるディレクトリー・サーバー (Microsoft Active Directory、ADAM、CA eTrust、IBM Tivoli、Novell eDirectory、Oracle Internet Directory (OID)、および Oracle Directory Server) のタイプ固有のディレクトリー・サーバー構成を表します。これらの構成は、ログイン対象のユーザー名とグループ名を認証する際に Content Engine サーバーによって照会されます。このプロパティーの値には次のいずれも使用できます。
フェイルオーバーに複数の IP アドレスを使用する利点は、ホスト名を変更した場合、あるいはドメイン・コントローラーまたは Tivoli Directory Server を廃棄した場合にフェイルオーバー・リストを変更する必要がないことです。 また、このオプションは、Active Directory のドメインにリモート・ドメイン・コントローラーが含まれているが、(下記の「ドメイン名」のオプションを使用するのではなく) ローカルの DC にのみ接続する場合に便利です。DC 接続は、並列で試行されます。最初に成功した接続が使用される DC になります。
フェイルオーバー・リストの形式は、以下の方法で設定します。
Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN
1 個のスペース文字を使用して、ホスト名とポート番号のペアを他のペアと区切ります。以下の例の最初のペアでは、マシン名として LaurelTree、ポート番号として 389 が指定されています。
LaurelTree:389 OliveTree:636 FigTree:389
Content Engine は、リスト内のペアの順序に基づいて、ディレクトリー・サーバーへの接続を試行します。Content Engine がディレクトリー・サーバーに正常に接続するか、リストの末尾まで試行し終わると、接続試行は停止します。Content Engine が以前に確立されたディレクトリー・サーバー接続を失うと、リストの先頭から接続試行が再開されます。
例えば、上記の例のリストが与えられた場合、Content Engine は、ポート 389 上のマシン LaurelTree にあるディレクトリー・サーバーへの接続を最初に試行します。その試行が失敗した場合には、ポート 636 上のマシン OliveTree にあるディレクトリー・サーバーへの接続を試行します。 その試行が成功した場合には、接続試行は停止します。その後、Content Engine が OliveTree にあるディレクトリー・サーバーへの接続を失った場合には、LaurelTree から接続試行が再び開始されます。
DirectoryServerHost プロパティーの値がフェイルオーバー・リストである場合、Content Engine はこのプロパティーを無視します。フェイルオーバー・リストの詳細については、DirectoryServerHost プロパティーを参照してください。
DirectoryStructure
クラスには、ディレクトリー構造タイプの設定用に定数が定義されています。有効な設定は次のとおりです。
DIRECTORY_STRUCTURE_SMALL
(デフォルト設定): 小型のディレクトリー構造を指定します。小型の構造は 2 レベルのディレクトリーで構成され、レベルごとに 23 のノードがあります (第 2 レベルでのディレクトリーの合計数は 529 です)。コンテンツは第 2 レベルのみで格納されます。DIRECTORY_STRUCTURE_LARGE
: 大型のディレクトリー構造を指定します。
大型の構造は小型の構造を拡張したもので、23 のノードを持つ第 3 レベルがあります (第 3 レベルでのディレクトリーの合計数は 12,167 です)。コンテンツは第 3 レベルのみで格納されます。true
の場合は、ディスパッチャーが実行され、false
の場合は、ディスパッチャーが実行されません。
CFSImportAgentConfiguration
インターフェースでは、このプロパティーの値が true
の場合にディスパッチャーが実行されますが、インポート・エージェントのサブコンポーネントも有効化されていないと、インポーター全体としてはインポート要求を処理しないことがあります。詳細については、CFSSiteSettings
インターフェースの「IsImportAgentEnabled」プロパティーを参照してください。インポーターのサブコンポーネントの説明については、CFSImportAgentConfiguration
インターフェースを参照してください。
ディスパッチャーの処理実行間隔 (秒単位) です。この時間中は、ディスパッチャーがアイドル状態になり、ワークが来るのを待ちます。次に示すように、このプロパティーで指定された値は、プロパティーの対象クラスに応じて異なる待機間隔を表します。
CFSImportAgentConfiguration
インターフェースでは、最大待機間隔を表します。(最小間隔は常に 1 秒で、変更はできません。)AsyncProcessingConfiguration
インターフェースでは、固定待機間隔を表します。(事実上は、最小待機間隔と最大待機間隔の両方を表します。)
最小間隔と最大間隔との連携は、次のようにして行われます。前の処理実行でディスパッチャーが実行すべきワークがあった場合は、最小間隔が、ディスパッチャーが実際にアイドル状態を維持する今後の待機間隔時間となります。ディスパッチャーが実行すべきワークがなかった場合は、(a) 前の待機間隔の 2 倍、(b) 最大待機間隔のうち、いずれか短い方が待機間隔時間となります。例えば、最小間隔が 35 秒、最大間隔が 120 秒の場合、ディスパッチャーはアイドル状態を 35 秒間維持し、実行可能なワークが検出されなければ、次にアイドル状態を 70 秒間 (前の待機時間の 2 倍) 維持します。また実行可能なワークが検出されなければ、今度はアイドル状態を 120 秒間 (最大間隔) 維持します。さらに実行可能なワークが検出されなければ、またアイドル状態を 120 秒間維持します。ワークが来たことを検出し、そのワークを処理した場合は、今度はアイドル状態を 35 秒間維持します。注: 最小間隔と最大間隔が等しい場合の例は単純です (AsyncProcessingConfiguration
インターフェースの場合は常に等しくなります)。最小間隔と最大間隔がどちらも 35 秒の場合、ディスパッチャーはアイドル状態を 35 秒間維持し、実行可能なワークが検出されなければ、またアイドル状態を 35 秒間維持します。ワークが来たことを検出し、そのワークを処理した場合も、またアイドル状態を 35 秒間維持します。
CFSImportAgentConfiguration
インターフェースでは、このプロパティーはその名前にもかかわらず、インポート・エージェントとして認識されているインポーター・サブコンポーネントに適用され、インポート・ディスパッチャーには適用されません。インポーター・サブコンポーネントについては、「CFSImportAgentConfiguration
」インターフェースを参照してください。
Name
プロパティーとなります。CmAuditProcessingBookmark
および AuditDefinition
オブジェクトの場合、このプロパティーは、監査ログを処理するクライアント・アプリケーションを識別する目的で使用されます。
CmAuditProcessingBookmark
オブジェクトの場合、このプロパティーは、監査廃棄機能のサポートのため、オブジェクトを作成したクライアントを識別します。
AuditDefinition
オブジェクトの場合、このプロパティーは、特定のクライアントまたはクライアント機能の監査定義のセットを識別します。
CmAuditProcessingBookmark
オブジェクトおよび AuditDefinition
オブジェクトの場合、ユーザーがこのプロパティーを設定することが推奨されます。
クライアント・アプリケーション同士を区別するため、固有値を指定してください。
ただし、サーバーは、複数の CmAuditProcessingBookmark
オブジェクトまたは AuditDefinition
オブジェクトでの
同じ表示名の使用を禁止していません。したがって、クライアント・アプリケーション側の責任で固有性を順守する必要があります。
LocalizedString
オブジェクトのコレクションを持つ LocalizedStringList
オブジェクトを指定します。各 LocalizedString オブジェクトは、クラス定義、プロパティー・テンプレート、または選択に関する、ロケール固有でユーザーが判読可能な表示名を表します。WHERE
節に相当する式のフラグメントでなければなりません。
式の値が true と評価された場合は、監査イベントが削除されます。
廃棄ルールはフィルター式として評価され、FilterExpression プロパティーと 同じ構文の要件が適用されます。
廃棄ルール内で参照されるプロパティーは、イベント・オブジェクトに対して相対的なプロパティーであり、 イベントのソース・オブジェクトに対してではありません。ただし、イベント・オブジェクトに直接設定された ソース・オブジェクトのプロパティー、例えば、ソース・オブジェクト・クラスまたは ID などは参照できます。 また、プロパティー監査の結果として イベントに追加されたソース・オブジェクトのプロパティーも参照できます。
あるグループまたはユーザーを固有に識別する名前。識別名 (DN) は、グループまたはユーザーの短縮名と、グループまたはユーザーが属するドメインの名前で構成されます。例えば、短縮名が "Managers" のグループの場合、識別名は "CN=Managers,DC=example,DC=com" のようになります。
DocumentClassificationAction
オブジェクトのコレクションを持つ DocumentClassificationActionSet
オブジェクトを指定します。各 DocumentClassificationAction
オブジェクトは、特定タイプのコンテンツ・データを保持するドキュメントを自動分類する Java™ コードを表します。DocumentLifecyclePolicy
オブジェクトと関連付けられた DocumentLifecycleAction
オブジェクトを指定します。DocumentLifecycleAction
オブジェクトのコレクションを持つ DocumentLifecycleActionSet
オブジェクトを指定します。DocumentLifecycleAction
オブジェクトと関連付けられた DocumentLifecyclePolicy
オブジェクトのコレクションを持つ DocumentLifecyclePolicySet
オブジェクトを指定します。DocumentLifecyclePolicy
オブジェクトを指定します。ドキュメント・ライフ・サイクル・ポリシーは、ドキュメントに対して有効なライフ・サイクル状態のセットを定義し、これらの状態の変更を制御し、ドキュメントのライフ・サイクル状態が変更されたときに実行するアクションを指定します。
DocumentLifecyclePolicy
オブジェクトによって定義された、有効なドキュメント状態の完全セットを持つ DocumentStateList
オブジェクトを指定します。なお、各状態は DocumentState
オブジェクトで表されます。各ドキュメント・ライフ・サイクル・ポリシーでは、ライフ・サイクル中にドキュメントが移行できる状態のセットが定義されます。
IBM ドキュメントを使用するために、www.ibm.com サイトにある IBM Knowledge Center、またはユーザーがインストールおよびデプロイするローカル・インフォメーション・センターのいずれかにリンクできます。 ヘルプ・トピックを正常に取得するためには、クライアントは、適用できるトピックのプラグイン・パスをドキュメント・サーバーの基本 URL に連結する必要があります。
IBM ドキュメントの基本 URL の設定について詳しくは、『FileNet P8 ドメインの基本ドキュメント URL の更新 (Updating the base documentation URL for the FileNet P8 domain)』を参照してください。
DomainType
オブジェクト。DomainType プロパティーには、以下のいずれかの値を指定できます。
STANDALONE
: ドメインがスタンドアロン・ドメインであることを示します。スタンドアロン・ドメインでは、テナント・ドメインの作成は許可されません。MASTER
: ドメインがマスター・ドメインであることを示します。マスター・ドメインは、操作上はスタンドアロン・ドメインと同じですが、1 つ以上のテナント・ドメインをオプションで作成できます。作成されたテナント・ドメインは、マスター・ドメインと同じ物理インフラストラクチャーおよびリソースを共有します。TENANT
: ドメインがテナント・ドメインであることを示します。各テナント・ドメインは、マスター・ドメインの物理インフラストラクチャーおよびリソースを共有しますが、API にとってはスタンドアロン・ドメインのように見えます。true
に設定すると、ストレージ域内に同一のコンテンツが既に存在する場合には、着信コンテンツはストレージ域に追加されません。重複しないコンテンツのみが追加されます。
Content Engine リポジトリーに E メールをアーカイブするときのように、大量のコンテンツを取り込む場合には、このプロパティーを true
に設定することを検討してください。
ただし、この機能はサーバー・パフォーマンスに影響するため、コンテンツが重複する頻度が低い場合には、デフォルト設定を維持することもできます。
FixedStorageArea
インターフェースについては、このリリースでは値を true
に設定できません。
詳細については、『コンテンツ重複の抑止 (Content duplication suppression)』を参照してください。
uniquemember
属性を識別することがあります。
dxDynamicGroupOfUniqueNames
)。
dxMemberURL
属性です。Content Engine サーバーは、この照会を実行して、グループの動的メンバーを検索します。
VirtualServer
の URI エンドポイントを転送する EJB を保持します。このプロパティーでは、サイト内の仮想サーバーが転送された要求を受信するために、有効な URI を指定する必要があります。VirtualServer
は、転送された要求に対する唯一のアドレス指定可能ユニット。VirtualServer
では、リモート・サーバーが接続するための接続文字列を指定する必要があります。この接続情報は EJBForwardingEndpoint プロパティーで指定します。このプロパティーが空の場合は、VirtualServer
が転送された要求を受け入れることを管理者が望んでいないものと見なされます。この場合は、CanAcceptForwardedRequests プロパティーを使用して、転送された要求を受け入れるように Site
を構成しても、要求の転送は実行されません。
次に、指定されたアプリケーション・サーバー環境の URI の例を示します (ホスト名は名前または IP アドレス形式で指定できます)。
"t3://Server1:7001/FileNet/Engine"
"iiop://Server1:2809/FileNet/Engine"
"jnp://Server1:1099/FileNet/Engine"
URI 文字列の最大長は 2083 文字です。
1 回のみ実行するスイープ・ジョブにこのプロパティーを設定する場合、特にテーブルが非常に大きい場合は、スイープ・ジョブがテーブル全体を処理するために十分な時間を割り当てるように注意してください。この有効終了日付に必要な時間を割り当てない場合、スイープ・ジョブはテーブルを完全に処理する前に終了します。
同様に、1 回のみ実行するバックグラウンド検索にこのプロパティーを設定する場合、照会完了のための十分な時間を確保してください。そうしないと、すべての検索結果を返す前にスイープが終了してしまいます。
このプロパティーへは、ContentElement
ベースのオブジェクトまたは GetContentEvent
(このプロパティーで指定されたコンテンツ・エレメントの取得時に発生するイベントを表す) からアクセスできます。
CmVerityIndexRequest
の場合、このプロパティーは非推奨です。
User.get_Email()
によって返されます。true
) 無効にするか (false
) を指定します。
無効にする場合、Email Services Extensions アドオンの一部としてインストールされるハンドラーおよび E メール・キューは無視されます。
true
) 否か (false
) を示します。このプロパティーを true
に設定すると、新しい暗号鍵が生成されます。この暗号鍵は、新しいコンテンツを暗号化する際に使用されます。
コンテンツの暗号化方法の詳細については、「コンテンツの暗号化 (Content encryption)」を参照してください。
null
が返されます。
このプロパティーは、IBM 製品のサポートによる暗号鍵の外部管理を目的とします。 サーバーによって生成される鍵の代わりに独自の鍵を提供せざるを得ない理由がない限り、通常、カスタム・アプリケーションはこのプロパティーを使用しないででください。
暗号鍵の長さは 128 ビットにする必要があります。長さが正しくないと、E_BAD_VALUE
例外が発生します。
暗号鍵の生成には、連邦情報処理標準 (FIPS) 140 準拠アルゴリズムを使用することをお勧めします。
暗号鍵が使用されるのは、EncryptionEnabled プロパティーが true
に設定されている場合だけです。
EncryptionEnabled プロパティーが false
に設定されている場合、このプロパティーに設定された値は無視されます。
EncryptionEnabled プロパティーが true
に設定されていて、このプロパティーが設定されていない場合、サーバーは自動的に暗号鍵を生成します。
コンテンツの暗号化方法の詳細については、「コンテンツの暗号化 (Content encryption)」を参照してください。
null
となります。
コンテンツが P8 ストレージ域に移動された後、統合ドキュメントおよびアノテーションの複製を無効にするには、このプロパティーを true に設定します。コンテンツの移動後、サーバーはドキュメントおよびアノテーションの ReplicationGroup プロパティーを null に設定します。
Subscription
ベースのオブジェクト (ClassSubscription
、ClassWorkflowSubscription
、InstanceSubscription
、InstanceWorkflowSubscription
) によってサブスクライブされるイベントの発生時に実行されるアクションを定義するイベント・アクション・オブジェクトです。このプロパティーは EventAction
オブジェクトと共に設定するため、このオブジェクトがオブジェクト・ストア内に既に存在している必要があります。したがって、このプロパティーは、Subscription
ベースのオブジェクトの作成時に指定します。このプロパティーが設定されると、Content Engine は Subscription
ベースのオブジェクトを EventAction
オブジェクトの Subscriptions
コレクション・プロパティーに追加します。
ObjectStore
オブジェクトと関連付けられた EventAction
オブジェクトのコレクション。Event
オブジェクト。カスタム・イベントの場合は、クライアント・アプリケーションがこのプロパティーを設定して、イベント・アクション・ハンドラーに状態を伝えることができます。したがって、このプロパティー値を定義および解釈するのは、クライアント・アプリケーションとイベント・アクション・ハンドラーです。イベント・アクション・ハンドラーでは、ハンドラーに渡されるイベント・オブジェクトからこのプロパティーが取得されます。
大半のユーザーにとって、このプロパティーの設定は読み取り専用です。書き込みアクセス権限 (AccessRight.PRIVILEGED_WRITE) が与えられているユーザーの場合は、作成時にのみこのプロパティーを設定できます。最初にオブジェクトを作成した後は、すべてのユーザーに対してこのプロパティーが読み取り専用となります。
バックグラウンド検索の場合は、検索内でこの時点までに返された照会結果行の数。この数は、MaximumExaminedRowCount プロパティーの設定を反映します。
IBM Content Foundation では、Case Analyzer および Process Simulator はサポートされません。
ExternalPropertyAliasList
コレクションを指定します。ExternalClassDescription
オブジェクトのコレクションを内蔵している ExternalClassDescriptionSet
オブジェクトを指定します。それぞれの ExternalClassDescription
オブジェクトは、この外部リポジトリー内のクラスの説明を表します。
ExternalPropertyDescription
オブジェクトのコレクションを内蔵している ExternalPropertyDescriptionSet
オブジェクトを指定します。ExternalIdentity
オブジェクトの ExternalIdentityList
読み取り専用コレクションを指定します。ExternalRepository
オブジェクトのコレクションを内蔵している ExternalRepositorySet
オブジェクトを指定します。ExternalRepository
オブジェクト。
外部リポジトリーは、IBM® Content Manager OnDemand (CMOD) リポジトリーや IBM® FileNet® Image Services リポジトリーなど、Content Engine サーバーの外部に存在するリポジトリーです。
テキスト抽出を書き込む際に使用する言語のロケール名 (分かっている場合)。
テキスト抽出中にコンテンツから抽出されたプロパティーの名前と値のペアのリスト。
テキスト抽出操作の状況。
true
に設定します。
例えば、Centera ログ・ファイル名およびその他のロギング・パラメーターを CenteraLogging.cfg という名前のファイル内で定義する場合には、このプロパティーの値をそのファイルの完全修飾名 (C:¥config¥CenteraLogging.cfg など) に設定します。これにより、Content Engine は、そのファイル名を Centera に渡します。Centera によってユーザー指定のログ・ファイルに記録された情報は、Content Engine と Centera 固定コンテンツ・デバイスの間の接続およびパフォーマンスの問題の診断に役立ちます。
構成パラメーターの詳細については、Centera の資料を参照してください。次に、現在使用可能なパラメーターの一部を示します。
例えば、構成ファイルでは、以下のパラメーターと値を指定できます。
FP_LOGPATH=C:¥logs¥Centera.log
FP_LOG_STATE_POLL_INTERVAL=10
FP_LOGKEEP=APPEND
FP_LOGLEVEL=1
FP_LOGFORMAT=TAB
true
に設定すると、ロギングが使用可能になります。false
に設定すると、ロギングが使用不可になります。Centera ネイティブ・ロギングを使用可能にする場合には、FPLogConfigFile プロパティーの値を適切に設定する必要があります。
FPPool.Open
が接続を開始する方法を指定します。使用可能な値は次のとおりです。FPPool.Open
は、接続文字列内にあるすべてのアドレスと、関連するすべての複製アドレスへの接続開始を試みます。この方法は、プールが開いている間にアプリケーションが多数の操作を実行する場合に使用してください。このオプションはデフォルトの方法であり、FP_OPTION_DEFAULT_OPTIONS と同じです。FPPool.Open
は必要なアドレスへの接続のみ開始します。この方法は、アプリケーションがプールの開閉を頻繁に行う場合に使用してください。BlobWriteCollisionAvoidanceFlag
はタグの書き込みに使用され、BLOB のみに適用されます。)FPClip.Delete
および FPClip.AuditedDelete
) と廃止されたパージ操作 (FPClip.Purge
および FPTag.BlobPurge
) のフェイルオーバー方法を指定します。使用可能な値は次のとおりです。FPClip.Exists
および FPTag.BlobExists
) のフェイルオーバー方法を指定します。使用可能な値は次のとおりです。FPPoolQuery.Open
) のフェイルオーバー方法を指定します。使用可能な値は次のとおりです。FPClip.Open
、FPTag.BlobRead
、FPTag.BlobReadPartial
) のフェイルオーバー方法を指定します。使用可能な値は次のとおりです。FPClip.Write
および FPTag.BlobWrite
) のフェイルオーバー方法を指定します。使用可能な値は次のとおりです。バックグラウンド検索の場合、このプロパティーの値は常に 0 です。
キュー・エントリーで、このプロパティーが CmQueueSweep
の MaximumFailures プロパティーの値以上になると、QueueEntryStatus プロパティーは FAILED
に設定され、スイープ・サービスはこのエントリーを処理対象として選択しなくなります。
FAILED
状態にあるキュー・エントリーの処理を再開するには、このプロパティーをゼロにリセットします。そうすれば、QueueEntryStatus プロパティーは FAILED
から RETRY_WAIT
に変更されます。
バックグラウンド検索 (CmBackgroundSearch
) で、このプロパティーが CmBackgroundSearch
の MaximumFailures プロパティーの値以上になると、バックグラウンド検索は停止します。
関連する JNDI 名については、「FederationJNDIXADataSource」プロパティーを参照してください。外部リポジトリーの指定については、「SourceRepositoryName」プロパティーを参照してください。
関連する JNDI 名については、「FederationJNDIDataSource」プロパティーを参照してください。外部リポジトリーの指定については、「SourceRepositoryName」プロパティーを参照してください。
true
の場合は、外部ドキュメントの変更が優先され、CFS はインポートされたメタデータを使用して FileNet P8 ドキュメントを無条件で更新します。false
の場合は、FileNet P8 ドキュメントよりも対応する外部ドキュメントの方が最近変更されている場合にのみ、FileNet P8 ドキュメントが更新されます。
例えば、FileNet P8 ドキュメント X と対応する外部ドキュメント Y があり、FileNet P8 リポジトリー内のユーザーが X のメタデータを昨日変更し、外部リポジトリー内のユーザーが Y のメタデータを一昨日変更し、さらに CFS が今日、スケジュールに従って外部リポジトリーから FileNet P8 リポジトリーにメタデータをインポートするとします。この場合、CFS は X が Y よりも最近変更されたことを検出するため、Y のメタデータで X を更新しません (FederationUpdateHasPriority プロパティーの値が false
であることを前提としています)。
CFS は、FileNet P8 の DateLastModified プロパティーと外部ドキュメントの対応するプロパティーに基づいて、変更日の比較を行います。外部ドキュメントに対応するプロパティーがない場合、CFS はこのプロパティーの値に関係なく、インポートされたメタデータを使用して FileNet P8 ドキュメントを無条件で更新します。
StoragePolicy
、Subscription
、AuditDefinition
、CmSweepPolicy
、および CmSweepJob
の各オブジェクトに適用されます。
StoragePolicy
の場合、ドキュメントまたはアノテーションのコンテンツの格納先となるストレージ域を決定する選択基準として、FilterExpression が使用されます。この式はすべてのストレージ域を対象に評価され、この保管ポリシーの観点から「同等」と見なされるストレージ域が決定されます。詳細については、『保管ポリシー』を参照してください。
Subscription
の場合、イベント・アクションを起動するかどうかを判断するために FilterExpression が使用されます。AuditDefinition
の場合、
イベントの監査が必要かどうかを判断するために FilterExpression が使用されます。
このフィルターは、ソース・オブジェクトか、Subscription
または AuditDefinition
の
FilteredPropertyId
プロパティーで指定されたオブジェクト (オプション) に適用されます。
注: バージョン・シリーズのサブスクリプションの場合は、バージョン・シリーズではなく、トランザクション内のドキュメント・バージョンにフィルターが適用されます。
Subscription
の場合、Content Engine サーバーは、次のようにフィルター式を評価します。
true
と評価された場合は、サブスクリプションで指定されたイベント・アクションが開始されるか、またはキューに入れられます (どちらになるかは、イベント・アクションが同期実行と非同期実行のどちらに設定されているかによって決まります)。false
または unknown
と評価されるか (一般に、プロパティーに値がないため)、評価時にエラー (式内の構文エラー、プロパティー参照の間違いなど) が発生した場合は、イベント・アクションがサイレントで破棄されます。スイープ・ジョブまたはスイープ・ポリシーの場合、FilterExpression は、スイープ・ターゲットのクラスの各インスタンスを評価するために使用されます。式の値が true
と評価された場合は、操作がインスタンスに適用されます。実行される操作はスイープのタイプによって異なります。
AuditDefinition
オブジェクトの場合、FilterExpression は、タイプが ObjectChangeEvent
のイベントにのみ適用されます。
式の値が true
と評価されると、イベントは監査されます。そうでなければ、監査されません。
このプロパティーの構文は、SQL where
節に相当する式のフラグメントにし
(例えば、VersionStatus = 1
)、サポートされる演算子を使用する必要があります。「SQL 構文のリファレンス」を参照してください。
アドホック SQL 照会で有効な演算子の中には、FilterExpression でサポートされていないものがあることに注意してください。次の演算子はサポートされていません。
注: フィルター式には、照会不可能で非永続的なプロパティーに対して表現された条件を含めることができます。有効な式の例を次に示します。Owner='jsmith'
Subscription
オブジェクト および AuditDefinition
オブジェクトの場合のみ、ソース・オブジェクトの
変更されたプロパティーに基づいてイベントをフィルタリングするため、IsModified 述部を使用できます。
IsModified 述部を使用するフィルター式は、次のような構文にする必要があります: IsModified(property)。ここで、property は、照会内の他の場所でサポートされるフォーム (例えば、table_alias.property_alias) にできます。
IsModified 述部は、フィルター式内でのみ使用できます。アドホック SQL 照会内では使用できません。
FilterExpression
プロパティーで定義されます。)例えば、ReferentialContainmentRelationship
上のイベントでは、FilterPropertyId
プロパティーで Head
を指定して、ReferentialContainmentRelationship
ではなく包含可能なオブジェクトをフィルタリングに使用できます。フィルター式の使用はオプション。FilterPropertyId
が null
の場合は、ソース・オブジェクト自体がフィルター式によって評価されます。
注: PublishRequestEvent
の場合、フィルター式は、パブリッシュされるソース・オブジェクトのオブジェクト値プロパティーではなく、PublishRequest
オブジェクトの
InputDocument
プロパティーに適用します。ドキュメントをパブリッシュすると PublishRequest
オブジェクトが
作成されます。これは、実行時に PublishRequestEvent
をトリガーするソース・オブジェクトです。
FilteredQueryTimeout
を使用して、ジョブおよびポリシーのスイープのパフォーマンスを最適化することができます。
FilteredQueryTimeout
がデフォルト値の 0 に設定されている場合、スイープはまず候補オブジェクトをデータベースから取得する照会を発行し、次に候補オブジェクトに対してフィルター式条件を適用して、処理するオブジェクトを判別します。
FilteredQueryTimeout
値が 0 より大きい場合、データベースに発行される照会の WHERE
節には、フィルター式の条件が含まれます。
FilteredQueryTimeout プロパティーの値は、照会に対して時間制限を設定するために使用されます。
時間制限は、スイープ反復の最初の照会にのみ適用されます。
照会の時間制限を超過すると、照会は終了し、スイープは、WHERE
節にフィルター式が含まれていない照会の使用にフォールバックします。
FilteredQueryTimeout
プロパティーを使用することには、スイープが長時間実行されるデータベース照会を発行するのか、それとも候補オブジェクトを処理前に評価するのかの間での、トレードオフの関係があります。
詳細については、『FilteredQueryTimeout によるスイープの最適化』を参照してください。
FixedStorageArea
オブジェクトまたは外部リポジトリーに関連付けられている固定コンテンツ・デバイスを指定します。
非推奨。
キャッシュに含まれる項目のエイジが等しいと見なすことのできる、各項目のタイム・スタンプ (エイジ) のミリ秒差 (デルタ) の最大数。この値は、FolderCacheReapFrequency
と関連付けられたキャッシュ・パージ・アルゴリズムによって使用されます。タイム・スタンプの差がこのミリ秒数以下のフォルダー項目は、キャッシュからパージする項目を決定する際の比較目的において、等しいと見なされます。
非推奨。
キャッシュがFolderCacheMaxEntries
の値を超えたときに、フォルダー・キャッシュがパージされる頻度。削除されるフォルダー項目は、使用方法のアルゴリズムによって決定されます。キャッシュ内の項目数が FolderCacheMaxEntries
の値以下になるまで、キャッシュからフォルダー項目が削除されます。
このプロパティーの値は、キャッシュが FolderCacheMaxEntries
の値を超えた場合、パージ・アルゴリズムが実行される前に n (指定値) 個の項目をキャッシュに追加できることを意味します。
* \ / : ? " < > |
Folder
オブジェクトを持つ FolderSet
コレクション・オブジェクト。このプロパティーの値が true に設定されていると、サーバーは、基礎データベースが式ベースの索引を処理でき、かつ文字列値列が索引定義内に含まれている場合にのみ、値を保持します。上記以外の場合、サーバーはこのプロパティーの値を false に設定し、この変更を示すメッセージが p8_server_error.log
ファイルに記入されます。
このプロパティーの値が指定されていないと、サーバーは、以下の条件がすべて満たされている場合に、この値を true に設定します。
ObjectStore
上の ForceCaseInsensitiveSearch プロパティーの値が true である。以上の条件のいずれかが満たされていない場合、サーバーは、このプロパティーの値を false に設定します。
ObjectStore
オブジェクトの場合、このプロパティーは、表されたオブジェクト・ストア内の検索を大文字小文字の区別なしで実行するかどうかを決定します。
IsolatedRegion
オブジェクトの場合、このプロパティーは、表されたアイソレート・リージョン内の検索を大文字小文字の区別なしで実行するかどうかを決定します。この設定は、アイソレート・リージョンに関連付けられているオブジェクト・ストアで大文字小文字を区別するかどうかの設定とは別個に設定できます。このプロパティーがアイソレート・リージョン上で設定されていない場合、デフォルトの動作では、アイソレート・リージョンに関連付けられているオブジェクト・ストア上の ForceCaseInsensitiveSearch プロパティーの設定を使用します。
UpgradeAddOn
オブジェクトによってアップグレードされたアドオン・バージョンを識別する ID のリストを指定します。このリストには、1 つ以上の ID が含まれている必要があります (通常は ID が 1 つだけ含まれています)。FULLTEXTROWLIMIT
オプションを使用すると、この値を超えることができます。この値を大きくすると、全文検索操作で使用されるシステム・リソースの量が増え、全文検索の実行時間が長くなり、結果的にヒット件数も多くなります。この値を小さくすると、全文検索の精度が下がる可能性があります。FULLTEXTROWLIMIT
オプションを指定した場合は、返すことのできる最大行数として、このプロパティー値と FULLTEXTROWLIMIT
に指定した値のうち小さい方が使用されます。この制限の設定により、検索操作中の過度のリソース使用を抑えられます。システム管理者がこのプロパティー値を変更しない場合、この値はデフォルトで無限大に設定されます。
複数台サーバー構成の場合、仮に GCD の更新が通常の頻度で発生するなら、より頻繁なキャッシュ更新のポーリング間隔 (より小さい TTL 値) が必要です。しかし GCD に存在するオブジェクトは元々静的に設計されているため、GCDCacheTTL の更新は恐らく必要ありません。
このプロパティーの値には次のいずれも使用できます。
null
である場合、Content Engine は、GC を検出するための内部メカニズムを使用します。フェイルオーバー・リスト形式
フェイルオーバー・リストの形式は、以下の方法で設定します。
Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN
1 個のスペース文字を使用して、ホスト名とポート番号のペアを他のペアと区切ります。以下の例の最初のペアでは、マシン名として LaurelTree、ポート番号として 3268 が指定されています。
LaurelTree:3268 OliveTree:3269 FigTree:3268
Content Engine は、リスト内のペアの順序に基づいて、GC への接続を試行します。Content Engine が GC に正常に接続するか、リストの末尾まで試行し終わると、接続試行は停止します。Content Engine が以前に確立した GC 接続が失われると、リストの先頭から接続試行が再開されます。
例えば、上記の例のリストが与えられた場合、Content Engine は、ポート 3268 上のマシン LaurelTree にある GC への接続を最初に試行します。その試行が失敗した場合には、ポート 3269 上のマシン OliveTree にある GC への接続を試行します。 その試行が成功した場合には、接続試行は停止します。その後、Content Engine が OliveTree にある GC への接続を失った場合には、LaurelTree から接続試行が再び開始されます。
GCHost プロパティーの値が null
またはフェイルオーバー・リストである場合、Content Engine はこのプロパティーを無視します。フェイルオーバー・リストの詳細については、GCHost プロパティーを参照してください。
以下の表では、サポートされているサービス・プロバイダーごとに、このプロパティーのデフォルト値を示します。 一部のプロバイダーでは、ルックアップ属性を使用できます。 属性を指定する場合、忘れずに不等号括弧 (<attribute>) を含めてください。
プロバイダー | 検索フィルター | プロバイダー属性 |
---|---|---|
Active Directory | 適用されない | デフォルト: null この値は変更しないでください。 プロバイダーはその memberOf 属性を使用して、グループ・メンバーシップをルックアップします。 |
ADAM または AD LDS | 適用されない | デフォルト: <memberOf>
CPE 5.2.1.2-P8CPE-FP002 以降が必要です。 |
IBM Tivoli | デフォルト:
(|(&(objectclass=groupOfNames)(member={0}))(&(objectclass=groupOfUniqueNames)(uniqueMember={0}))) |
<ibm-allGroups>
CPE 5.2.1.2-P8CPE-FP002 以降が必要です。 ご使用のバージョンでこの属性がサポートされているかどうかを確認するには、IBM Tivoli の資料をご覧ください。 |
Novell eDirectory | デフォルト:
(&(objectClass=groupOfNames)(member={0})) |
<groupMembership>
CPE 5.2.1.2-P8CPE-FP002 以降が必要です。 ご使用のバージョンでこの属性がサポートされているかどうかを確認するには、Novell eDirectory の資料をご覧ください。 |
Oracle Internet Directory (OID) | デフォルト:
(|(&(member={0})(objectClass=groupOfNames))(&(uniqueMember={0})(objectClass=groupOfUniqueNames))) |
適用されない |
Oracle Directory Server Enterprise Edition
または Sun Directory Server Enterprise Edition または SunOne |
デフォルト:
(&(objectClass=groupOfUniqueNames)(uniqueMember={0})) |
適用されない |
Computer Associates eTrust | デフォルト:
(&(cn={0})(objectClass=person)) |
適用されない |
samAccountName
、それ以外のサポート対象ディレクトリー・サービス・プロバイダーの場合は cn
となります。"(&(objectClass=user_defined_class)(an_attribute={0}))"
の形式にする必要があります。ここで、user_defined_class には必要なオブジェクト・クラス (例: user) が入り、an_attribute には LDAP サーバー固有の属性 (例: samAccountName、cn、uid) が入ります。このプロパティーのデフォルト値はディレクトリー・サービス・プロバイダーに固有です。値は次のとおりです。
Group.Id
プロパティーに使用する
ディレクトリー・サーバー属性を指定します。デフォルトのプロパティー値はディレクトリー・サーバー・タイプに依存し、認証プロバイダーの構成によって指定されます。サポートされている認証プロバイダーのデフォルトの SID 属性のリストについては、「セキュリティー権限について (What are access rights?)」を参照してください。
非推奨。
ディレクトリー・サーバー・グループ固有 ID 属性がバイナリー値または文字列値のどちらであるかを示すブール値。true
の値は、属性がバイナリー・タイプであることを示します。false
は、文字列タイプであることを示します。Group
オブジェクトのコレクション。
DynamicReferentialContainmentRelationship
オブジェクトの場合、現行のドキュメント・バージョンを表す Versionable
オブジェクトが常に先頭となります。
ReferentialContainmentRelationship
オブジェクトの場合は、任意の Containable
サブクラス (CustomObject
、Document
、または Folder
オブジェクト) を先頭にすることができます。この場合、先頭が Document
オブジェクトのときは特定のドキュメント・バージョンを表します。
Link
オブジェクトの場合、このプロパティーには IndependentObject
基本クラスのサブクラスとなる任意のオブジェクトを指定できます。
CmHoldable
インスタンスへの参照。
Document
タイプの場合、これはバージョン・シリーズではなく特定のバージョンを参照します。
ヒットとして強調表示されるフラグメントを表す、テキスト検索の結果の要約テキスト内でのオフセット。
VirtualServer
や ServerInstance
など) に Case History の処理が行われないようにできます。
CmHold
インスタンスへの参照。
このプロパティーの値は、同じホスト上で構成されたすべての Content Engine サーバー・インスタンスを識別しやすくするために使用されます。
HTTP デバイスが同じ企業ファイアウォール内にあり、自己署名証明書を使用している場合は、証明書の検証を無効にすることを検討してください。証明書の検証を無効にすると、テスト環境内でアプリケーション・サーバーのセットアップを簡略化するためにも役立ち、自己署名証明書をアプリケーション・サーバー JVM 上にインストールする必要がなくなります。
高可用性環境の場合、rmi://<node1Name>:<node1Port>/<ConfigurationServerName>, <node2Name>:<node2Port>/<ConfigurationServerName> と URL を入力します。
ISDomainName
プロパティーおよび ISOrganization
プロパティーから得られます。ISDomainName
プロパティーおよび ISOrganization
プロパティーから得られます。大半の場合、この値は "FileNet" になります。User
および Group
クラスの場合、Id プロパティーは、128 ビットの GUID でなくセキュリティー識別子 (SID) の値を取ります。SID の文字列表現の形式は、次の例のようになります。S-1-5-21-1559522492-2815155736-3711640725-55269
。
IBM FileNet P8 のディレクトリー・サービスとして Active Directory を使用する場合、User.get_Id()
および Group.get_Id()
の呼び出しは常に、プリンシパルの現在の SID を返します。これはユーザーまたはグループが、Active Directory サーバーの履歴 SID を持つ場合も同様です。
あるプロパティー表現に対して、Id プロパティーには以下の特性があります。
PropertyDescription.get_Id()
は PropertyTemplate.get_Id()
と等価であり、これは PropertyDefinition.get_PrimaryId()
と等価です。PropertyDefinition.get_Id()
は PropertyDefinition.get_PrimaryId()
と等価ではありません。PropertyDefinition.get_Id()
は PropertyDescription.get_Id()
と等価ではありません。
新規に作成されたドキュメント・オブジェクトの場合は、そのドキュメントを初めて保存するかチェックインする前に、それに関連付けられた VersionSeries
オブジェクトの Id プロパティーをオーバーライドすることができます。
IdList
オブジェクトを指定します。このコレクションには、当該クラス記述の値またはプロパティー説明の Id プロパティーの値、および割り当てられた別名 ID の値が含まれます。ThumbnailImageColor.COLOR
です。
ThumbnailImageFormat.JPEG
です。
ImageServicesClassDescriptionList
オブジェクトを指定します。このオブジェクトには、この FileNet Image Services 固定コンテンツ・デバイスに関連付けられている Image Services ドキュメント・クラス記述のコレクションが格納されています。ImageServicesPropertyDescriptionList
オブジェクトを指定します。このプロパティーには、IS サーバー上にある既存の IS ドキュメント・クラスに関連付けられている IS プロパティーが格納されます。また、このプロパティーは、統合ドキュメントのインポート時に IS ドキュメント・プロパティーを Content Engine プロパティーにマップする目的で、IS Import Agent により使用されます。ThumbnailImagesSize.SMALL
です。
ClassDefinitionSet
オブジェクトを指定します。ここには、この ClassDefinition
オブジェクトで定義されるクラスの直接のサブクラスであるクラスごとに ClassDefinition
オブジェクトが格納されています。ClassDescriptionSet
オブジェクトを指定します。ここには、この ClassDescription
オブジェクトで記述されるクラスの直接のサブクラスであるクラスごとに ClassDescription
オブジェクトが格納されています。com.filenet.engine.content.fcprovider.centera.CenteraFCP
com.filenet.engine.content.fcprovider.is.ImageServicesFCP
com.filenet.engine.content.fcprovider.fsb.SnaplockFCP
com.filenet.engine.content.fcprovider.tsm.TsmFCP
true
) か使用できない (false
) かを指定します。IndexationId
プロパティーによって参照される IBM® Content Search Services 索引が含まれる索引領域を表す IndexArea
オブジェクト。
IndexArea
オブジェクト。CmIndexDefinitionList
コレクション・オブジェクト。
IndexJobItem
のサブクラスです。CmIndexDefinition
の場合、このプロパティーの値を設定するには、値は、基礎データベースによって索引名に適用されるすべての制約に準拠する必要があります。名前を指定しないと、サーバーが名前を生成します。
CMTextSearchIndex
オブジェクトの場合、このプロパティーの値は、この IBM Content Search Services 索引に割り当てられる名前です。
CmIndexParitionConstraint
オブジェクトのリスト。このリストは読み取り専用で、Content Engine サーバーによって維持されます。
これらの制約を満たす Content Engine オブジェクトのみが、パーティション化された IBM Content Search Services 索引に
追加されます。1 つの IBM Content Search Services 索引は、最大で日付索引パーティション制約と文字列索引パーティション制約を
それぞれ 1 つずつ保持できます。日付索引パーティション制約は、この索引のパーティション化に使用する日付範囲を
指定し、文字列索引パーティション制約は、この索引のパーティション化に使用する名前と値を指定します。
null
です。
このオブジェクトの文字列値プロパティーが CBR 対応の場合、サーバーはこのプロパティーを設定します。
オブジェクトのいずれかの文字列値プロパティーについてプロパティー定義の PropertyDefinitionString.IsCBREnabled
プロパティーを true
に設定すると、そのオブジェクトは CBR 対応と見なされます。
CmIndexedColumnList
コレクション・オブジェクト。CmIndexedColumn
オブジェクトがリスト内に出現する順序は、列が索引内で定義されている順序を反映します。リストには少なくとも 1 つのエレメントが必要です。
特定の索引のすべてのキー列の名前は、同じテーブル上の他のどの索引のキー列の名前とも異なっている必要があります。非キー・エレメントが索引定義のリスト内に出現する順序は重要ではないことに注意してください。しかし、IBM では、アプリケーションのリスト内で非キー・エレメントをキー定義エレメントの後に配置することをお勧めします。(キー列は、CREATE INDEX ステートメントの ON 節に表示される列です。非キー列は、CREATE INDEX ステートメントの INCLUDE 節 (またはそれと同等の節) に表示されます。)
CmTimeslot
オブジェクトのリストを
指定する CmTimeslotList
コレクション。これらのオブジェクトはそれぞれ、バックグラウンドの IBM® Content Search Engine Services 索引付け
タスクをスケジュールするために使用するタイム・スロットを表します。
各タイム・スロットは、(バックグラウンド・タスクを実行するサーバーを基準にした) ローカル開始時刻と曜日、および時間を指定します。
タイム・スロットのリストは、索引付けジョブのバックグラウンド・タスクの実行が許可される時期を制御します。これにより、管理者は、負荷の大きい索引付けのロードをオフピークの時間に行うようにスケジュールすることができます。
タイム・スロットを指定しない場合 (デフォルト)、索引付けジョブ・タスクは無制限に実行され、(指定された十分な索引付けジョブを) 連続して
実行できます。
IndexingOperation
定数。IndexingOperation プロパティーのユーザー設定可能な値は SKIP
のみです。それ以外の場合、このプロパティーは読み取り専用になります。
CBR 対応オブジェクトの索引付けをスキップするには、索引要求操作を SKIP
操作に変更します。IndexingOperation プロパティーを SKIP
に設定すると、Content Engine サーバーは、索引要求の CmIndexingFailureCode プロパティーを MARKED_AS_SKIPPED
に設定し、CBR 対応オブジェクトの IndexationId プロパティーを null
に設定します。
このプロパティーを SKIP
に設定できるのは、この索引要求の IndexRequestStatus プロパティーに NOT_STARTED
または IN_PROGRESS
の値がある場合のみです。
IndexingOperation プロパティーに使用できる値は次のとおりです。
CREATE
: 索引入力が作成されることを示します。UPDATE
: 既存の索引入力が更新入力に置き換えられることを示します。CBR 対応オブジェクトが変更されて null 以外の IndexationId プロパティー値がある場合、索引更新要求が生成されます。DELETE
: 索引入力が削除されることを示します。SKIP
: 索引要求がスキップされることを示します。Content Engine サーバーは、索引要求の CmIndexingFailureCode プロパティーを MARKED_AS_SKIPPED
に設定し、CBR 対応オブジェクトの IndexationId プロパティーを null
に設定します。この値は、ユーザーが設定可能な唯一の値です。NO_OP
: 内部だけで使用します。IndexingStatus
オブジェクト。
Content Engine サーバーは必要に応じて自動的に索引を別の IBM Content Search Services サーバーに再割り当てし、サーバーの索引付けワークロード・バランシングを実行します。IndexingStatus プロパティーに使用できる値は次のとおりです。NORMAL
: 索引が IBM Content Search Services サーバーに割り当てられ、再割り当てする必要はありません。REBALANCING
: 索引は、新しい IBM Content Search Services サーバーに再割り当てされている最中です。
索引がこの状態にある場合は、索引の ResourceStatus プロパティーの値を API により変更することはできません。再割り当てが完了すると、以下の索引のプロパティーが Content Engine サーバーにより変更されます。
NORMAL
に設定されます。REPLACING
: 索引が使用不可で、索引ジョブにより索引の ResourceStatus プロパティーが CLOSED
に設定されています。索引がこの状態にある場合は、索引の ResourceStatus プロパティーの値を API により変更することはできません。RESYNCHING
: 索引は、オブジェクト・ストア・データベース内のデータと再同期されています。索引付けの対象となるデータが索引と非同期状態になると、正しくない検索結果が生成されることがあります。この非同期状態が発生する可能性がある状況としてまず考えられるのは、索引がバックアップからリストアされる場合です。
再同期されている索引について、索引ジョブは、削除されたオブジェクト、別の索引に移動されたオブジェクト、または CBR 対応ではなくなったオブジェクトの索引入力を削除します。また、索引ジョブは、索引内で現在索引付けされていないオブジェクトの索引入力が必要な場合には、それらの索引入力を作成します。
-2、-3、およびそれより小さい値は、継承されない ACE (すなわち、PermissionSource
値が SOURCE_DIRECT
、SOURCE_DEFAULT
、
または SOURCE_TEMPLATE
) の場合のみ許可され、その InheritableDepth 値によって、
権限がセキュリティーの親オブジェクトそのものに影響するのを防ぐことができるため
便利です。例えば、権限によりユーザーに削除権が与えられていて、InheritableDepth 値が -2 の場合、
ユーザーは、その権限を継承したセキュリティーの子オブジェクトは削除できますが、セキュリティーの親
オブジェクトそのものは削除できません。
権限が継承された場合 (PermissionSource.SOURCE_PARENT
)、InheritableDepth 値は
常に 0、-1、1、または 1 より大きい他の正の値になり、この値が
-2、-3、または -3 より小さい他の負の値になることは絶対にありません。
継承可能レベルの値の詳細については、「セキュリティーの継承」を参照してください。
[<タスク名>(<コンテキスト>)]
ここで
タスク名は、名前でバックグラウンド・タスクの機能を識別します。この機能には複製、CFS インポート、特定タイプのスイープ・ポリシー、スイープ・ジョブ、またはキュー・スイープなどがあります。
コンテキストは、このタスク・タイプに適用できるコンテキスト情報を指定します。コンテキスト情報には、タスクにより処理されるターゲット・ソース・リポジトリーやターゲット・クラスなどがあります。 値がこのプロパティーの最大長を超えた場合、コンテキスト部分の文字列が切り捨てられます。
ContentConfiguration
クラスでこのプロパティーを設定するほかに、Content Platform Engine クライアント・アプリケーションでも JVM 引数 FileNet.Content.GetBlockSizeKB を設定する必要があります。デフォルトでは、この JVM 引数は 1 MB に設定されます。許可される最大値は 10 MB です。サーバーが適用する制限 (InlineContentRetrievalLimit プロパティーによって設定される値) が優先されるため、JVM 引数を InlineContentRetrievalLimit プロパティーの値よりも大きい値に設定した場合、JVM 値は無視されます。
null
になります。AddOn
を示します。NULL の場合、このオブジェクトはシステムまたは外部アプリケーションによって作成されました。
CmSweep
オブジェクトのプロパティー設定は、CmSweepConfiguration
グローバル・オブジェクトのプロパティー設定をオーバーライドします。CmSweep
オブジェクトのプロパティーが null に設定されていると、CmSweepConfiguration
オブジェクトの InterBatchDelay 設定が使用されます。
クラスの場合は、以下の条件が適用されます。
true
に設定する必要があります。true
に設定した場合、クラスに関連付けられた任意のコンテンツの全文索引処理も有効になります(CBR を有効にする、コンテンツ・プロパティーはありません)。プロパティーの場合、このプロパティーは、Document
、Annotation
、CustomObject
、および Folder
の各オブジェクトに対してのみ有効にできます。
true
) 否か (false
) を指定します。現行バージョンは、メジャー・バージョンでもマイナー・バージョンでもかまいません。true
) 扱わないか (false
) を指定します。このプロパティーは、アプリケーションが表示またはレンダリングするときにこの DateTime プロパティーを日付のみのプロパティーとして扱うことを示すヒントとして使用します。Content Engine サーバーと Content Engine API はいずれも、保管または取得された datetime 値をこのプロパティー設定に基づいて変更しないことに注意してください。このプロパティーを無視するアプリケーションとの相互運用性を最適化するには、時刻コンポーネントを UTC の午後 0 時に設定してください。以下のコード・フラグメントは、
Date now = new Date();
System.out.println("now " + now);
Calendar cal = new GregorianCalendar(new SimpleTimeZone(0, "UTC"));
cal.setTime(now);
cal.set(Calendar.HOUR_OF_DAY, 12);
cal.set(Calendar.MINUTE, 0);
cal.set(Calendar.SECOND, 0);
cal.set(Calendar.MILLISECOND, 0);
System.out.println(" " + cal.getTime());
EventAction
オブジェクトの IsEnabled
プロパティーを false
(オフ) または true
(オン) に設定すれば、アクティブなイベントを一括して無効または有効にすることができます。同様に、サブスクリプション、セキュリティー・テンプレート、監査定義、監査廃棄ポリシー、変更プリプロセッサー定義、変更プリプロセッサー・アクション、およびスイープについても、有効と無効を切り替えることができます。プロパティーのデフォルトは true です。
セキュリティー・テンプレートを有効にするとは、セキュリティー・テンプレートをオブジェクトに適用できることを示しています。無効になっているセキュリティー・テンプレートは、そのセキュリティー・ポリシー・コンテナーの一部のまま残りますが、オブジェクトに適用することはできません。セキュリティー・ポリシーを構成しているセキュリティー・テンプレートをテストしている場合や作成している場合は、セキュリティー・テンプレートを無効にしておくと便利です。
サブスクリプションを無効にすると、イベントに関連付けられているコード・ハンドラーは読み込まれず、実行されません。サブスクリプションを無効にする場合としては、ビジネス・プロセスでの変更のために変更を受けた場合や、統合ドキュメントに対してコード・プロシージャーを実行しない場合などがあります。EventAction
を無効にすると、それに関連付けられたサブスクリプションもすべて無効になります。ただし、ある特定の Subscription
を無効にした場合は、そのサブスクライブ済みイベント・リストに登録されているイベントのみが無効になります。
変更プリプロセッサー・アクションを無効にすると、システム全体に影響します。この場合、変更プリプロセッサー・アクションを参照するすべてのクラス定義について、コード・ハンドラーを実行できなくなります。 一方、変更プリプロセッサー定義を無効にすると、クラス単位で影響します。この場合、対象となるクラス定義と、変更されたプロパティー値が伝搬されるすべてのサブクラス定義についてのみ、コード・ハンドラーを実行できなくなります。
true
) 否か (false
) を指定します。ドキュメントのバージョンがフリーズである場合は、そのカスタム・プロパティーを変更できません。ただし、そのドキュメントのその他のバージョンのカスタム・プロパティーを変更することは可能です (その他のバージョンはフリーズでないことが前提)。ドキュメントのシステム・プロパティーが変更可能かどうかは、ドキュメント・バージョンのフリーズ状況には影響されません。true
) 否か (false
) を示します。非階層マーキング・セットには 1 つ以上のマーキングが含まれており、それぞれのマーキングは互いに独立しています。階層型のマーキング・セットでは、そのマーキングに対する優先順位がセット内の順序で決まります。このマーキングは、単一分岐の単純な階層に配列されます。アクセス権の評価はこの優先順位に基づいて行われます。各マーキングには上位マーキング (同一セット内にある必要あり) がありますが、最上位マーキングは例外です (その上位は null
)。階層マーキング・セットのマーキングによって、一連のセキュリティー・プリンシパルにアクセス権が明示的に付与されます。また、このマーキングでは、階層内の下位にあるすべてのマーキングに対して、暗黙的に同じ権限が付与されます。
false
の場合、エージェントは実行されません。この値が true
の場合、エージェントは実行されますが、ディスパッチャーのサブコンポーネントも有効化されていないと、インポーター全体としてはインポート要求を処理しないことがあります。詳細については、CFSImportAgentConfiguration
インターフェースの DispatcherEnabled プロパティーを参照してください。
インポーターのサブコンポーネントの説明については、CFSImportAgentConfiguration
インターフェースを参照してください。
true
) 否か (false
) を指定します。ドキュメントが例外状態にある限り、そのライフ・サイクル状態を昇格することも降格することもできません。例外状態からドキュメントを解除するには、その changeState
メソッドを呼び出して、LifecycleChangeFlags
パラメーターを CLEAR_EXCEPTION
に設定する必要があります。true
) 否か (false
) を指定します。
このプロパティーを true
に設定する場合は、この索引ジョブに属するすべての IndexJobItem
オブジェクトの
タイプは IndexJobCollectionItem
(Verity コレクション用) でなければなりません。
true
) 否か (false
) を指定します。指定の名前プロパティーを持つオブジェクト (そのいずれかのプロパティーの IsNameProperty プロパティーが設定されているか、オブジェクトのクラス記述の NamePropertyIndex プロパティーが設定されている) には、その Name プロパティーに割り当てられている指定の名前プロパティーの値があります。オブジェクトが保持できるのは、指定の名前プロパティー 1 つのみです。true
) 否か (false
) を指定します。このプロパティーが false
の場合、オブジェクトの状態を保存できるのはサーバーのみになります。true
) 否か (false
) を指定します。IsReadOnly
が true
の場合、プロパティーの値を変更できるのはサーバーのみになります。HandlerCallContext
クラスで getReadProtectedProperty
メソッドを使用すると、バイナリー値の読み取り保護プロパティーの値を表す Property
オブジェクトが返されます。
Document
オブジェクトの場合は、当該バージョンの次のバージョンをチェックインする権限をユーザーが予約するか (true
) しないか (false
) を指定します。VersionSeries
オブジェクトの場合は、当該バージョン・シリーズの現行バージョンをチェックアウトするか (true
) しないか (false
) を指定します。true
) 無効にするか (false
) を指定します。
セキュリティー保護を他に依存するオブジェクトでは親オブジェクトからセキュリティーを継承しますが、独立してセキュリティー保護ができるオブジェクトでは、独自の ACL (アクセス制御リスト) でセキュリティーが指定されていて、ユーザーがオブジェクトへのアクセスを試行するたびにアクセス権が確認されます。一例として、Document
オブジェクトは、それに依存する ContentElement
オブジェクトに対してセキュリティー上の親になります。このプロパティーの値は、あるオブジェクトのセキュリティー機能を (Document
の場合と同様に) 独立して設定可能な場合は true
であり、オブジェクトのセキュリティー機能が (ContentElement
の場合と同様に) セキュリティー上の親から継承される場合は false
になります。
Subscription
ベースのオブジェクト (ClassSubscription
、ClassWorkflowSubscription
、InstanceSubscription
、InstanceWorkflowSubscription
) に対してイベント・プロシージャー・コードを実行するメソッドです。イベント・プロシージャーを同期させて実行するには、このプロパティーを true
に設定します。イベント・プロシージャーを非同期で (バックグラウンドで) 実行するには、このプロパティーを false
に設定します。
デフォルトは false
です。Subscription
ベースのオブジェクトを作成する場合は、このプロパティーを指定してください。非同期のイベント・プロシージャーを起動すると、別の実行スレッドでアクションが実行されるため、アクションの結果を待たずにサブスクリプション・プロセッサーの動作を継続できます。Content Engine は、待機中のその他の非同期操作の後で、QueueItem テーブルにイベントを挿入し、リソースが不足していない限り、そのイベントを実行します。通常は即座に実行されますが、キューで待機中の非同期のイベントまたは操作 (セキュリティー伝搬や XML 分類など) が他に多数存在すると、遅延が生じることがあります。ご使用のアプリケーションが、実行中の特定の非同期イベント・プロシージャーに依存する場合は、最初に対象のイベントの状況をアプリケーションでテストして、イベントの完了を確認してください。
非同期のイベント・アクションに障害が発生すると、サーバーに例外が返されます。イベント・アクションのトランザクションはロールバックされますが、起点となるアクティビティーのトランザクションは実行されます。
複数の Content Engine サーバー・インスタンスが存在するドメインの場合、そのドメイン内のどのサーバーもキューに入っている非同期イベントを処理することができ、非同期イベントを生成したサーバーに限定されません。
同期イベント・プロシージャーを起動すると、イベント・アクションを実行する呼び出しにより、サブスクリプション・プロセッサーによる処理は、アクションが完了するまで阻止されます。アクションは、対象オブジェクトに対する元のアクティビティーと同一のトランザクションで処理されます。アクションに障害が発生すると、クライアントに例外が返されます。トランザクションが 1 つロールバックされます。このため、イベント・アクションの他に元のアクティビティーにも障害が発生します。
ワークフロー・サブスクリプションのイベントは、Content Engine 上で必ず非同期で起動されるため、ワークフロー・サブスクリプションの場合、このプロパティーは値が false
の読み取り専用プロパティーになります。
IsSystemGenerated
を true にすると、記述されているプロパティーにはシステム情報 (DateCreated
など) が提供されるか、メソッド呼び出しなどの操作の結果に従ってサーバーにより値が指定されます (例えば、フォルダーの CreateSubFolder
メソッドを呼び出すと、SubFolders
プロパティーによって返される一連のオブジェクトに対して、新規に作成されたフォルダーがシステムにより自動的に追加されます)。CmThumbnail
の場合は、サムネール・イメージがシステムにより自動的に生成されたかどうかを示します。
イメージがユーザーによって生成された場合、つまり、Content Engine ではなくサード・パーティー・アプリケーションにより生成されると、システムはイメージを別のイメージで上書きすることはできません。
ただし、クライアント・アプリケーションは CmThumbnail
オブジェクトを取得して、イメージがシステム生成またはユーザー生成されたかどうかにかかわらず既存のイメージを上書きできます。
CmIndexDefinition
オブジェクトの場合は、オブジェクトがシステム所有である (このプロパティーの値が true である) と、オブジェクトを変更または削除できません。
true
) 否か (false
) を指定します。同じオブジェクト・ストア (ObjectStore プロパティーに設定されています) に複数のアイソレート・リージョンが関連付けられている場合、それらのアイソレート・リージョンはオブジェクト・ストアと同じデータベース接続を共有します。 同じデータベース・スキーマ名を使用した同じデータベースのアイソレート・リージョン間をサーバーが区別するには、このプロパティーを各アイソレート・リージョンの固有値に設定する必要があります。
アイソレート・リージョンが、同じデータベース・スキーマ名を使用したその他のアイソレート・リージョンとデータベース接続を共有しない場合、固有値は不要です。
IsolatedRegion
オブジェクトのコレクションを表します。
ObjectStore
の場合、このプロパティーは非推奨です。
ObjectStore
の場合、このプロパティーは非推奨です。
true
) 否か (false
) を指定します。
このプロパティーを true
に設定すると、索引ジョブの JobStatus プロパティーが IndexJobStatus.PAUSED
に
設定されます。true を設定しなかった場合、この索引ジョブは処理中であり、このジョブの JobStatus プロパティーは IndexJobStatus.IN_PROGRESS
に
設定されます。
DYNAMIC_LABEL_CR
というタイプのコンポーネント関係でバインドされるかどうかを判別します。それ以外のコンポーネント関係タイプでは、このプロパティーの値が null
になります。詳細については、「ComponentRelationshipType」プロパティーを参照してください。IndexJob
および CmIndexRequest
オブジェクトの場合は、このプロパティーにより、索引ジョブの最終失敗条件が識別されます。
ReplicationJournalEntry
オブジェクトの場合、このプロパティーには、このジャーナル・エントリーを生成する複製操作についての最新の失敗条件 (存在する場合) が記述されます。
CmThumbnailRequest
オブジェクトの場合は、このプロパティーにより、ドキュメントのサムネール生成が失敗した理由が示されます。
CmBackgroundSearch
オブジェクトの場合、このプロパティーには、このジャーナル・エントリーを生成するバックグラウンド検索操作についての最新の失敗条件 (存在する場合) が記述されます。
CmTask
オブジェクトの場合は、このプロパティーにより、オブジェクトが例外状態に設定された理由が示されます。
このプロパティーは、SET_EXCEPTION
changeState トランザクション内でのみ設定できます。次に例を示します。
CmTask.changeState(SET_EXCEPTION);
CmTask.set_LastFailureReason ( "Required document was not attached to workflow.");
CmTask.save();
LastFailureReason を NULL 値にリセットするには、CmTask.changeState(CLEAR_EXCEPTION)
を実行して例外をクリアします。
大半のユーザーにとって、このプロパティーの設定は読み取り専用です。書き込みアクセス権限 (AccessRight.PRIVILEGED_WRITE
) が与えられているユーザーの場合は、このプロパティーの読み取り/書き込みが可能です。(これらのユーザーに対する読み取り/書き込み権限を変更できるのは、オブジェクト・ストア上の ACL を変更した場合のみです。この ACL は、オブジェクト・ストア内のオブジェクトに対する書き込みアクセス権限を持つユーザーを制御します。)
CmAuditSequence
プロパティーを
取得し、その値を LastProcessed
プロパティーに設定する必要があります。
バッチが別のワーカーに割り当てられるまでに、ワーカーがそのバッチを処理することができる最大の間隔 (秒単位)。マルチサーバー調整に使用されるこの間隔により、 前にバッチに割り当てられたワーカーが異常終了した場合でも、バッチの実行が妨げられることはありません。
VerityServerConfiguration
の場合、このプロパティーは非推奨です。
UserContext
のロケール固有操作、ならびに Web サービス SOAP トランスポートの WSDL 定義ロケールの両方に適用されます。lock
メソッドを正常に呼び出した結果としてデータが取り込まれます。このプロパティーの値は、ロックのユーザーを決定する上では実質的な影響を持たない単なるカスタム文字列です。このプロパティーにより指定されるオーナーは、Content Engine に認識されているユーザーまたはグループと照合されることはありません。このプロパティーは、unlock
メソッドが呼び出されると null
に設定されます。ロックが自然に期限切れになった場合は、値はそのまま変更されません。lock
メソッドを正常に呼び出した結果として取り込まれます。ただし、updateLock
を呼び出せば値を更新できます。このプロパティーの値は、オブジェクトの DateLastModified プロパティー内の値を超えて、ロックのユーザーがオブジェクトのロックを維持できる秒数です。計算の結果は、現在のシステム時刻を基準に測定されます。オブジェクトの DateLastModified プロパティーと LockTimeout プロパティーの値の合計が、現行のシステム時刻よりも前の時刻である場合は、ロックは有効期限切れと見なされます。(ミリ秒の桁の数は計算に入れません。)このプロパティーは、unlock
メソッドが呼び出されると null
に設定されます。ロックが自然に期限切れになった場合は、値はそのまま変更されません。unlock
によって) 解除されると、LockToken
の値は null
に設定されます。(ロックが自然に期限切れになった場合、値はそのまま変更されません。)ReplicationDirection
定数。
このマッピング方向は、受信、送信、または送受信です。
ActiveMarking
オブジェクトに対して get_Marking()
を呼び出すと、このオブジェクト値プロパティーが返されます。MarkingSet
は、特定のマーキング対応プロパティーに使用可能なすべての値を保持するコンテナーです。マーキング・セット内の各 Marking
オブジェクトは、そのプロパティーの別の値を表します。PropertyDefinitionString
、PropertyTemplateString
、または PropertyDescriptionString
インターフェースで get_MarkingSet()
メソッドを呼び出せば、文字列値プロパティーのマーキング・セットを取得できます。
MarkingSet
オブジェクトのコレクションを指定します。
MarkingUseGranted プロパティーの主な用途は、現在のユーザーに「使用」権限があるかどうかを検出することです。「使用」権限により、オブジェクトにマーキングが存在するためにそのオブジェクトへのアクセスが制限されるかどうかが決まります。ユーザーがマーキングに対する「使用」権限を保持している場合は、関連の独立オブジェクトへのアクセスが Marking
オブジェクトの ConstraintMask プロパティーの値によって制約を受けることはありません。「使用」権限がないと、関連オブジェクトの有効なアクセス権計算値 (IndependentlyPersistableObject.getAccessAllowed()
メソッドにより返される値) から ConstraintMask プロパティーの値が引かれることになります。この場合は、マーキングの制約マスクによって、付与できない権限、および無視される権限が識別されます。これにより、関連の独立オブジェクトの ACL で付与されている該当の権限が実質的に削除されます。
MarkingSet
に関連付けられたプロパティーを持つオブジェクトに対して Marking
を適用する場合に使用する値を指定します。マーキングの値は、マーキング・セット内では固有である必要があります。Marking
オブジェクトのコレクションを持つ MarkingList
オブジェクトを保持します。VerityServerConfiguration
の場合、このプロパティーは非推奨です。
IndexArea.ResourceStatus
プロパティーはサーバーによって「クローズ」に設定され、この同じサイトとオブジェクト・ストアに対して、ResourceStatus
の値が「スタンバイ」になっていることが検出された最初の索引領域の ResourceStatus
値は、サーバーによって「オープン」に変更されます。メモリー内状態キャッシュは、サーバーごとに 1 つずつ存在します。状態キャッシュには、サーバーの 1 次コンテンツ・キャッシュ領域にあるコンテンツ・エレメントの状態情報が格納されており、状態情報を取得するためにサーバーが行う必要があるディスク・アクセスの回数を削減することにより、サーバーのパフォーマンスを改善できる可能性があります。例えば、キャッシュ・コンテンツ・エレメントの作成日時を保管することにより、以前に取得した情報が有効なまま維持されているかどうかをサーバーが判別できます (これにより、コンテンツ・エレメントの情報を再度取得する必要がなくなる可能性があります)。
この値と MaxWorkerThreads パラメーターとを組み合わせることにより、あるしきい値が設定されます。このしきい値を超えると、統合要求の追加バッチをメモリー内プリフェッチ・キューに挿入できなくなります。ワークのバッチはワーカー・スレッドにディスパッチされるため、キュー内のアイテム数は減少します。キュー内のバッチ数は、最終的にしきい値より低い値になり、データベース・キューからの新規バッチの追加が再開されます。
FULL
に設定されます。
このプロパティーの設定はオプションです。
-1 の値は、制限がないことを示します。
VerityServerConfiguration
の場合、このプロパティーは非推奨です。
FULL
に設定されます。このプロパティーの設定はオプションです。
-1 の値は、制限がないことを示します。
有効な時間制限は、このプロパティーと SQL Timelimit
オプションの最小値です。
SQL Timelimit
オプションが設定されていない場合、有効な時間制限は、このプロパティーと DefaultQueryTimeLimit プロパティーの最小値です。
Timelimit
オプションもプロパティーも設定されていない場合、照会時間は無制限です。
クライアント/サーバー間 RPC に影響を与える時間制限に加えて、データベース・レベルでの照会実行を制限する QueryDatabaseTimeout プロパティーを設定できます。
詳細については、『サーバー照会タイムアウトの動作』を参照してください。
1 つの索引ジョブの索引要求数に対する制限を維持すると、大規模な索引ジョブによってパフォーマンス上の問題が発生することを防止できます。この索引要求数の制限は、IndexRequests テーブル内に存在する索引ジョブの索引要求の数にのみ適用されます。これは、1 つの索引ジョブが作成できる索引要求の総数に対する制限ではありません。
デフォルト値は 100,000、最小値は 1000 です。未処理の索引要求数を制限しない場合は、このプロパティーを -1 に設定します。
FULL
に設定されます。このプロパティーの設定が必要です。
CmBackgroundSearch
オブジェクトの場合、このプロパティーは無視されます。
CFSImportAgentConfiguration
オブジェクトと CmThreadPoolConfiguration
オブジェクトに適用されます。
CFSImportAgentConfiguration
オブジェクトの場合、MaxWorkerThreads プロパティーは、インポート・エージェントで作成できるインポート・ワーカーの最大数です。このプロパティーの値を適切に設定することにより、Content Engine サーバーの使用不足または過剰使用を CFS インポーターの代わりに防止できます。CFS インポート・エージェントについては、「CFSImportAgentConfiguration
」インターフェースを参照してください。
CmThreadPoolConfiguration
オブジェクトの場合、MaxWorkerThreads プロパティーは、ワーカー・スレッド・プールでバックグラウンド・タスクを処理するときに割り振り可能なスレッドの最大数です。
1 つの CPE インスタンス当たりの同時バッチ数 = (プロパティー値 / 索引処理が有効になっている CPE インスタンス数)
この計算で、索引処理が有効になっている CPE インスタンス数 には、索引処理を有効にして構成されているすべての Content Platform Engine インスタンスが含まれます。 プロパティー値 は、MaximumConcurrentIndexingBatches プロパティーの値です。 例えば、プロパティー値を 12、索引処理が有効になっているインスタンス数を 2 とすると、1 つの Content Platform Engine インスタンス当たりの最大同時索引処理バッチ数は、12 / 2 = 6 となります。
この計算では、実行されていない Content Platform Engine インスタンスは考慮していません。 (例えば、インスタンスがシャットダウンされるなどの理由で) インスタンスのいずれかが実行を停止した場合、IBM Content Search Services サーバーは、構成されているよりも小さなキャパシティーで動作します。先の例では、Content Platform Engines インスタンスのいずれかが実行を停止した場合でも、残りのインスタンスは引き続き、最大で 6 つの同時バッチを送信します。その結果、サーバーは 50% のキャパシティーで動作することになります。 IBM Content Search Services サーバーがフルキャパシティーで実行され続けるようにする場合は、すぐに実行を再開しない可能性がある Content Platform Engine インスタンスの索引処理はすべて無効にします。
なお、このプロパティーは、CmTextSearchConfiguration
クラスの ThreadCount プロパティーと連携して、Content Platform Engine インスタンスの索引処理の作業負荷を制御します。
コンテンツ・キャッシュ領域の場合、新しいコンテンツをキャッシュに追加できるのは、コンテンツ・エレメント数の統計値 (ContentElementCount プロパティー) がこの最大値よりも小さい場合に限られます。(統計値の管理は原則として遅れることと、複数のサーバーがコンテンツを追加できることから、この最大値をわずかに超える場合があります。)このプロパティーの値は、1 以上にする必要があります。
コンテンツ変換ワーク・アイテムの内部キューの上限となる最大サイズを指定します。このサイズを超えると、新規アイテムの挿入がブロックされます。
コンテンツ変換アクティビティーに関わるバックグラウンド・ワーカーの最大数を指定します。
CmQueueSweep
の場合、キュー・スイープのデキュー操作の失敗後、この操作を再試行する最大回数。
このプロパティーをゼロに設定した場合、失敗の最大回数に制限はありません。
キュー・エントリー (CmAbstractQueueEntry
サブクラスによって表される) の QueueEntryStatus が FAILED
に設定された場合、スイープ・サービスはこのエントリーを処理対象として選択しなくなります。
キュー・スイープ・ハンドラーが処理の失敗を報告すると、スイープ・サービスはキュー・エントリーの FailureCount プロパティーを増分します。
新しい値が、スイープを制御している CmQueueSweep オブジェクトの現行の MaximumFailures プロパティー値以上になると、QueueEntryStatus プロパティーは FAILED
に設定されます。
キュー・スイープ・ハンドラーがエントリーの処理結果を SweepItemOutcome.FAILED_NO_RETRY
に設定した場合も、QueueEntryStatus プロパティーは FAILED
に設定されます。
FAILED
状態にあるキュー・エントリーの処理を再開するには、キュー・エントリーの FailureCount プロパティーをゼロにリセットします。
CmBackgroundSearch
の場合、CmBackgroundSearch
インスタンスが終了する前にスイープ・サービスで許容される失敗の最大回数。
このプロパティーをゼロに設定した場合、失敗の最大回数に制限はありません。
テキスト索引付けプリプロセッシング・ワーク・アイテムの内部キューの上限となる最大サイズを指定します。このサイズを超えると、新規アイテムの挿入がブロックされます。
テキスト索引付けプリプロセッシングに使用するワーカーの最大数を指定します。
コンテンツ・キャッシュ領域の場合、新しいコンテンツをキャッシュに追加できるのは、コンテンツ・エレメントのサイズの統計値 (ContentElementKBytes プロパティー) がこの最大値よりも小さい場合に限られます。(統計値の管理は原則として遅れることと、複数のサーバーがコンテンツを追加できることから、この最大値をわずかに超える場合があります。)このプロパティーの値は、1 以上にする必要があります。
定期的な除去は、最大存続時間の半分の時間間隔で行われます。例えば、最大存続時間を 2 週間と指定した場合、定期的な除去は週に 1 度行われます。この除去の目的は、期限切れファイルを適時に削除できるようにすることです。定期的な除去は、常に完全除去になります。完全除去の定義および除去処理の詳細については、「PruneAmount」プロパティーを参照してください。
重要: このプロパティーは Content Platform Engine サーバーでキャッシュされなくなりました。 これは、このプロパティーを取得するクライアント・アプリケーションのパフォーマンスに悪影響を与える可能性があります。 この潜在的な問題を軽減する、あるいは解決するには、MemberOfGroups プロパティーはキャッシュされなくなったを参照してください。
このプロパティーを使用すると、Content Engine サーバーでメモリーの過剰使用を防止するのに役立ちます。マージ・スコープ・キャッシュが作成され、クラスの記述がキャッシュ内に読み込まれると、そのクラスの名前は、マージされるオブジェクト・ストアの配列順序で検出されるクラスの最初のインスタンスにマップされます。例えば、オブジェクト・ストア A 内のクラスに、名前が X で、オブジェクト・ストア B 内の Y という名前のクラスと同じ GUID を持つクラスがあるとします。ここで、オブジェクト・ストア A とオブジェクト・ストア B をマージすると、マージ・スコープ・キャッシュ (A,B) のクラス名は X となり、マージ・スコープ・キャッシュ (B,A) のクラス名は Y となります。この例からわかるように、マージされるオブジェクト・ストアに多数の異なる順序を指定すると、過剰な数のマージ・スコープ・キャッシュが作成され、サーバーのメモリー容量を超える可能性があります。このプロパティーの値を設定することにより、メモリー内に置くことができるメタデータのマージ・スコープ・キャッシュの数を制限します。
Document
オブジェクトの場合、特定のドキュメント・バージョンの MimeType プロパティーは、そのバージョンが予約オブジェクトになっている間 (作成時やその後のチェックアウト時) に設定できます。ただし、ドキュメントの MimeType プロパティーの値は、明示的に再設定しない限り、ドキュメントをチェックインするたびに、システムによる割り当て値に戻ります。
Annotation
および CmThumbnail
オブジェクトの場合、このプロパティーは随時設定できます。
DocumentClassificationAction
オブジェクトの場合は、ドキュメントを自動的に分類できるように、ドキュメントに収容する必要があるコンテンツのタイプが MimeType プロパティーによって指定されます。このプロパティーは随時設定できます。
ドキュメントまたはアノテーションに付属する各コンテンツ・エレメントには、独自の MIME タイプがあります。この MIME タイプは、その ContentType プロパティーで指定します。ドキュメントまたはアノテーションに対して MimeType プロパティーを指定しないと、MimeType プロパティーは、1 番目のコンテンツ・エレメントが ContentTransfer
オブジェクトまたは ContentReference
オブジェクトのいずれであるかどうかに関係なく、Content Platform Engine により自動的に、1 番目のコンテンツ・エレメントに設定されます。
Content Platform Engine はこのプロパティーの値の形式を強制しませんが、MIME 形式の文字列は、コンテンツ・タイプ、コンテンツ・サブタイプ、およびオプションのパラメーターで構成され、「content type/subtype[;parameter]」という形式 (例: 「text/html」) になります。
MIME では、次のコンテンツ・タイプが定義されます。
次の MIME タイプは FileNet 固有です。
ContentReference
コンテンツ・エレメントを持つオブジェクトContentReference
コンテンツ・エレメントのみを持つオブジェクトcom.filenet.api.constants
パッケージの AccessRight
クラスを使用します。次の操作を実行できます。ModificationAccessRequired
プロパティーの値を設定するset_ModificationAccessRequired
を呼び出して、その値を変更するClassDefinition
オブジェクト上でその値を変更するインポート・エージェントが、キューに入れられたインポート要求をワーカー・スレッドに割り当てると、 ワーカー・スレッドは要求のリースを獲得します。リースとは、ワーカー・スレッドが そのワークを完了するために、インポート・ディスパッチャーによってワーカー・スレッドに配分される秒数です。ワークが 完了する前に期限が切れた場合、ディスパッチャーは、要求を別のスレッドに 割り当てることができます。移動操作は非常に時間がかかるため、配分された秒数を 超える可能性があります。移動操作を試行する前に、ワーカー・スレッドはリースの 残り時間を判定し、その値と MoveContentLeaseThreshold プロパティー値を 比較します。時間が MoveContentLeaseThreshold の値より長い場合、ワーカー・スレッドはワークの実行を続行します。 残り時間が MoveContentLeaseThreshold の値より短い場合、ワーカー・スレッドは リースを解放し、インポート・ディスパッチャーが要求を別のスレッドに再割り当て できるようにします。
警告: サポート担当者の指示なしに、このプロパティー値を変更しないでください。不用意に値を変更すると、システム・パフォーマンスが低下するおそれがあります。
ほとんどのクラスでは、このプロパティーは読み取り専用であり、そのオブジェクトの指定済みの名前プロパティーの値が返されます。名前プロパティーが存在しない場合はオブジェクトの ID が返されます。ClassDescription.NamePropertyIndex
に値がある場合、このプロパティーには指定の名前プロパティーの値が入ります。指定の名前プロパティーに値が存在せず、オブジェクトに Id プロパティーがある場合、このプロパティーには Id プロパティーの文字列値が入ります。これらのいずれの条件も満たさない場合、このプロパティーには空の文字列が入ります。
ComponentRelationship
オブジェクトの場合、このプロパティーは読み取り/書き込みが可能で、オブジェクトの名前を指定します。
ClassDescription
オブジェクトの PropertyDescriptions
コレクションにある PropertyDescription
オブジェクトの 0 ベースの索引を指定します。このコレクションは、クラスのオブジェクト・インスタンスの名前プロパティーとして機能します。NamePropertyIndex
が null
である場合、そのクラスに指定の名前プロパティーは入りません。この場合、クラスのオブジェクト・インスタンス化の Name プロパティーは、その Id プロパティーの値に設定されます。CenteraFixedContentDevice
オブジェクトによって防止するか (true) しないか (false) を示します。true の場合、プロバイダーによるクリップまたは BLOB の削除は試行されず、すべてのコンテンツがまったくそのままの状態で Centera デバイス上に残ります。通常、この設定は保存期間の適用には影響しません (ストレージ域では保存期間が順守され、削除は適宜阻止されます)。null
になります。このキャッシュについて詳しくは、「セキュリティーのキャッシング」を参照してください。
このキャッシュについて詳しくは、「セキュリティーのキャッシング」を参照してください。
ORIGINAL_AND_MODIFIED_OBJECTS
(元のイベント前オブジェクトと変更されたイベント後のオブジェクトの両方が記録されます)、MODIFIED_OBJECT
(変更されたイベント後のオブジェクトのみ記録されます)、および NONE
(ソース・オブジェクトは記録されません) があります。MODIFIED_OBJECT
を設定すると、イベントの OriginalObject プロパティーは null になります。NONE
を指定すると、イベントの OriginalObject プロパティーと SourceObject プロパティーは null になり、イベントの ModifiedProperties プロパティーは空になります。注: データベース内に監査済みソース・オブジェクトを保持すると、ラージ・オブジェクト (LOB) 格納域がかなり消費される可能性があります。
ObjectStoreParticipant
の場合は、複製グループのこのオブジェクト・ストア参加者のオブジェクト・ストア。
IsolatedRegion
の場合は、アイソレート・リージョンに関連付けられているオブジェクト・ストア。
このプロパティーを設定すると、サーバーは DatabaseConnection プロパティーおよび DatabaseSchemaName プロパティーを、それらのプロパティーが以前に別の値に設定されていても、オブジェクト・ストアにある同じ名前のプロパティーと同じ値に自動的に設定します。このプロパティーは、いったん設定すると変更できません。
アイソレート・リージョンが IBM Case Manager で使用されている場合は、ObjectStore プロパティーを設定する必要があります。
提供されたデフォルトのスキーマ・スクリプトをカスタマイズし、Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)
メソッドの呼び出し時にカスタマイズしたスクリプトを送信できます。デフォルトのスクリプトに対する典型的な変更には、さまざまなテーブル、索引、ラージ・オブジェクト (LOB) 列の、異なるテーブル・スペース間への配布が含まれます。詳細については、『カスタム・スキーマ・スクリプトの使用』を参照してください。
提供されたデフォルトのスキーマ・スクリプトをカスタマイズし、Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)
メソッドの呼び出し時にカスタマイズしたスクリプトを送信できます。デフォルトのスクリプトに対する典型的な変更には、さまざまなテーブル、索引、ラージ・オブジェクト (LOB) 列の、異なるテーブル・スペース間への配布が含まれます。詳細については、『カスタム・スキーマ・スクリプトの使用』を参照してください。
提供されたデフォルトのスキーマ・スクリプトをカスタマイズし、Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)
メソッドの呼び出し時にカスタマイズしたスクリプトを送信できます。デフォルトのスクリプトに対する典型的な変更には、さまざまなテーブル、索引、ラージ・オブジェクト (LOB) 列の、異なるテーブル・スペース間への配布が含まれます。詳細については、『カスタム・スキーマ・スクリプトの使用』を参照してください。
ObjectStore
オブジェクトのコレクションを表します。
https://dal05.objectstorage.softlayer.net/auth/v1.0/
。
VerityServerConfiguration
の場合、このプロパティーは非推奨です。
true
) 含まれないか (false
) を指定します。このプロパティーは、最適なパフォーマンスを得るためにバックグラウンド検索を調整する方法を提供します。GROUP BY 節のプロパティーによって順序付けすると、データベース操作の数が減少することにより、検索パフォーマンスが向上する場合があります。逆に、検索の詳細、および検索対象のテーブルに追加される索引の数によっては、パフォーマンスが低下する場合もあります。デフォルト値は true
です。
get_SourceObject
を使用します。ソース・オブジェクトの 2 つの状態を比較するには、get_OriginalObject
および get_SourceObject
によって返されるオブジェクトのプロパティーをフェッチします。CmRecoveryItem
の場合は、削除用のマークが付けられた元のオブジェクト。
元のオブジェクトを取得するには、ユーザーがオブジェクト・ストアに対する VIEW_RECOVERABLE_OBJECTS
アクセス権を持っている必要があります。
このコレクション内で索引処理されたオブジェクトの場合は、GUID に序数をマップしてこの序数を示すために、そのオブジェクトの GUID に対して算術関数が実行されます (オブジェクトが置かれているコレクション)。
true
) か使用できない (false
) かを指定します。AppenderNames
プロパティーの値が FileAppender
クラスまたはサブクラスである場合にのみ使用されます)。指定しなかった場合や null を指定した場合、このプロパティーのデフォルト値は、アプリケーション・サーバー・インスタンスの作業ディレクトリー・パスの末尾に "/FileNet" が追加されたものになります。トレース・ログのファイル名は常に "p8_server_trace.log" になり、使用される log4j レイアウト・パターンは "%d %5p [%t] - %m%n" になります。注: log4j では処理中にディレクトリーが作成されるため、このプロパティーの非ヌル値に対して行われる検証は、場所が有効なディレクトリー内にあるかどうかのみです。
Document
オブジェクトへの参照が含まれます。このドキュメントがパブリッシュされたドキュメントであり、ソースとのカスケードの削除関係がある場合、このプロパティーはパブリッシュされたドキュメントのソース・ドキュメントを指定します。 (OwnerDocument
プロパティーと PublicationSource
プロパティーは同じドキュメントを参照します)。 PEConnectionPoint
インスタンス) を収容している PEConnectionPointSet
オブジェクト。Folder
オブジェクト。Document
オブジェクト。この親 Document
オブジェクトでの CompoundDocumentState プロパティーの設定は、COMPOUND_DOCUMENT
にする必要があります。また、ドキュメントのリンク権限 (AccessRight.LINK
) も必要です。Document
オブジェクトを持つ DocumentSet
コレクション・オブジェクト。コレクションに収容されるのは、ユーザーが読み取り権限を持つ親ドキュメントのみです。このドキュメントを子コンポーネント・ドキュメントとして参照する ComponentRelationship
オブジェクトごとに、コレクションは親コンポーネント・ドキュメントを収容します。コレクションには、同じ親ドキュメントが複数存在してもかまいません。ComponentRelationship
オブジェクトを持つ ComponentRelationshipSet
コレクション・オブジェクト。コレクションに収容されるのは、ユーザーが読み取り権限を持つ親関係オブジェクトのみです。CmIndexPartitionConstraintDate
オブジェクトの StartDate プロパティーおよび EndDate プロパティーの値が決まります。
CmIndexPartitionConstraint
オブジェクトの
場合、IBM® Content Search Services 索引のパーティション制約として機能するように、オブジェクト・ストア内で割り当てられる CBR 対応のオブジェクト・
プロパティーの名前。
このプロパティーは読み取り専用であり、索引の作成時に Content Engine サーバーによって割り当てられます。
CmTextSearchPartitionProperty
オブジェクトの場合、IBM Content Search Services の索引パーティション化プロパティーとして
機能するように、オブジェクト・ストア内で割り当てられる CBR 対応のオブジェクト・プロパティーの名前。
この読み取り/書き込みプロパティーは、
カスタムの文字列値プロパティーまたは日付値プロパティーでなければならず、SETTABLE_ONLY_ON_CREATE
が設定可能でなければなりません。
1 つのオブジェクト・ストアに文字列と
日付の索引パーティション化プロパティーをそれぞれ複数割り当てることはできません。
CmTextSearchPartitionProperty
オブジェクトのリスト。このリストは、最大で、1 つの CmTextSearchPartitionDateProperty
オブジェクト
(カスタムの日付値索引パーティション制約プロパティーを表すオブジェクト) と 1 つの
CmTextSearchPartitionStringProperty
オブジェクト (カスタムの
文字列値索引パーティション制約プロパティーを表すオブジェクト) を含むことができます。両方のプロパティーが、SETTABLE_ONLY_ON_CREATE
を設定可能でなければなりません。
アクセス権の出所は、次のいずれかになります。
有効なタイプは、単一 (すなわち、単一のアクセス権)、レベル (アクセス権のよく使用される組み合わせ)、デフォルトのレベル (すなわち、新しい権限の推奨レベル)、および継承 (権限により記述される親オブジェクトの子オブジェクトに対してのみ該当) です。
PropertyPersistence
定数を指定します。プロパティーを永続化できる場合、データベース内に専用の列または専用のテーブルが必要です。PersistenceType プロパティーには、次の表のいずれかの値が入ります。
名前 | 値 | 説明 |
---|---|---|
NOT_PERSISTENT |
0 | プロパティーを永続化できないことを指定します。プロパティーが NOT_PERSISTENT として定義され、デフォルト値を持ち、プロパティー・テンプレートの Settability プロパティーが PropertySettability.READ_ONLY であれば、プロパティーは定数と見なされ、プロパティーの任意のインスタンスに対して常にデフォルト値が返されます。 |
OWN_COLUMN |
1 | このプロパティーにはデータベース内に専用の列があるため、永続化できることを指定します。 |
OWN_TABLE |
2 | このプロパティーにはデータベース内に専用のテーブルがあるため、永続化できることを指定します。この設定は、複数値スカラー (非オブジェクト) プロパティーにのみ適用され、サーバーがプロパティーの値をカスタム・テーブルに格納するようにします。このテーブルは、プロパティー・テンプレートをプロパティー定義としてクラス定義に最初に割り当てるときに、サーバーによって生成されます。このテーブルの名前は、対応するプロパティーの名前から派生します。いったん作成すると、プロパティーが割り当てられているクラスに無関係に、同じテーブルがプロパティーの値の格納に使用されます。 |
FPPool
クラス・コンストラクターに渡される Centera プール・アドレスを指定します。このプール・アドレスが使用されるのは、このオブジェクトの Site プロパティーにより指定されるサイト内で Content Engine サーバーが実行されている場合です。CmTask
オブジェクトが完了したと見なされるために、このオブジェクトが満たす必要がある条件。
事後条件式はタスクのクラス定義内に (クラス定数プロパティーとして) 指定されます。
タスク・インスタンスに設定することはできません。
事後条件は、CmTask
オブジェクトが WORKING
状態にあるときに、CmTask
に対して changeState(LifecycleChangeFlags.PROMOTE)
が実行されると評価されます。
条件は SQL 述部として表現され、CmTask
オブジェクトそのもの、
またはオブジェクト値プロパティーによって CmTask
に関連付けられたオブジェクトに適用されます。
例えば、ClaimStatus
プロパティーが CLOSED
に設定されるまでは完了できない
クレーム処理タスクがあるとします。この場合の事後条件式は、ClaimStatus = 'CLOSED'
の
ようになります。
事後条件の構文の要件は、FilterExpression プロパティーと同じです。
CmTask
オブジェクトの処理を開始する準備が整ったと見なされるために、このオブジェクトが満たす必要がある条件。
前提条件式はタスクのクラス定義内に (クラス定数プロパティーとして) 指定されます。
タスク・インスタンスに設定することはできません。
前提条件は、CmTask
オブジェクトが WAITING_PRECONDITION
状態の際に、CmTask
の
changeState(LifecycleChangeFlags.PROMOTE)
が実行されると評価されます。
条件は SQL 述部として表現され、CmTask
オブジェクトそのもの、
またはオブジェクト値プロパティーによって CmTask
に関連付けられたオブジェクトに適用されます。
例えば、InputDocument
プロパティーがリリース済みドキュメント・バージョンに設定されるまで
処理を開始できないドキュメント承認タスクがあるとします。
この場合の前提条件式は、InputDocument SATISFIES (VersionStatus = 1)
のようになります。
前提条件の構文の要件は、FilterExpression プロパティーと同じです。
CmTaskRelationship
オブジェクトを作成すると、それが、このプロパティーに設定する
CmTask
オブジェクトの Successors
プロパティーに
反映されます。
CmTaskRelationship
オブジェクトの作成時、そのオブジェクトの SuccessorTask
プロパティーにこの CmTask
オブジェクトを設定すると、新規作成した
CmTaskRelationship
オブジェクトが列挙に追加されます。
OPEN
になっていることや、キャッシュの容量が限度に達していないなどの理由により) コンテンツが通常どおりキャッシュに格納された場合、主記憶領域に新規に追加されたコンテンツは、キャッシュ領域にも追加されます。テキスト索引付けプリプロセッシング・ワーカーが終了するまでに許容される最大アイドル時間 (秒) を指定します。
false
の場合、オブジェクトの元の直接権限は、適用されるセキュリティー・ポリシー・テンプレートまたはライフ・サイクル・ポリシーにより定義される権限に置き換えられます。オブジェクトのセキュリティー上の親から継承された権限は、維持されます。プロパティーの値が true
の場合、オブジェクトの元の直接権限は、その継承された権限と同様に維持されます。さまざまなクラスに存在するが、同じプロパティー・テンプレートから得られるプロパティー定義の PrimaryId プロパティー値は、すべて同じになります。同じプロパティー・テンプレートから複数のプロパティー定義を作成できることと、プロパティー定義の Id プロパティーはすべてのクラスのすべてのプロパティー定義に対して固有である必要があることから、プロパティー定義の PrimaryId プロパティーは、その Id プロパティーとは等しくなりません。あるプロパティー表現に対して、PrimaryId プロパティーには以下の特性があります。
PropertyDefinition.get_PrimaryId()
は PropertyTemplate.get_Id()
と等価であり、これは PropertyDescription.get_Id()
と等価です。PropertyDefinition.get_PrimaryId()
は PropertyDefinition.get_Id()
と等価ではありません。PropertyDefinition.get_Id()
は PropertyDescription.get_Id()
と等価ではありません。このキャッシュについて詳しくは、「セキュリティーのキャッシング」を参照してください。
このキャッシュについて詳しくは、「セキュリティーのキャッシング」を参照してください。
PropertySettability
定数を指定します。この定数は、アプリケーションに特権書き込み権限 (AccessRight.PRIVILEGED_WRITE
アクセス権) が付与されている場合、プロパティーを設定できるかどうかを示します。特権書き込み権限では、通常は読み取り専用である Creator、DateCreated、DateLastModified、LastModifier の各プロパティーを設定する潜在的な機能がアプリケーションに付与されます。Settability プロパティーでは、その他のすべてのユーザーを対象にプロパティーの設定可能性が引き続き示されます。PrivilegedSettability プロパティーには、次の表のいずれかの値が入ります。
名前 | 値 | 説明 |
---|---|---|
READ_ONLY |
3 | プロパティーが読み取り専用であることを示します。この値を設定できるのはサーバーのみです。 |
READ_WRITE |
0 | プロパティーが読み取り/書き込み可能であることを示します。この値は随時設定できます。 |
SETTABLE_ONLY_BEFORE_CHECKIN |
1 | プロパティーの値を設定できるのは、そのプロパティーが属しているオブジェクトをチェックインする前のみであることを示します。 |
SETTABLE_ONLY_ON_CREATE |
2 | プロパティーの値を設定できるのは、そのプロパティーが属するオブジェクトを作成したときのみであることを示します。オブジェクトを最初に保存すると、プロパティーの値は変更できなくなります。 |
VirtualServer
や ServerInstance
など) に Process Engine の処理が行われないようにできます。
バックグラウンド検索の場合は、検索の結果として生成された CmAbstractSearchResult
オブジェクトの数。
検索で SQL 集約関数および GROUP BY 節を使用しない場合、値は ExaminedObjectCount プロパティーと同じです。
そのケースでは、CmAbstractSearchResult
オブジェクトは、照会結果行の集約を反映します。
Action
ベースのオブジェクトの呼び出し時に実行されるアクション・ハンドラーを指定します。
ScriptText プロパティーで設定される JavaScript ハンドラーの場合は、このプロパティーを「Javascript」に設定します。
Java™ ハンドラーの場合は、実行する Java クラスの完全修飾名を指定します。
WorkflowEventAction
オブジェクトの場合、ProgId はシステム指定のハンドラー filenet.pe.ce.wfeventhandler.WorkflowEventActionHandler
に設定されている必要があります。
ClassDescription
オブジェクトで記述されるクラスのすべてのサブクラスに属しているプロパティー説明オブジェクトのコレクションを内蔵する PropertyDescriptionList
オブジェクトを指定します。PropertyDefinitionList
オブジェクトを指定します。PropertyDescriptionList
オブジェクトを指定します。ActiveMarking
インターフェースの get_PropertyDisplayName
を呼び出して、このプロパティーの値を取得します。戻り値は、あるオブジェクトのマーキング・プロパティーとして指定されているプロパティーの表示名に対応します。一例として、Document
オブジェクトに "foo" というプロパティーがあり、そのプロパティーがマーキング・プロパティーとして識別される場合は、ドキュメントのアクティブ・マーキング・インスタンスのリストに、"foo" プロパティーの表示名に対応するプロパティー表示名が示されます。ExternalPropertyDescription
オブジェクトの場合のみ、この文字列は固定で、外部プロパティー説明の属する外部クラス内で固有です。
PropertyDescriptionBinary
オブジェクトで記述されるプロパティーに割り当てることができるバイナリー値のリストを格納する BinaryList
オブジェクトを指定します。PropertyDescriptionBoolean
オブジェクトで記述されるプロパティーに割り当てることができるブール値のリストを格納する BooleanList
オブジェクトを指定します。PropertyDescriptionDateTime
オブジェクトで記述されるプロパティーに割り当てることができる DateTime 値のリストを格納する DateTimeList
オブジェクトを指定します。PropertyDescriptionFloat64
オブジェクトで記述されるプロパティーに割り当てることができる倍精度 (Float64) 値のリストを格納する Float64List
オブジェクトを指定します。PropertyDescriptionId
オブジェクトで記述されるプロパティーに割り当てることができる GUID 文字列値のリストを格納する IdList
オブジェクトを指定します。PropertyDescriptionInteger32
オブジェクトで記述されるプロパティーに割り当てることができる整数値のリストを格納する Integer32List
オブジェクトを指定します。PropertyDescriptionObject
オブジェクトで記述されるプロパティーに割り当てることができる一連の Content Engine オブジェクトを格納する DependentObjectList
オブジェクトを指定します。PropertyDescriptionString
オブジェクトで記述されるプロパティーに割り当てることができる文字列値のリストを格納する StringList
オブジェクトを指定します。PropertyTemplate
サブクラスのオブジェクト・インスタンス (PropertyTemplateBinary
など) を収容します。PropertyTemplateSet
オブジェクトを指定します。具体的には、除去アクションは、ファイル数の割り当て量とファイル・サイズの割り当て量の 2 つの除去割り当て量を計算することから始まります。これらの割り当て量は、各ディレクトリーに適用します。割り当て量の計算では、除去量のパーセンテージ (PruneAmount プロパティーにより指定)、除去のしきい値 (PruneThresholdContentElements プロパティーおよび PruneThresholdSizeKBytes プロパティーにより指定)、キャッシュ内にあるコンテンツの現在の量 (ContentElementCount and ContentElementKBytes プロパティーにより指示)、およびキャッシュ・ディレクトリーの数が考慮されます。具体的には、以下のとおりです。
例えば、ファイル数の割り当て量の場合は、除去アクションの開始時にキャッシュには 100,100 ファイルが入っており、除去のしきい値が 100,000 ファイル、除去パーセンテージが 5%、キャッシュのディレクトリー数が 529 であるとします。この場合、除去のターゲットは、100,000 - 5,000 (100,000 の 5%) = 95,000 になります。各ディレクトリーの割り当て量は、(100,100 - 95,000) / 529 (切り上げ) = 10 になります。ファイル・サイズの割り当て量も同様の方法で計算されます。
完全除去アクションは、初期除去と部分除去の 2 つのフェーズから構成されています。初期除去では、キャンセルされたファイルおよび有効期限切れファイルがすべて削除され、ディレクトリーごとに LRU (最長未使用時間) リストも生成されます。ディレクトリー内のすべてのファイルは、リスト内の前回使用時刻の昇順に置かれています。リストの先頭のファイルは、それ以外のファイルよりも過去にアクセスされています (言い換えると、最も古いファイルです)。部分除去では、古いファイルが LRU リストの順に処理されます。ファイルはキャッシュから随時取得できるため、ファイルの前回使用時刻は、LRU リストの生成時よりも後になっている可能性があります。このため、部分除去では、ファイルを削除する前に、ファイルの前回使用時刻を必ず検査します。前回使用時刻が LRU リスト作成時刻よりも後のファイルは、すべてスキップされます。部分除去では、この方式で LRU リストを下方向に進行し、ファイルが削除またはスキップされると、そのファイルをリストから除外します。
ディレクトリー内で削除された古いファイルおよび有効期限切れファイルは、そのディレクトリーの割り当て量に到達するまですべてカウントされますが、(有効期限切れファイルは、初期除去中にすべて削除されるため) 割り当て量で制御されるのは、部分除去中に削除された古いファイルの数のみです。完全除去では、除去割り当て量が初期除去の段階で達成されることがあります。その場合、完全除去の第 2 段階である部分除去は実行されません。さらに、除去の過程で除去割り当て量にいつ到達するかに関係なく、初期除去では、新しい LRU リストが必ず生成されます。
除去の概要や、除去処理時に削除されるファイルのカテゴリーの説明については、「ContentCacheArea」インターフェースを参照してください。
任意のディレクトリーに対して、必須の除去は完全除去でも部分除去でもかまいません (したがって、キャッシュ全体に対して、必須の除去は完全除去と部分除去の混合になることがあります)。LRU リストを生成する必要がある場合にのみ、完全除去が必須になります。具体的には、以下の状況では完全除去が必須になります。新しいキャッシュの最初の除去アクションであるため、LRU リストがまだ存在しない。LRU リストの有効期限が切れた (リストの存続時間が 1 日より長い)。前の除去アクションにより、LRU リストがすべて処理された。(部分除去では、LRU リストがすべて処理されても除去割り当て量が達成されない場合があることに注意してください。)
キャッシュ除去の概要については、「ContentCacheArea」インターフェースを参照してください。除去用語 (完全除去、部分除去、LRU リストなど) の定義や除去処理の詳細については、「PruneAmount」プロパティーを参照してください。
前述したように、「PruneThresholdSizeKBytes」プロパティーは、別の除去しきい値を定義することに注意してください。
<publicationinfo>
<styletemplateid>{14917CF3-4D5F-499D-BA38-8E010199745E}</styletemplateid> <publishtemplateid>{4D696690-EEBB-4341-9FE7-A8F715BAE96D}</publishtemplateid> <pubtemplversionseriesid>{459A0D5A-5B44-4AD1-B15C-91D7B773B3DD}</pubtemplverseriesid> <outputfolderid>{4EF26F2E-61D8-47FD-8201-EE81C3AA75FA}</outputfolderid> </publicationinfo>
ドキュメントがパブリッシュ・ドキュメントではない場合、このプロパティーは空です。
PublishStyleTemplate
オブジェクトへの参照が含まれます。PublishTemplate
オブジェクトへの参照が含まれます。このプロパティーを設定すると、PublishRequest
オブジェクトはパブリッシュ操作の対象になります。再度パブリッシュ操作を実行するには、PublicationDocument
プロパティーを設定し、このプロパティーを null
に設定する必要があります。Document
オブジェクト。COUNT_LIMIT
オプションがゼロに設定されている場合にのみ使用されます。
このプロパティーを、以下の値に設定できます。
デフォルト値は QueryPageDefaultSize プロパティーの値の 2 倍です。
結果カウントのパフォーマンスを最適化するには、管理者がサーバーでの照会の時間制限の設定を考慮する必要があります。 詳細については、オブジェクト・ストアのプロパティー DefaultQueryTimeLimit、MaxQueryTimeLimit、および QueryDatabaseTimeLimit を参照してください。
このプロパティーを、以下の値に設定できます。
デフォルト値は QueryPageMaxSize プロパティーの値の 2 倍です。
結果カウントのパフォーマンスを最適化するには、管理者がサーバーでの照会の時間制限の設定を考慮する必要があります。 詳細については、オブジェクト・ストアのプロパティー DefaultQueryTimeLimit、MaxQueryTimeLimit、および QueryDatabaseTimeLimit を参照してください。
このプロパティーを、以下の値に設定できます。
このプロパティーを設定すると、各 JDBC ステートメント実行の有効な時間制限は、ステートメント実行時に残っているすべての RPC 時間制限の値と QueryDatabaseTimeout 値の小さい方の値になります。
このプロパティーは、データベース・リソースを長い時間消費する長期実行検索 (テーブル・スキャンが発生する LIKE %value% 照会、複雑な結合照会など) の追加制御を指定します。
このプロパティーに有効な設定を判断するには、DefaultQueryTimeLimit プロパティーで設定する、クライアント/サーバー間 RPC の時間制限を考慮する必要があります。 クライアント/サーバー間 RPC の合計時間は、Content Engine (CE) SQL からデータベース (DB) SQL への構文解析、DB SQL の実行、データベースからの行のフェッチ、および検索された各行のセキュリティー・チェックを行う時間で構成されます。 また、コンテンツ・ベース・リトリーブ (CBR) 検索の場合は、この時間には全文検索の時間も含まれます。さらに、ページングされた検索を使用すると、一定数の行 (通常はページ・サイズの 2 倍) がデータベースから一度に取得され、初期の行セットがクライアント・ページに満たない場合、DB SQL 実行およびフェッチの全体の処理が繰り返されます。これは、セキュリティー・フィルタリングのためか、CBR ヒットの初期セットがデータベースのプロパティー条件に一致しない場合に発生する可能性があります。
そのため、例えば合計の RPC 時間制限を 10 分に設定した場合、上記のクライアント/サーバー間検索のステップはすべて 10 分以内に完了する必要があります。 同時に、データベース・リソースの問題 (ブロッキングなど) がさらに短い時間フレームで発生するおそれがあるため、QueryDatabaseTimeout 値を 30 秒に設定して DB SQL 実行時間を明確に制限できます。
長い RPC タイムアウトを設定する典型的なユース・ケースには、長期実行 CBR 検索、または大量の行セットを返すページングされていない検索が含まれます。QueryDatabaseTimeout を設定する典型的なユース・ケースでは、データベースでのテーブル・スキャンまたは複雑な結合照会の長期実行が防止されます。
RPC タイムアウトおよび QueryDatabaseTimeout を正しく選択するには P8 管理者と DBA の両方の考慮事項が必要です。
詳細については、『サーバー照会タイムアウトの動作』を参照してください。
PublishingConfiguration
オブジェクトの場合、このプロパティーは、パブリッシュ要求ハンドラー・インスタンスの最大数を指定します。
PublishingConfiguration
オブジェクトの場合、キュー・アイテムはパブリッシュ要求です。
Subscription
オブジェクトである場合があります。AsyncUpgradeQueueItem
インターフェースの場合、このプロパティーは内部使用専用です。
IBM Legacy Content Search Engine で使用されるランク値の範囲は、IBM Content Search Services で使用される値の範囲と一致するように変更することができます。この範囲を変更するには、Content Engine が使用する Java Virtual Machine (JVM) コマンドにパラメーター "-DCBR.RankConsistency=true" を追加します。これにより、IBM Legacy Content Search Engine と IBM Content Search Services の両方から返されるランク値の範囲が 0 から 1000 になります。
FAILURE
に設定されている CmSweepResult オブジェクトで表されます。
スイープ・ジョブがプレビュー・モードで実行されている場合、このプロパティーは無視されます。
CmRecoveryBin
。
例: クラス A 内のあるオブジェクト値プロパティーに対して、その反映プロパティーは、クラス A を必須とするクラス B 内のオブジェクト値プロパティーとします。クラス A からインスタンス化されたオブジェクト内のオブジェクト値プロパティーが特定のオブジェクトを返すためには、返したいクラス B の各オブジェクトの反映プロパティーを設定する必要があります。
リージョン・キーは、Process Engine アプリケーションと Process Engine サーバー間で使用する IBM FileNet P8 識別トークンを生成する際に使用します。IBM FileNet P8 4.5 リリースでは、このキーは、Content Engine によって RegionPassword プロパティーに基づいて生成されます。将来のリリースでは、Process Engine が、FIPS 140-2 準拠の Advanced Encryption Standard (AES) アルゴリズムを使用してアイソレート・リージョン・キーを生成します。その後、このキーは Content Engine に渡され、値が Content Engine サーバーの GCD に Content Engine のマスター・キーで暗号化されて格納されます。
データ型はバイナリーであるため、セキュリティーで保護されたチャネル (Secure Socket Layer、SSL) を通じて RegionKey プロパティー値を設定する必要があります。値を設定すると、リージョン・キーの取得で長さがゼロの値が返されます。それ以外の場合、null
が返されます。
注: 将来のリリースでは、パスワードを使用したアイソレート・リージョン・キーの生成はサポートされなくなります。
リージョン・キーは、Process Engine アプリケーションと Process Engine サーバー間で使用する P8 識別トークンを生成する際に使用します。アイソレート・リージョンに対して入力するリージョン・パスワードは、Process Engine 管理ツールを使用してアイソレート・リージョンを作成または編集する場合に入力するリージョン・パスワードと完全に一致する必要があります。これら 2 つのパスワード (およびそれらから生成されるリージョン・キー) が完全に一致しないと、Process Engine 認証は失敗します。
パスワードは伝送される前に暗号化されるため、データ型はバイナリーです。
RELEASED
という VersionStatus プロパティー値を持つメジャー・バージョンのことです。1 つのバージョン・シリーズにおいて、リリース済み状態のドキュメント・バージョンは一度に 1 つのみであることに注意してください。Content Engine サーバーは、ソース・オブジェクトの現行索引が満杯であることを索引更新要求時に検出した場合、このプロパティーを設定します。サーバーは、満杯状態の索引内で索引入力を更新しようとするときに、代わりに、代替索引に新しい索引入力を作成して満杯状態の索引内で元の入力を削除する必要があります。新しい索引入力が作成されてから元の索引入力が削除されるようにするために、サーバーはこれらのタスクを以下の順番で実行します。
IndexRequest
オブジェクトの RemovalIndexationId プロパティーを、満杯状態の索引のオブジェクト ID に設定します。IndexRequest
オブジェクトの IndexationId プロパティーを、代替索引のオブジェクト ID に設定します。RenditionEngineConnection
オブジェクトへの参照が含まれます。RenditionEngineConnectionSet
オブジェクトへの参照が格納されています。ReplicationDirection
定数。
拡張ストレージ域の場合、このプロパティーは、コンテンツ・キュー・スイープ (CmContentBackoutQueueSweep
、CmContentDeletionQueueSweep
、または CmContentReplicatonQueueSweep
) によって処理されるコンテンツ・アイテムについての内部データを保管します。
ここに保管されるデータは、照会できません。
ReplicationGroup
オブジェクトを指定します。ReplicationJournalEntry
オブジェクトの場合のみ、このプロパティーは、このジャーナル・エントリーを生成する複製操作のソース・オブジェクトが属する複製グループを表します。
ReplicationGroup
オブジェクトのコレクションを含んでいる ReplicationGroupSet
オブジェクトを指定します。ReplicationMode
定数。複製モードにより、複製グループでのオブジェクトの複製方法が決まります。
この定数には、以下のいずれかの値を指定することができます。
MASTER
: マスター・モード。このモードの場合、リポジトリーで複製されたオブジェクトを変更することができます。すべての変更内容は、複製グループ内の他の参加者に対して伝搬されます。SLAVE
: スレーブ・モード。このモードの場合、リポジトリーで複製されたオブジェクトが読み取り専用になります。これらのオブジェクトが変更されるのは、マスター・モードで複製グループ内で動作する別のリポジトリーから変更内容が伝搬された場合だけです。ReplicationParticipant
オブジェクトの ReplicationParticipantsList
コレクションを指定します。各オブジェクトは、この複製グループ内の外部リポジトリーまたはオブジェクト・ストア参加者を表します。
ReplicationJournalStatus
定数。
PropertyDescriptionObject
オブジェクトによって記述されるオブジェクト値プロパティーに返されるオブジェクトの、クラスまたはスーパークラスを記述する ClassDescription
オブジェクトを指定します。PropertyDefinitionObject
オブジェクトによって定義されるカスタム・プロパティーのオブジェクト値が準拠しなければならないクラスの ID を指定します。このプロパティーは、必須クラスを記述する ClassDescription
オブジェクトの ID プロパティー値を保持します。
RequiredClassId プロパティーは任意のクラス・タイプに設定できますが、Content Platform Engine では、カスタム・オブジェクト値プロパティーに対して以下の必須クラスのみが許可されます。
RepositoryObject
サブクラス。SecurityPrincipal
サブクラス (User
および Group
クラスが含まれる)。EntireNetwork
および Domain
は使用できません。
参照する PropertyDefinitionObject
オブジェクトは、単一カーディナリティーでなければならず、外部オブジェクトを許可せず、反映プロパティー ID を持たず、NONE または NULL の削除アクションが設定されている必要があります。
このプロパティーを、依存オブジェクトを記述するクラスに設定すると、この PropertyDefinitionObject
オブジェクトによって定義されるプロパティーをその依存オブジェクトに設定できなくなります。これは、カスタム・オブジェクト値プロパティーを依存オブジェクトに設定することはできないためです。システム・オブジェクト値プロパティーとは異なり、カスタム・オブジェクト値プロパティーは独立オブジェクトのみを保持できます。
CmIndexDefinition
オブジェクトの場合は、索引が固有であるか (true) 固有でないか (false) を指定します。
他のすべてのオブジェクトの場合は、複数値プロパティーの値が固有であるか (true) 固有でないか (false) を指定します。
RESERVATION
という VersionStatus プロパティー値があります。予約オブジェクトは、ドキュメントをチェックアウトするとサーバーにより作成されます。このドキュメントは、変更して、そのドキュメントの新規バージョンとしてチェックインできます。ReservationType
定数。ReservationType プロパティーには、次の表のいずれかの値が入ります。
名前 | 値 | 説明 |
---|---|---|
COLLABORATIVE |
16 | コラボレーション型の予約を指定します。これは、適切な権限を持つ任意のユーザーがチェックイン、変更、削除を実行できる予約です。 |
EXCLUSIVE |
32 | 排他型予約を指定します。このタイプの予約の場合、ドキュメントをチェックアウトしたユーザーだけがそのドキュメントをチェックインできます。このユーザーと完全制御アクセス権を持つユーザーは、予約を削除できます。 |
OBJECT_STORE_DEFAULT |
0 | 予約タイプを、DefaultReservationType プロパティーによって指定されるオブジェクト・ストアのデフォルトの予約タイプと同じタイプとして指定します。 |
true
) しないか (false
) を指定します。ドキュメントに関連付けられた DocumentLifecyclePolicy
オブジェクトの ResetLifecycleOnCheckin プロパティーを false
に設定すると、ドキュメントのライフ・サイクル状態は、ドキュメントの changeState
メソッドを使用して明示的に変更しない限り、あるバージョンから次のバージョンまで同じ状態のまま維持されます。ResourceStatus
定数を指定します。これは、索引領域、索引、またはストレージ域の
使用可能状況を示します。
CmTextSearchIndexArea
オブジェクトの場合、このプロパティーは、IBM® Content Search Services 索引領域の
使用可能状況を指定します。このプロパティーに使用できる値は次のとおりです。
OPEN
: 索引領域はアクティブであり、この領域に新規の索引を作成できます。新規の索引は、
このプロパティーが OPEN
に設定された場合に限り、索引領域に作成できます。また、既存の索引を更新、削除、または照会することもできます。CLOSED
: 新規の索引に対して索引領域が閉じられます。ただし、既存の索引を更新、削除、または照会することはできます。FULL
: 索引の数が MaxIndexes プロパティーの値と同等になり、すべての索引が満杯になったかあるいは閉じられたために、
索引領域の容量はいっぱいになりました。この設定値は、索引領域にオブジェクトをこれ以上索引付けできないことを示します。
ただし、既存の索引を削除または照会することはできます。ResourceStatus プロパティーを FULL
に設定できるのは、Content Engine サーバーのみです。STANDBY
: 索引領域は非アクティブです。新規の索引を作成することはできませんが、既存の入力を更新、削除、または照会することができます。使用可能な開放状態の索引領域がない場合、Content Engine サーバーは索引領域の状況を STANDBY
から OPEN
に設定できます。
CmTextSearchIndexArea
オブジェクトの場合、Content Engine サーバーは次の状況値間での手動変更のみをサポートします。
OPEN
から CLOSED
へ: この変更は常に許可されます。OPEN
から STANDBY
へ: この変更は常に許可されます。CLOSED
から OPEN
へ: この変更は、MaxIndexes プロパティーの値が索引領域内の索引の数より大きい場合、
または索引領域に開放状態の索引がある場合のみ許可されます。CLOSED
から STANDBY
へ: この変更は、MaxIndex プロパティーの値が索引領域内の索引の数より大きい場合、
または索引領域に開放状態の索引がある場合のみ許可されます。FULL
から OPEN
へ: この変更は、MaxIndex プロパティーの値が索引領域内の索引の数より大きい場合、
または索引領域に開放状態の索引がある場合のみ許可されます。
FULL
から CLOSED
へ: この変更は常に許可されます。FULL
から STANDBY
へ: この変更は、MaxIndex プロパティーの値が索引領域内の索引の数より大きい場合、
または索引領域に開放状態の索引がある場合のみ許可されます。
STANDBY
から OPEN
へ: この変更は常に許可されますが、ある索引が満杯になった場合は自動的に発生してスタンバイ状態の索引が開放されます。STANDBY
から CLOSED
へ: この変更は常に許可されます。
CmTextSearchIndex
オブジェクトの場合、このプロパティーは、IBM® Content Search Services 索引の
使用可能状況を指定します。このプロパティーに使用できる値は次のとおりです。
OPEN
: この索引は索引作成要求に対して開放されています。新規の索引入力は、このプロパティーが OPEN
に設定された場合に限り、索引に作成できます。また、既存の索引入力を更新、削除、または照会することもできます。CLOSED
: この索引は索引作成要求に対して閉じられています。ただし、既存の索引入力を更新、削除、または照会することはできます。
索引ジョブが削除用の索引を閉じた場合、サーバーは ResourceStatus プロパティーを CLOSED
に設定し、IndexingStatus プロパティーを REPLACING
に設定します。IndexingStatus プロパティーが REPLACING
に設定されている限り、ユーザーは API を使用して ResourceStatus プロパティーを CLOSED
から OPEN
に変更することはできません。索引ジョブが取り消された場合、サーバーは IndexingStatus プロパティーを NORMAL
に設定しますが、ResourceStatus プロパティーは API で変更されない限り CLOSED
に設定されたままです。FULL
: この索引の容量がいっぱいになりました。この容量は、
これが属する索引領域によって定義されています (CmTextSearchIndexArea
オブジェクトの MaxObjectsPerIndex および MaxSizePerIndexKbytes プロパティー)。
この設定値は、索引入力をこれ以上作成できないことを示します。ただし、既存の索引入力を削除または照会することはできます。
ResourceStatus プロパティーを FULL
に設定できるのは、Content Engine サーバーのみです。UNAVAILABLE
: この索引を索引付けに使用できません。新規の索引を作成することができず、既存の索引入力を更新、削除、照会することもできません。使用不可の索引を含む照会は失敗しませんが、いずれの結果も生成しません。索引が UNAVAILABLE
に設定されている場合、管理者はユーザーに通知する必要があります。
管理者は通常、破損した索引が原因で再索引付けが失敗しないように、索引を UNAVAILABLE
状況に設定します。
UNAVAILABLE
に設定されている破損した索引を使用すると、再索引付け操作全体の失敗を引き起こす可能性があるエラーを生成せずに再索引付けを完了できます。UNAVAILABLE
に設定された後は、索引を他のいずれの状態にも設定することはできません。つまり、この状態は索引の最終の状態です。できるだけ早く使用不可の索引を再索引付けすることをお勧めします。サーバーは自動的に新規の索引を作成するかスタンバイ状態の索引を開放して、使用不可の索引に対する保留の索引要求をすべて処理します。使用不可の索引が再索引付けされると、サーバーはその使用不可の索引を削除します。
CmTextSearchIndex
オブジェクトの場合、Content Engine サーバーは次の状況値間での手動変更のみをサポートします。
OPEN
から CLOSED
へ: この変更は常に許可されます。OPEN
から UNAVAILABLE
へ: この変更は常に許可されます。CLOSED
から OPEN
へ: この変更は、索引が索引ジョブにより削除されるようにスケジュールされていない (つまり、IndexingStatus プロパティーが REPLACING
に設定されていない) 場合のみ許可されます。CLOSED
から UNAVAILABLE
へ: この変更は常に許可されます。FULL
から OPEN
へ: この変更は、索引の容量がいっぱいになっていない場合のみ許可されます。
この容量は、索引が属する索引領域によって定義されています (CmTextSearchIndexArea
オブジェクトの MaxObjectsPerIndex および MaxSizePerIndexKbytes プロパティー)。
FULL
から CLOSED
へ: この変更は常に許可されます。FULL
から UNAVAILABLE
へ: この変更は常に許可されます。
StorageArea
オブジェクトの場合、このプロパティーは、ストレージ域の
使用可能状況を指定します。このプロパティーに使用できる値は次のとおりです。
OPEN
: ストレージ域は新規コンテンツに対して開放されています。既存コンテンツを更新、削除、または取得することもできます。CLOSED
: ストレージ域が無効になっているか、または終了日が設定されており、その日付を過ぎています。閉じられた状態のストレージ域では、新規コンテンツの作成も既存コンテンツの更新もできません。ただし、既存コンテンツを削除または取得することはできます。FULL
: ストレージ域のコンテンツ・エレメントの最大サイズまたは最大数を超えています。満杯状態のストレージ域では、新規コンテンツの作成も既存コンテンツの更新もできません。ただし、既存コンテンツを削除または取得することはできます。STANDBY
: ストレージ域はスタンバイ・モードになっています。スタンバイ状態のストレージ域では、新規コンテンツを作成できません。ただし、既存コンテンツを更新、削除、または取得することはできます。
StorageArea
オブジェクトの場合、Content Engine サーバーは次の状況値間での自動変更をサポートします。
OPEN
から FULL
へ: ストレージ域へのコンテンツ・エレメントの追加により、ストレージ域に許可された
コンテンツ・エレメントの最大サイズまたは最大数を超える場合に適用されます。
OPEN
から CLOSED
へ: 終了日を過ぎているストレージ域にコンテンツ・エレメントを追加すると適用されます。STANDBY
から OPEN
へ: 保管ポリシーにスタンバイ状態のストレージ域が含まれているが開放状態のストレージ域は含まれていないとき、ストレージ域にコンテンツ・エレメントを追加すると適用されます。
StorageArea
オブジェクトの場合、Content Engine サーバーは次の状況値間での手動変更のみをサポートします。
CLOSED
、FULL
、または STANDBY
への変更: これらの変更は、
常に許可されます (サイズ、カウント、または終了日付の制限値により変更が制約されることはありません)。
OPEN
への変更: これらの変更は、サイズとカウントが指定された制限値に達していない場合で、終了日になっていない (または null
) の場合のみ許可されます。この制限には、OPEN
から OPEN
への変更が含まれ、
その場合には開放領域の制限値を変更できます。Image Services の場合、このプロパティーを設定すると、Image Services 固定コンテンツ・デバイスに保管されているコンテンツの Image Services ドキュメント・クラス名を指定できます。この値は、関連の IMFixedContentDevice
オブジェクトの DefaultISDocumentClass プロパティーより優先されます。
次に例を示します。
x-filenetfsrs:?ISDocClassName=SomeDocClassName
Atmos 固定コンテンツ・デバイスの場合は、このプロパティーを Atmos 保存のために設定する必要があります。文字列はキーと値のペアから成り立っている必要があり、保存が更新されるときにこれらのペアが Atmos デバイス上でメタデータとして適用されます。Atmos デバイスは、このプロパティー内で指定されたメタデータに基づいて特定のポリシーを割り当てるように構成されている必要があります。 Atmos 保存のための詳細な構成要件については、『Atmos 固定コンテンツ・デバイスの構成 (Configuring the Atmos fixed content device)』を参照してください。
IBM Tivoli® Storage Manager (TSM) 固定コンテンツ・デバイスの場合は、このプロパティーを、コンテンツを保管する予定の TSM サーバーによって定義された有効な TSM 管理クラスに設定する必要があります。TSM 管理クラスは、TSM サーバーの特定の保存設定を表します。TSM サーバーの有効な TSM 管理クラスのセットは、そのサーバーを参照する TSM 固定コンテンツ・デバイス上の TSMManagementClasses プロパティーから取得できます。
構文は以下のとおりです。
x-filenetfsrs:?tivoliMCName=<mangagement_class_name>&retentioninit=<'event'| 'cron'>
次に例を示します。
x-filenetfsrs:?tivoliMCName=KIRK001CLASS&retentioninit=event
詳しくは、『IBM Tivoli Storage Manager 固定コンテンツ・デバイスのための保存 (Retention for the IBM Tivoli Storage Manager fixed content device)』を参照してください。
ユーザーは、構成されているレルム内に存在すれば、構成されていないレルム内のグループに属することができます。
デフォルト (プロパティー値が false
の場合) では、サーバーは自動的にレルム間グループ・メンバーシップ (Active Directory では、ドメイン間グループ・メンバーシップとも呼ばれる) を検索します。管理コンソールで構成されていないレルムに到達すると、サーバーは「レルムが見つかりません」というエラーを返し、グループ・メンバーシップ検索処理は停止します。しかし、この状態が発生したときにプロパティー値が true
の場合、サーバーは情報メッセージをサーバー・エラー・ログに記録し、グループ・メンバーシップ検索は続行します。
注: Windows Active Directory Application Mode (ADAM) ディレクトリー・サービス・プロバイダーでは、このプロパティーはサポートされていません。ADAM でレルム間グループ・メンバーシップ (ADAM の用語では、パーティション間メンバーシップ) がサポートされていないためです。
AllowRetentionReduction プロパティーが true に設定されている場合、RetentionDurationUpdate を使用して保存期間を短縮できます。RetentionPeriodUnits プロパティーの適用できる単位とともに、このプロパティーを負の値に設定します。 サーバーは、このプロパティーで指定された量だけ現在の保存日を短縮します。
SpecificRetentionDate プロパティーが設定されている場合、RetentionDurationUpdate プロパティーおよび BaseDatePropertyName プロパティーを設定することはできません (その逆も同様です)。
RetentionPeriod
クラスに列挙されているように、以下のとおりです。FixedStorageArea
オブジェクトのみ)DurationUnits
定数。保存期間 (クラス定義の DefaultRetentionPeriod プロパティー、あるいは保存期間の更新ポリシーまたは保存日の更新ジョブの RetentionDurationUpdate プロパティー) を表す時間の単位を指定します。例えば、RetentionPeriodUnits プロパティーが MONTHS
に設定されており DefaultRetentionPeriod プロパティーが 5 に設定されている場合、保存期間は 5 カ月です。
この定数には、以下のいずれかの値を指定することができます。
YEARS
MONTHS
WEEKS
DAYS
HOURS
MINUTES
SECONDS
クラス記述では、RetentionPeriodUnits は読み取り専用です。
ContentTransfer
オブジェクトで表現) を取得して編集することができる元ファイルへのパスを指定します。(ファイル名を含む) 完全なパスには、最長で 2083 文字を使用できます。ファイル名自体は最大 255 文字までです。true
に設定すると、サービス・プロバイダーにより、名前が DN 形式で返されます。この形式は、他のタイプのディレクトリー・サービス・プロバイダーと整合性が取れています。ClassDefinition
およびそのサブクラスからインスタンス化されたオブジェクト) が格納されている ClassDefinitionSet
を指定します。各クラス定義では、任意のクラスに対して (プロパティー定義など) 一連の可変メタデータが定義されます。RootClassDefinitions
プロパティーにより返されるコレクションへの参照を設定すると、このオブジェクト・ストアで使用可能なすべての可変クラス・メタデータにアクセスできます。
CmTextSearchIndexArea
オブジェクトの場合、このルート・ディレクトリーは、IBM® Content Search Services サーバーが所定の索引領域内に IBM Content Search Services 索引を保管するために使用されます。索引領域が含まれる同じオブジェクト・ストア・サイトに属するすべての IBM Content Search Services サーバーは、このディレクトリーへの読み取りおよび書き込み権限が付与されている必要があります。指定されたルート・ディレクトリーがマシンに存在しない場合、サーバーはルート・ディレクトリーを作成します。
アフィニティー・グループを索引領域に割り当てた場合、そのアフィニティー・グループに割り当てられた IBM Content Search Services サーバーでのみ、索引領域のルート・ディレクトリーへの読み取りおよび書き込み権限が必要になります。サイト内のその他のサーバーに権限を割り当てる必要はありません。索引領域がアフィニティー・グループに割り当てられている場合、アフィニティー・グループ内のすべての IBM Content Search Services サーバーでローカルであるルート・ディレクトリーを使用することをお勧めします。ローカル・ディスクの方が入出力操作が高速になるため、これを行うことによりパフォーマンスが改善できます。
Folder
オブジェクト。ログイン ID は、SMTP サーバーにあらかじめ存在していなければなりません。
Action
ベースのオブジェクトの呼び出し時に実行されるスクリプト・テキスト。
false
です。フォレスト間グループ・メンバーシップ検索を有効にするには、このプロパティーを true
に設定します。false
である場合、動的グループは検索されません。
特定の検索を定義するために、パラメーターは、CmBackgroundSearch
サブクラスに追加されるカスタム・プロパティーによって定義されます。各パラメーター名は、カスタム・プロパティーのシンボル名と一致します。
ObjectStore
オブジェクト。このプロパティーは、CmBackgroundSearch
インスタンスが属しているオブジェクト・ストアとは異なるオブジェクト・ストアを検索する場合にのみ、設定する必要があります。このプロパティーが NULL である場合、検索は、CmBackgroundSearch
インスタンスが属しているのと同じオブジェクト・ストア内で実行されます。
CmBackgroundSearch
インスタンスが属しているオブジェクト・ストアとは異なるオブジェクト・ストアを検索するときに、検索式の SELECT リストにオブジェクト値プロパティーが含まれている場合、CmBackgroundSearch
インスタンスの対応するプロパティーは、外部オブジェクトを許可する必要があります (AllowsForeignObject プロパティーが true
に設定されている必要があります)。許可しない場合、検索は失敗します。
CmAbstractSearchResult
オブジェクトの現在の列挙を保持する CmAbstractSearchResultSet
オブジェクト。各 CmAbstractSearchResult
オブジェクトは、このバックグラウンド検索によって生成される検索結果を表します。
VerityIndexArea.VeritySearchServers
プロパティー内のリストに基づくサーバーの数。選択されるサーバーは、既に付加されているコレクションの数が最小のサーバーになります。非推奨
検索するオブジェクト・ストアを識別します。 この設定値は、SearchScope
インスタンスに指定されたオブジェクト・ストアによってオーバーライドされます。
非推奨
照会するオブジェクト・タイプを識別します。この設定値はSearchScope
メソッドの searchFromClause
パラメーターによってオーバーライドされます。次のタイプを使用できます (検索節ごとに 1 つのタイプ): document
folder
customobject
Folder
オブジェクト (セキュリティーの親) を示します。この値は、Folder.file
メソッドの defineSecurityParentage
パラメーターの値として DefineSecurityParentage を指定すると、間接的に設定されます。この場合、この値は、オブジェクトをファイルとして格納するフォルダーになります。
1 つ以上のオブジェクト値プロパティーを使用して、これらのプロパティーの SecurityProxyType 値を INHERITANCE
に設定すれば、オブジェクトに対してセキュリティーの親を複数指定できます。
User
および Group
オブジェクトを参照できるようにするために、サーバーによって使用されます。
非推奨。代わりに、SecurityFolder
を使用してください。
ReferentialContainmentRelationship
(または DynamicReferentialContainmentRelationship
) です。オブジェクトは、その権限をセキュリティーの親から継承できます。例えば、Document
オブジェクトは、そのオブジェクトがファイルとして格納される Folder
の権限を継承できます。Folder
オブジェクトは常に、その親フォルダーから権限を継承します。オブジェクトのセキュリティーの親は、オブジェクトの SecurityParent
プロパティーの値に反映されます。オブジェクトをファイルとしてフォルダーに格納するときにオブジェクトのセキュリティーの親を明示的に設定するには、Folder.file
メソッドの defineSecurityParentage
パラメーターを指定します。
ObjectStore
オブジェクトに関連付けられているセキュリティー・ポリシーのコレクションを持つ SecurityPolicySet
オブジェクトを指定します。SecurityPolicy
を指定します。SecurityPolicy
は、任意のオブジェクトに割り当てる権限を定義する 1 つ以上の SecurityTemplate
オブジェクトを内蔵しています。セキュリティー・テンプレートは、VersioningSecurityTemplate
または ApplicationSecurityTemplate
という 2 種類のいずれかです。VersioningSecurityTemplate
では、オブジェクトのバージョン状態が変更されると、そのオブジェクトに自動的に割り当てられる権限が定義されます。ApplicationSecurityTemplate
では、アプリケーション・プログラムによって権限を定義する呼び出しが明示的に行われると、オブジェクトに割り当てられる権限が定義されます。これらの種類のテンプレートのそれぞれについては、それらのインターフェースの説明を参照してください。Document
、CustomObject
、または Folder
オブジェクト (またはそれらのサブクラス) へのセキュリティー・ポリシーの割り当ては、オプションです。
FULL
INHERITANCE
および NONE
です。ただし、FULL
は
内部使用に限られます。このプロパティーの値を FULL
に設定しないでください。
それぞれの値の詳細については、「SecurityProxyType」を参照してください。
FULL
に設定されているオブジェクトでは、そのアクセス制御権限が、そのプロパティーにより参照されるオブジェクトに委任されます。FULL
に設定できるのは、オブジェクト・インスタンス 1 つにつき 1 つのプロパティーのみになります。SecurityPolicy
オブジェクトに関連付けられているセキュリティー・テンプレートのコレクションを持つ SecurityTemplateList
オブジェクトを指定します。CmAbstractSequential
のサブクラスの場合は、テーブルに挿入されたエントリーのシーケンス番号を示します。
シーケンス番号を使用して、エントリーを作成された順序で処理できます。
シーケンス番号は作成時に各オブジェクトに割り当てられます。ただし、それらのシーケンス番号は必ずしも連続していません (欠落がある場合があります)。シーケンス番号は固有であり単調に増加することが保証されています。
ホスト名検証は、宛先仮想サーバーのホスト名がその証明書内に記録された名前と一致することを確認します。証明書チェーン検証は、有効な証明書チェーンを使用して、宛先仮想サーバーの証明書の認証性を確認します。いずれについても、証明書が認証局によって署名されているか、宛先サーバーの証明書がソース・サーバーの JRE 内にインポートされている必要があります。
Content Platform Engine サーバー通信に対して有効になっている場合、ServerCommunicationURL プロパティーによって指定されたエンドポイントには、SSL サーバー証明書がデプロイされている必要があります。 さらに、このエンドポイントと通信するすべての Content Platform Engine サーバーに、この証明書がデプロイされる必要があります。
URL 形式 protocol://host:port/wsi/FNCEWS40MTOM
を使用します。HTTP または HTTPS プロトコルを使用します。
このサイト内の CPE サーバーのロード・バランサーを参照することをお勧めします。または、この仮想サーバーの下で実行されているサーバー・インスタンスの Web サービス・エンドポイント URL のコンマ区切りリストを使用できます。
『サーバー通信の構成 (Configuring server communication)』を参照してください。
ServerInstance
オブジェクトのコレクションを表します。PropertySettability
定数を指定します。特権書き込み権限を付与できる特殊なシステム・プロパティーの場合、AccessRight.PRIVILEGED_SETTABILITY
権限を持つユーザーを対象とするプロパティーの設定可能性は PrivilegedSettability プロパティーによって制御されますが、それ以外のすべてのユーザーを対象とするプロパティーの設定可能性は、引き続き Settability プロパティーによって示されます。これらの特殊な場合については、PrivilegedSettability プロパティーの説明を参照してください。Settability プロパティーには、次の表のいずれかの値が入ります。
名前 | 値 | 説明 |
---|---|---|
READ_ONLY |
3 | プロパティーが読み取り専用であることを示します。この値を設定できるのはサーバーのみです。 |
READ_WRITE |
0 | プロパティーが読み取り/書き込み可能であることを示します。この値は随時設定できます。 |
SETTABLE_ONLY_BEFORE_CHECKIN |
1 | プロパティーの値を設定できるのは、そのプロパティーが属しているオブジェクトをチェックインする前のみであることを示します。 |
SETTABLE_ONLY_ON_CREATE |
2 | プロパティーの値を設定できるのは、そのプロパティーが属するオブジェクトを作成したときのみであることを示します。オブジェクトを最初に保存すると、プロパティーの値は変更できなくなります。 |
ユーザーの短縮名の例は "test1"、グループの短縮名の例は "Managers" などです。短縮名形式では、ドメインなど、その他の修飾情報は必要ありません。User
インターフェースまたは Group
インターフェースの「DistinguishedName」プロパティーを参照して、短縮名形式と識別名 (DN) 形式を比較してください。
Document
、Folder
、Annotation
、または CustomObject
オブジェクト。Site
プロパティーの値は、デフォルトで Domain.DefaultSite
の値になります。ObjectStore
オブジェクトのサイトを直接変更できないことに注意してください。
オブジェクト・ストアを別のサイトに移動するには、ObjectStore
オブジェクトに参照される CmDatabaseConnection
オブジェクト上でこのプロパティーを変更する必要があります。
IsolatedRegion
の場合、このプロパティーは非推奨です。
SiteSettings
オブジェクトを指定します。サイトを設定すると、サイト固有の構成値を無効にすることができます。無効にすることができる設定値を持つデバイス・タイプごとに、SiteSettings
の対応サブクラスを、デバイス・オブジェクト上にある同じ名前の対応プロパティーを無効にするプロパティー (値を取り込み済みの場合) を使用して定義します。
EMC Centera 固定コンテンツ・デバイスの場合は、このプロパティーにより、Content Platform Engine サーバーが実行されているサイトに応じて PoolAddress プロパティーを異なる値に設定できます。サーバーが実行されているサイトが SiteSetting
オブジェクトのいずれにも一致しない場合は、CenteraFixedContentDevice
オブジェクトの PoolAddress プロパティーがデフォルトとして使用されます。
FileNet Image Services 固定コンテンツ・デバイスの場合は、このプロパティーにより、Content Platform Engine サーバーが実行されているサイトに応じて CSMCache プロパティーを異なる値に設定できます。サーバーが実行されているサイトが SiteSetting
オブジェクトのいずれにも一致しない場合は、IMFixedContentDevice
オブジェクトの CSMCache プロパティーがデフォルトとして使用されます。
NetApp SnapLock 固定コンテンツ・デバイスの場合は、現在、サイトに応じてカスタマイズできるプロパティーはありません。
拡張ストレージ・デバイスの場合は、このプロパティーにより、Content Platform Engine サーバーが実行されているサイトに応じて ReplicaSynchronizationType プロパティーを異なる値に設定できます。サーバーが実行されているサイトが SiteSetting
オブジェクトのいずれにも一致しない場合は、CmStorageDeviceConnection
オブジェクトの ReplicaSynchronizationType プロパティーがデフォルトとして使用されます。
Site
オブジェクトのコレクション。このコレクションの各エレメントは、ドメイン内の地理的な領域を表します。CmBulkMoveContentJob
で CopyRetainedContent プロパティーを設定する方法によっては、固定コンテンツ・デバイス上の保存されたコンテンツを新しいストレージ域にコピーすることができます。
SourceObjectStore プロパティーが設定されると、サーバーはこのプロパティーおよび SourceDatabaseSchemaName プロパティーを、オブジェクト・ストアにある同じ名前のプロパティーと同じ値に自動的に設定します。 このプロパティーまたは SourceDatabaseSchemaName プロパティーの、オブジェクト・ストアから得られた値を変更することはできません。
Case History の場合は、SourceObjectStore プロパティーを設定する必要があります。 Case Analyzer とともにレガシー・ワークフロー・システムを使用する場合は、SourceDatabaseConnection プロパティーおよび SourceDatabaseSchemaName プロパティーを、レガシー・システムを参照する値に設定します。
IBM Content Foundation では、Case Analyzer はサポートされません。
SourceObjectStore プロパティーが設定されると、サーバーはこのプロパティーおよび SourceDatabaseConnection プロパティーを、オブジェクト・ストアにある同じ名前のプロパティーと同じ値に自動的に設定します。 このプロパティーまたは SourceDatabaseConnection プロパティーの、オブジェクト・ストアから得られた値を変更することはできません。
Case History の場合は、SourceObjectStore プロパティーを設定する必要があります。 Case Analyzer とともにレガシー・ワークフロー・システムを使用する場合は、SourceDatabaseConnection プロパティーおよび SourceDatabaseSchemaName プロパティーを、レガシー・システムを参照する値に設定します。
IBM Content Foundation では、Case Analyzer はサポートされません。
ObjectChangeEvent
のサブクラスの get_OriginalObject
を使用します。CmSweepResult
の場合、プレビュー・モードで実行されているスイープが処理候補として選択したオブジェクト、または通常モードで実行されているスイープが処理に失敗したオブジェクト。
ObjectChangeEvent
ベースのイベントのソースであるオブジェクトの ID。このプロパティーを使用すると、あるオブジェクトがオブジェクト・ストアに既に存在していないかどうかを確認できます。このプロパティーを設定すると、サーバーは SourceDatabaseConnection プロパティーおよび SourceDatabaseSchemaName プロパティーを、それらのプロパティーが以前に別の値に設定されていても、オブジェクト・ストアにある同じ名前のプロパティーと同じ値に自動的に設定します。このプロパティーは、いったん設定すると変更できません。
Case History の場合は、SourceObjectStore プロパティーを設定する必要があります。
CFS では、FileNet P8 モデルと互換性のあるドキュメント・モデルがこの外部リポジトリーに必要であり、またそれを想定しています。特に、CFS では、外部リポジトリー内のドキュメント・コンテンツを変更しないまま保つ必要があり、この要件を満たすため、必要に応じてドキュメントをロックダウンします。(ドキュメントのロックダウンを実装するために必要なプロパティーの概要については、「IICEFixedContentDevice
」インターフェースを参照してください。)この要件に加えて、CFS および Content Engine では、ドキュメントのバージョン順序を変更しないことを想定しています。(外部リポジトリーがドキュメントのバージョン管理をサポートしていない場合、CFS は、各バージョン・シリーズが 1 つのバージョンで構成されているものと見なします。)バージョン順序が不変ではない形でバージョン・シリーズを統合することで、この想定に従わなかった場合は、以下のような結果になります。
CFS ドキュメントのインポートの詳細については、「CFSImportAgentConfiguration
」インターフェースを参照してください。
AllowRetentionReduction が true に設定されている場合、SpecificRetentionDate を使用して保存期間を短縮できます。このプロパティーを、保存可能オブジェクトの CmRetentionDate プロパティーに設定されている値よりも現在日付に近い値に設定します。
null
となります。
StartMinutesPastMidnight は絶対的な協定世界時 (UTC) ではないため、同じタイム・スロットが指定されると、それぞれのサーバーがそれぞれのタイム・ゾーンに応じて異なる時刻に開始されます。 分散環境の場合は、特定のサーバー・インスタンス・レベルで特定のタイム・スロットを構成し、ビジネスにとって重要な時間に索引または廃棄処理が行われることのないようにする必要があります。
保管ポリシーの場合、これは、(ResourceStatus プロパティーの値に関係なく) ポリシーが参照するすべてのストレージ域を表します (フィルターを含む)。
StoragePolicySet
オブジェクトを指定します。ドキュメントを作成した場合、Document
インスタンス上での格納を設定する場合の優先順位は、(高いほうから低い方へ) 次のようになります。
ドキュメントのデフォルトの ClassDefinition により、StorageArea は「データベースのストレージ域」に設定され、StoragePolicy は「すべてのストレージ域」に設定されます。このため、StoragePolicy プロパティーのみを設定してデフォルトの Document
ClassDefinition の新規 Document
インスタンスを作成する場合、ドキュメントは、StorageArea プロパティーのクラスのデフォルト値 (データベースのストレージ域) を使用します。
この状況を回避するには、ドキュメントの StorageArea プロパティーのインスタンス値を null
に設定する必要があります。StorageArea のインスタンス値は設定されていても値が存在しないため、StoragePolicy プロパティーが評価されて使用されます。
通常、管理者が自分の格納システムを適切に管理できるようにするには、保管ポリシーを使用することが求められます。格納ポリシーにより、ロード・バランスを取れるように複数のストレージ域を割り当てることができます。さらに、現在のストレージ域のいずれかが満杯になった場合に使用するように、スタンバイ・ストレージ域を割り当てることができます。
PublishStyleTemplate
オブジェクトへの参照が格納されています。このプロパティーが null
の場合、パブリッシュ・テンプレートはコピー操作用です。それ以外の場合は、変換操作用です。変換の種類は、PublishStyleTemplate
オブジェクトの OutputFormat
プロパティーで決まります (HTML や PDF など)。Folder
に直接含有される子フォルダーの Folder
オブジェクトを含有する FolderSet
コレクション・オブジェクト。参照として含有される子フォルダーは、コレクションには含まれません。Subject
エレメントが削除されます。SubscribedEventList
コレクションに設定します。Subscription
ベースのオブジェクト (ClassSubscription
、ClassWorkflowSubscription
、InstanceSubscription
、InstanceWorkflowSubscription
) のターゲット・オブジェクトです。Subscribable
オブジェクトを使用してプロパティーを設定し、その後、Subscription
ベースのオブジェクトを作成するときにこのプロパティーを指定します。ClassSubscription
オブジェクトまたは ClassWorkflowSubscription
オブジェクトの場合は、SubscriptionTarget
プロパティーの値を、Content Engine クラスのタイプ (Document や Folder など) を指定する SubscribableClassDefinition
オブジェクトまたはサブクラスに設定します。この意味は、現時点でインスタンスが永続的ストアに存在するか、新規のインスタンスを作成したかに関係なく、クラスのインスタンスが作用すると、EventAction
オブジェクトのイベントが 1 つ以上発生するということです。
InstanceSubscription
オブジェクトまたは InstanceWorkflowSubscription
オブジェクトの場合は、SubscriptionTarget
プロパティーの値を特定のサブスクライブ可能オブジェクト
に設定します。この意味は、EventAction
オブジェクトのイベントが 1 つ以上発生するのは、現時点でインスタンス化されているこのオブジェクトが作用した場合のみであるということです。オブジェクトが VersionSeries
オブジェクトである場合、イベントが発生するのは、バージョン・シリーズのうちの 1 つのバージョンが作用した場合です。
CmTaskRelationship
オブジェクトを作成すると、それが、このプロパティーに設定する
CmTask
オブジェクトの Predecessors
プロパティーに
反映されます。
CmTaskRelationship
オブジェクトの作成時、そのオブジェクトの PredecessorTask
プロパティーにこの CmTask
オブジェクトを設定すると、新規作成した
CmTaskRelationship
オブジェクトが列挙に追加されます。
ClassDefinition
オブジェクトを指定します。ClassDescription
オブジェクトを指定します。ExternalClassDescriptions
コレクションにない場合、このプロパティーを null に設定できます。AddOn
によって置換される AddOn
オブジェクトの ID。このプロパティーは AddOn
オブジェクトのほか、継承を行った場合は UpgradeAddOn
オブジェクトにも存在しますが、UpgradeAddOn
オブジェクトでは使用されません。
新しいバージョンの AddOn
は機能的に置換する、以前のバージョンの AddOn
オブジェクト ID をこのプロパティーに指定します。置換される (更新される) 機能に依存するアプリケーションは、新しいバージョンの AddOn
を通じて同じ機能が利用可能かどうかを判別できます (isAddOnInstalled
ヘルパー・メソッドも参照)。
以下の表の言語コードがサポートされています。
言語コード | 言語 |
---|---|
af | アフリカーンス語 |
ar | アラビア語 |
ca | カタロニア語 |
zh | 中国語 |
cs | チェコ語 |
da | デンマーク語 |
nl | オランダ語 |
en | 英語 |
fi | フィンランド語 |
fr | フランス語 |
de | ドイツ語 |
el | ギリシャ語 |
he | ヘブライ語 |
it | イタリア語 |
ja | 日本語 |
ko | 韓国語 |
nb | ノルウェー語 (ブークモール) |
nn | ノルウェー語 (ニーノシュク) |
pl | ポーランド語 |
pt | ポルトガル語 |
ru | ロシア語 |
es | スペイン語 |
sv | スウェーデン語 |
NULL
の場合、スイープはまだ完了していません。
このプロパティーは、タイプ SweepMode の値を取ります。
このプロパティーは、以下の値を取ります。
注: スイープ・ポリシーがプレビュー・モードで実行されるように設定されている場合は、このプロパティーをゼロに設定しないでください。そうしないと、スイープ・ポリシーは結果レコードを生成しません。
null
に設定されます。
スイープ・ジョブの場合、このプロパティーはジョブが完了した後でもタイム・スタンプ値に設定されたままになります。
バックグラウンド検索スイープでは、このプロパティーは自動的にバックグラウンド検索結果クラスに設定されます。
CmSweep
オブジェクトのプロパティー設定は、CmSweepConfiguration
グローバル・オブジェクトのプロパティー設定をオーバーライドします。CmSweep
オブジェクトのプロパティーが null に設定されていると、CmSweepConfiguration
オブジェクトのタイム・スロット設定が使用されます。SymbolicName プロパティーを設定できるオブジェクト (オブジェクト・ストア、クラス定義、およびプロパティー・テンプレート・オブジェクト) の場合、SymbolicName プロパティーの値は文字で始める必要があり、使用できる文字は「A」から「Z」まで、「a」から「z」まで、「0」から「9」まで、および「_」(下線) に限られます。 空白や記号は使用できません。SymbolicName プロパティーに値を指定しなかった場合は、オブジェクトを保存したときに、DisplayName プロパティーの値に基づいて、サーバーによって値が生成されます。クラス定義オブジェクトおよびプロパティー・テンプレート・オブジェクトのシンボル名は、予約済みの接頭部 (Cm、Dita、および RM) のいずれかで開始される値に割り当てないでください。
オブジェクト・ストア・オブジェクトの場合、オブジェクト・ストアのシンボル名は、ドメイン内で固有である必要があります。
クラス定義オブジェクトの場合、クラスのシンボル名は、オブジェクト・ストア内で固有である必要があります。
プロパティー・テンプレート・オブジェクトの場合、シンボル名は、他のプロパティー・テンプレート・オブジェクトに対して固有である必要はありません。しかし、プロパティー・テンプレートを使用して、プロパティー定義を作成し、それをクラスに関連付けるときには、そのプロパティー定義のシンボル名は、クラス・ファミリー内で固有である必要があります。
クラス・ファミリーは、1 つのルート・クラス (Document
、Folder
、CustomObject
など) およびそのすべての子孫によって定義されます。
文字列値プロパティーについてプロパティー・テンプレートのシンボル名を変更すると、その変更は、そのテンプレートに基づいたプロパティー定義に伝搬されます。全文索引処理が有効になっている (IsCBREnabled プロパティーが true
に設定されている) プロパティー定義では、そのプロパティーを含むすべてのオブジェクトの再索引処理が必要になります。再索引処理をしなかった場合、このプロパティーでの全文検索では、どのオブジェクトも検索できなくなります。
true
)、使用不可であるか (false
) を指定します。
このプロパティーは、TSM オプション・ファイル内の ENABLEARCHIVERETENTIONPROTECTION オプションに対応し、TSM サーバー上のデータ保存保護設定と一致する必要があります。
true
)、圧縮されないか (false
) を指定します。
このプロパティーは、TSM オプション・ファイル内の COMPression オプションに対応します。
TivoliFixedContentDevice
オブジェクト・プロパティーが変更されたときに、Content Engine サーバーによって書き込まれます。これらのファイルが欠落または損傷している場合には、TSM サーバーを実行できないため、ファイルは頻繁にバックアップしてください。
TivoliFixedContentDevice
クラスに関連付けられた CmTivoliManagementClass
管理クラスのコレクション。各管理クラスは、IBM® Tivoli® Storage Manager サーバーに適用できる特定の保存設定 (保存スキーム・タイプと保存期間から構成されます) を表します。次の値から 1 つを指定できます。
ClassDefinition
オブジェクトまたは PropertyDefinition
オブジェクトが置かれているデータベース・テーブルの TableDefinition
オブジェクト。TableDefinition
オブジェクトのコレクション。このコレクションは、Content Engine により使用されるすべてのデータベース・テーブルを表します。テーブル・オーバーフロー・サポートを有効にすると、データベース・パフォーマンスがわずかに低下する場合があります。 このサポートを有効にする前に、メタデータ設計オプションを検討することをお勧めします。
DynamicReferentialContainmentRelationship
オブジェクトまたは ReferentialContainmentRelationship
オブジェクトの場合、これは必ず Folder
オブジェクトになります。
Link
オブジェクトの場合は、IndependentObject
のいずれかのサブクラスになります。
AccessRight
列挙の 1 つ以上の値である場合があります。PropertyDefinitionObject
では、クラス定義の一環としてオブジェクト値プロパティーが定義されます。その TargetAccessRequired プロパティーでは、ターゲット・オブジェクトによって呼び出し元に権限を付与する必要があるアクセス・レベルが指定されます。この目的は、定義されるオブジェクト値プロパティーの値としてアクセス・レベルを割り当てることです。argetAccessRequired プロパティーの値を取得するには、PropertyDefinitionObject
のプロパティー・アクセサー・メソッドを呼び出します。
PropertyDescriptionObject
では、TargetAccessRequired は読み取り専用です。
XMLPropertyMappingScript
オブジェクトのターゲット・ドキュメント・クラスを定義する DocumentClassDefinition
オブジェクトを指定します。ターゲット・クラスは、プロパティー・マッピング・スクリプトによってマップされる特定のドキュメント・プロパティーを示します。CmTask.changeState
メソッドを使用して、手動で行われるものもあります。
状態は Content Engine サーバーによって定義されます。
可能な状態の説明については、TaskState
クラスを参照してください。
CmTextSearchConfiguration
オブジェクトおよび VerityIndexArea
オブジェクトでは、このプロパティーは、一時的な索引処理ファイルを格納するために使用するディレクトリーを割り当てます。
このディレクトリーは、Content Engine に対して使用可能になっている必要があります。Content Engine サーバーのアカウントには、このディレクトリーが存在しない場合にそれを作成する権限と、このディレクトリー内にファイルを作成する権限が付与されている必要があります。
パフォーマンス上の理由により、この値は、Content Engine と IBM Content Search Services の両方に対してローカルとなるパスに設定することをお勧めします。
CmContentConversionConfiguration
オブジェクトの場合、このプロパティーはサポートされていません。
AccessPermissionDescription
オブジェクトを表します。AccessPermission
オブジェクトが格納されます。定義されたテキスト索引付けプリプロセッサーのハンドラーを指定します。
定義されたクラスに関連するテキスト索引付けプリプロセッサーのリスト。
CmTextSearchAffinityGroup
オブジェクトのリスト。
このリストは Content Engine サーバーによって維持されます。true
) 否か (false
) を指定します。
CmTextSearchIndex
オブジェクトのリストを
指定する CmTextSearchIndexList
コレクション。これらのオブジェクトはそれぞれ、
この索引領域に作成された IBM® Content Search Services 索引を表します。
このプロパティーで指定する言語が、このオブジェクト・ストアにあるほとんどのドキュメントの言語と一致するようにしてください。そうしないと、パフォーマンスの遅延が発生する場合があります。このプロパティーを 1 つ以上の言語コードに設定せず、非推奨の TextSearchIndexingLanguage プロパティーが以前に設定されていない場合は、索引付け中にエラーが発生します。
TextSearchIndexingLanguages プロパティーには、以下の表の 1 つ以上の言語コードを指定できます。
言語コード | 言語 |
---|---|
af | アフリカーンス語 |
ar | アラビア語 |
ca | カタロニア語 |
zh | 中国語 |
cs | チェコ語 |
da | デンマーク語 |
nl | オランダ語 |
en | 英語 |
fi | フィンランド語 |
fr | フランス語 |
de | ドイツ語 |
el | ギリシャ語 |
he | ヘブライ語 |
it | イタリア語 |
ja | 日本語 |
ko | 韓国語 |
nb | ノルウェー語 (ブークモール) |
nn | ノルウェー語 (ニーノシュク) |
pl | ポーランド語 |
pt | ポルトガル語 |
ru | ロシア語 |
es | スペイン語 |
sv | スウェーデン語 |
INDEX_AND_SEARCH
(0): サーバーは、索引付けと検索タスクの両方を実行します。
IBM は、一般の実動システムにこの使用モードは推奨しません。INDEX
(1): サーバーは、索引付けタスクのみを実行します。SEARCH
(2): サーバーは、検索タスクのみを実行します。DISABLED
に設定された際、シャットダウン要求を
IBM® Content Search Services サーバーに送信するか (true
) 否か (false
) を指定します。
Content Engine サーバーは、IBM Content Search Services サーバーがいったんシャットダウンすると、
その後再始動を試行しないため、TextSearchServerShutdownOnDisable プロパティーを true
に設定する場合は、注意が必要です。
ENABLED
(0): IBM Content Search Services サーバーは使用可能で、その
使用モード (TextSearchServerMode プロパティー) を使用して指定できます。このプロパティーを ENABLED
に
設定すると、Content Engine サーバーは、この IBM Content Search Services サーバーへの接続が存在するかどうか
検査します。Content Engine サーバーは、この IBM Content Search Services サーバーに接続できない場合、自動的に
このプロパティーを UNAVAILABLE
に設定します。DISABLED
(1): IBM Content Search Services サーバーは、メンテナンス目的のため使用できません。UNAVAILABLE
(2): IBM Content Search Services サーバーに到達できません。
Content Engine サーバーは、この IBM Content Search Services サーバーと通信できない場合、自動的に
このプロパティーを UNAVAILABLE
に設定します。IBM Content Search Services サーバーへの接続が再度確立されると、Content Engine サーバーは、
自動的にこのプロパティーを ENABLED
に設定します。このプロパティーを UNAVAILABLE
に
設定できるのは、Content Engine サーバーのみです。API を使用してこのプロパティーを UNAVAILABLE
に設定しようとすると、エラーが発生します。API を使用してこのプロパティーを設定する場合、Content Engine サーバーは、次の状況値間の 手動遷移のみをサポートします。
ENABLED
から DISABLED
DISABLED
から ENABLED
UNAVAILABLE
から ENABLED
UNAVAILABLE
から DISABLED
CmTextSearchServer
オブジェクトのリスト。このリストは Content Engine サーバーによって維持され、読み取り専用です。
IBM Content Search Services オブジェクトは、API を使用して、サーバーの CmTextSearchServer
オブジェクトを
直接操作することで、このリストに追加したり、リストから削除することができます。
Content Platform Engine は、索引サーバー状況に基づいて、ワーカー・スレッドの数を自動的に増減させ、受信したワークで IBM Content Search Services が過負荷状態にならないようにします。この自動スケーリングは、以下の計算に従って、ベース値として ThreadCount プロパティーの値を使用します。
1 つの CPE インスタンス当たりの最大ワーカー数 = ベース値 * (実行中の CSS サーバー数 / 構成されている CSS サーバー数)
この計算で、CPE インスタンス は Content Platform Engine インスタンスを指し、CSS サーバー は IBM Content Search Services 索引サーバーを指します。 構成されている CSS サーバー数には、状況が UNAVAILABLE または ENABLED (つまり、DISABLED 以外のすべての状況) の、登録されているすべての索引サーバーが含まれます。実行中の CSS サーバー数には、状況が ENABLED の、構成されているすべてのサーバーが含まれます。 例えば、4 つの索引サーバーを Content Platform Engine に登録して有効にし、ベース値を 20 に設定した場合を考えます。 通常の状態では、構成されているすべての CSS サーバーは実行中であり、計算されるワーカー・スレッドの最大数は、ベース値と同じ (20 * (4 / 4) = 20) になります。通常の状態ではなく、構成されている一部の CSS サーバーが実行されていない場合、計算される最大数は、ベース値よりも小さくなります。 例えば、実行中の索引サーバーが 3 つのみである場合、計算される最大数は 15 (20 * (3 / 4) = 15) になります。
なお、このプロパティーは、CmTextSearchServer
クラスの MaximumConcurrentIndexingBatches プロパティーと連携して、Content Platform Engine インスタンスの索引処理の作業負荷を制御します。索引処理の最大ワーカー・スレッド数が同時バッチ数と同じになる必要はありません。
十分なコンピューティング・リソースがあるとして、すべての Content Platform Engine インスタンスで同時バッチ数よりも多いワーカー・スレッドがあれば、それは正常な状態です。
このプロパティーが設定されていない場合は、ContentTempDirectoryRoot プロパティーで指定されたディレクトリーが使用されます。
null
になります。このプロパティーは、索引処理ジョブに含まれる要求が完了したことを示すわけではありません (この情報については「JobStatus
」プロパティーを参照してください)。UpgradeAddOn
オブジェクトを適用した結果として論理的に生成されるアドオンのバージョンを識別する ID のリストを指定します。このリストには、1 つ以上の ID が含まれている必要があります (通常は ID が 1 つだけ含まれています)。Folder
オブジェクトを含む FolderSet
コレクション・オブジェクト。PDF パブリッシュ・イベント・ハンドラーに関連付けられているパブリッシュ・スタイル・テンプレートでは、(TransformationOptions プロパティー内に XML として格納される) PDF セキュリティー設定値および電子透かし設定値を必要に応じて指定できます。HTML パブリッシュ・イベント・ハンドラーに関連付けられているパブリッシュ・スタイル・テンプレートの場合は、TransformationOptions プロパティーに設定値が指定されることはありません。
URICR
である場合です。その他のコンポーネント関係タイプの場合は、ChildComponent プロパティーを設定することによって子コンポーネントを指定します。ComponentRelationshipType プロパティーを URICR
以外の値に設定すると、URIValue プロパティーの値は null
になります。このプロパティーには任意の String
値を入力できます。この値は、必ずしも有効な URI アドレスである必要はありません。true
) 割り当てないか (false
) を指定します。(これらの発生順の ID は順次 ID です。) このプロパティーの値が true
に設定されている場合、このオブジェクト・ストア内で作成される新しいオブジェクトには、ランダム ID の代わりに順次 ID が割り当てられます。
順次 ID では、時間ベースおよびカウンター・ベースの部分がランダム部分と結合されます。これにより、作成される連続 ID は、基礎データベースによって適用される自然順序付けに従って順次的 (単調) になります。順次 ID を含む主キーのクラスター化された索引を使用する索引付きデータベース列またはテーブルは、完全にランダムな ID が使用されている場合よりも、データをコンパクトに保管し、効率的に管理できることがあります。そのため、パフォーマンスの向上およびスペースの節約を実現できる可能性があります。
ClassDefinitionSet
オブジェクトを指定します。samAccountName
uid
cn
cn
cn
cn
null
値を戻します。
UserDomain プロパティー、UserName プロパティー、および UserPassword プロパティーの値は、索引付け処理および検索操作を行うために、Content Engine サーバーが IBM Legacy Content Search Engine での認証に使用します。
"(&(objectClass=user_defined_class)(an_attribute={0}))"
の形式にする必要があります。ここで、user_defined_class には必要なオブジェクト・クラス (例: user または person) が入り、an_attribute には LDAP サーバー固有の属性 (例: samAccountName、cn、uid) が入ります。このプロパティーのデフォルト値はディレクトリー・サービス・プロバイダーに固有です。値は次のとおりです。
このキャッシュについて詳しくは、「セキュリティーのキャッシング」を参照してください。
このキャッシュについて詳しくは、「セキュリティーのキャッシング」を参照してください。
User.Id
プロパティーに使用する
ディレクトリー・サーバー属性を指定します。デフォルトのプロパティー値はディレクトリー・サーバー・タイプに依存し、認証プロバイダーの構成によって指定されます。サポートされている認証プロバイダーのデフォルトの SID 属性のリストについては、「セキュリティー権限について (What are access rights?)」を参照してください。
非推奨。
ディレクトリー・サーバー・ユーザー固有 ID 属性がバイナリー値または文字列値のどちらであるかを示すブール値。true
の値は、属性がバイナリー・タイプであることを示します。false
は、文字列タイプであることを示します。User
オブジェクトのコレクション。false
) 長い文字列として格納するか (true
) を指定します。長い文字列のテーブル列では、その値がテーブル内のその他の列とは別に格納されるため、テーブル行サイズの制限を回避できます。テーブルの行サイズ制限値を超えないようにするため、大きい文字列値プロパティーの格納先となるデータベース・テーブルにカスタム・プロパティーが多数存在する場合は、長い文字列の列を使用して、大きい文字列値プロパティーを格納します。長い文字列の列の実際のテキスト・データは、それ以外の列のデータベース行データとは別に格納されるため (データを取得するために追加の読み取り操作が必要なため)、パフォーマンスが若干低下する場合があります。ただし、場合によってはシステム・パフォーマンスの向上を体感することもあります。これは、オブジェクトごとの全体的な行サイズは、長い文字列の列を使用した場合に小さくなるため、取り出し時間および格納時間が短縮されるからです。
短い文字列の列とは異なり、長い文字列の列はデータベースの索引には指定できないことに注意してください。
短い文字列と長い文字列のテーブル列に関するデータベース固有の情報については、「データベース・エンジンによる差異」を参照してください。
filenet.vw.api.VWSession
インターフェースの transfer メソッドを介して) ワークフロー定義が Process Engine サーバーに転送されると、このプロパティーの値が Process Engine によって割り当てられます。true
) 検証しないか (false
) を指定します。
CmSMTPConfiguration
クラスの場合、このプロパティーを true
に設定することはサポートされていません。
true
) 検証しないか (false
) を指定します。
CmSMTPConfiguration
クラスの場合、このプロパティーを true
に設定することはサポートされていません。
VerityDomainConfiguration
オブジェクトの ExcludedBrokers プロパティーを
使用すると、Content Engine の用途からブローカーが除外されます。VerityMasterAdminServerHostname
で指定された Verity 管理サーバーに関連付けられているすべての Verity ブローカーの名前。これは、Verity から返されるブローカーのリストです。VerityCollection
オブジェクト。各 Verity コレクションは、1 つの索引域のメンバーです。
ObjectStore
オブジェクトの場合、Verity ドメイン用の IBM Legacy Content Search Engine 構成プロパティーを
含む VerityDomainConfiguration
オブジェクト。この構成で、オブジェクト・ストアによって使用される Verity ドメインが決まります。
複数のオブジェクト・ストアで同じ Verity ドメイン構成を共有できます。Domain
オブジェクトの場合、このプロパティーは非推奨です。このプロパティーは、ObjectStore
オブジェクト
に使用して、オブジェクト・ストアに Verity ドメイン構成を割り当てます。
VerityDomainConfiguration
オブジェクトを
含む VerityDomainConfigurationSet
コレクション・オブジェクト。
新規に作成された VerityDomainConfiguration
オブジェクトを保存すると、そのオブジェクトは自動的にこのセットに追加されます。
VerityMasterAdminServerHostname
プロパティーで指定された Verity 管理サーバーに関連付けられているすべての Verity 索引サーバーの名前。この索引サーバーのリストは、Verity によって返されます。VerityMasterAdminServerHostname
で指定されたマスター Verity 管理サーバーに割り当てられているポート。時間間隔は月数を表す整数値であり、年末から年始の境界をまたぐことはありません。 可能な値は null、0、1、2、3、4、6、または 12 です。値が 1 の場合は 1 カ月の間隔を対象とするコレクションが生成され、値が 2 の場合は 2 カ月の間隔を対象とするコレクションが生成されます。以下同様です。 例えば、索引付け可能なドキュメントに関連付けられた日付が 2008 年 12 月 15 日であり、VerityPartitionInterval が 3 カ月である場合、このドキュメントは、開始日が 2008 年 10 月 1 日で停止日が 2009 年 1 月 1 日であるコレクション内で索引付けされます。
デフォルトは null
であり、パーティション化機能が使用不可であることを示します。
0 の値を指定した場合も、パーティション化機能は使用不可になります。上記のリストにない値を設定すると、E_BAD_VALUE
例外が戻されます。
ObjectStore
オブジェクトが作成された後で、VerityPartitionProperty プロパティー値を変更できます。
このプロパティーは、オブジェクト・ストア上で構成されたすべての索引域に影響します。デフォルトは null
であり、パーティション化機能が使用不可であることを示します。
VerityMasterAdminServerHostname
プロパティーで指定された Verity 管理サーバーに関連付けられているすべての Verity (検索) サーバーの名前。この索引サーバーのリストは、Verity によって返されます。DYNAMIC_CR
および DYNAMIC_LABEL_CR
については、親コンポーネントにバインドされる子コンポーネントのドキュメント・バージョンが決定されます。それ以外のコンポーネント関係タイプでは、このプロパティーの値が null
になります。(ドキュメントのバインドの詳細については、「ComponentRelationshipType」プロパティーを参照してください。)VersionBindType クラスには、バインド・タイプの設定用に定数が定義されています。有効な設定は次のとおりです。
LATEST_VERSION
: すべてのドキュメント・バージョン (メジャーおよびマイナー) がバインディングの候補と見なされます。LATEST_MAJOR_VERSION
: メジャー・ドキュメント・バージョンのみがバインディングの候補と見なされます。DynamicReferentialContainmentRelationship
オブジェクトに関連付けられているすべてのドキュメント・バージョンが格納されている VersionSeries
オブジェクトを指定します。その他のバージョン管理関連イベントの場合は、ソース・オブジェクトのバージョン・シリーズの ID です。このプロパティーに有効な値が入るのは、イベントのソース・オブジェクトが Document
またはそのサブクラスのインスタンスである場合のみです。バージョン管理不可能なオブジェクトの場合、このプロパティーは null です。
VersionStatus
定数を指定します。VersionStatus プロパティーには、次の表のいずれかの値が入ります。
名前 | 値 | 説明 |
---|---|---|
IN_PROCESS (処理中) |
2 | 処理中のドキュメント・バージョンを示します。処理中のバージョンとは、チェックインされているバージョンで、最新のマイナー・バージョンのことです。ある特定のバージョン・シリーズでは、IN_PROCESS 状態にすることができるのは、一度に 1 つのバージョンのみです。予約バージョンがマイナー・バージョンとしてチェックインされ、それが新規の処理中バージョンになると、以前の処理中バージョンは置換済みバージョンになります。 |
RELEASED (リリース済み) |
1 | リリース済みのドキュメント・バージョンを示します。リリース済みのバージョンとは、チェックインされているバージョンで、最新のメジャー・バージョンのことです。ある特定のバージョン・シリーズでは、RELEASED 状態にすることができるのは、一度に 1 つのバージョンのみです。 |
RESERVATION (予約) |
3 | 予約ドキュメント・バージョンを示します。予約バージョンとは、チェックアウトされているバージョンのことです。 |
SUPERSEDED (置換済み) |
4 | 置換済みのドキュメント・バージョンを示します。置換済みのバージョンとは、より新しいバージョンによって置き換えられたメジャー・バージョンまたはマイナー・バージョンのことです。 |
VersionableSet
オブジェクトを指定します。VirtualServer
オブジェクトのコレクションを表します。Weekday
列挙型の値 (Weekday.SUNDAY
、Weekday.MONDAY
など) に対応します。InstanceWorkflowSubscription
あるいは ClassWorkflowSubscription
) オブジェクトが格納されている SubscriptionSet
コレクション。XMLPropertyMappingScript
オブジェクトの適用先となるソース XML ドキュメントのタイプを指定します。このプロパティーの値は次のいずれかになります。DocumentClassDefinition
オブジェクトに関連付けられている XMLPropertyMappingScript
オブジェクトのコレクションを内蔵している XMLPropertyMappingScriptSet
オブジェクトを指定します。各 XMLPropertyMappingScript
オブジェクトには、特定のタイプの XML ドキュメントに登録されているプロパティー・マッピング XSL スクリプトが格納されています。このスクリプトでは、XML ドキュメントからコンテンツを抽出して、それを特定のドキュメント・クラスに関連付けられているプロパティー値にマップします。
DocumentClassDefinition
オブジェクトの場合は、このプロパティーにより、この DocumentClassDefinition
オブジェクトをその TargetClass プロパティーの値として指定した一連の XMLPropertyMappingScript
オブジェクトが指定されます。