共通キャプチャ・クラスの使用

8 共通キャプチャ・クラスの使用

この章では、認識プロセッサおよびインポート・プロセッサに関連する共通キャプチャ・クラスについて説明します。

これは、認識プロセッサ・スクリプトおよびインポート・プロセッサ・スクリプトの設計に使用可能なクラスに加えて使用できるクラスです。認識プロセッサ・クラスおよびインポート・プロセッサ・クラスの詳細は、「認識プロセッサのクラス」および「インポート・プロセッサのクラス」を参照してください。

共通キャプチャ・クラス

認識プロセッサおよびインポート・プロセッサに関連するクラスは、次のとおりです:

BatchEntity

BatchEntityクラスは、Captureワークスペース内のバッチを表します。バッチは、バッチ・アイテムおよびドキュメントのコレクションです。

プロパティ	タイプ	説明
itemID	String	一意のバッチ・アイテム識別子。
id	Integer	一意のバッチID。
state	Integer	バッチの現在の状態。次のいずれかの値になります: 1 - 準備完了 2 – ロック済 16 – エラー 32 – 処理中
errorMessage	String	処理の失敗に関連するエラー・メッセージ。
status	BatchStatusEntity	バッチの現在のステータスを表すBatchStatusEntityへの参照。
priority	Integer	バッチの現在の優先度値。
itemCount	Integer	バッチ内のアイテムの数。
userID	String	バッチを作成したユーザーのユーザーID。
workstationID	String	バッチを作成したシステムのホスト名。
comment	byte[]	バッチに関するコメントまたはノート。
dateTime	Date	バッチが作成された日時。
workspace	CaptureWorkspaceEntity	バッチが属するワークスペースへの参照。
documents	List<DocumentEntity>	バッチ内に存在するDocumentEntity参照のリスト。
items	List<BatchItemEntity>	バッチに関連付けられたバッチ・アイテムのリスト。
lastModifiedDateTime	Date	バッチが最後に変更された日時。
lastModifiedUserID	String	バッチを最後に変更したユーザーのID。
batchName	String	バッチの名前。

BatchItemEntity

BatchItemEntityクラスは、バッチ内のバッチ・アイテムを表します。BatchItemEntityは、バッチ内のドキュメントの作成に使用されるDocumentPageEntityに関連付けられています。

プロパティ	タイプ	説明
itemID	String	一意のバッチ・アイテム識別子。
sourceFileName	String	アイテムの元のファイル名。アイテムがインポートされたファイルである場合に便利です。
sourceFormat	String	イメージ以外のファイルの場合、これは通常、ファイル拡張子(DOC、XLS、PDF)です。イメージ・ファイルの場合、値は空になります。
patchCode	Integer	パッチ・コードが読み取られた場合のパッチ・コード値。
barcodeCount	Integer	バー・コード検出中に読み取られたバー・コードの数。
linkCount	Integer	アイテムにリンクされているドキュメントの数。
fileLength	Long	アイテムのサイズ(バイト)。
barcodes	String[]	バー・コード認識中に読み取られたバー・コード値を表す文字列の配列。

BatchLockEntity

BatchLockEntityクラスは、バッチに対するロックを表します。ロックは、ユーザーおよびプロセッサが同じバッチに同時にアクセスできないようにするために使用します。

プロパティ	タイプ	説明
id	String	一意のバッチ・ロックID。
batch	BatchEntity	ロックされたバッチへの参照。
batchName	String	バッチ・ロックが適用されるバッチの名前。
workspace	CaptureWorkspaceEntity	バッチが属するワークスペースへの参照。
workspaceName	String	バッチが属するワークスペースの名前。
lockDate	Date	バッチ・ロックが作成された日付。
userID	String	バッチをロックしたユーザーのID。
computerName	String	バッチのロックに使用されるコンピュータの名前。
processID	String	バッチのロックに使用されるプロセスID。

BatchManagerSession

BatchManagerSessionクラスには、アクションを監査し、バッチ、ドキュメント、ドキュメント・ページおよびバッチ・アイテム・オブジェクトを操作するためのメソッドがあります。これには、作成、読取り、更新、削除、移動などが含まれます。

