Desktop Automation サービスの設定

この章では、Desktop Automation サービスの設定について説明します。

Desktop Automation の前提条件

Desktop Automation の要件および前提条件については、すべて 『Kofax RPA インストール ガイド』 の「依存関係と要件」の章に記載されています。

Desktop Automation サービスは Windows UI オートメーション API に依存しています。UI オートメーション API クライアントは同じコンピュータ上で Desktop Automation Agent と同時に実行しないでください。

Desktop Automation エージェントの設定

コンピュータが Desktop Automation に必要な要件をすべて満たすと、Desktop Automation エージェントをインストールおよび構成することができます。

  1. Java アプリケーションを自動化する必要がある場合、Java 32 ビット (JRE または JDK) をリモート デバイスにインストールし、Java Access Bridge がデバイスで有効になっていることを確認します。詳細については、Java Access Bridge の確認 を参照してください。
  2. Kofax RPA Desktop Automation インストーラをデバイスにダウンロードし、実行します。
  3. Desktop Automation サービスをスタート メニューから開始します。サービスが開始すると、そのステータスを通知領域のアイコンで確認できます。

    アイコン

    ステータス

    デバイス オートメーション サービスが開始中

    Desktop Automation サービスが開始し、設定されている Management Console に接続しようとしています。

    デバイス オートメーション サービスが実行中で、Management Console に接続していない

    Desktop Automation サービスが実行中で、設定に応じて Management Console に接続されているか、またはシングル ユーザー モードで実行中です。

    デバイス オートメーション サービスが実行中で、Management Console に接続されている

    Desktop Automation サービスが実行中で、RoboServer または Design Studio によって使用中です。

    デバイス オートメーション サービスは実行していない

    Desktop Automation サービスは実行していません。

    デバイス オートメーション サービス エラー

    Desktop Automation サービスはエラーのため実行していません。

  4. Desktop Automation サービス オプションを編集するには、通知領域の Desktop Automation サービス アイコンを右クリックし、[設定] を選択します。これにより、Desktop Automation サービス ウィンドウが開きます。オプションを変更したら、[保存して再起動] をクリックします。

    オプションを手動で編集するには、オートメーション デスクトップの server.conf ファイルを開きます。ファイルは [ユーザー] > [ユーザー名] > [AppData] > [ローカル] > [Kofax RPA 11.1.0] フォルダにあります。ユーザー名はサービスが実行されているユーザーの名前です。

    以下の Desktop Automation サービス オプションの表を参照してください。
  5. [管理] > [デバイス] タブでデバイスが Management Console に登録されていることを確認します。

以下は、Desktop Automation サービス構成ウィンドウです。


デバイス オートメーション サービス設定ダイアログ ボックス

次の表に、利用可能な Desktop Automation サービス オプションを一覧表示します。

設定ウィンドウ オプション

server.conf オプション

値と説明

[シングル ユーザー]

Design Studio からオートメーション デスクトップへの直接接続、または RDP 接続の使用時に選択します。

"singleUser"

クリア (デフォルト)

指定した Management Console に Desktop Automation サービスを自動的に登録するには、空のままにします。

オートメーション デスクトップへの直接接続の場合は、オプションを選択し、トークンを指定します。*

[ホスト名]

"hostName"

Desktop Automation サービスを実行しているコンピュータの名前または IP アドレス。

コンピュータに複数の名前または IP アドレスが設定されている場合、RoboServer と Design Studio がこの Desktop Automation エージェントとの通信に使用するものを指定します。つまり、ホスト名または IP アドレスは RoboServer と Design Studio から接続可能である必要があります。

[コマンド ポート]

"commandPort"

49998 (デフォルト)

Desktop Automation サービスが手動で設定されていない状態で開始した場合は、デフォルトの設定が使用され、デフォルトの 49998 ポートでリッスンします。

必要に応じて、このポートをオートメーション デスクトップに再割り当てします。

[ストリーム ポート]

"streamPort"

