> ## 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.

# Scanphase integrieren

> Betten Sie die ABBYY FlexiCapture Web-Scanning-Station über ein iframe in ein Drittsystem ein, um mit Manage-URL-Befehlen Batches zu erstellen, zu öffnen oder erneut zu scannen.

Diese Anweisungen setzen die Windows-Authentifizierung voraus. Sie können auch die FlexiCapture- oder SAML-Authentifizierung verwenden.

Um die Oberfläche und die Funktionen der Scanning Station zu laden, verwenden Sie das Element `<iframe>`. Die Station unterstützt vier Szenarien: das Erstellen eines Batchs, das Öffnen eines Batchs, das Öffnen oder Erstellen eines Batchs und das Abrufen einer Aufgabe zum erneuten Scannen.

<Note>
  Verwenden Sie die URL-Kodierung, um nicht englische Zeichen, etwa japanische, als Parameterwerte in der URL zu übergeben.
</Note>

<div id="create-a-batch">
  ## Batch erstellen
</div>

Um einen neuen Batch mit bestimmten Registrierungsparametern zu erstellen und zu öffnen, setzen Sie das Attribut `src` auf:

```http theme={null}
<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]
```

| Name            | Erforderlich | Beschreibung                                                                                                                                                                                                                                          |
| --------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<stationUrl>`  | Ja           | Die Adresse der Scanning Station, auf die das Drittsystem zugreift. Der Standardwert lautet `<serverName>/FlexiCapture12/Scanning`.                                                                                                                   |
| `WinAuth`       | Ja           | Windows-Authentifizierungsparameter.                                                                                                                                                                                                                  |
| `Create`        | Ja           | Der Name des Befehls, der einen neuen Batch erstellt.                                                                                                                                                                                                 |
| `projectId`     | Ja           | Die ID des Projekts, in dem der Batch erstellt werden soll.                                                                                                                                                                                           |
| `batchTypeName` | Ja           | Der Typ des zu erstellenden Batches.                                                                                                                                                                                                                  |
| `batchName`     | Nein         | Ein Name für den neuen Batch. Ohne Angabe eines Namens wählt das Programm anhand der Einstellungen des ausgewählten Batch-Typs einen Namen aus.                                                                                                       |
| `regparam`      | Nein         | Ein Registrierungsparameter im Format `name:value`. Der Parameter muss in den Einstellungen des Batch-Typs `batchTypeName` auf der Web Station angegeben sein, andernfalls wird er ignoriert. Mehrere Parameter werden mit dem Zeichen `&` verknüpft. |

<div id="open-a-batch">
  ## Batch öffnen
</div>

Um einen vorhandenen Batch mit bestimmten Registrierungsparametern zu öffnen, setzen Sie das Attribut `src` auf:

```http theme={null}
<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]
```

| Name           | Required | Description                                                                                                                                                                                                                                        |
| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<stationUrl>` | Ja       | Die Adresse der Scanning Station, auf die das Drittsystem zugreift. Der Standardwert lautet `<serverName>/FlexiCapture12/Scanning`.                                                                                                                |
| `WinAuth`      | Ja       | Windows-Authentifizierungsparameter.                                                                                                                                                                                                               |
| `Open`         | Ja       | Der Name des Befehls, der einen vorhandenen Batch öffnet. Enthält das Projekt mehrere Batches, verwendet der Befehl den alphabetisch ersten.                                                                                                       |
| `projectId`    | Ja       | Die ID des Projekts, das den zu öffnenden Batch enthält.                                                                                                                                                                                           |
| `batchName`    | Nein     | Ein neuer Name für den Batch. Verwenden Sie diesen Parameter, um den Batch umzubenennen.                                                                                                                                                           |
| `regparam`     | Nein     | Ein Registrierungsparameter im Format `name:value`. Der Parameter muss in den Einstellungen des Batch-Typs `batchTypeName` auf der Web Station angegeben sein, andernfalls wird er ignoriert. Verbinden Sie mehrere Parameter mit dem Zeichen `&`. |

<Note>
  Sie können nur einen Batch öffnen, der noch nicht auf den Server hochgeladen wurde.