このクラスには、次のメソッドが含まれます:

auditActivity()

次の表では、auditActivity()メソッドの構文について説明します:

構文	説明
`public void auditActivity(BatchLockEntity ble, Integer actionID, int dataInt, float dataFloat, String dataText1, String dataText2, String dataText3, String dataText4, String dataText5) throws CaptureException`	プロセスで定義されたアクションについて、監査レコードをデータベースに書き込みます。

次の表では、auditActivity()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
ble	BatchLockEntity	処理中のバッチに対するバッチ・ロック。
actionID	Integer	ログに記録するアクションの識別子。これはプロセスに固有です。
dataInt	int	プロセスおよびアクションに固有の整数。
dataFloat	Float	プロセスおよびアクションに固有の浮動小数。
dataText1	String	プロセスおよびアクションに固有のテキスト値。
dataText2	String	プロセスおよびアクションに固有のテキスト値。
dataText3	String	プロセスおよびアクションに固有のテキスト値。
dataText4	String	プロセスおよびアクションに固有のテキスト値。
dataText5	String	プロセスおよびアクションに固有のテキスト値。

calculateTotalDocumentPagesInBatch()

次の表では、calculateTotalDocumentPagesInBatch()メソッドの構文について説明します:

構文	説明
`public Integer calculateTotalDocumentPagesInBatch(String batchID) throws CaptureException)`	ドキュメントにリンクされたバッチ・アイテムの合計数を計算します。

次の表では、calculateTotalDocumentPagesInBatch()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchID	String	バッチの識別子。

次の表では、calculateTotalDocumentPagesInBatch()メソッドで返される値について説明します:

値	タイプ	説明
return	Integer	バッチ内のドキュメント・ページの合計数を表す整数。

createDocument()

次の表では、createDocument()メソッドの構文について説明します:

構文	説明
`public String createDocument(String batchLockID, DocumentEntity doc, Integer insertionPoint) throws BatchLockException, CaptureException`	指定されたロック済バッチにドキュメント・オブジェクトを関連付けます。

次の表では、createDocument()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
doc	DocumentEntity	バッチに関連付けられるドキュメント・エンティティ。
insertionPoint	Integer	このドキュメントを挿入するドキュメント番号。

次の表では、createDocument()メソッドで返される値について説明します:

値	タイプ	説明
return	String	一意のドキュメント識別子。

createDocumentAttachments()

次の表では、createDocumentAttachments()メソッドの構文について説明します:

構文	説明
`public void createDocumentAttachments(String batchLockID, List<DocumentEntity> documents, List<BatchItemEntity> items, Integer insertionPoint, Boolean reNumberFirstDocument, String parentDocID) throws BatchLockException, CaptureException`	指定されたドキュメントへの添付としてのDocumentEntitiesおよびデータベースへのBatchItemEntitiesのコレクションを作成します。クライアントはこのメソッドをコールすると、サーバーに繰り返しリクエストを行わなくても、一連のバッチ・アイテムおよびドキュメント・エンティティを作成できます。

次の表では、createDocumentAttachments()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
documents	List<DocumentEntity>	データベースの永続性を必要とするドキュメント・オブジェクトのコレクション。
items	List<BatchItemEntity>	データベースの永続性を必要とするバッチ・アイテム・オブジェクトのコレクション。
insertionPoint	Integer	ドキュメントの挿入場所を表す整数。
reNumberFirstDocument	Boolean	最初のドキュメントに再度番号を付けるかどうかを示すブール値。最初のドキュメントがデータベースにすでに存在する場合は、Falseを指定する必要があります。
parentDocID	String	添付と関連付ける親ドキュメントの識別子。

deleteDocument()

次の表では、deleteDocument()メソッドの構文について説明します:

構文	説明
`public void deleteDocument(String batchLockID, String documentID) throws BatchLockException, CaptureException`	指定されたロック済バッチ内のドキュメントを削除します。

次の表では、deleteDocument()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
documentID	String	削除するドキュメントの一意識別子。

findDocumentByID()

次の表では、findDocumentByID()メソッドの構文について説明します:

構文	説明
`public DocumentEntity findDocumentByID(String docID) throws CaptureException`	識別子を使用してDocumentEntityを検索します。

次の表では、findDocumentByID()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
docID	String	検索するドキュメントの一意識別子。

次の表では、findDocumentByID()メソッドで返される値について説明します:

値	タイプ	説明
return	DocumentEntity	一致するドキュメントが見つかった場合、そのドキュメントの関連するエンティティが返されます。一致が見つからなかった場合は、nullが返されます。

findBatchItemByID()

次の表では、findBatchItemByID()メソッドの構文について説明します:

構文	説明
`public BatchItemEntity findBatchItemByID(String docPageID) throws CaptureException`	指定されたdocPageIDのBatchItemEntityを検索します。

次の表では、findBatchItemByID()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
docPageID	String	検索するバッチ・アイテムの一意識別子。

次の表では、findBatchItemByID()メソッドで返される値について説明します:

値	タイプ	説明
return	BatchItemEntity	一致するバッチ・アイテムが見つかった場合、そのバッチ・アイテムの関連するエンティティが返されます。一致が見つからなかった場合は、nullが返されます。

linkItemToDocument()

次の表では、linkItemToDocument()メソッドの構文について説明します:

構文	説明
`public DocumentPageEntity linkItemToDocument(String batchLockID, String imageID, String documentID, Integer documentPage) throws CaptureException, BatchLockException`	バッチ・アイテムをドキュメントに関連付けます。

次の表では、linkItemToDocument()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの識別子。
imageID	String	バッチ・アイテムの識別子。
documentID	String	ドキュメントの識別子。
documentPage	Integer	このアイテムのページ番号。

次の表では、linkItemToDocument()メソッドで返される値について説明します:

値	タイプ	説明
return	DocumentPageEntity	リンクされたページを含むDocumentPageEntity参照。

loadBatchItems()

次の表では、loadBatchItems()メソッドの構文について説明します:

構文	説明
`public List<BatchItemEntity> loadBatchItems(String batchID) throws CaptureException`	指定されたバッチに属するバッチ・アイテムのリストを返します。

次の表では、loadBatchItems()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchID	String	バッチの一意識別子。

次の表では、loadBatchItems()メソッドで返される値について説明します:

値	タイプ	説明
return	List<BatchItemEntity>	バッチに属するアイテムのコレクション。

loadDocumentPages()

次の表では、loadDocumentPages()メソッドの構文について説明します:

構文	説明
`public List<DocumentPageEntity> loadDocumentPages(String documentID) throws CaptureException`	バッチに関連付けられたドキュメント・オブジェクトのコレクションを返します。

次の表では、loadDocumentPages()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
documentID	String	ドキュメントの識別子。

次の表では、loadDocumentPages()メソッドで返される値について説明します:

値	タイプ	説明
return	List<DocumentPageEntity>	ドキュメントに関連付けられたドキュメント・ページのコレクション。

loadDocuments()

次の表では、loadDocuments()メソッドの構文について説明します:

構文	説明
`public List<DocumentEntity> loadDocuments(String batchID) throws CaptureException`	バッチに関連付けられたドキュメント・オブジェクトのコレクションを返します。

次の表では、loadDocuments()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchID	String	バッチの一意識別子。

次の表では、loadDocuments()メソッドで返される値について説明します:

値	タイプ	説明
return	List<DocumentEntity>	ドキュメントに関連付けられたドキュメント・ページのコレクション。

loadDocumentAttachments()

次の表では、loadDocumentAttachments()メソッドの構文について説明します:

構文	説明
`public List<DocumentEntity> loadDocumentAttachments(String docID) throws CaptureException`	指定されたドキュメントに添付されたドキュメント・オブジェクトのコレクションを返します。

次の表では、loadDocumentAttachments()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
docID	String	ソース・ドキュメントの一意識別子。

次の表では、loadDocumentAttachments()メソッドで返される値について説明します:

値	タイプ	説明
return	List<DocumentEntity>	ソース・ドキュメントに添付されたドキュメントのコレクション。

persistBatch()

次の表では、persistBatch()メソッドの構文について説明します:

構文	説明
`public void persistBatch(String batchLockID, BatchEntity be) throws BatchLockException, CaptureException`	指定されたバッチをデータベースに対して永続化します。

次の表では、persistBatch()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
be	BatchEntity	更新されるバッチ・エンティティ。

persistBatchItem()

次の表では、persistBatchItem()メソッドの構文について説明します:

構文	説明
`public BatchItemEntity persistBatchItem(String batchLockID, BatchItemEntity entity) throws BatchLockException, CaptureException`	アイテムを指定されたロック済バッチに対して永続化します。

次の表では、persistBatchItem()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの識別子。
entity	BatchItemEntity	永続化するBatchItemEntity。

次の表では、persistBatchItem()メソッドで返される値について説明します:

値	タイプ	説明
return	BatchItemEntity	永続化されたBatchItemEntityオブジェクトへの参照。

persistDocument()

次の表では、persistDocument()メソッドの構文について説明します:

構文	説明
`public void persistDocument(String batchLockID, DocumentEntity document) throws CaptureException`	バッチ内の特定のドキュメント・エンティティを永続化します。

次の表では、persistDocument()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの識別子。
document	DocumentEntity	永続化するDocumentEntity。

unlinkDocumentPage()

次の表では、unlinkDocumentPage()メソッドの構文について説明します:

構文	説明
`public void unlinkDocumentPage(String batchLockID, String documentPageID) throws BatchLockException, CaptureException`	指定されたページ・コレクション内のドキュメント・ページと、その関連ドキュメントとのリンクを解除します。

次の表では、unlinkDocumentPage()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
documentPageID	String	リンクを解除するページの識別子。

deleteDocumentPages()

次の表では、deleteDocumentPages()メソッドの構文について説明します:

構文	説明
`public void deleteDocumentPages(String batchLockID, List<DocumentPageEntity> pages) throws BatchLockException, CaptureException`	ページ・コレクション内の指定されたドキュメント・ページと、その関連ドキュメントとのリンクを解除します。

次の表では、deleteDocumentPages()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
pages	List<DocumentPageEntity>	各ドキュメントとのリンクを解除する必要があるページのコレクション。

insertItemsIntoDocument()

次の表では、insertItemsIntoDocument()メソッドの構文について説明します:

構文	説明
`public void insertItemsIntoDocument(String batchLockID, String docID, Integer insertionPoint, List<BatchItemEntity> items) throws BatchLockException, CaptureException`	アイテム・コレクション内のバッチ・アイテム・エンティティをデータベースに対して永続化し、指定されたドキュメント内のアイテムへのリンクを作成します。

次の表では、insertItemsIntoDocument()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの一意識別子。
docID	String	アイテムの挿入先のドキュメントの識別子。
insertionPoint	Integer	アイテムを挿入する必要があるポイント。
items	List<BatchItemEntity>	永続性を必要とするアイテムのコレクション。

splitDocument()

次の表では、splitDocument()メソッドの構文について説明します:

構文	説明
`public DocumentEntity splitDocument(String batchLockID, String sourceDocID, Integer docBreakPoint, String newDocTitle) throws BatchLockException, CaptureException`	指定されたブレーク・ポイントでソース・ドキュメントを新しいドキュメントに分割します。データベース内に新しいドキュメントが作成され、ソース・ドキュメント内の指定されたブレーク・ポイント以降のすべてのページが新しいドキュメントに移動されて、ソースから削除されます。

次の表では、splitDocument()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	操作中のバッチの有効なバッチ・ロック識別子。
sourceDocID	String	分岐するページが含まれるソース・ドキュメント。
docBreakPoint	Integer	移動するページの開始ページ番号。
newDocTitle	String	作成される新しいドキュメントのタイトル。

次の表では、splitDocument()メソッドで返される値について説明します:

値	タイプ	説明
return	DocumentEntity	ソース・ブランチからのページが含まれる新しいドキュメント・エンティティ。

mergeDocuments()

次の表では、mergeDocuments()メソッドの構文について説明します:

構文	説明
`public void mergeDocuments(String batchLockID, MetadataMergeOption mergeOption,DocAttachmentIncludeOption attachmentIncludeOption, DocumentEntity sourceDocument, List<DocumentEntity> destinationDocuments, boolean addToBeginning) throws CaptureException, BatchLockException`	2つのドキュメントを1つにマージします。

次の表では、mergeDocuments()メソッドのパラメータについて説明します:

パラメータ	タイプ	説明
batchLockID	String	バッチ・ロックの識別子。
mergeOption	MetadataMergeOption	マージ中にドキュメント索引を処理する方法を示します。可能な値は次のとおりです: discardSourceValues applySourceValuesOverwrite applySourceValuesDoNOTOverwrite
attachmentIncludeOption	DocAttachmentIncludeOption	マージ中にドキュメント添付を処理する方法を示します。可能な値は次のとおりです: doNotInclude includeAll includeOnlyMatches (添付タイプが一致する添付のみを含める)
sourceDocument	DocumentEntity	ソース・ドキュメント・エンティティ。
destinationDocuments	List<DocumentEntity>	宛先ドキュメント・コレクション。
addToBeginning	Boolean	ソース・ドキュメントを宛先ドキュメント・コレクションの先頭にマージするかどうかを示します。

BatchStatusEntity

BatchStatusEntityクラスは、Captureワークスペース内のバッチ・ステータスを定義します。バッチ・ステータスは、Captureワークスペース内でバッチに関連付けることができます。

プロパティ	タイプ	説明
statusID	String	ステータスの一意識別子。
value	String	ステータスのテキスト値。
workspaceEntity	CaptureWorkspaceEntity	ステータスが定義されているワークスペースへの参照。

CaptureWorkspaceEntity

CaptureWorkspaceEntityクラスは、Captureシステム内のワークスペースを表します。ワークスペースは、メタデータ、ドキュメント・プロファイルおよびバッチ・ステータスを定義します。

プロパティ	タイプ	説明
workspaceID	String	一意のワークスペース識別子。
workspaceName	String	ワークスペースの名前
description	String	ワークスペースの説明。
dateCreated	Date	ワークスペースが作成された日付。
dateLastModified	Date	ワークスペースが最後に変更された日付。
createdBy	String	ワークスペースを作成したユーザーのユーザーID。
lastModifiedBy	String	ワークスペースを最後に変更したユーザーのユーザーID。
indexDefinitions	List<IndexDefinitionEntity>	ワークスペース内で定義されている索引定義エンティティのリスト。
statuses	List<BatchStatusEntity>	ワークスペース内で定義されているバッチ・ステータスのリスト。
documentTypes	List<DocumentTypeEntity>	ワークスペース内で定義されているドキュメント・プロファイルのリスト。

DBSearchResults

DBSearchResultsクラスには、データベース参照の実行で返された情報が含まれます。また、返された行のリストと、行の列を説明する検索フィールド情報のリストも含まれます。

プロパティ	タイプ	説明
resultsList	List<DbSearchResultRow>	データベース参照からの行のリスト。
fieldInfoList	List<DbSearchFieldInfo>	データベース参照で使用される列を説明する検索フィールド情報のリスト。

DBSearchResultRow

DbSearchResultRowクラスは、データベース参照から返される1行の結果を表します。

プロパティ	タイプ	説明
results	List<String>	1つの検索結果に関連付けられている文字列値のリスト。このリスト内の値の順序は、戻りフィールドが定義されている順序と同じです。

DBSearchFieldInfo

DbSearchFieldInfoクラスは、データベース参照の結果の説明であるフィールド情報を表します。

プロパティ	タイプ	説明
captureIndexDefID	String	メタデータ・フィールドID。
dbColumnName	String	データベース列の名前。
dbColumnType	Integer	データベース列のタイプ。
captureFieldType	Integer	メタデータ・フィールドのデータ型。

DocumentEntity

DocumentEntityクラスは、バッチ内のドキュメントを表します。ドキュメントは、BatchItemEntity参照を参照するDocumentPageEntity参照のコレクションで構成されます。

