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

システム要件

オペレーティング システム

  • Windows 10
  • Windows 11
  • Windows Server 2012 + Desktop Experience
  • Windows Server 2012 R2 + Desktop Experience
  • Windows Server 2016 + Desktop Experience
  • Windows Server 2019 + Desktop Experience
  • Windows Server 2022 + Desktop Experience

RAM

約 500,000 件のベンダーを含むデータセットには、2.5 GB 以上の RAM を推奨します

ソフトウェア互換性

  1. ABBYY FlexiCapture Connect は、ABBYY FlexiCapture Application Server Release 3 以降で使用できます
  2. .NET Framework 4.6.1 以降が必須です

セットアップ

ABBYY FlexiCapture Connect を設定するには、以下の手順に従ってください。
このセクションの手順を実行する際は、サービス アカウントを使用することをお勧めします。
  1. https://www.abbyy.com/flexicapture-downloads/cloud/ から FlexiCapture_Connect_Installer_*.msi** ファイルをダウンロードして実行します。 注: ABBYY FlexiCapture Connect がすでにインストールされていて、既存のバージョンを更新する場合は、必ず config.json ファイルのバックアップを作成してください。このファイルは C:\Program Files (x86)\ABBYY FlexiCapture Connect\config.json にあります。
  2. config.json ファイルを必要に応じて編集します (以下の 設定ファイルの説明 セクションを参照) 。
  3. 新しい設定をテストします。
    1. ABBYY FlexiCapture Connect サービスを一時停止します。
    2. ABBYY.FlexiCapture.Connect.exe ファイルを実行します。詳細なログが表示されたコンソール ウィンドウが開きます。
  4. ABBYY FlexiCapture Connect を再起動します。

設定ファイルの説明

{
"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" ]
}
]
}
]
}
]
}
一般的な設定ファイルの各セクションについては、以下で説明します。
  1. 一般設定
    • url – テナントのURL (例: https://europe.flexicapture.com) 。
    • tenant – テナント名。
    • user – サービスアカウントのユーザー名。 注: ドキュメントをインポートおよびエクスポートするには、テナントアカウントを External User として設定する必要があります。データセットを同期するには、テナントアカウントに Administrator ロール、または Project Settings Editor ロールと External User ロールの両方が必要です。既定では、テナントアカウントはすべてのプロジェクトにアクセスできます。これは、特定のユーザーロールに付与するアクセス権を調整することで変更できます。詳しくは、ユーザーロールとアクセス権の設定を参照してください。
    • password – サービスアカウントのパスワード。
    • projects – このセクションには、ドキュメントのインポートおよびエクスポートのパラメーターや、データセット同期のパラメーターなど、個々のプロジェクトの設定が含まれます。
  2. プロジェクト設定
    • name – プロジェクト名。
    • import – このセクションは、ドキュメントのインポートに使用します。
    • export – このセクションは、ドキュメントのエクスポートに使用します。
    • templates – このセクションは、データセットの同期に使用します。
  3. インポート設定
    • directory – ドキュメントのインポート元フォルダーへのパス。
    • fileMask – ファイルおよびフォルダーのフィルター。* と ? のワイルドカードがサポートされています。
    • settings – バッチ登録パラメーター。
    • createDocument – 指定可能な値は ForEachFile (インポートした各ファイルごとに個別のドキュメントを作成) または Automatically (プロジェクトのパラメーターを使用) です。この機能をアクティブ化するには、まず ABBYY FlexiCapture プロジェクトで Automatically when Document Definition is applied オプションを選択する必要があります。 注: ファイルがインポートされるたびに新しいバッチが作成されます。バッチ名には現在の日付と時刻が含まれます。
    • periodschedule – タスクスケジュール。period プロパティは、タスクをどのくらいの頻度で開始するかを指定します (たとえば、“period”: “00:02:30” はタスクを2分30秒ごとに開始します) 。schedule プロパティは、タスクを開始する時刻を指定します (たとえば、“schedule”: [ “09:00:00”,“19:00:00” ] はタスクを毎日9:00と19:00に開始します) 。 注: period プロパティと schedule プロパティは、互いに独立して設定できます。
  4. エクスポート設定
    • directory – エクスポートしたファイルを保存するフォルダーへのパス。 注: ドキュメントがエクスポートされると、現在「処理完了」ステージにあるプロジェクト内の各バッチごとにフォルダーが作成されます。これらの出力先フォルダーには、それぞれ対応するバッチと同じ名前が付けられ、すべての処理結果が格納されます。出力先フォルダーが削除された場合、プログラムは同じ名前の新しいフォルダーを作成し、そこに処理結果を配置します。
    • periodschedule – タスクスケジュール。period プロパティは、タスクをどのくらいの頻度で開始するかを指定します (たとえば、“period”: “00:02:30” はタスクを2分30秒ごとに開始します) 。schedule プロパティは、タスクを開始する時刻を指定します (たとえば、“schedule”: [ “09:00:00”,“19:00:00” ] はタスクを毎日9:00と19:00に開始します) , 注: period プロパティと schedule プロパティは、互いに独立して設定できます。
  5. Document Definition 設定
    • name – 指定したセクションに関連付けられた Document Definition の名前。
    • datasets – Document Definition のデータセット同期パラメーター。
  6. データセット同期設定
  1. データセットを同期すると、現在のデータセットは新しいものに置き換えられます。2) 検証オペレーターが値の編集、追加、削除によって変更した既存のレコードは保存されて同期されますが、手動で追加した新しいレコードは削除されるため、同期されません。3) 非常に大きなデータセットの場合、同期に数時間かかることがあります。
  • name – データセット名。
    • file – ERP システムからエクスポートされたマスターデータを含む CSV ファイルへのパス。 注: CSV ファイルの先頭行には、データセットのフィールド名をカンマ区切りで記載する必要があります。カンマを含む値は、二重引用符で囲む必要があります。
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
  • periodschedule – タスクの実行スケジュール。period プロパティは、タスクをどのくらいの間隔で開始するかを指定します (たとえば、“period”: “00:02:30” は、2 分 30 秒ごとにタスクを開始します) 。schedule プロパティは、タスクを開始する時刻を指定します (たとえば、“schedule”: [ “09:00:00”,“19:00:00” ] は、毎日 9:00 と 19:00 にタスクを開始します) 。 注: period プロパティと schedule プロパティは、それぞれ独立して設定できます。

