> ## 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 representa un lote en los scripts de FlexiCapture: permite mover y eliminar documentos y páginas, crear páginas a partir de imágenes y leer las propiedades del lote y los datos de SLA.

<div id="what-it-does">
  ## Qué hace
</div>

Representa el lote.

<a id="webverificationavailableinterface" />

<Note>
  Algunos métodos y propiedades de este objeto no están disponibles en la estación web de verificación para comprobar reglas de forma local. Los métodos y propiedades que no se admiten están marcados con un asterisco (\*).
</Note>

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

<Warning>
  Los siguientes métodos requieren permisos para modificar la estructura del lote. Estos métodos solo pueden llamarse desde el script de [procesamiento por lotes](/es/flexi-capture/appendix/scripts/scripts-handling#batchprocessingscript).
</Warning>

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

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

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

      <td>
        <p>Elimina los resultados del reconocimiento del documento.</p>
      </td>
    </tr>

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

      <td>
        <p>
          Toma una página del documento y crea un documento nuevo a partir de ella. En el parámetro <strong>targetPosition</strong>, especifique un índice para el documento nuevo en el batch. El índice debe
          ser un número entre 0 y N, donde N es el número total de documentos del batch.
        </p>

        <p>
          Cuando se llama al método <strong>CreateDocumentFromPage </strong>:
        </p>

        <ul>
          <li>
            Los documentos con índices comprendidos entre <strong>0</strong> y <strong>targetPosition – 1</strong> permanecerán en sus posiciones originales.
          </li>

          <li>
            Los documentos con índices comprendidos entre <strong>targetPosion</strong> y <strong>N</strong> avanzarán una posición.
          </li>

          <li>
            El documento nuevo se colocará en la posición <strong>targetPosition</strong> que quedó vacante.
          </li>
        </ul>

        <p>
          <strong>Nota: </strong> Si el documento queda vacío después de quitar la página, se eliminará.
        </p>

        <details>
          <summary>Ejemplo</summary>
          <p>Ejemplo de script para procesar el primer documento:</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="/es/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a>, \[optional] target :{" "}
          <a href="/es/flexi-capture/appendix/scripts/idocument">IDocument</a>, \[optional] position : int, \[optional] sourceInfo : string ) :{" "}
          <a href="/es/flexi-capture/appendix/scripts/ipage">IPage</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Crea una página a partir del objeto <a href="/es/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a> y devuelve la página creada:
        </p>

        <ul>
          <li>
            Si se especifica un documento de destino, la página se agrega a este documento. Para crear un documento de una sola página, especifique <strong>null</strong> como documento de destino.
          </li>

          <li>
            Si se especifica una posición, la página se agrega en la posición indicada del documento (si se especifica un documento de destino). De lo contrario, se agrega un documento de una sola página en la posición indicada
            del lote (si se especifica <strong>null</strong> como documento de destino). La posición inicial corresponde a "0," y el final del documento o lote corresponde a "-1."
          </li>

          <li>
            Si se especifica el parámetro <strong>sourceInfo</strong>, se guarda en la información sobre el origen de la página. De lo contrario, la información sobre el origen de la página se obtiene de{" "}
            <a href="/es/flexi-capture/appendix/scripts/ipictureobject">IPictureObject</a>.
          </li>
        </ul>
      </td>
    </tr>

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

      <td>
        <p>Elimina el documento.</p>
      </td>
    </tr>

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

      <td>
        <p>Elimina la página.</p>
      </td>
    </tr>

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

      <td>
        <p>Mueve el documento a la posición especificada del lote.</p>
      </td>
    </tr>

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

      <td>
        <p>Mueve la página con índice sourcePageIndex del documento de origen a la posición targetPageIndex del documento de destino.</p>
      </td>
    </tr>
  </tbody>
</table>

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

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

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

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Acceso</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="/es/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>
          Convierte el batch en un objeto <a href="/es/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Archivos adjuntos</p>
      </td>

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Archivos adjuntos del usuario.</p>
      </td>
    </tr>

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

      <td>
        <p>cadena</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>El nombre del tipo de lote.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Comentario</p>
      </td>

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

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>El comentario.</p>
      </td>
    </tr>

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

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>El autor del lote que se acaba de crear.</p>

        <p>
          En la versión independiente de FC, devuelve <strong>null</strong>.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>La fecha y hora en que se creó el lote.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Documentos</p>
      </td>

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Documentos que componen el lote</p>
      </td>
    </tr>

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

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>El identificador del lote (único dentro del proyecto).</p>
      </td>
    </tr>

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

      <td>
        <p>cadena</p>
      </td>

      <td>
        <p>Lectura y escritura</p>
      </td>

      <td>
        <p>El nombre del batch.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Prioridad</p>
      </td>

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

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>La prioridad del lote.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Proyecto</p>
      </td>

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>El proyecto que contiene el batch.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Propiedades</p>
      </td>

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Parámetros con nombre del lote.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lectura y escritura</p>
      </td>

      <td>
        <p>Fecha límite de procesamiento del lote.</p>
      </td>
    </tr>

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

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>La hora en que se inició el procesamiento del lote.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>La hora de inicio del período durante el cual se mostrará una advertencia de que el plazo de la tarea está próximo a vencer. Se especifica en minutos restantes hasta el plazo.</p>
      </td>
    </tr>

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

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

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>
          Devuelve el objeto <a href="/es/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a> con información sobre la etapa de procesamiento del documento. Los campos TaskId y PrincipalId no se utilizan.
        </p>
      </td>
    </tr>
  </tbody>
</table>