49999 (デフォルト)

このポートは、Design Studio と Desktop Automation サービス間のデータ送信に使用されます。streamPort が "0" に設定されると、Desktop Automation サービスではランダムにポート番号が選択されます。

Design Studio とオートメーション デスクトップの間にファイアウォールがある場合、streamPort の再割り当てが必要になることがあります。

[CA ファイル]

"caFile"

空 (デフォルト)

SSL を使用して Management Console と通信できます。node.js のデフォルトの証明書が使用されない場合、このパラメータを使用して別の証明書へのパスを指定できます。これを動作させるにはルート証明書が必要であります。Google Chrome ブラウザからルート証明書をファイルに保存するには、次のようにします。

  1. アドレス バーのロック アイコンを右クリックし、[証明書 (有効)] をクリックします。

  2. [証明のパス] タブで、一番上の (ルート) 証明書を選択し、[証明書の表示] をクリックします 。

  3. [詳細] タブで [ファイルにコピー] をクリックし、ウィザードを完了してルート証明書を base-64 エンコード X.509 証明書としてエクスポートします。

これで、エクスポートされた証明書を含むファイルへのパスを指定できるようになります。

[タイムアウト]

"commandTimeout"

このオプションでは、コマンド実行のタイムアウトを秒単位で指定します。コマンドとは、マウス ボタンをクリックする、アプリケーションを開く、「ロケーションが見つかった場合」ガードを追加するといったオートメーション デスクトップに送信される命令のことです。コマンドが指定した時間内に完了できない場合、サービスによって通知が送信され、ロボットの実行が停止します。

ガード チョイス ステップの場合、この設定はワークフローでのガードの呼び出しに適用されますが、ガードが満たされるまでの待機はこのタイムアウトとは無関係のため、無制限に待機し続ける可能性があります。マウス移動 ステップと抽出ステップの使用時に、同様の状況が発生します。コマンドはフィールドで指定されたタイムアウト以内にデバイスで呼び出される必要がありますが、ロボットはコマンドの完了を最大 240 秒間待機します。

Desktop Automation ロボットでのターミナルの自動化や Web サイトの閲覧に対するコマンド タイムアウトは、Design Studio でワークフローを実行する場合は、[Design Studio 設定] ウィンドウの [Desktop Automation] タブで設定し、RoboServer を実行する場合は、[RoboServer 設定] ウィンドウの [セキュリティ] タブの Desktop Automation セクションで設定します。

[シングル ユーザー] タブの [トークン]

"token"

空 (デフォルト)

[シングル ユーザー] オプションが選択されていない場合は、このオプションを空のままにします。オートメーション デスクトップ (シングル ユーザーが選択済み) への直接接続を使用する場合は、トークンを指定します。定義されたどのトークンでもかまいません。

[証明書] タブ
[オプション] ダイアログ ボックスの [証明書] タブ

"tlsServerConfig"

Kofax RPA は、オートメーション デスクトップと RoboServer または Design Studio の間の TLS 通信を提供します。通信には、通信を暗号化するための証明書が使用されます。以下は、server.conf ファイル コードの抽出です。詳細については、TLS コミュニケーションを使用を参照してください。

  "tlsServerConfig": {
    "key": "kapow.remote.das.pem",
    "cert": "kapow.remote.das.cert.pem",
    "ca": "./serverCa"
  },

[Windows] タブ