Windows Vault を使用したサービス アカウント認証情報の保存

サービス アカウントの認証情報は、ABBYY FlexiCapture Connect サービス ディレクトリ内の config.json ファイル、またはより安全な方法として Windows Vault に保存できます。詳細については、こちら または こちら を参照してください。 ABBYY FlexiCapture Connect が Windows Vault からサービス アカウント認証情報を取得できるようにするには、次の手順に従います。
  1. 新しい Windows アカウントを作成します (または既存の Windows アカウントを選択します) 。
  2. 新しく作成した Windows アカウント (または手順 1 で選択した既存の Windows アカウント) で cmd.exe を実行し、次のコマンドを実行します: cmdkey /generic:https://europe.flexicapture.com#tenant /user:userName /password:p@ssword。ここで、https://europe.flexicapture.com#tenant は、ABBYY FlexiCapture の URL とテナント名を組み合わせたものです。
  3. ABBYY FlexiCapture Connect サービス ディレクトリにある config.json ファイルから、Username とパスワードを削除します。
  4. Windows Service Manager (services.msc) を実行し、ABBYY FlexiCapture Connect が手順 2 で選択した Windows アカウントと同じアカウントで起動するように設定します:
    1. Services のプロパティで、ABBYY FlexiCapture Connect を開きます。
    2. Log On タブで、This account を選択し、Windows アカウントの認証情報を入力します。
Windows Vault から認証情報を削除するには:
  1. Credential Manager を開きます。
  2. Windows Credentials タブで、削除する認証情報を展開し、Remove をクリックします。

エクスポートの設定

ABBYY FlexiCapture Cloud から ABBYY FlexiCapture Connect を使用してファイルをエクスポートするには、以下の説明に従ってプロジェクトを設定します。
  1. <project> Properties ダイアログの General タブで、Export root path field が空欄のままであることを確認します (詳細は Project properties を参照) 。
  1. Export Settings ダイアログで、<project> Properties ダイアログの General タブで指定したルート パスからの相対パスとしてエクスポート パスを指定します。このルート パスは空欄のままなので、ルート パス自体は含めずにディレクトリを指定します。
If file exists オプションは無視されます。ABBYY FlexiCapture Cloud から ABBYY FlexiCapture Connect 経由でファイルをエクスポートする場合、新しいドキュメントごとに新しいファイルが作成されます。

制限事項

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

トラブルシューティング

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