一般的な REST API のワークフローは次のとおりです。
REST API アプリケーションで使用する FlexiCapture プロジェクトには、適切に設定されたワークフローが含まれている必要があります。以下の手順では、サンプルの Banking Card Application プロジェクトのワークフローを REST API で使用できるように調整する方法を示します。サンプル プロジェクトの詳細については、ABBYY FlexiCapture sample projects を参照してください。
この手順を始める前に、Project Setup Station を起動し、サンプルの Banking Card Application プロジェクトを開いてください (既定の場所は C:\Users\Public\ABBYY\FlexiCapture\12.0\Samples\FlexiCapture\English\Banking_eng\banking_eng.fcproj です) 。
REST API は、処理対象のデータを常に “Default” バッチタイプとして送信します。そのため、プロジェクト内のすべての文書処理は “Default” バッチタイプ用に設定する必要があります。
Advanced ワークフロースキーマを選択する
Project メニューで Project Properties をクリックし、Workflow タブをクリックします。Schema ドロップダウンリストから Advanced を選択し、以下のようにワークフロー設定を変更します。 検証用に Web Station を有効にする
Verification → General をクリックし、Enable web stations オプションを選択します。注: プロジェクトで検証ステージが不要な場合は、この設定を省略できます。
検証のエントリ条件を設定する
Verification → Entry Conditions をクリックし、Documents are admitted to stage オプションを Always に設定します。ソリューションの要件によっては、Entry Conditions タブのスクリプトベースのルールを使用して、検証ステージを一時的または条件付きで無効にすることもできます。
XML Layout をエクスポートするステージを追加する
プロジェクトで training/layout/{taskId}/{fileId} endpoint を有効にするには、field データと layout を含む XML ファイルをエクスポートします。検証ステージの直前に文書処理ステージを作成します。 新しいステージのエントリ条件を設定する
Entry Conditions タブで Always を選択します。 スクリプト エディターを開く
Script タブで Edit script… をクリックします。 エクスポートスクリプトを追加する
次のコードスニペットをスクリプトペインにコピーして貼り付けます。using System;
Document.SaveXmlToFileStorage();
変更を保存する
OK をクリックして変更を保存します。
REST API 経由でファイルをアップロードする場合、document assembly に関するプロジェクト設定 (Image processing → Create document) は無視されます。ファイルごとに個別の文書が作成されます。
ABBYY FlexiCapture Cloud は、エクスポートされたファイルをオブジェクト ストレージに保存します。このため、REST API プロジェクトではルート付きのエクスポート パスを使用しないでください。
変更したプロジェクトを ABBYY FlexiCapture Cloud にアップロードする
アップロード ダイアログを開く
File > Upload Project to Server… をクリックして、プロジェクトを ABBYY FlexiCapture Cloud にアップロードします。
サーバーとテナントを入力する
開いたダイアログで、テナントをホストしているクラウドサーバーの URL を入力し、テナント名を指定します。
認証情報を入力する
Use server authentication を選択し、テナント管理者の認証情報を入力します。
接続をテストする
Test connection をクリックして、接続設定を確認します。
プロジェクトをアップロードする
OK をクリックし、プロジェクトのアップロードが完了するまで待ちます。
