スキャンステージの統合

このセクションの手順は、Windows 認証を使用することを前提としています。代わりに、FlexiCapture または SAML 認証を使用することもできます。 Scanning Station の GUI と機能をロードするには、<iframe> 要素を使用します。次のシナリオがサポートされています。

バッチの作成

特定の登録パラメーターを持つ新しいバッチを作成して開くには、src 属性の値を次のように設定します。<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value], ここで

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

バッチを開く

特定の登録パラメーターを持つ既存のバッチを開くには、src 属性の値を次のように設定します。<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value], ここで


		サードパーティシステムからアクセスする Scanning Station のアドレスです。デフォルト値は <serverName>/FlexiCapture12/Scanning です。
		Windows 認証パラメーターです。
		既存のバッチを開くコマンド名です。重要: プロジェクト内に複数のバッチがある場合は、アルファベット順で最初のバッチが選択されます。
		開くバッチが含まれているプロジェクトの ID です。
		バッチの新しい名前です。バッチ名を変更する場合は、このパラメーターを使用します。
		“name:value” 形式の登録パラメーターです。regparam 登録パラメーターは、Web Station上の batchTypeName バッチタイプの設定で指定されている必要があります。指定されていない場合、このパラメーターは無視されます。注: 複数のパラメーターを ”&” 記号で連結することで、複数の登録パラメーターを渡すことができます。

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

指定したバッチを開き、存在しない場合は新しいバッチを作成する

指定したバッチを開き、そのバッチが存在しない場合は新しいバッチを作成するには、src 属性の値を次のように設定します。<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value], ここで


		サードパーティシステムからアクセスする Scanning Station のアドレスです。既定値は <serverName>/FlexiCapture12/Scanning です。
		Windows 認証パラメーターです。
		指定したバッチを開くか、そのバッチが存在しない場合は新しいバッチを作成するコマンドの名前です。
		開くまたは作成するバッチが含まれるプロジェクトの ID です。
		開くまたは作成するバッチのバッチタイプです。
		バッチの新しい名前です。既存のバッチ名を変更する場合、または新しいバッチに名前を付ける場合は、このパラメーターを使用します。新しいバッチの作成時にこのパラメーターを使用しない場合、プログラムは選択したバッチタイプの設定に基づいて名前を選択します。
		“name:value” 形式の登録パラメーターです。regparam 登録パラメーターは、Web Station 上の batchTypeName バッチタイプの設定で指定されている必要があります。指定されていない場合、このパラメーターは無視されます。注: 複数のパラメーターを ”&” 記号で連結すると、複数の登録パラメーターを渡すことができます。

サーバーにまだアップロードされていないバッチだけを開くことができます。

再スキャンタスクの取得

再スキャンタスクを取得するには、src 属性の値を次のように設定します。<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value], ここで

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

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

URL 内でパラメーター値として英語以外の文字 (日本語など) を渡す必要がある場合は、URL エンコードを使用してください。