ABBYY FlexiCapture Connect - ABBYY Documentation

ABBYY FlexiCapture Connect は Windows サービスとして動作し、ABBYY FlexiCapture Cloud プロジェクトへのドキュメントのインポート、ABBYY FlexiCapture Cloud プロジェクトからのドキュメントのエクスポート、およびデータセットの同期を行えます。

Windows サーバー上で実行される ABBYY FlexiCapture Connect が、ファイアウォールを介してポート 443 経由で ABBYY FlexiCapture Cloud に接続する様子を示す図。

システム要件

要件	詳細
オペレーティングシステム	Windows 10、Windows 11、または Windows Server 2012、2012 R2、2016、2019、2022、2025 (いずれも Desktop Experience を含む) 。
RAM	約500,000件のベンダーを含むデータセットには、2.5 GB以上のRAMを推奨します。
ソフトウェア互換性	ABBYY FlexiCapture Application Server Release 3 以降、.NET Framework 4.6.1 以降。

ABBYY FlexiCapture Connect をインストールして設定する

ABBYY FlexiCapture Connect のインストールと設定には、サービスアカウントを使用してください。

インストーラーをダウンロードして実行する

ABBYY FlexiCapture Connect がすでにインストールされていて、既存のバージョンを更新する場合は、まず C:\Program Files (x86)\ABBYY FlexiCapture Connect\config.json にある config.json ファイルのバックアップコピーを作成してください。https://www.abbyy.com/flexicapture-downloads/cloud/ から FlexiCapture_Connect_Installer_*.msi ファイルをダウンロードして実行します。

設定ファイルを変更する

必要に応じて config.json ファイルを変更します。詳細については、設定ファイルリファレンスを参照してください。

新しい設定をテストする

ABBYY FlexiCapture Connect サービスを一時停止します。
ABBYY.FlexiCapture.Connect.exe ファイルを実行します。詳細なログが表示されたコンソールウィンドウが開きます。

サービスを再起動する

ABBYY FlexiCapture Connect サービスを再起動します。

設定ファイルリファレンス

この config.json ファイルの例では、1 つのProjectにドキュメントをインポートし、処理結果をエクスポートしたうえで、1 つのデータセットを同期します。

{
  "url": "https://europe.flexicapture.com/",
  "tenant": "testtenant",
  "user": "user1",
  "password": "password1",
  "projects": [
    {
      "name": "project1",
      "import": {
        "directory": "C:\\HotFolder\\Import",
        "fileMask": "*",
        "settings": {
          "region": "US",
          "verification_type": "NoVerification",
          "export_format": "Xml"
        },
        "createDocument": "ForEachFile",
        "period": "00:01:00",
        "schedule": [ "12:00:00", "06:00:00" ]
      },
      "export": {
        "directory": "C:\\HotFolder\\Export",
        "period": "00:01:00",
        "schedule": [ "12:00:00" ]
      },
      "templates": [
        {
          "name": "template",
          "datasets": [
            {
              "name": "DataSet",
              "file": "C:\\HotFolder\\DataSets\\DataSet.csv",
              "period": "00:01:00",
              "schedule": [ "12:00:00" ]
            }
          ]
        }
      ]
    }
  ]
}

一般設定

最上位のプロパティは、テナントとサービスアカウントを識別します。

プロパティ	説明
`url`	テナントの URL (例: `https://europe.flexicapture.com`) 。
`tenant`	テナント名。
`user`	サービスアカウントのユーザー名。
`password`	サービスアカウントのパスワード。
`projects`	各Projectの設定を含みます。たとえば、ドキュメントのインポート/エクスポートパラメーターや、データセット同期パラメーターなどです。

ドキュメントをインポートおよびエクスポートするには、テナントアカウントを External User として設定します。データセットを同期するには、テナントアカウントに Administrator ロール、または Project Settings Editor ロールと External User ロールの両方が必要です。既定では、テナントアカウントはすべてのProjectにアクセスできます。これを変更するには、特定のユーザーロールに付与するアクセス権を調整します。詳細については、ユーザーロールとアクセス権の設定を参照してください。

Project設定

projects 配列内の各オブジェクトが、それぞれ 1 つのProjectを定義します。

プロパティ	説明
`name`	Project名。
`import`	ドキュメントのインポート設定。
`export`	ドキュメントのエクスポート設定。
`templates`	データセットの同期設定。

インポート設定

Projectの import オブジェクトでは、ドキュメントをインポートする方法とタイミングを定義します。

