2 クライアントと他のWebアプリケーションとの統合
この章では、Webアプリケーションを起動してCaptureクライアントと通信する方法について説明します。
Webアプリケーションは、Uniform Resource Locator (URL)を介してCaptureクライアントを呼び出します。パラメータ(ワークスペース、キャプチャ・ソース、クライアント・プロファイル、ドキュメント・プロファイル、オプションのメタデータ値など)は、URL内で渡されます。
たとえば、「スキャン」ボタンをライン・オブ・ビジネスのWebアプリケーションに追加します。ビジネス・アプリケーションのエントリ・フィールドへの入力が完了したら、ユーザーは「スキャン」ボタンをクリックします。Captureクライアント・ウィンドウがユーザーに対して表示され、Captureにより、URL内に指定されているクライアント・プロファイルで指定されたスキャナと設定を使用して、ただちにドキュメントのスキャンが開始されます。スキャン後、ドキュメントがドキュメント・ペインに表示されます。メタデータのフィールドには自動的に、URLで渡されたユーザー・エントリが移入されます。ユーザーはドキュメントを確認し、その他のメタデータ・フィールドに入力してから、バッチをリリースするか、その他のバッチをスキャンするか、Captureクライアントを閉じます。
WebアプリケーションがURLを起動すると、Captureクライアントが起動され、ユーザーにログインを求めるプロンプトが表示されます。ログイン後、Captureクライアントは適宜パラメータを使用します。WebアプリケーションがURLを起動したときにCaptureクライアントがすでに実行されている場合、パラメータはCaptureクライアントのすでに実行中のインスタンスに渡されます。
クライアント統合の構成
WebアプリケーションとCaptureクライアントとの統合を構成するには:
-
Webアプリケーションで、クライアントをアクティブ化する起動ポイント(「スキャン」ボタンなど)を追加します。
-
URLとそのパラメータを構成します。
パラメータの一覧と説明は、表2-1を参照してください。
「クライアント統合Webアドレスの例」の統合構成の例を参照してください。
ノート: 12cでは、Captureクライアントはブラウザ内で実行されないため、クライアント・ユーザーは常にCaptureクライアントにログインする必要があります。
表2-1 クライアント統合URLのパラメータ
パラメータ 説明 CaptureWorkspace どのワークスペースにドキュメントをキャプチャするかを指定します。 ClientProfile ドキュメントのキャプチャに使用するクライアント・プロファイルを指定します(オプション)。プロファイルを指定した場合は、クライアントのバッチ・ペインに「クライアント・プロファイル」フィールドは表示されません。プロファイルが指定されていない場合は、そのシステム上でそのユーザーが前回使用したクライアント・プロファイルが使用されます。 CaptureDriver ドキュメントのキャプチャに使用するドライバを指定します。
インポートの場合は、CAPTURE_IMPORT_DRIVER
を指定します。
TWAINスキャンの場合は、CAPTURE_TWAIN_DRIVER
を指定します。ドライバIDもソース名も指定されていない場合は、前回使用されたドライバとソースが使用されます。CaptureSource 選択されているCaptureDriverに基づいて、ドキュメントのキャプチャに使用するソースを指定します。
インポートの場合は、Import Source
を指定します。
TWAINスキャンの場合は、スキャナ名を指定します。これは、クライアントの「キャプチャ・ソース」のオプションに指定されているのと同じスキャナ名です。ドライバIDもソース名も指定されていない場合は、そのシステム上でそのユーザーが前回使用したドライバとソースが使用されます。SignOutOnRelease バッチのリリース後にビジネス・ユーザーをキャプチャからサインアウトさせるかどうかを指定します。 false
または0
(デフォルト)を指定した場合、ユーザーは「リリース」ボタンをクリックしてバッチをリリースした後もサインインしたままになります。true
または1
を指定すると、バッチのリリース後にユーザーはサインアウトされます。SignOutOnClose ウィンドウを閉じた後にユーザーがCaptureからサインアウトされるかどうかを指定します。この設定は、Captureクライアントが終了したときにユーザーがサインアウトされるかどうかを制御します。 false
または0
を指定した場合、Captureクライアント・ウィンドウを閉じた後も、ユーザーは(Captureクライアントが起動された)ブラウザ・アプリケーションにサインインしたままです。true
または1
(デフォルト)を指定した場合、ユーザーは(Captureクライアントが起動された)ブラウザ・アプリケーションのログアウトURLにリダイレクトされてサインアウトされます。ShowAllBatches クライアント・ユーザーに対してバッチの一覧をバッチ・ペインに表示するかどうかを指定します。 false
または0
(デフォルト)を指定した場合、バッチ・リストは最初は空であり、そのセッションでスキャンされたバッチのみが表示されます。true
または1
を指定した場合、バッチ・リストにはそのユーザーが参照を許可されているバッチがすべて表示されます。DocumentProfile ユーザーがドキュメントの索引付けに使用するドキュメント・プロファイルを指定します。
ドキュメント・プロファイルを指定した場合、クライアントのメタデータ・ペインに「ドキュメント・プロファイル」フィールドは表示されません。
プロファイルが指定されていない場合は、そのシステム上でそのユーザーが前回使用したドキュメント・プロファイルが使用されます。その他 URLに含まれているその他の文字は、メタデータ名および値とみなされます。「フィールド・タイプ」がDateであるCaptureメタデータ・フィールドに日付値を指定する場合、日付は協定世界時(UTC)形式(yyyy-MM-ddTHH:mm:ssZ)にする必要があります。
クライアント統合URLの例
URLの例を示します。(このURLはすべてを1行に収める必要があります。)
oraclecapture://
CaptureWorkspace=Accounting&ClientProfile=Import%20Invoices&CaptureDriver=CAPTURE_IMPORT_DRIVER&CaptureSource=Import%20Source&SignOutOnRelease=1&Company=MyCompany&Dept=Accounting&Invoice%20Date=2015-08-04T12:00:00Z
このURLによって、クライアント統合は次のように構成されます:
-
CaptureWorkspace=Accounting
- ドキュメントのキャプチャ先のワークスペースとしてAccountingを指定します。 -
ClientProfile=Import Invoices
- 使用するクライアント・プロファイルとしてImport Invoicesを指定します。 -
CaptureDriver=CAPTURE_IMPORT_DRIVER
- CAPTURE_IMPORT_DRIVERをインポートのキャプチャ・ソースとして指定します。 -
CaptureSource=Import Source
- キャプチャ・ソースとしてImport Sourceを指定します。 -
SignOutOnRelease=1
- バッチのリリース後にユーザーがサインアウトされるように指定します。 -
Company=MyCompany
- Companyメタデータ・フィールドの値としてMyCompanyを渡します。 -
Dept=Accounting
- Deptメタデータ・フィールドの値としてAccountingを渡します。 -
Invoice%20Date=2015-08-04T12:00:00Z
- 「インボイス日」メタデータ・フィールドに日時の値を2015年8月4日正午(UTC時間)として渡します。