Zum Hauptinhalt springen

​
Was diese Methode bewirkt

Fügt einem Batch ein neues Dokument aus einer Bilddatei hinzu. Um ein Dokument ohne Bild zu erstellen, lassen Sie den Parameter file leer (file.Name = "", file.Bytes = new bytes [0]). Ein neues Dokument wird mit dem Flag excludeFromAutomaticAssembling erstellt, das auf true gesetzt ist. Dieses Flag gibt an, dass das Dokument bereits zusammengestellt wurde und die für den Batch-Typ festgelegten Einstellungen für die Zusammenstellung nicht auf dieses Dokument angewendet werden.
Neu hinzugefügte Dokumente sind erst verfügbar, nachdem ihre Bilder vorverarbeitet wurden. Verwenden Sie die Methode ProcessBatch, um die Batch-Verarbeitung nach dem Hinzufügen neuer Dokumente zu starten.
Wenn dem Batch ein neues Dokument hinzugefügt wird, darf das Feld Id des entsprechenden Objekts nicht leer sein.
Wenn Sie PDF-Dokumente hinzufügen und möchten, dass das Programm den in ihrer Textebene gespeicherten Text verwendet, stellen Sie sicher, dass für das Projekt, in dem die Dokumente verarbeitet werden, die Option PDF-Textebene anstelle von OCR verwenden ausgewählt ist (Sie finden diese Option auf der Registerkarte Verarbeitung des Dialogfelds Seiteneigenschaft).

​
Definition

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

​
Parameter

sessionId

int

Die ID der Verbindung zum Application Server

document

Document

Eine Beschreibung des Dokuments, das erstellt wird

file

File

Die Datei, die das Dokumentbild enthält

excludeFromAutomaticAssembling

bool

Ein Flag, das angibt, ob das Dokument von der Dokumentassemblierung ausgeschlossen ist:

  • True - das Dokument wurde bereits assembliert und wird nicht in die Dokumentassemblierung einbezogen;
  • False - das Dokument wird gemäß den für den Batch-Typ angegebenen Einstellungen assembliert.

previousItemId

int

Die ID, die die Position des neuen Dokuments im Set explizit angibt:

  • -1 - das neue Dokument wird am Ende des Sets hinzugefügt
  • 0 - das neue Dokument wird am Anfang des Sets hinzugefügt
  • Document ID - das neue Dokument wird nach dem Dokument mit dieser ID hinzugefügt
    Hinweis: Ein Dokument mit dieser ID muss vorhanden sein.
Sie können auch eine POST-Anforderung verwenden, um ein Dokumentbild hinzuzufügen. Erstellen Sie dazu mit dieser Methode ein Dokument mit einer leeren Datei (file.Name = “FileName”, file.Bytes = new bytes [0]). Führen Sie dann eine POST-Anforderung mit den folgenden Parametern aus:
  • Action = Save
  • objectType = 0
  • objectId = documentId, wobei documentId die von der Methode AddNewDocument zurückgegebene Dokument-ID ist
  • version = 0
  • streamName = “C:\Temp\image.pdf”, wobei image.pdf der Name der Datei ist, die beim Aufruf der Methode AddNewDocument angegeben wurde

​
Rückgabewert

TypBeschreibung
intDie ID des erstellten Dokuments