プロパティ	説明
`directory`	ドキュメントのインポート元フォルダーへのパス。
`fileMask`	ファイルおよびフォルダーのフィルタ。ワイルドカード `*` と `?` を使用できます。
`settings`	バッチの登録パラメーター。
`createDocument`	指定可能な値は `ForEachFile` (インポートしたファイルごとに個別のドキュメントを作成) または `Automatically` (Projectのパラメーターを使用) です。`Automatically` を使用するには、事前に ABBYY FlexiCapture Projectで Automatically when Document Definition is applied オプションを選択しておく必要があります。
`period`	タスクを開始する間隔。たとえば、`"period": "00:02:30"` と指定すると、2 分 30 秒ごとにタスクが開始されます。`period` と `schedule` はそれぞれ個別に設定できます。
`schedule`	タスクを開始する時刻。たとえば、`"schedule": [ "09:00:00", "19:00:00" ]` と指定すると、毎日 9:00 と 19:00 にタスクが開始されます。

ファイルをインポートするたびに、新しいバッチが作成されます。バッチ名には現在の日時が含まれます。

エクスポート設定

プロジェクトの export オブジェクトは、処理結果をエクスポートする場所とタイミングを定義します。

プロパティ	説明
`directory`	エクスポートしたファイルの保存先フォルダーのパス。
`period`	エクスポートタスクを開始する間隔。インポートと同じ形式で指定します。`period` と `schedule` は、それぞれ独立して設定できます。
`schedule`	エクスポートタスクを開始する時刻。インポートと同じ形式で指定します。

ドキュメントがエクスポートされると、現在 処理完了 ステージにあるProject内の各バッチごとにフォルダーが作成されます。これらの保存先フォルダーには、それぞれ対応するバッチと同じ名前が付けられ、すべての処理結果が格納されます。保存先フォルダーが削除されると、プログラムは同じ名前の新しいフォルダーを作成し、そこに処理結果を格納します。

Document Definition 設定

templates 配列内の各オブジェクトは、Document Definition とそのデータセットを指定します。

プロパティ	説明
`name`	指定したセクションに関連付けられた Document Definition の名前。
`datasets`	Document Definition のデータセット同期パラメーター。

データセット同期設定

datasets 配列内の各オブジェクトは、同期するデータセットを 1 つ定義します。

プロパティ	説明
`name`	データセットの名前。
`file`	ERP システムからエクスポートしたマスターデータを含む CSV ファイルへのパス。CSV ファイルの 1 行目には、データセットの field 名をカンマ区切りで記載する必要があります。カンマを含む値は二重引用符で囲む必要があります。
`period`	同期タスクを開始する頻度。インポートと同じ形式で指定します。`period` と `schedule` はそれぞれ個別に設定できます。
`schedule`	同期タスクを開始する時刻。インポートと同じ形式で指定します。

同期を行うと、現在のデータセットは新しいものに置き換えられます。既存のレコードのうち、検証オペレーターが変更したもの (値の編集、追加、削除による変更) は保存されて同期されます。手動で追加した新しいレコードは削除され、同期されません。非常に大きなデータセットでは、同期に数時間かかることがあります。次の Vendors データセットの CSV ファイルの例では、最初のベンダーに複数の IBAN (国際銀行口座番号) が登録されています。

Id,Name,Street,City,ZIP,CountryCode,VATID,IBAN,IBAN,BusinessUnitId
1,MacWay,9 Route d'Eschau,Illkirch-Graffenstaden,67411,FR,1A345678901,FR1420041010050500012M02606,FR7630006000011234567890189,1
2,Bottled Water Ltd,Mary Ann St,Cardiff,CF102EN,GB,123456789,GB29NWBK60161331926819,,2
3,CCcompany Ltd.,2 Wilkins Grove,Welwyn Garden City,AL86JS,GB,234567890,GB27BOFI90212729823529,,3
4,MANZANA solutions,"Calle de la Botanica, 15",Madrid,28000,ES,E73895722,ES9121000418450200051332,,4

Windows Vault にサービスアカウントの認証情報を保存する

サービスアカウントの認証情報は、ABBYY FlexiCapture Connect サービスディレクトリ内の config.json ファイルに保存することも、より安全な方法として Windows Vault に保存することもできます。詳細については、Credential Manager および cmdkey に関する Microsoft の Documentation を参照してください。

Windows Vault に認証情報を追加する

ABBYY FlexiCapture Connect が Windows Vault からサービスアカウントの認証情報を取得できるようにするには、cmdkey で認証情報を登録し、同じ Windows アカウントでサービスを実行します。

Windows アカウントを作成または選択する

新しい Windows アカウントを作成するか、既存の Windows アカウントを選択します。

cmdkey で認証情報を登録する

その Windows アカウントで cmd.exe を実行し、次の cmdkey コマンドを実行します。このコマンドの https://europe.flexicapture.com#tenant は、ABBYY FlexiCapture の URL とテナント名を組み合わせたものです。