"automationnative"

  • "useLegacy"

    状況によっては、Java Access Bridge が動作しないため、レガシー モードに切り替えることをお勧めします。デフォルトは false です。

  • インストール済みパッケージ

    このコンピュータにインストールされている Desktop Automation サービスパッケージを表示します。バージョン 10.7 から、以下の [パッケージをロック] オプションが選択されていない場合は、新しいバージョン パッケージが自動的にインストールされます。ZIP ファイルのパッケージは、自動化されたコンピュータの C:\ProgramData\Kofax RPA にインストールされます。RoboServer のバージョンに応じて、適切なパッケージが自動的に選択されます。使用するバージョン パッケージを 1 つだけ指定する場合は、[パッケージをロック] を選択し、インストールされているパッケージの 1 つを選択します。

  • パッケージをロック

    選択すると、作業する唯一のバージョン パッケージを選択できます。異なるバージョンの RoboServer は、このサービスに接続できません。デフォルト: オプションはクリアまたは server.conf ファイルで false です。

    トリガーを使用してロボットを実行する場合、このオプションを選択するか、server.conf ファイルで設定を true に変更します。

  • RFS 共有をドライブ文字にマッピング

    ロボット ファイル システムのファイル共有が使用している Windows ドライブ。ファイル共有が Windows ドライブにマップされると、他の Windows アプリケーションもこのファイル共有にアクセスできます。

[OCR] タブ

"ocrConfig"

"defaultLanguage": "eng"

"ocrEngine": "tesseract",

OCR 操作を実行するために、1 つ以上の言語と 1 つのエンジンを指定します。Tesseract エンジン (デフォルト) および OmniPage OCR エンジンから選択できます。OmniPage エンジンを使用するには、[OCR] タブで [Kofax OmniPage OCR を使用 (RPA 11.1 以降で作成されたロボットのみ)] を選択します。[有効な OCR 言語] フィールドで OCR 言語を指定します。たとえば、日本語を使用する場合は、engjpn に置き換えます。または、複数の言語を使用する場合は、eng+jpn といったように + 記号を使用して jpn を追加します。

Tesseract の場合、Kofax RPA でインストールされるのは英語版のみです。言語のインストール手順については、以下の Desktop Automation のデフォルトの OCR 言語の変更 を参照してください。

[システム] タブ

このタブでは、ログ ファイルを開いてエラーを調べることができ、サービス ファイルのバージョンと場所が表示されます。このタブを使用して、サービスが実行されているコンピュータに Java Access Bridge が適切にインストールされているかどうかを確認できます。詳細については、Java Access Bridge の確認を参照してください。

Management Console オプション

[MC パス]

接続プロトコル、名前または IP アドレス、ポート番号、およびデバイス パスを登録する必要がある Management Console 。形式は次のとおりです。

http://10.10.0.136:50080.

"hostName"

デバイスを登録する必要がある Management Console の名前または IP アドレス。

"port"

指定した Management Console の接続ポート。

"schema"

指定した Management Console の接続プロトコル。

"path"

空 (デフォルト)

