プロキシサーバーをご利用の企業における OPA（On-Prem agent）のインストール

# はじめに

Workato の OPA（On-Prem agent）を導入することで、クラウドサービスだけでなく、社内の API、データベース、ファイルシステムなどのオンプレミスシステムともシームレスにデータ連携が可能になります。

OPA は HTTPS（TLS WebSocket）通信を使用するため、HTTP 通信が許可されていれば、企業のファイアウォールに手を加えることなく通信を行うことができます。

しかし、企業のイントラネットでは、プロキシサーバーをはじめ社内ネットワークに通信制限のある場合が多いかと思います。今回は、プロキシサーバーが導入されている社内ネットワークに OPA（On-Prem agent）をインストールする方法について解説します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/652f8488-bb2c-c437-19af-fc4f5a68fa97.png)

# プロキシサーバーを利用されている場合の注意点

プロキシサーバー経由で OPA が Workato へ接続する際の要件は、以下となります。

- Workato のクラウドに対して、HTTPS 通信ができること
- プロキシサーバー が WebSocket に対応していること
- DNS で名前解決ができること (HTTP プロキシサーバーを使用する場合であっても)

注意すべきは最後の要件です。企業内のネットワークでは DNS が制限されている場合がございます。例えば、イントラネット内の名前解決のみが可能で、インターネットの名前解決ができないケースです。本来、HTTP(S)でプロキシサーバーを使用する場合、名前解決はプロキシサーバー側が行うため DNS は不要ですが、OPA では **DNS 名前解決が必須**となります。

OPA が名前解決を行うのは、OPA が接続する Workato の FQDN です。したがって、イントラネット内の DNS サーバーで、以下のホスト名を名前解決できるようにしてください。(なお、hosts ファイルに追記しても、接続することはできました。）

JPデーターセンターをご利用の場合:
| FQDN               | IPs                                        |
|--------------------|--------------------------------------------|
| sg3.jp.workato.com | 35.79.205.155, 52.199.27.57, 35.78.12.221  |
| sg4.jp.workato.com | 3.113.210.186, 3.113.92.57, 54.92.47.124   |

USデーターセンターをご利用の場合:
| FQDN             | IPs                                        |
|------------------|--------------------------------------------|
| sg3.workato.com  | 54.224.75.148, 52.206.161.203, 52.204.114.159 |
| sg4.workato.com  | 54.91.65.247, 54.221.112.165, 3.216.209.184 |


# OPA のインストール手順 (プロキシ対応版)

### OPA グループの作成

[Workspace admin] から [On-prem groups] を選択します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/37fa5f2a-d2eb-9e0f-e629-4eafaf65212d.png)

次に、新規に On-prem group を作成します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/6f322fda-07a3-e5d5-8191-89da2cccf13e.png)

[Group name] に、On-prem group の名前を入力します。[Set up connections] は、OPA の設定を Workato のクラウド側に持つか、ローカルの設定ファイルに持つ（旧来の方法）のかを設定します。古くからのユーザーで下位互換性が必要ない限り、クラウド側に持つ「Directly in Workato」を選択します。（**※この設定は、一度設定するとあとから変更できません。** また、この設定により、ローカルファイルへのコネクションなどの設定方法にも違いが生じますのでご注意ください。）

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/9243b1b4-d3db-2af5-c198-37c6b1bfda23.png)

### OPA の追加～ダウンロード (Workato ワークスペース上の操作)

On-prem group を作成したら、次は OPA を追加します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/5fa3d314-e260-f591-0ebc-02bd804916bb.png)

エージェントの名前を入力し、OPA をインストールするコンピューターのOSを選択します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/a93f9791-ab7f-36e3-1161-9cfa3399d031.png)

続いて、OPA のプログラム（exeファイル）をダウンロードします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/6ce3ddbd-2ae0-9d98-df3c-2acda45c6801.png)

続いて、表示されたアクティベーションコードをコピーします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/89fe729c-45b5-052c-21e2-9eaf0ea08463.png)


### OPA のセットアップ (OPA インストール PC 上の操作)

ダウンロードしたエージェントをダブルクリックして、起動します。（実行には、管理者権限が必要です。）

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/0b3bf1da-9e66-6c1a-8164-d8e54d6d809c.png)

インストーラーが起動したら、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/418017a1-74bb-2b0a-0f35-6cd15072e45f.png)

エージェント名を入力し、[Next] をクリックします。OPA を追加する際、Workato の画面上で指定したエージェント名と合わせておくことをおすすめしますが、1台のコンピューターに1つのOPAしかインストールしない場合、インスタス名は空欄でも構いません。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/c905cc66-3d05-18e2-8a5f-f587582f1692.png)

インストールフォルダの規定値が表示されるので、問題がなければ、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/cf6d7498-bbeb-9348-a7b7-3cbb274c56e3.png)

スタートメニューフォルダの規定値が表示されるので、問題がなければ、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/f9a70c4f-fb95-f038-0b75-527974953468.png)

デスクトップのショートカットアイコンの作成と、サービスとしてインストールするかどうかのオプションが表示されます。このまま変更せず、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/4a8be253-94c5-0b42-0bd5-597b9fa315af.png)

インストール前の最終確認を聞かれるので、問題がなければ、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/47065fa4-b751-93a9-4cfa-46f57222b53a.png)

