メインコンテンツへスキップ

機能

画像ファイルから新しい文書をバッチに追加します。 画像なしで文書を作成するには、file パラメーターを空のままにします (file.Name = "", file.Bytes = new bytes [0]) 。 新しい文書は、excludeFromAutomaticAssembling フラグが true に設定された状態で作成されます。このフラグは、その文書がすでにアセンブリ済みであり、バッチタイプに指定されたアセンブリ設定がその文書には適用されないことを示します。
新しく追加した文書にアクセスできるようになるのは、その画像の前処理が完了した後です。新しい文書を追加した後にバッチ処理を開始するには、ProcessBatch メソッドを使用します。
新しい文書をバッチに追加する場合、対応するオブジェクトの Id フィールドは空であってはなりません。
PDF 文書を追加し、そのテキストレイヤーに保存されているテキストをプログラムで使用したい場合は、それらの文書の処理に使用される Project で、OCR の代わりに PDF テキストレイヤーを使用 オプションが選択されていることを確認してください (このオプションは 処理 タブの ページのプロパティ ダイアログにあります) 。

定義

int AddNewDocument( int sessionId, Document document, File file, bool excludeFromAutomaticAssembling, int previousItemId );

パラメーター

sessionId

int

Application Server への接続 ID

document

Document

作成する文書の説明

file

File

文書画像を含むファイル

excludeFromAutomaticAssembling

bool

文書を文書アセンブリの対象から除外するかどうかを示すフラグです。

  • True - 文書はすでにアセンブリ済みであり、文書アセンブリには含まれません。
  • False - 文書は、バッチタイプに指定された設定に従ってアセンブリされます。

previousItemId

int

セット内での新しい文書の位置を明示的に指定する ID です。

  • -1 - 新しい文書はセットの末尾に追加されます
  • 0 - 新しい文書はセットの先頭に追加されます
  • 文書 ID - 新しい文書はこの ID を持つ文書の後に追加されます
    注: この ID を持つ文書が存在している必要があります。
POST リクエストを使用して文書画像を追加することもできます。この場合は、このメソッドで空のファイルを持つ文書を作成します (file.Name = “FileName”, file.Bytes = new bytes [0]) 。その後、次のパラメーターを指定して POST リクエストを実行します。
  • Action = Save
  • objectType = 0
  • objectId = documentId (documentId は AddNewDocument メソッドによって返される document ID)
  • version = 0
  • streamName = “C:\Temp\image.pdf” (image.pdf は、AddNewDocument メソッドの呼び出し時に指定したファイル名です)

戻り値

説明
int作成されたドキュメントの ID