ABBYY Vantage では、Vantage サーバー上の共有フォルダーからドキュメントをアップロードできます。
フォルダーへのアクセスは SFTP プロトコル経由で提供されます。作成したフォルダーのアクセス情報 (インポート用フォルダーと例外用フォルダーへのリンク、フォルダーへアクセスするためのログイン名とパスワードなど) は、Input Settings: Shared Folder ダイアログボックスに表示されます。
入力用共有フォルダーにファイルをアップロードするには、SFTP クライアントでバイナリ転送モードを使用する必要があります。
| フォルダー | 利用可能なユーザー操作 |
|---|
| Import フォルダー | - ファイルとディレクトリの一覧を表示 - フォルダーにファイルをアップロード - ファイルやディレクトリの名前を変更 - アップロード時に既存のファイルを上書き - ファイルを削除 |
| Exceptions フォルダー | - ファイルとディレクトリの一覧を表示 - フォルダーからファイルをダウンロード - ファイルやディレクトリの名前を変更 - ファイルを削除 |
Skill が公開されると、ABBYY Vantage は 20 秒ごとにフォルダー内の新規ファイルをチェックし始めます。
インポートエージェントが一度に取得できるファイル数は最大 30 件です。SFTP フォルダーへのアップロードがボトルネックになる場合は、SFTP フォルダーを個別に割り当てた Skill を 2 つ作成することを検討してください。これにより、2 つのエージェントが同時にファイルを取得できます。
ソースタイプ (FolderImport) とソースファイル名は、ドキュメント登録パラメーターの SourceType および SourceFileName に保存されます。Skill Monitor の Transactions セクションに対応する列を追加すると、これらのパラメーターの値にアクセスできます。これらは、完全なデータ抽出結果を含む出力 JSON ファイルにもエクスポートされます。出力アクティビティの Exported Data セクションで設定できます。
次の文字はファイル名で使用できず、アップロード時にアンダースコアに置換されます: / : ? # [ ] @ ! $ & ' ( ) * + , ; = \。元のファイル名はドキュメント登録パラメーターに保存されます。このスクリプトを使用して取得できます。
ファイルが正常にインポートされると、そのファイル用のトランザクションが作成され、ファイルはインポートフォルダーから削除されます。ファイルをインポートできず、トランザクションも作成されなかった場合は、例外フォルダー <Input folder name>-exception に移動されます。例外フォルダーの場所は、Input Settings: Shared Folder ダイアログで指定します。例外フォルダー内のファイルの保管期間は保持ポリシーによって決まり、既定では2週間です。
インポートフォルダーにファイルが残っていないのに処理結果が見つからない場合は、トランザクションがエラーで終了した可能性があります。トランザクションエラーの詳細は Skill Monitor で確認できます。詳しくは Skill Monitor Transactions Section を参照してください。
Vantage は共有フォルダーのトップレベルディレクトリからアーカイブをインポートできます。現在、次のファイルタイプがサポートされています:
- Windows で作成された ZIP ファイル
- Linux で tar czvf コマンドにより作成された TAR GZ ファイル
アーカイブをインポートできるのは、インポート方法で Single file が選択されている場合のみです。
アーカイブのサイズは 3 GB に制限されています。アーカイブ内の各ファイルのサイズは 100 MB に制限されています。
アーカイブごとに新しいトランザクションが作成されます。アーカイブ内のすべてのファイルは、そのトランザクションのドキュメントになります。アーカイブ名はドキュメント登録 Parameter の SourceArchiveName に保存されます。
アーカイブの種類がサポート対象外の場合、またはアーカイブに未サポートのファイル種類やアーカイブが含まれている場合、該当するトランザクションは失敗します。
ファイルサイズの制限に違反している場合、またはアーカイブにサブフォルダーが含まれている場合、当該アーカイブは例外フォルダーに移動され、トランザクションは作成されません。該当するエラーは Error log で確認できます。
複数のファイルを1つのトランザクションにインポートする
デフォルトでは、Vantage は共有フォルダーからインポートされた各ファイルごとに個別のトランザクションを作成します。Import method を From subfolder に設定すると、この動作を変更できます。このモードでは、Vantage はファイルではなくサブフォルダーを共有フォルダー内で検出します。サブフォルダー名は指定された命名スキームに一致している必要があります。条件に合うサブフォルダーが見つかると、そのサブフォルダー内のすべてのファイル (入れ子になったフォルダー内のファイルを含む) が、1つのトランザクションのドキュメントとしてインポートされます。サブフォルダー名は、各ドキュメントの SourceFolderName ドキュメント登録 Parameter に保存されます。
ファイルがサブフォルダー内の入れ子フォルダーからインポートされた場合、SourceFolderName Parameter にはルートサブフォルダーの名前が格納されます。
サブフォルダーをインポートできない場合は、Exceptions フォルダーに移動されます。Vantage はそのサブフォルダーに対してトランザクションを作成せず、Skill Monitor サービスの Error Log で確認できるエラーを生成します。
サブフォルダーに未サポート形式のファイルが含まれている場合、該当するトランザクションは失敗します。
サブフォルダーからのアーカイブのインポートはサポートされていません。
命名スキームに一致する名前の空のサブフォルダーは共有フォルダーから削除されますが、Vantage はそのサブフォルダーに対してトランザクションを作成せず、インポートできるデータがないため警告を生成します。この警告は Skill Monitor サービスの Error Log で確認できます。
サブフォルダーは、その名前がサブフォルダーの命名規則に一致する場合にのみインポートされます。既定値の「」は任意の文字列に一致します。マスクは、任意の数の文字を表すプレースホルダーとして「」記号を使用して設定できます。1 文字のプレースホルダーとしての「?」はサポートされません。マスクは大文字と小文字を区別しません。たとえば「subfolder」と「SUBFOLDER」は、いずれも「subfolder」マスクに一致します。マスクの長さは 64 文字に制限されます。
ファイル アクセスの競合を回避するため、まずファイルをサブフォルダーにコピーしてから、規則に従ってサブフォルダーの名前を変更してください。
ABBYY Vantage で共有フォルダーからの Document アップロードを設定する
- ドキュメント処理フローで Input アクティビティ ブロックを左クリックします。まだ Skill Designer に追加していない場合は、Activities ペインから追加します。
- Actions ペインで Select additional source にチェックを入れ、Shared folder を選択します。
- Settings をクリックします。共有フォルダーへのアクセス情報を設定するダイアログボックスが開きます。
提案されたインポート用フォルダー名は変更できます。
フォルダー名は次の条件を満たす必要があります:
- Skill 内で一意であること (Output アクティビティ ブロック内の他の共有フォルダー名と同一にできません) 。
- 数字または英字で始まること。
- 特殊文字
: * ? " < > / | \ および制御文字 (例: 改行、タブ) を含まないこと。
- 末尾をドットにしないこと。
- 空にしないこと。
- 64 文字以内であること。
- 必要に応じて、Import method を From subfolder に変更し、Subfolder naming scheme を要件に合わせて調整します (必要な場合) 。
- Input Settings: Shared Folder ダイアログで提供されたログイン情報を使用し、SFTP クライアントで当該フォルダーへのファイル取り込みを設定します。各 field の内容は、対応する field のコピー icon をクリックするとクリップボードにコピーできます。フォルダーリンクには接続設定に必要なすべてのデータが含まれています。リンクを SFTP クライアントの設定ダイアログに貼り付けると、その他の Parameter が自動的に入力されます。
- 変更を保存する場合は Save、保存しない場合は Cancel をクリックしてダイアログ ボックスを閉じます。
設定の変更は、Skill を発行した後にのみ有効になります。
管理者は Skill Monitor サービスを使用して、ドキュメントのインポートを無効化できます。詳細は Skill Monitor を参照してください。ドキュメントのインポートを無効化しても、API を通じてこの Skill にドキュメントをインポートすることには影響しません。
Skill を削除すると、共有インポートフォルダーはサーバーから削除されます。