WinActor

2021.02.02
サンプルシナリオ 外部サービス連携
AI inside 株式会社の「DX Suite」をWeb API経由で利用し、ファイルアップロードとOCR結果取得を行うサンプルシナリオ

DX Suite のOCRへPDFファイルをアップロードしてOCR実行結果をダウンロードするサンプルシナリオとなります。

DX Suite のOCRを利用して書類に書かれた文字列をデータ化したいユーザ向けのサンプルシナリオです。
本サンプルシナリオを変更することで、Web API経由でDX Suite のOCRを実行する手順を自動化することが可能です。

本コンテンツをダウンロードする前にこちらの利用条件を必ずご確認いただき、内容に同意をしたうえでダウンロードしてください。 また、"コンテンツの利用条件"は下のボタンからダウンロードし、お手元で保管してください。

サンプルシナリオ概要

はじめに

WinActorのライブラリ等のWinActorモジュールを使用して、AI inside 株式会社のAI-OCRサービス「DX Suite」にWeb APIを介してPDFファイルをアップロードしてOCR実行結果のCSVファイルをダウンロードするサンプルシナリオ(以降、本サンプルシナリオ)について説明します。

本サンプルシナリオの概要

本サンプルシナリオは、以下の処理を行います。

  • DX Suite に読み取りを行うPDFファイルをアップロードします。
  • DX Suite のOCRを実行します。
  • OCR実行結果のCSVファイルをダウンロードします。

使用するWinActorモジュール

本サンプルシナリオでは、以下のWinActorモジュールを使用します。

  • ノード/アクション/指定時間待機
  • ノード/アクション/スクリプト実行
  • 02_エラー処理/エラー.ums6
  • 07_文字列操作/01_変換・整形/括弧書きの内側を取り出す.ums6
  • 07_文字列操作/03_連結/文字列の連結(4つ).ums6
  • 07_文字列操作/03_連結/文字列の連結(5つ).ums6
  • 98_構造データ関連/01_JSON/JSON変数 読み取り.ums6
  • 98_構造データ関連/01_JSON/JSON形式読み取り.ums6
  • 99_外部サービス連携/02_HTTP関連/HTTP.ums6

本サンプルシナリオの入力ファイル

PDFファイルを入力ファイルとします。
シナリオ内でDX Suite にアップロードし、OCR読み取りを行います。
入力ファイルの詳細は、入力ファイルの形式を参照してください。

本サンプルシナリオの想定レベル

本ドキュメントは、以下の技術レベルのユーザを対象としています。

  • DX Suite の使い方について理解している。

動作確認環境

本サンプルシナリオは以下の環境で確認しています。

  • Windows 10、WinActor 6.3.0
  • Windows 10、WinActor 7.1.0

制約事項

  • 本サンプルシナリオを実行するためには、DX Suite にアクセスするためのインターネット環境が必要です。
  • 本サンプルシナリオおよびドキュメントは、DX Suite にログインできる状態を前提に記載されています。
  • 本サンプルシナリオは WinActor 6.3 より古いバージョンでは動作しません。

本サンプルシナリオの使い方

本サンプルシナリオの実施方法は以下の通りです。

Step1.DX Suite 事前設定

本サンプルシナリオではシナリオ実行前の手順としてDX Suite を操作する必要があります。

DX Suite へのログイン

DX Suite を開いてログインを行ってください。

login_v1.1.png

DX Suite ホーム画面

ドキュメントの読み取り範囲の設定

本サンプルシナリオではドキュメントの読み取り範囲を事前に設定する必要があります。
以下の手順で設定をしてください。(手順内に記載されている"注文書サンプル.pdf"は本サンプルシナリオに添付されています。)

1. ホーム画面の[Intelligent OCR]ボタンを押下します。
2. Intelligent OCR画面のフォルダの[追加]ボタンを押下します。

intelligentOCR_v1.1.png

Intelligent OCR画面



3. フォルダ作成画面のフォルダ名入力欄に「注文書」を入力します。 ※任意の文字列で問題ありません。
4. フォルダ作成画面の[作成]ボタンを押下します。

createFolder_v1.1.png

フォルダ作成画面



5. IntelligentOCR画面のドキュメントの[追加]ボタンを押下します。(ボタン左の文字列(注文書)は先ほど追加したフォルダ名です。)
6. ドキュメント作成画面の[新しい画像から]を押下します。
7. ドキュメント作成画面下部に表示された[ファイルを選択]を押下します。
8. ファイル選択画面から"注文書サンプル.pdf"を選択します。
9. ドキュメント作成画面下部に表示されたドキュメント名入力欄に「注文書_01」を入力します。 ※任意の文字列で問題ありません。
10. ドキュメント作成画面下部に表示された[ドキュメント設定へ進む]を押下します。

createDocument_v1.1.png

ドキュメント作成画面


11. ドキュメント設定画面左側のツールの[読取範囲の指定]を押下し、ドキュメント設定画面の画像の注文書と同じく読み取り範囲選択の指定をします。
 読み取り範囲は以下の項目に指定します。 ※発注日以外の項目は行をまとめて設定してください。

  • 発注日
  • 品名
  • 入数
  • 箱数
  • 数量
  • 単位
  • 単価
  • 金額



settingDocument_v1.1.png

ドキュメント設定画面



12. ドキュメント設定画面右側の読取範囲全てにCSV設定をします。
  以下の表の値を設定してください。

table_v1.1.png

CSV読み取り範囲設定



readingBlock_v1.1.png

読取範囲設定ブロック