プロパティ	タイプ	説明
documentID	String	ドキュメントを一意に識別する値。
documentTitle	String	ドキュメント・タイトル。
documentNumber	Integer	バッチ内のドキュメントの位置。
batchEntity	BatchEntity	ドキュメントが属するバッチへの参照。
documentPages	List<DocumentPageEntity>	ドキュメントを構成するドキュメント・ページ・エンティティ参照のリスト。
documentType	DocumentTypeEntity	ドキュメントに関連付けられたdocumentTypeへの参照。
indexes	List<IndexValue>	ドキュメントの索引値のリスト。
documentState	Integer	ドキュメントの現在の状態。次のいずれかの値になります: 1 (準備完了) – ドキュメントをコミットする準備ができています。 2 (保留) – ドキュメントはコミット・プロセッサによりコミットされません。
lastModifiedDateTime	Date	ドキュメントが最後に変更された日時。
lastModifiedUserID	String	ドキュメントを最後に変更したユーザーのID。

DocumentPageEntity

DocumentPageEntityクラスは、ドキュメント内のページを表します。バッチ内のBatchItemEntityを参照し、親ドキュメント内のページの位置を表すページ番号を含みます。

プロパティ	タイプ	説明
docPageID	String	ドキュメント・ページを一意に識別する値。
batchItemEntity	BatchItemEntity	ドキュメント・ページに関連付けられたBatchItemEntityへの参照。
documentEntity	DocumentEntity	ページが属するDocumentEntityへの参照。
pageNumber	int	ドキュメント内のページの位置。

DocumentTypeEntity

DocumentTypeEntityクラスは、Captureワークスペース内のドキュメント・プロファイルを定義します。DocumentTypeEntityは、名前、説明、およびドキュメント・プロファイルに関連する索引定義フィールドのリストで構成されます。

プロパティ	タイプ	説明
docTypeID	String	ドキュメント・プロファイルの一意識別子。
docTypeName	String	ドキュメント・プロファイルの名前。
description	String	ドキュメント・タイプの説明。
workspaceEntity	CaptureWorkspaceEntity	ドキュメント・プロファイルが属する親ワークスペース。
fields	List<IndexDefinitionEntity>	ドキュメント・プロファイルに関連付けられたIndexFieldDefinitionEntityオブジェクト参照のリスト。

IndexDefinitionEntity

IndexDefinitionEntityは、ワークスペース内で定義された索引定義を表します。索引定義は、入力に使用できるメタデータ・フィールドを定義します。

プロパティ	タイプ	説明
indexFieldID	String	索引定義の一意識別子。
fieldName	String	フィールドの名前。
workspaceEntity	CaptureWorkspaceEntity	フィールドが定義されている親ワークスペースへの参照。
dataType	Integer	フィールドのデータ型。 0 – 数値 1 – 英数字 3 – 日付 4 – 浮動小数
maxLength	Integer	フィールドに格納される最大文字数。
minValue	Float	使用できる最小値。
maxValue	Float	使用できる最大値。
required	Boolean	コミット時にフィールドに値が存在することを必要とする場合はTrueに設定し、そうでない場合はFalseに設定します。デフォルト値は、Falseです。
defaultValue	String	フィールドのデフォルト値。
inputMask	String	フィールドに定義されている入力マスク。
displayFormat	String	フィールドの表示形式。
locked	Boolean	フィールドへの入力がロックされているかどうかを示します。
autoPopulate	Integer	次の値があります: 0 – なし 1 – デフォルト値 2 – スキャン日付 3 – 現在日 4 – バッチ名 5 – ユーザーID 6 – ホスト名 7 – プロファイル名 8 – バッチ・ステータス 9 – バッチ優先度 10 – ドキュメント・タイプ
validationExpression	String	フィールド値の検証に使用される正規表現文字列。

IndexValue

IndexValueクラスは、ドキュメント内のメタデータ・フィールドの値を表します。これには、ユーザーに表示される表示値と、コミット時に使用されるfieldValueが含まれます。

プロパティ	タイプ	説明
fieldID	String	索引値に関連付けられたIndexDefinitionEntityの一意識別子。
fieldValue	String	ドキュメントのコミット時に使用されるフィールドの値。
displayValue	String	ユーザーに表示される値。コミット時にこの値は使用されません。