> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IBatch

> IBatch repräsentiert einen Batch in FlexiCapture-Skripten: Dokumente und Seiten verschieben und löschen, Seiten aus Bildern erstellen sowie Stapeleigenschaften und SLA-Daten lesen.

<div id="what-it-does">
  ## Was es tut
</div>

Stellt den Batch dar.

<a id="webverificationavailableinterface" />

<Note>
  Einige Methoden und Eigenschaften dieses Objekts sind in der Web-Verifizierungsstation für die lokale Überprüfung von Regeln nicht verfügbar. Nicht unterstützte Methoden und Eigenschaften sind mit einem Sternchen (\*) gekennzeichnet.
</Note>

<div id="methods">
  ## Methoden
</div>

<Warning>
  Die unten aufgeführten Methoden erfordern Berechtigungen zum Ändern der Batch-Struktur. Diese Methoden können nur aus dem Skript zur [Batchverarbeitung](/de/flexi-capture/appendix/scripts/scripts-handling#batchprocessingscript) aufgerufen werden.
</Warning>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Definition</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Beschreibung</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          CleanRecognitionResults( document : <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a> ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Löscht die Erkennungsergebnisse für das Dokument.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          CreateDocumentFromPage( targetPosition : int, page : <a href="/de/flexi-capture/appendix/scripts/ipage">IPage</a> ): <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a>{" "}
          <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Entnimmt dem Dokument eine Seite und erstellt daraus ein neues Dokument. Geben Sie im Parameter <strong>targetPosition</strong> einen Index für das neue Dokument im Batch an. Der Index muss
          eine Zahl zwischen 0 und N sein, wobei N die Gesamtzahl der Dokumente im Batch ist.
        </p>

        <p>
          Wenn die <strong>CreateDocumentFromPage </strong>Methode aufgerufen wird:
        </p>

        <ul>
          <li>
            Die Dokumente mit Indizes von <strong>0</strong> bis <strong>targetPosition – 1</strong> bleiben an ihren ursprünglichen Positionen.
          </li>

          <li>
            Die Dokumente mit Indizes von <strong>targetPosion</strong> bis <strong>N</strong> werden um eine Position weitergeschoben.
          </li>

          <li>
            Das neue Dokument wird an der frei gewordenen <strong>targetPosition</strong> eingefügt.
          </li>
        </ul>

        <p>
          <strong>Hinweis: </strong> Wenn das Dokument nach dem Entfernen der Seite leer ist, wird es gelöscht.
        </p>

        <details>
          <summary>Beispiel</summary>
          <p>Ein Beispiel für ein Skript zur Verarbeitung des ersten Dokuments:</p>

          <pre>
            <code>
              IDocument document = Documents\[0]; for( int i = document.Pages.Count - 1; i >= 0; --i ) \{    Batch.CreateDocumentFromPage( document.Index + 1, document.Pages\[i]
              ); }
            </code>
          </pre>
        </details>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          CreatePageFromImage( page : <a href="/de/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a>, \[optional] target :{" "}
          <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a>, \[optional] position : int, \[optional] sourceInfo : string ) :{" "}
          <a href="/de/flexi-capture/appendix/scripts/ipage">IPage</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Erstellt eine Seite aus dem Objekt <a href="/de/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a> und gibt die erstellte Seite zurück:
        </p>

        <ul>
          <li>
            Wenn ein Zieldokument angegeben ist, wird die Seite diesem Dokument hinzugefügt. Um ein einseitiges Dokument zu erstellen, geben Sie <strong>null</strong> als Zieldokument an.
          </li>

          <li>
            Wenn eine Position angegeben ist, wird die Seite an der angegebenen Position im Dokument eingefügt (wenn ein Zieldokument angegeben ist). Andernfalls wird ein einseitiges Dokument an der angegebenen
            Position im Batch eingefügt (wenn <strong>null</strong> als Zieldokument angegeben ist). Die Startposition entspricht "0", das Ende des Dokuments oder Batchs entspricht "-1".
          </li>

          <li>
            Wenn der Parameter <strong>sourceInfo</strong> angegeben ist, wird er in die Informationen zur Quelle der Seite geschrieben. Andernfalls werden die Informationen zur Quelle der Seite aus{" "}
            <a href="/de/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a> übernommen.
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          DeleteDocument( document : <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a> ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Löscht das Dokument.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          DeletePage( page : <a href="/de/flexi-capture/appendix/scripts/ipage">IPage</a> ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Löscht die Seite.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          MoveDocument( source : <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a>, targetPosition : int ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Verschiebt das Dokument an die angegebene Position in der Batch.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          MovePage( source : <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a>, target : <a href="/de/flexi-capture/appendix/scripts/idocument">IDocument</a>, sourcePageIndex : int, int
          targetPageIndex : int ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Verschiebt die Seite mit dem in sourcePageIndex angegebenen Index aus dem Quelldokument an die in targetPageIndex angegebene Position im Zieldokument.</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## Eigenschaften
</div>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Name</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Typ</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Zugriff</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Beschreibung</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          AsBatchItem <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>
          Wandelt den Batch in ein <a href="/de/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>-Objekt um.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Anhänge</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/iattachments">IUserAttachments</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Anhänge des Benutzers.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>BatchTypeName</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Name des Batch-Typs.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Kommentar</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>Der Kommentar.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>CreatedBy</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/iprincipal">IPrincipal</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Autor des neu erstellten Batchs.</p>

        <p>
          Für die Standalone-Version von FC wird <strong>null</strong> zurückgegeben.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>CreationDate</p>
      </td>

      <td>
        <p>DateTime</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Zeitpunkt, an dem der Batch erstellt wurde.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Dokumente</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/idocuments">IDocuments</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Dokumente im Batch</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Id</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Batch-Bezeichner (innerhalb des Projekts eindeutig).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Name</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>Der Name des Batches.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Priorität</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/tprocessingpriority-appendix-scripts">TProcessingPriority</a>
        </p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>Die Priorität des Batches.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Projekt</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/iproject">IProject</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Das Projekt, zu dem der Batch gehört.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Eigenschaften</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/iproperties">IProperties</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Benannte Parameter des Batches.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a id="ibatch-slaexpirationdate" />SLAExpirationDate
        </p>
      </td>

      <td>
        <p>DateTime</p>
      </td>

      <td>
        <p>Lesen/Schreiben</p>
      </td>

      <td>
        <p>Verarbeitungsfrist des Batches.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>SlaStartDate</p>
      </td>

      <td>
        <p>DateTime</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Zeitpunkt, zu dem die Verarbeitung des Batch begonnen hat.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SlaWarningPeriod <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Int</p>
      </td>

      <td>
        <p>Lesen/Schreiben</p>
      </td>

      <td>
        <p>Der Beginn des Zeitraums, in dem eine Warnung vor der nahenden Frist der Aufgabe angezeigt wird. Angegeben als verbleibende Minuten bis zur Frist.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>StageInfo</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>
          Gibt das <a href="/de/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a>-Objekt mit Informationen zur Verarbeitungsstufe des Dokuments zurück. Die Felder TaskId und PrincipalId werden nicht verwendet.
        </p>
      </td>
    </tr>
  </tbody>
</table>