> ## 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ésente un lot dans les scripts FlexiCapture : déplacer et supprimer des documents et des pages, créer des pages à partir d'images et consulter les propriétés du lot ainsi que les données SLA.

<div id="what-it-does">
  ## Ce qu’il fait
</div>

Représente le lot.

<a id="webverificationavailableinterface" />

<Note>
  Certaines méthodes et propriétés de cet objet ne sont pas disponibles dans Web Verification Station pour la vérification locale des règles. Les méthodes et propriétés non prises en charge sont signalées par un astérisque (\*).
</Note>

<div id="methods">
  ## Méthodes
</div>

<Warning>
  Les méthodes ci-dessous nécessitent des autorisations pour modifier la structure du lot. Elles ne peuvent être appelées que depuis le script de [traitement de lot](/fr/flexi-capture/appendix/scripts/scripts-handling#batchprocessingscript).
</Warning>

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

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

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

      <td>
        <p>Supprime les résultats de reconnaissance du document.</p>
      </td>
    </tr>

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

      <td>
        <p>
          Prend une page du document et crée un nouveau document à partir de cette page. Dans le paramètre <strong>targetPosition</strong>, spécifiez l’indice du nouveau document dans le batch. L’indice doit
          être un nombre compris entre 0 et N, N étant le nombre total de documents dans le batch.
        </p>

        <p>
          Lorsque la méthode <strong>CreateDocumentFromPage </strong>est appelée :
        </p>

        <ul>
          <li>
            Les documents dont les indices vont de <strong>0</strong> à <strong>targetPosition – 1</strong> restent à leur position d’origine.
          </li>

          <li>
            Les documents dont les indices vont de <strong>targetPosion</strong> à <strong>N</strong> sont décalés d’une position.
          </li>

          <li>
            Le nouveau document est placé à la position <strong>targetPosition</strong> ainsi libérée.
          </li>
        </ul>

        <p>
          <strong>Remarque : </strong> Si le document devient vide après le retrait de la page, il sera supprimé.
        </p>

        <details>
          <summary>Exemple</summary>
          <p>Exemple de script pour traiter le premier document :</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="/fr/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a>, \[optional] target :{" "}
          <a href="/fr/flexi-capture/appendix/scripts/idocument">IDocument</a>, \[optional] position : int, \[optional] sourceInfo : string ) :{" "}
          <a href="/fr/flexi-capture/appendix/scripts/ipage">IPage</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Crée une page à partir de l’objet <a href="/fr/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a> et renvoie la page créée :
        </p>

        <ul>
          <li>
            Si un document cible est spécifié, la page est ajoutée à ce document. Pour créer un document d’une seule page, spécifiez <strong>null</strong> comme document cible.
          </li>

          <li>
            Si une position est spécifiée, la page est ajoutée à la position spécifiée dans le document (si un document cible est spécifié). Sinon, un document d’une seule page est ajouté à la position
            spécifiée dans le lot (si <strong>null</strong> est spécifié comme document cible). La position initiale correspond à "0" et la fin du document ou du lot correspond à "-1".
          </li>

          <li>
            Si le paramètre <strong>sourceInfo</strong> est spécifié, il est enregistré dans les informations sur la source de la page. Sinon, les informations sur la source de la page sont récupérées depuis{" "}
            <a href="/fr/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a>.
          </li>
        </ul>
      </td>
    </tr>

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

      <td>
        <p>Supprime le document.</p>
      </td>
    </tr>

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

      <td>
        <p>Supprime la page.</p>
      </td>
    </tr>

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

      <td>
        <p>Déplace le document à la position spécifiée dans le lot.</p>
      </td>
    </tr>

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

      <td>
        <p>Déplace la page d’indice sourcePageIndex du document source à la position targetPageIndex dans le document cible.</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## Propriétés
</div>

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

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

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Accès</strong>
        </p>
      </th>

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

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>
          Convertit le batch en un objet <a href="/fr/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Pièces jointes</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Pièces jointes de l’utilisateur.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Le nom du type de lot.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Commentaire</p>
      </td>

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Commentaire.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>L’auteur du lot qui vient d’être créé.</p>

        <p>
          Pour la version autonome de FC, renvoie <strong>null</strong>.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>L’heure à laquelle le lot a été créé.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Documents</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Documents composant le lot</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ID</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>L’identifiant du batch (unique au sein du projet).</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Le nom du batch.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Priorité</p>
      </td>

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>La priorité du lot.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Projet</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Le projet contenant le lot.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Propriétés</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Paramètres nommés du lot.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Date limite de traitement du lot.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>L’heure de début du traitement du lot.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>L’heure de début de la période durant laquelle un avertissement signalant l’approche de l’échéance de la tâche s’affiche. Exprimée en nombre de minutes restantes avant l’échéance.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>
          Renvoie l’objet <a href="/fr/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a> qui contient des informations sur l’étape de traitement du document. Les champs TaskId et PrincipalId ne sont pas utilisés.
        </p>
      </td>
    </tr>
  </tbody>
</table>
