スキャンステージの統合

ABBYY FlexiCapture Web Scanning Station を iframe 経由でサードパーティシステムに埋め込み、Manage URL コマンドを使用してバッチを作成、開く、または再スキャンします。

この手順は、Windows 認証を使用することを前提としています。FlexiCapture または SAML 認証を使用することもできます。

Scanning Station のインターフェイスと機能をロードするには、<iframe> 要素を使用します。このステーションは、バッチの作成、バッチを開く、バッチを開くまたは作成する、再スキャン タスクの取得という 4 つのシナリオをサポートしています。

日本語などの英語以外の文字を URL のパラメーター値として渡すには、URL エンコードを使用してください。

​

バッチ の作成

特定の 登録パラメーター を指定して新しい バッチ を作成し、そのまま開くには、src 属性に次の値を設定します。

<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]

Name	必須	説明
<stationUrl>	はい	サードパーティシステムがアクセスするScanning Stationのアドレス。デフォルト値は <serverName>/FlexiCapture12/Scanning です。
WinAuth	はい	Windows認証パラメーター。
Create	はい	新しいバッチを作成するコマンドの名前。
projectId	はい	バッチを作成するProjectのID。
batchTypeName	はい	作成するバッチタイプ。
batchName	いいえ	新しいバッチの名前。名前を指定しない場合は、選択したバッチタイプの設定に基づいてプログラムが名前を決定します。
regparam	いいえ	name:value 形式の登録パラメーター。このパラメーターはWeb Station上の batchTypeName バッチタイプの設定で指定されている必要があり、指定されていない場合は無視されます。複数のパラメーターは & 記号で連結します。

​

バッチ を開く

特定の 登録パラメーター が設定された既存の バッチ を開くには、src 属性に次の値を設定します。

<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]

Name	必須	Description
<stationUrl>	はい	サードパーティシステムがアクセスするScanning Stationのアドレス。デフォルト値は <serverName>/FlexiCapture12/Scanning です。
WinAuth	はい	Windows 認証 parameter。
Open	はい	既存のバッチを開くコマンドの名前。Projectに複数のバッチが含まれている場合は、アルファベット順で最初のバッチが対象となります。
projectId	はい	開くバッチが含まれるProjectのID。
batchName	いいえ	バッチの新しい名前。バッチの名前を変更する場合にこのparameterを使用します。
regparam	いいえ	name:value 形式の登録パラメーター。このparameterは、Web Station上の batchTypeName バッチタイプの設定で指定されている必要があります。指定されていない場合は無視されます。複数のparametersは & 記号でつなぎます。

開けるのは、まだサーバーにアップロードされていないバッチのみです。

​

バッチ を開く、または作成する

指定した バッチ を開き、その バッチ が存在しない場合は新しく作成するには、src 属性を次のように設定します。

<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]

Name	必須	Description
<stationUrl>	はい	サードパーティシステムがアクセスするScanning Stationのアドレスです。デフォルト値は<serverName>/FlexiCapture12/Scanningです。
WinAuth	はい	Windows 認証 parameterです。
OpenOrCreate	はい	指定したバッチを開き、存在しない場合は新しいバッチを作成するコマンドの名前です。
projectId	はい	開く、または作成するバッチが含まれるProjectのIDです。
batchTypeName	はい	開く、または作成するバッチタイプです。
batchName	いいえ	バッチの新しい名前です。既存のバッチ名を変更する場合や、新しいバッチに名前を付ける場合にこのparameterを使用します。指定しない場合、新しいバッチには選択したバッチタイプの設定に基づいた名前が付けられます。
regparam	いいえ	name:value形式の登録パラメーターです。このparameterは、Web Station上でbatchTypeNameバッチタイプの設定に指定されている必要があります。指定されていない場合は無視されます。複数のparameterは&記号でつなぎます。

開くことができるのは、まだサーバーにアップロードされていないバッチのみです。

​

再スキャン タスクを取得する

再スキャン タスクを取得するには、src 属性に次の値を設定します。

<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]

Name	必須	Description
<stationUrl>	はい	サードパーティ システムがアクセスする Scanning Station のアドレスです。デフォルト値は <serverName>/FlexiCapture12/Scanning です。
WinAuth	はい	Windows 認証のパラメーターです。
GetRescan	はい	既存の再スキャン タスクを取得するコマンドの名前です。Projectに複数のタスクがある場合は、アルファベット順で最初のタスクが取得されます。
projectId	はい	再スキャンするバッチを含むProjectの ID です。
batchName	いいえ	バッチの新しい名前です。再スキャンするバッチの名前を変更する場合に、この Parameter を使用します。
regparam	いいえ	name:value 形式の登録パラメーターです。この Parameter は Web Station 上の batchTypeName バッチタイプの設定で指定されている必要があり、指定されていない場合は無視されます。複数の Parameter は & 記号で連結します。

​

サードパーティシステムへの復帰

ユーザーがバッチでの作業を終えて統合された Scanning Station を終了すると、postMessage メソッドが FC_Scanning_TaskClosed メッセージを親要素に渡し、最終ページが開きます。開発者は、そのページからユーザーをサードパーティシステムに戻す必要があります。