13. ドキュメント設定画面右側の読取範囲ブロック全てのワークフロー 1番に「OCR」を設定します。
14. ドキュメント設定画面右側の品名の読取範囲の[設定]ボタンを押下します。
15. 読取範囲の詳細画面の縦入力欄に行数「8」を入力します。
16. 読取範囲の詳細設定画面の[設定]ボタンを押下します。
17. 14~16までの手順を発注日以外の読取範囲ブロック全てに行います。

readSetting_v1.1.png

読取範囲の詳細設定画面



18. ドキュメント設定画面左側のツールの[データ加工設定]を押下します。
19. データ加工設定画面の右上部にある[追加]ボタンを押下します。
20. データ加工設定画面の中央に表示された設定ブロックのリンスコントロールから「前行コピー」を選択します。
21. データ加工設定画面の中央に表示された設定ブロックの入力列入力欄に「A(1)」を入力します。
22. データ加工設定画面の中央に表示された設定ブロックの出力列入力欄に「A(1)」を入力します。
23. データ加工設定画面の右上部にある[追加]ボタンを押下します。
24. データ加工設定画面の中央に表示された設定ブロックのリストコントロールから「読取範囲グループ行分割」を選択します。
25. データ加工設定画面の中央に表示された設定ブロックの入力列入力欄に「B(2)」を入力します。
26. データ加工設定画面の中央に表示された設定ブロックの出力列入力欄に「B(2)」を入力します。
27. 23~26の手順を発注日以外の読取範囲分行います。使用する列名は順に C(3), D(4), E(5), F(6), G(7), H(8)です。
28. データ加工設定画面下部の[確定]ボタンを押下します。

dataProcessing_v1.1.png

データ加工設定画面



29. ドキュメント設定画面右下部の[保存]ボタンを押下します。
30. ポップアップされた保存後の画面遷移先の[一覧画面へ戻る]を押下します。
31. Intelligent OCR画面の左上部の[ホームマーク]ボタンを押下します。

Step2.入力ファイルをディレクトリに配置

任意のディレクトリに入力ファイルを配置します。
本サンプルシナリオには、サンプルのPDFファイル(注文書サンプル.pdf)が添付されています。 このファイルを使用して、入力を行います。

Step3.WinActorで本サンプルシナリオを読み込み

WinActorを起動し、本サンプルシナリオを読み込みます。

Step4.動作に必要な変数を設定

本サンプルシナリオを実行するために必要な値を、変数一覧で設定します。
本サンプルシナリオの実行にあたり、事前に設定が必要な変数は下記の通りです。

  • APIキー
    • DX Suite のAPIキーを指定します。
      APIキーはDX Suite のホーム画面右上の組織名をクリックし、[設定] - [APIキー] の設定から確認できます。

  • 読み取りファイルパス
    • 本サンプルシナリオの入力ファイルのファイルパスを指定します。
      例) C:\sample\注文書サンプル.pdf

  • 読み取り結果CSVファイルパス
    • OCR実行結果のファイルを出力するファイルパスを指定します。
      例) C:\sample\結果.csv

  • ドキュメントId
    • ドキュメントIDを指定します。
      documentIdはIntelligent OCR画面のいずれかのドキュメントを選択するとアドレスバーに表示されます。("documentId=0000" の0000の部分)

  • URL社名部分
    • URLに表示されている社名部分を指定します。
      社名部分はDX Suite を開いている際のアドレスバーに表示されます。(https://社名.dx-suite.com/ConsoleWeb/Dx/Top)

variable_webAPI_v1.1.png

本サンプルシナリオ変数一覧の設定

Step5.WinActorで本サンプルシナリオを実行

本サンプルシナリオを実行します。
OCR実行結果がダウンロードされると、本サンプルは終了します。

Step6.サンプルシナリオ実行終了後の確認

OCR読み取り結果CSVファイルパス変数に設定したファイルにOCR実行結果が記載されていることを確認してください。

トラブルシューティング

本サンプルシナリオでは、HTTPリクエストを使用しています。
シナリオ実行中にエラーが表示される場合はお手数ですが、エラーに表示されているレスポンスステータスコードを確認してください。
また、Step 4. 動作に必要な変数を設定を再度確認してください。

サンプルシナリオ解説

本サンプルシナリオで使用している実装テクニックについて説明します。

入力ファイルの形式

本サンプルシナリオの入力ファイル(PDF)は以下の形式をとります。

inputFile_v1.1.png


入力ファイルサンプル

入力ファイルを自作する場合の注意事項

読み取り範囲を設定したドキュメント(入力ファイルサンプル)に形式を合わせて作成してください。
また、自作した場合は読み取り箇所がずれてしまうことがあるため、OCR実行をして読み取り結果を確認してください。

変更履歴

版数 日付 修正内容
版数
1.0版
日付
2020/2/13
修正内容
初版
版数
1.1版
日付
2021/2/2
修正内容
DX Suite のアップデートに対応。(DX Suite 2020/12/22 リリース版で動作確認済。)
版数
1.2版
日付
2024/1/11
修正内容
・注意事項を削除
・ファイル名を「SS2002_10043_DXSuite_Operation_WebAPI_1.0.1.zip」に変更

本コンテンツをダウンロードする前にこちらの利用条件を必ずご確認いただき、内容に同意をしたうえでダウンロードしてください。 また、"コンテンツの利用条件"は下のボタンからダウンロードし、お手元で保管してください。

"外部サービス連携"に関連するその他のサンプルシナリオ

サンプルシナリオ一覧へ戻る
当サイトでは、お客さまに最適なユーザー体験をご提供するためにCookieを使用しています。当サイトをご利用いただくことにより、お客さまがCookieの使用に同意されたものとみなします。詳細は、「プライバシーポリシー」をご確認ください。