</Note>

<div id="open-or-create-a-batch">
  ## Batch öffnen oder erstellen
</div>

Um einen angeforderten Batch zu öffnen bzw. einen neuen anzulegen, falls der angeforderte Batch nicht vorhanden ist, setzen Sie das Attribut `src` auf:

```http theme={null}
<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]
```

| Name            | Erforderlich | Beschreibung                                                                                                                                                                                                                                         |
| --------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<stationUrl>`  | Ja           | Die Adresse der Scanning Station, auf die das Drittsystem zugreift. Der Standardwert ist `<serverName>/FlexiCapture12/Scanning`.                                                                                                                     |
| `WinAuth`       | Ja           | Windows-Authentifizierungsparameter.                                                                                                                                                                                                                 |
| `OpenOrCreate`  | Ja           | Der Name des Befehls, der einen angeforderten Batch öffnet oder einen neuen Batch erstellt, falls der angeforderte nicht vorhanden ist.                                                                                                              |
| `projectId`     | Ja           | Die ID des Projekts, das den zu öffnenden oder zu erstellenden Batch enthält.                                                                                                                                                                        |
| `batchTypeName` | Ja           | Der Typ des zu öffnenden oder zu erstellenden Batches.                                                                                                                                                                                               |
| `batchName`     | Nein         | Ein neuer Name für den Batch. Verwenden Sie diesen Parameter, um einen bestehenden Batch umzubenennen oder einen neuen zu benennen. Andernfalls erhält ein neuer Batch einen Namen gemäß den Einstellungen des ausgewählten Batch-Typs.              |
| `regparam`      | Nein         | Ein Registrierungsparameter im Format `name:value`. Der Parameter muss in den Einstellungen des Batch-Typs `batchTypeName` auf der Web Station angegeben sein, andernfalls wird er ignoriert. Mehrere Parameter werden mit dem Symbol `&` verknüpft. |

<Note>
  Sie können nur einen Batch öffnen, der noch nicht auf den Server hochgeladen wurde.
</Note>

<h2 id="getting-a-rescanning-task">
  Aufgabe zum erneuten Scannen abrufen
</h2>

Um eine Aufgabe zum erneuten Scannen abzurufen, setzen Sie das Attribut `src` auf:

```http theme={null}
<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]
```

| Name           | Required | Description                                                                                                                                                                                                                                          |
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<stationUrl>` | Ja       | Die Adresse der Scanning Station, auf die das Drittsystem zugreift. Der Standardwert lautet `<serverName>/FlexiCapture12/Scanning`.                                                                                                                  |
| `WinAuth`      | Ja       | Windows-Authentifizierungsparameter.                                                                                                                                                                                                                 |
| `GetRescan`    | Ja       | Der Name des Befehls, der eine vorhandene Aufgabe zum erneuten Scannen abruft. Enthält das Projekt mehrere Aufgaben, wird die alphabetisch erste verwendet.                                                                                          |
| `projectId`    | Ja       | Die ID des Projekts, das den erneut zu scannenden Batch enthält.                                                                                                                                                                                     |
| `batchName`    | Nein     | Ein neuer Name für den Batch. Mit diesem Parameter benennen Sie den erneut zu scannenden Batch um.                                                                                                                                                   |
| `regparam`     | Nein     | Ein Registrierungsparameter im Format `name:value`. Der Parameter muss in den Einstellungen des Batch-Typs `batchTypeName` auf der Webstation angegeben sein, andernfalls wird er ignoriert. Mehrere Parameter werden mit dem Zeichen `&` verbunden. |

<div id="return-to-the-third-party-system">
  ## Rückkehr zum Drittsystem
</div>

Wenn der Benutzer die Arbeit mit dem Batch abgeschlossen hat und die integrierte Scanning Station verlässt, übergibt die Methode `postMessage` die Nachricht `FC_Scanning_TaskClosed` an das übergeordnete Element und die Abschlussseite wird geöffnet. Der Developer muss den Benutzer von dieser Seite zurück zum Drittsystem leiten.