ファイルのコピーが始まるので、しばらく待機します。（1分以内に完了します）

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/a0929189-4b5c-3259-2351-b94426125147.png)

Workatoの画面でコピーしたアクティベーションコードを入力し、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/872978bd-ced2-017a-5b43-88ff8420bb68.png)

しかし、プロキシサーバー経由でしか接続できない環境では、以下の画面が表示されアクティベーションに失敗します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/a807371f-432a-3c76-9f82-a7d23b3eb23b.png)

そこで、元の画面に戻り、[Activate agent manually] にチェックをいれ、[Next] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/3d7e9667-fda7-132f-1d22-f899b3fa68c9.png)

[Finish] をクリックし、インストールを完了します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/4a7682a1-8b9b-aa0a-672b-9c0c28c7635a.png)

### エージェントキーのダウンロード (Workatoワークスペース上の操作)

Workato側に戻り、[Next]を押し、「Test agent」の画面に移動します。
しかしここでは、[Test agent] のボタンはクリックせず、そのまま [Done] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/d27ccc7b-ab67-a7dc-9638-ea50e6dd15cc.png)

作成したOPAの右端にある [...] メニューを開き、[Download agent key] をクリックしエージェントキーファイル(Zipファイル)をダウンロードします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/f9ed29c4-12f3-64ff-863d-31bda2fd7f26.png)

ダウンロードした Zipファイルを展開すると、cert.key と cert.pem という2つファイルが現れます。2つのファイルを、エージェントをインストールしたPCへコピーします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/808c5aa1-3ab5-5039-c335-61025373ae08.png)

### エージェント側の追加設定 (OPA インストール PC 上の操作)

コピーした2つのファイルは、エージェントのインストールフォルダの下の conf フォルダにコピーします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/ce76eaac-2f37-6fc0-2277-72e7a2a3c993.png)

次に、同じフォルダの config.yml をテキストエディタで開き、プロキシサーバーの設定を追加します。自社のプロキシサーバーのアドレス、ポート番号に合わせて記載してください。

```yml:config.yml
# WORKATO, INC ("WORKATO") CONFIDENTIAL
# Unpublished Copyright (c) 2013-2023 WORKATO, All Rights Reserved.
# See the LICENSE.txt file.

proxy:
   host: proxy.example.com # プロキシサーバーのホスト名
   port: 8080 # プロキシサーバーのポート番号
```
なお、ユーザー認証が必要なプロキシサーバーの場合は、次のようにユーザー名とパスワードを指定します。

```yml:config.yml
# WORKATO, INC ("WORKATO") CONFIDENTIAL
# Unpublished Copyright (c) 2013-2023 WORKATO, All Rights Reserved.
# See the LICENSE.txt file.

proxy:
   host: proxy.example.com # プロキシサーバーのホスト名
   port: 8080 # プロキシサーバーのポート番号
   username: proxy_user # プロキシーサーバーのユーザー名
   password: proxy_password # プロキシーサーバーのパスワード
```
config.yml を保存したら、「サービス」の管理コンソール(services.msc)を開き、OPAのサービスを開始します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/7a53a0e9-bbb1-ad1e-8fd0-b2e4c3e508b2.png)

### エージェントのテストを実行 (Workato ワークスペース上の操作)

再び、Workato 側へ戻り、[Set up now] をクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/a3231cdd-c953-f9af-fa27-e3413bca4796.png)

[Next] を押して、「Test Agent」の画面まで移動します。今度は、[Test agent] ボタンをクリックします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/30a696c1-6ca7-cdde-3a90-bc5adaa49e83.png)

テストが成功すれば、「Your agent is ready!」と表示されます。テストに失敗する場合、数分おいてから試してみてください。それでもエラーが続く場合は、エージェント側のログを確認してください。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/6a9e8944-2f3b-76ef-8dc9-b4e685030bf0.png)

OPAの一覧でも、ステータスが「Active」となっていることが確認できるかと思います。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3444315/54cce871-d096-e925-c1af-483670db2545.png)

# まとめ
まとめると、以下のようになります。

* DNS サーバーで Workato のサーバーに対して名前解決できることが必須
* プロキシサーバーを利用する環境でも利用可能だが、以下の手順が必要
    * インストーラーでは、「手動アクティベーション」を選択
    * エージェントキーを別途ダウロードして、OPA インストールフォルダ配下の「conf フォルダ」にコピー
    * 設定ファイル (config.yml)  にプロキシサーバーの設定を追加

# おわりに
いかがでしょうか？ このように、プロキシサーバーを利用されている環境でも、OPAをインストールすることが可能です。なお、お客様の環境によっては、個別の追加設定やプロキシサーバー側への変更が必要となる場合もございます。

Workato の導入・導入後の活用などでお困りの場合、Workato リセラーにご相談する方法もございます。お困りごとがございましたら、認定リセラーの[日立ソリューションズ](https://www.hitachi-solutions.co.jp/rpa/sp/products/workato)へ是非ご相談ください。

# 参考リンク

* 株式会社 日立ソリューションズ
    * [Workato ご紹介サイト](https://www.hitachi-solutions.co.jp/rpa/sp/products/workato)
* Workato 公式サイト
    * [Accessing On-prem](https://docs.workato.com/on-prem.html)