cmdkey /generic:https://europe.flexicapture.com#tenant /user:userName /password:p@ssword

設定ファイルから認証情報を削除する

ABBYY FlexiCapture Connect サービスディレクトリにある config.json ファイルから、user name と password を削除します。

その Windows アカウントでサービスを実行する

cmdkey の実行に使用したものと同じ Windows アカウントで起動するように、ABBYY FlexiCapture Connect を設定します。

Windows Service Manager (services.msc) を起動します。
Services のプロパティで、ABBYY FlexiCapture Connect を開きます。
Log On タブで、This account を選択し、Windows アカウントの認証情報を入力します。

This account が選択され、Windows アカウントの認証情報が入力された ABBYY FlexiCapture Connect サービスのプロパティの Log On タブのスクリーンショット。

Windows Vault から認証情報を削除する

Credential Manager を開く

Credential Manager を開きます。

認証情報を削除する

Windows Credentials タブで、削除する認証情報を展開し、Remove をクリックします。

Credential Manager の Windows Credentials タブで、認証情報が展開され、Remove オプションが表示されているスクリーンショット。

Projectのエクスポートパスを設定する

ABBYY FlexiCapture Connect を使用して ABBYY FlexiCapture Cloud からファイルをエクスポートするには、Projectのエクスポートパスを調整します。

ルートエクスポートパスを空にする

<Project> Properties ダイアログの General タブで、ルートエクスポートパス field が空欄のままであることを確認します。詳細については、Projectのプロパティを参照してください。

ルートエクスポートパス field が空欄になっている **<Project> Properties** ダイアログの **General** タブのスクリーンショット。

相対エクスポートパスを指定する

Export Settings ダイアログで、<Project> Properties ダイアログの General タブで指定したルートパスからの相対パスとして、エクスポートパスを指定します。このルートパスは空のままにしているため、ルートパスそのものは含めずにディレクトリを指定します。

空のルートパスからの相対パスとしてエクスポートパスが指定されている **Export Settings** ダイアログのスクリーンショット。

If file exists オプションは無視されます。ABBYY FlexiCapture Cloud から ABBYY FlexiCapture Connect 経由でファイルをエクスポートすると、新しいドキュメントごとに新しいファイルが作成されます。

ABBYY FlexiCapture Connectの制限事項

同期できるデータセットは約500,000レコードまでです。
データセットの更新中は、ユーザーはWeb Stationでベンダーを検索できません。
ABBYY FlexiCapture Connectでは、Project設定に基づくHot Folderのインポートプロファイルは認識されません。
ABBYY FlexiCapture Connectは、サーバー上で利用可能なすべてのバッチからドキュメントをエクスポートします。Project設定は出力先ディレクトリ名に影響せず、その名前は常に元のバッチ名と同じになります。
ABBYY FlexiCapture Connectでは、バッチ全体しかエクスポートできません。ProjectのWorkflow SettingsでWait for all documents in a batchオプションを無効にしても、ドキュメントが個別にエクスポートされることはありません。
ABBYY FlexiCapture Connectでは、1つのバッチ内のすべてのドキュメントの結果を1つのファイルにエクスポートすることはできません。バッチ内の各ドキュメントごとに、エクスポートディレクトリ内に個別のファイルが作成されます。
ABBYY FlexiCapture Connectでは、すべてのバッチの結果を1つのファイルにエクスポートすることはできません。各バッチの各ドキュメントごとに、エクスポートディレクトリ内に個別のファイルが作成されます。
インポートおよびエクスポートするファイルのサイズは199 MBまでに制限されています。
プロキシサーバーはサポートされていません。

ABBYY FlexiCapture Connect のエラーのトラブルシューティング

エラーが発生した場合は、まず %LocalAppData%\ABBYY\FlexiCapture\Connect\Logs にあるログファイルを確認してください。エラーは、設定ファイルに指定された設定が正しくない、または不完全であることが原因で発生する場合もあります。不整合や設定漏れがないか、config.json ファイルを確認してください。エラーが解消しない場合は、ABBYY サポートにお問い合わせください。サポートから、config.json ファイルとログファイルの両方の提出を求められる場合があります。

​システム要件

​ABBYY FlexiCapture Connect をインストールして設定する

​設定ファイルリファレンス

​一般設定

​Project設定

​インポート設定

​エクスポート設定

​Document Definition 設定

​データセット同期設定

​Windows Vault にサービス アカウントの認証情報を保存する

​Windows Vault に認証情報を追加する

​Windows Vault から認証情報を削除する

​Projectのエクスポート パスを設定する

​ABBYY FlexiCapture Connectの制限事項

​ABBYY FlexiCapture Connect のエラーのトラブルシューティング