メインコンテンツへスキップ

​
REST API ワークフロー

一般的な 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” バッチタイプに対して設定する必要があります。
  1. Project メニューで Project Properties をクリックし、次に Workflow タブをクリックします。Schema ドロップダウンリストから Advanced を選択し、以下のようにワークフロー設定を変更します。
  1. Verification → General をクリックし、Enable web stations オプションを選択します。 注: プロジェクトで Verification ステージが不要な場合は、この設定を省略できます。
  2. Verification → Entry Conditions をクリックし、Documents are admitted to stage オプションを Always に設定します。 注: ソリューションの要件によっては、Entry Conditions タブのスクリプトベースのルールを使用して、Verification ステージを一時的または条件付きで無効にすることもできます。
  1. プロジェクトで training/layout/{taskId}/{fileId} エンドポイントを有効にするには、field データとレイアウトを含む XML ファイルをエクスポートする必要があります。手順は次のとおりです:
    1. Verification ステージの直前に文書処理ステージを作成します:
  1. Entry Conditions タブで Always を選択します。
  1. Script タブで、Edit script… ボタンをクリックします。 : 4. スクリプト言語を C# .NET に変更します:
  1. 次のコードスニペットをスクリプトペインにコピーして貼り付けます:
using System;
Document.SaveXmlToFileStorage();
  1. OK をクリックして変更を保存します。
REST API 経由でファイルをアップロードする場合、ドキュメントアセンブリに関するプロジェクト設定 (画像処理 → ドキュメントの作成) は適用されません。各ファイルごとに個別のドキュメントが作成されます。

​
データのエクスポート設定の調整

REST API 経由で送信されたバッチの処理が完了すると、REST API がエクスポート済みファイルを取得し、client がダウンロードできるようにします。
ABBYY FlexiCapture Cloud は、エクスポートされたファイルをオブジェクト ストレージに保存します。このため、REST API プロジェクトではルート付きのエクスポート パスを使用しないでください。
REST API プロジェクトでは、特別なフォルダー構造は必要ありません。各バッチのルート フォルダー名を使用し、document ID をファイル名の一部に含めることで、フラットなフォルダー構造を使用できます。REST API services は、REST API 経由で送信された各バッチに対して、一意のランダムなバッチ名を割り当てます。これにより、REST API 経由で送信されたバッチからデータをエクスポートする際に、一意のファイル名が生成されます。 次のスクリーンショットは、複数階層のフォルダー構造となる元のエクスポート設定を示しています。 次のスクリーンショットは、フラットなフォルダー構造となるよう変更したエクスポート設定を示しています。

​
変更したプロジェクトを ABBYY FlexiCapture Cloud にアップロードする

  1. File > Upload Project to Server… をクリックして、プロジェクトを ABBYY FlexiCapture Cloud にアップロードします。
  2. 表示されたダイアログで、テナントをホストしているクラウドサーバーの URL を入力し、テナント名を指定します。
  3. Use server authentication を選択し、テナント管理者の資格情報を入力します。
  4. Test connection をクリックして、接続設定を確認します。
  5. OK をクリックし、プロジェクトのアップロードが完了するまで待ちます。

​
次のステップ

プロジェクトを ABBYY FlexiCapture Cloud にアップロードしたら、次に以下をお試しください。
  1. プロジェクトに接続するアプリケーションを作成します。手順の詳細については、FlexiCapture REST API インターフェイスを使用したアプリケーションの作成を参照してください。
  2. アプリケーションが正しく接続されているかを確認するには、サンプルバッチを処理します。
  3. 問題が発生した場合は、処理エラーの診断を参照してください。