ポート番号の後のスタンドアロン Management Console へのパスの部分。たとえば、Management Console が Tomcat ( http://computer.domain.com:8080/ManagementConsole/) で展開されている場合、このパラメータで "/ManagementConsole/" を指定します。組み込み Management Console インストールの場合、このパラメータを空のままにします。

[ユーザー名]

"user"

空 (デフォルト)

指定された Management Console で認証するためのユーザー名。

[パスワード]

"password"

空 (デフォルト)

指定された Management Console で認証するためのパスワード。

[クラスタ]

"cluster"

プロダクション (デフォルト)

指定した Management Console のクラスタ名。

[ラベル]

"labels"

"label1,label2" (デフォルト)

オートメーション デバイスを区別するためのラベル。

[ping 間隔 (ms)]

"pingInterval"

5000 (デフォルト)

Desktop Automation サービスが Management Console に ping 送信する時間間隔。

[プロキシを使用して Management Console に接続]

"useProxy"

このオプションを Desktop Automation サービスに選択し、Management Console への接続時にプロキシを使用します。必要なパラメータはすべて次のフィールドで指定されます。


プロキシを使用して Management Console に接続するパラメータ

Linux の場合、server.conf ファイルの managementConsole セクションでプロキシ パラメータを設定できます。

    "useProxy": true,
    "proxyHostName": "proxyhost.com",
    "proxyPort": 9000,
    "proxyUserName": "username",
    "proxyPassword": "pwd"

* オートメーション デスクトップへの直接接続は、Design Studio でロボットの作成やデバッグを行う場合、および RDP 接続で使用する場合にお勧めします。

Desktop Automation サービスのロギング

Kofax RPA はサービス パフォーマンスを向上するために、特定の Desktop Automation サービス イベントの使用情報を収集します。

  • Desktop Automation サービスが Management Console に接続している場合、イベントは Management Console の RoboServer ログ データベースに保存されます。イベントを表示するには、[ログ ビュー] ページで [DAS メッセージ] を選択します。

    Management Console の接続パラメータが Desktop Automation サービスの設定ウィンドウで指定されている場合、[シングル ユーザー] モードが選択されていても、イベントは常に Management Console にログ記録されます。つまり、オートメーション デスクトップへの接続は Management Console がなくても直接確立されます。

  • もし Desktop Automation サービスが Management Console に接続できない場合 (Management Console が設定されていないため)、次の場所にある Desktop Automation Service Usage.csv のログ ファイルにイベントが書き込まれます。{path}\AppData\Local\Kofax RPA\<バージョン番号>\Logs\

    ファイルの場所は、log4net.xml ファイルで設定できます。

各イベントの情報には次が含まれています。

  • イベントが発生した時間 (UTC)。
  • イベントの種類:開始、停止、接続、切断、中断、スクリーン ロック。

  • Desktop Automation サービスの識別。host:port フォームの ID、サービスを実行しているユーザー アカウント、サービスに定義されたラベルを含みます。

  • ロボットの名前と実行 ID (接続と切断の場合のみ)。

  • 重要度の表示 (常に「情報」)。

  • メッセージ (常に空)。

Desktop Automation でのプロキシ サーバーの設定

すべての Desktop Automation サービス ロボットは Kofax RPA グローバル プロキシ設定を使用できます。Desktop Automation サービスは、Design Studio および Management Console と同じプロキシ設定を使用します。プロキシ サーバーの設定を構成するには、2 つの方法があります。

重要 Desktop Automation サービスの組み込みブラウザのローカル プロキシ設定は、[Design Studio] > [Design Studio 設定] で設定された Kofax RPA グローバル プロキシ設定よりも優先されます。タスクでローカル プロキシ設定を使用する必要がない限り、ロボットが Kofax RPA グローバル プロキシ設定を使用していることを確認してください。

また、cef.cfg ファイルを使用してプロキシ設定を構成することはできませんが、このファイルを使用した場合、上記のすべてのプロキシ設定よりも優先されます。

  1. Desktop Automation サービスで実行しているすべてのロボットに対して、[Design Studio 設定] ダイアログ ボックスの [プロキシ サーバー] タブで、次のプロキシ サーバーの詳細を入力します。

    • ホスト

    • ポート番号

    • ユーザー名

    • パスワード

    • 除外ホスト名

  2. 展開されたすべてのロボットに対して、[Management Console] > [管理] > [RoboServer] > [設定] > [「プロキシ サーバー」] タブで [新しいプロキシ] を選択し、次のプロキシ サーバーの詳細を入力します。

    • ホスト名

    • ポート番号

    • ユーザー名

    • パスワード

    • 除外ホスト名

Java Access Bridge の確認

Java Access Bridge は、Java アプリケーションを自動化する際に不可欠なコンポーネントです。Java のバージョンによっては、必要なファイルの一部がシステム フォルダ内にないことがあるため、Java Access Bridge は Desktop Automation サービスがインストールされているコンピュータで無効になっている場合があります。Java Access Bridge のインストール状態を確認するには、以下の手順を実行します。

  1. 通知領域で Desktop Automation アイコンを右クリックし、[設定] を選択します。
  2. [システム] タブをクリックし、[Java Access Bridge ファイルの確認] をクリックします。

    [Java Access Bridge] ダイアログ ボックスが開き、インストールされている Java のバージョンと、各バージョンの Java Access Bridge のインストール ステータスが表示されます。[JAB インストール] 列、[Java Access Bridge の Windows システム フォルダへのインストール]、[Java Access Bridge の有効化] に [はい] と表示されている場合、Java Access Bridge はコンピュータ上に適切にインストールされ、有効にされています。


    [Java Access Bridge] ダイアログ ボックスで Java Access Bridge の適切なインストールを確認
  3. [Java ホーム ディレクトリ] の下に Java の実装が表示されない場合、[フォルダの追加] をクリックし、Java ファイルがインストールされているホーム フォルダを指定します。

  4. [JAB インストール] 列に [いいえ] が表示されるなど、見つからないファイルがある場合は、[見つからないファイルの表示] をクリックします。

    [Java Access Bridge の見つからないファイル] ダイアログ ボックスに指定したフォルダにコピーする必要のあるファイルが表示されます。[見つからないファイルのインストール] をクリックして、Kofax RPA から提供されている最新バージョンの Java Access Bridge ファイルを Desktop Automation サービスのインストール フォルダにインストールします。

  5. [Java Access Bridge の有効化] に [いいえ] と表示されている場合は、[Java Access Bridge の有効化] をクリックします。

Desktop Automation のデフォルトの OCR 言語の変更

Kofax RPA では、Tesseract OCR エンジンまたは OmniPage OCR エンジンを使用して、イメージからテキストをキャプチャします。Tesseract の場合は、Kofax RPA の英語版のみがインストールされますが、OmniPage の場合は、サポートされるすべての言語のバージョンがインストールされます。ロボットが Desktop Automation を使用して 画像からテキスト抽出 ステップでテキスト認識を実行すると、Kofax RPA では [Desktop Automation サービス] ウィンドウの [OCR] タブで選択した言語が使用されます。OCR のデフォルトの言語を変更するには、次のステップを実行します。

  1. 通知領域で Desktop Automation アイコンを右クリックし、[設定] を選択します。
  2. [OCR] タブをクリックし、OCR に使用する言語の言語コードを [有効な OCR 言語] フィールドに入力します。言語コードは ISO 639-3 または ISO 639-1 形式である必要があります。複数の言語を使用するには、eng+jpn といったように + 記号を使用して別の言語を追加します。
    スクリーン認識で複数の言語を同時に使用すると、ロボットの実行が遅くなり、認識結果が低下します。
  3. [保存して再起動] をクリックします。

Tesseract を使用して英語以外の言語のテキスト認識を行う場合は、まず次のように必要な言語パックをダウンロードしてコピーする必要があります。

  1. 必要な言語の .traineddata ファイルを https://github.com/tesseract-ocr/tessdata からダウンロードします。たとえば、フランス語のファイルは fra.traineddata です。
  2. ダウンロード済みのトレーニングしたデータ ファイルを ProgramData フォルダの Kofax RPA\[バージョン]\lib\tessdata にコピーします。例:

    C:\ProgramData\Kofax RPA\11.1.0_110\lib\tessdata

TTF フォントまたは UI スクリーンショットのいずれかを使用して、Tesseract が文字セットを認識できるようにトレーニングすることができます。詳細については、Tesseract のトレーニングを参照してください。

仮想入力ドライバーをアクティブにする

仮想入力ドライバーは、ハードウェア キーボードとマウスをシミュレートできる Windows デバイス ドライバーです。ドライバーでサポートされるオペレーティング システムについては、Kofax RPA ドキュメント サイトで入手可能な『Kofax RPA 技術仕様書』を参照してください。ドライバーのインストールについては、『Kofax RPAインストール ガイド』 を参照してください。

スクリーン ロック機能や RDP ステップなどにより、自動化されているコンピュータのデスクトップがロックされている場合、仮想入力ドライバーは機能しません。

自動化されるコンピューターでキーボードおよびマウス操作の仮想入力ドライバーを有効にするには、環境変数 KOFAX_RPA_VIRTUAL_INPUTY.に設定します。仮想入力ドライバーの使用をキャンセルするには、環境変数を N に設定します。