1.1 Local Agentとは
- Local Agentを使用するとVPN接続などは使用せず、異なるネットワーク間でデータ連携できます。
例えば、あるLAN上のxpiサーバから、別のLAN上のリソースにアクセスすることができます。
![Local Agentとは](https://www.magicsoftware.com/wp-content/uploads/2021/05/Local-Agentとは-1024x446.png)
2.1 MQTTブローカー
- Local Agentは、通信サービスのMQTTブローカーとしてMosquittoを使用します。
- Local Agent管理サーバにMosquittoをインストールします。
- Mosquittoをインストールする前に、以下のソフトウェアをインストールする必要があります。
・OpenSSL
・Microsoft Visual C++ 2017 Redistributable (x64)
2.1.1 OpenSSL
【インストール】
- Mosquittoをインストールする前に、OpenSSLをインストールする必要があります。
- OpenSSLは下記URLよりダウンロードできます。
http://slproweb.com/products/Win32OpenSSL.html
![OpenSSL](https://www.magicsoftware.com/wp-content/uploads/2021/05/OpenSSL.png)
- ダウンロードした「Win64OpenSSL_Light-1_1_1h.exe」をダブルクリックし、インストーラを起動します。
- 利用規約に同意します。
![利用規約に同意](https://www.magicsoftware.com/wp-content/uploads/2021/05/利用規約に同意.png)
- インストール先フォルダを指定します。
- デフォルト値「C:\Program Files\OpenSSL-Win64」で結構ですが、必要に応じて変更します。
![インストール先フォルダを指定](https://www.magicsoftware.com/wp-content/uploads/2021/05/インストール先フォルダを指定.png)
- スタートメニューフォルダを指定します。
- デフォルト値「OpenSSL」で結構ですが、必要に応じて変更します。
![スタートメニューフォルダを指定](https://www.magicsoftware.com/wp-content/uploads/2021/05/スタートメニューフォルダを指定.png)
- OpenSSLのdllのコピー先を選択します。
- 「The OpenSSL binaries(/bin) directory」を選択します。
![OpenSSLのdllのコピー先](https://www.magicsoftware.com/wp-content/uploads/2021/05/OpenSSLのdllのコピー先.png)
- 設定内容を確認し、「Install」ボタンでインストールします。
- 修正したい内容がある場合は、「< Back」ボタンで前画面に戻り修正します。
![インストール](https://www.magicsoftware.com/wp-content/uploads/2021/05/インストール.png)
- 完了画面が表示されます。
- 寄付を行わない場合は全てのチェックをはずして「Finish」ボタンで完了します。
![完了画面が表示](https://www.magicsoftware.com/wp-content/uploads/2021/05/完了画面が表示.png)
【環境変数の設定】
- Mosquittoのインストールに必要なdllが、インストーラで指定したフォルダにコピーされます。
- このフォルダのパスを、システム環境変数「Path」の値として追加します。
![環境変数の設定](https://www.magicsoftware.com/wp-content/uploads/2021/05/環境変数の設定-1024x412.png)
2.1.2 Microsoft Visual C++ 2017 Redistributable (x64)
【インストール】
- Mosquittoをインストールする前に、Microsoft Visual C++ 2017 Redistributable (x64)をインストールする必要があります。
- Microsoft Visual C++ 2017 Redistributable (x64)は下記URLよりダウンロードできます。
https://my.visualstudio.com/Downloads?q=visual%20studio%202017&wt.mc_id=o~msft~vscom~older-downloads
![Microsoft Visual C](https://www.magicsoftware.com/wp-content/uploads/2021/06/インストール2-1024x383.png)
- ダウンロードした「VC_redist.x64.exe」をダブルクリックし、インストーラを起動します。
- ライセンス条項および使用条件に同意し、「インストール」ボタンでインストールします。
![VC_redist.x64](https://www.magicsoftware.com/wp-content/uploads/2021/06/VC_redist.x64.png)
![セットアップが完了](https://www.magicsoftware.com/wp-content/uploads/2021/06/セットアップが完了.png)
2.1.3 Mosquitto
【インストール】
- OpenSSL、VC++ 再領布可能パッケージをインストールしたら、Mosquittoをインストールします。
- Mosquittoは下記URLよりダウンロードできます。
https://www.eclipse.org/downloads/download.php?file=/mosquitto/binary/win64/mosquitto-1.5.4-install-windows-x64.exe&mirror_id=1190
![Mosquitto](https://www.magicsoftware.com/wp-content/uploads/2021/06/Mosquitto.png)
- ダウンロードした「mosquitto-1.5.4-install-windows-x64.exe」をダブルクリックし、インストーラを起動します。
![インストーラを起動します](https://www.magicsoftware.com/wp-content/uploads/2021/06/インストーラを.png)
- 必要となるOpenSSLのdllが表示されます。
- 「2.1.1」章、および「2.1.2」章のソフトウェアがインストール済みであることを確認します。
![OpenSSLのdll](https://www.magicsoftware.com/wp-content/uploads/2021/06/OpenSSLのdll.png)
- コンポーネントの選択画面が表示されます。
- デフォルト値のまま進めます(チェックボックスが非活性であるため変更できません)。
![コンポーネントの選択画面](https://www.magicsoftware.com/wp-content/uploads/2021/06/コンポーネントの選択画面.png)
- インストール先フォルダを指定します。
- デフォルト値「C:\Program Files\mosquitto」で結構ですが、必要に応じて変更します。
![インストール先フォルダを指定](https://www.magicsoftware.com/wp-content/uploads/2021/06/インストール先フォルダを指定2.png)
- 完了画面が表示されます。
- 「Finish」ボタンで完了します。
![「Finish」ボタンで完了](https://www.magicsoftware.com/wp-content/uploads/2021/06/「Finish」ボタンで完了.png)
【ファイルのコピー】
- <xpiインストーラフォルダ>\LocalAgent\Prerequisites\Mosquittoフォルダ配下のファイルをMosquittoのインストールフォルダにコピーします。
![ファイルのコピー](https://www.magicsoftware.com/wp-content/uploads/2021/06/ファイルのコピー-1024x427.png)
【認証設定 - パスワードファイルの作成 -】
- コマンドプロンプトでMosquittoのインストールフォルダに移動し、下記コマンドを実行します。
.\mosquitto_passwd –c <パスワードファイル名> <ユーザ名>
- パスワードを入力すると、暗号化されたパスワードを含むパスワードファイルが作成されます。
![認証設定](https://www.magicsoftware.com/wp-content/uploads/2021/06/認証設定 -1024x327.png)
【認証設定 – 設定ファイルの編集 -】
- <Mosquittoインストールフォルダ>\mosquitto_localagent.conf を編集します。
- 匿名モードをfalseに設定し、ユーザ名とパスワードファイルのパスを指定します。
![設定ファイルの編集](https://www.magicsoftware.com/wp-content/uploads/2021/06/設定ファイルの編集.png)
設定項目 |
設定内容 |
allow_anonymous |
匿名モードを許可するか否か |
user |
ユーザ名 |
password_file |
パスワードファイルのパス |
【Mosquittoの起動】
- <Mosquittoインストールフォルダ>\broker.cmdをダブルクリックして起動します。
![Mosquittoの起動](https://www.magicsoftware.com/wp-content/uploads/2021/06/Mosquittoの起動.png)
【Mosquittoの停止】
- Mosquittoのコマンドプロンプトで「Ctrl+C」→「Y」→「Enter」と入力します。
![Mosquittoの停止](https://www.magicsoftware.com/wp-content/uploads/2021/06/Mosquittoの停止.png)
2.2.1 Minio
【インストール】
- Minioサーバ(minio.exe)とMinioクライアント(mc.exe)をダウンロードします。
- Minioは下記URLよりダウンロードできます。
https://min.io/download#/windows
![minioインストール](https://www.magicsoftware.com/wp-content/uploads/2021/06/minioインストール.png)
- ダウンロードしたexeを適当なフォルダに配置します。
- ここでは「C:\Minio」フォルダを作成し、そこに配置しました。
![ダウンロードしたexe](https://www.magicsoftware.com/wp-content/uploads/2021/06/ダウンロードしたexe.png)
【ファイルのコピー】
- <xpiインストーラフォルダ>\LocalAgent\Prerequisites\Minioフォルダ配下のファイルをMinioのインストールフォルダにコピーします。
![minioファイルのコピー](https://www.magicsoftware.com/wp-content/uploads/2021/06/minioファイルのコピー-1024x427.png)
【バケット作成】
- コマンドプロンプトでMinioのインストールフォルダに移動し、バケット作成スクリプトを実行します。
![バケット作成](https://www.magicsoftware.com/wp-content/uploads/2021/06/バケット作成-1024x474.png)
- バケット作成の過程で、別ウィンドウでMinioサーバが起動します。
- 「Ctrl+C」で停止します。
![Minioサーバ](https://www.magicsoftware.com/wp-content/uploads/2021/06/Minioサーバ.png)
【起動スクリプトの編集】
<Minioインストールフォルダ>\minio.cmd
![起動スクリプトの編集](https://www.magicsoftware.com/wp-content/uploads/2021/06/起動スクリプトの編集.png)
【Minioの起動】
- <Minioインストールフォルダ>\minio.cmdをダブルクリックして起動します。
![Minioの起動](https://www.magicsoftware.com/wp-content/uploads/2021/06/Minioの起動.png)
【Minioの停止】
- Minioのコマンドプロンプトで「Ctrl+C」→「Y」→「Enter」と入力します。
![Minioの停止](https://www.magicsoftware.com/wp-content/uploads/2021/06/Minioの停止.png)
2.2.2 Minio管理コンソール
- Minio管理サーバ上のブラウザから、下記URLでMinioの管理コンソールにアクセスできます。
http://localhost:9000/minio/login
![Minio管理コンソール](https://www.magicsoftware.com/wp-content/uploads/2021/06/Minio管理コンソール-1024x466.png)
2.3.1 Apache Tomcat
【インストール】
- Local Agent管理コンソールを使用するためにTomcatをインストールします。
- Tomcatは下記URLよりダウンロードできます。
https://tomcat.apache.org/index.html
![Apache Tomcatインストール](https://www.magicsoftware.com/wp-content/uploads/2021/06/Apache-Tomcatインストール.png)
![Archives](https://www.magicsoftware.com/wp-content/uploads/2021/06/Archives.png)
![v8.5.55リンク](https://www.magicsoftware.com/wp-content/uploads/2021/06/v8.5.55リンク.png)
![bin](https://www.magicsoftware.com/wp-content/uploads/2021/06/bin.png)
- 「apache-tomcat-8.5.55-windows-x64.zip」リンクをクリックします。
![Apache Tomcat](https://www.magicsoftware.com/wp-content/uploads/2021/06/Apache-Tomcat.png)
- ダウンロードしたzipファイルを解凍し、適当なフォルダに配置します。
- ここでは「C:\」ドライブ直下に配置しました。
![zipファイル](https://www.magicsoftware.com/wp-content/uploads/2021/06/zipファイル.png)
【設定ファイルの編集】
- <Tomcatインストールフォルダ>\conf\logging.propertiesファイルを編集します。
- 「java.util.logging.ConsoleHandler.encoding」の値を「UTF-8」から「SJIS」に変更します。
![設定ファイルの編集](https://www.magicsoftware.com/wp-content/uploads/2021/06/設定ファイルの編集2-1024x406.png)
2.3.2 Local Agent管理コンソール
【ファイルのコピー】
- <xpiインストーラフォルダ>\LocalAgent\Managementフォルダ配下のファイルを<Tomcatインストールフォルダ>\libにコピーします。
![Local Agent管理コンソール](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agent管理コンソール-1024x427.png)
【WARファイルのコピー】
- <xpiインストーラフォルダ>\LocalAgent\Managementフォルダ配下のwarファイルを<Tomcatインストールフォルダ>\webappsにコピーします。
![WARファイルのコピー](https://www.magicsoftware.com/wp-content/uploads/2021/06/WARファイルのコピー-1024x427.png)
【設定ファイルの編集】
- <Tomcatインストールフォルダ>\lib\mgmt-console-api.propertiesファイルを編集します。
- 下記の項目を設定します。
設定項目 |
設定内容 |
入力例 |
localAgent.managementId |
Local Agent管理サーバの管理ID |
installation1 |
mqtt.broker.url |
MosquittoのURL |
tcp://xxx.xxx.xxx.xxx:1883 |
mqtt.broker.username |
Mosquittoのユーザ名 |
localagent |
mqtt.broker.password |
Mosquittoのパスワード |
12345qwerty |
minio.url |
MinioのURL |
http://xxx.xxx.xxx.xxx:9000 |
【Mosquittoの起動】
- <Mosquittoインストールフォルダ>\broker.cmdをダブルクリックして起動します。
![Mosquittoの起動](https://www.magicsoftware.com/wp-content/uploads/2021/06/Mosquittoの起動2.png)
【Minioの起動】
- <Minioインストールフォルダ>\minio.cmdをダブルクリックして起動します。
![Minioの起動](https://www.magicsoftware.com/wp-content/uploads/2021/06/Minioの起動.png)
【Tomcatの起動】
- <Tomcatインストールフォルダ>\bin\startup.batをダブルクリックして起動します。
![Tomcatの起動](https://www.magicsoftware.com/wp-content/uploads/2021/06/Tomcatの起動.png)
【管理コンソール】
- Local Agent管理サーバ上のブラウザで下記URLにアクセスし、管理コンソールを表示します。
http://localhost:8080/mgmt-console-api/
![管理コンソール](https://www.magicsoftware.com/wp-content/uploads/2021/06/管理コンソール-1024x473.png)
【管理IDについて】
- Local Agent管理サーバでは複数の管理IDを扱うことができます。
- デフォルトでは「installation1」という管理IDのみ定義されています。
- 管理IDの名前を変更したり、管理IDを追加したい場合は、下記ファイルを編集します。
<Tomcatインストールフォルダ>\lib\management-ids.xml
![管理IDについて](https://www.magicsoftware.com/wp-content/uploads/2021/06/管理IDについて-1024x284.png)
3.1 Local Agent
- xpiサーバが、Local Agent管理サーバを介してデータ連携を行う相手側のマシンにLocal Agentをインストールします。
- Local AgentはWindowsのサービスとしてインストールされます。
- Local Agentをインストールするマシンには、Java 8(64bit)が必要です。
【インストール】
- <xpiインストーラフォルダ>\LocalAgent\LAN\setupLA.exeを起動します。
![Local Agentインストール](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agentインストール-1024x427.png)
![「Next 」ボタンで進みます](https://www.magicsoftware.com/wp-content/uploads/2021/06/「Next-」ボタンで進みます.png)
- インストール先フォルダを指定します。
- デフォルト値「C:\LocalAgent」で結構ですが、必要に応じて変更します。
![Local Agentインストール先フォルダを指定](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agentインストール先フォルダを指定.png)
- JRE8(x64)のパスを指定します。
- JREがインストールされていない場合はいったんキャンセルし、JREをインストールしてください。
![JRE](https://www.magicsoftware.com/wp-content/uploads/2021/06/JRE.png)
- Local Agent名と、Local Agent管理サーバの管理IDを入力します。
- Local Agent名は、ホストごとに重複しない名前を指定します。
![Local Agent管理サーバ](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agent管理サーバ.png)
- Local Agent管理サーバのMQTTブローカー(Mosquitto)およびMinioのURLを入力します。
- MQTTブローカーのURLは「tcp://xxxx:1883」、MinioのURLは「http://xxxx:9000」となります。
![MQTTブローカー](https://www.magicsoftware.com/wp-content/uploads/2021/06/MQTTブローカー.png)
- 日本ではクラウド機能がサポートされていません。
- Cloud Authenticationのチェックをはずし、空欄のまま次へ進みます。
![Cloud Authentication](https://www.magicsoftware.com/wp-content/uploads/2021/06/Cloud-Authentication.png)
- 設定内容を確認し、「Install」ボタンでインストールします。
- 修正したい内容がある場合は、「< Back」ボタンで前画面に戻り修正します。
![Local Agent設定内容](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agent設定内容.png)
- 完了画面が表示されます。
- 「Finish」ボタンで完了します。
![Local Agent_Finish](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agent_Finish.png)
【設定ファイルの編集】
- インストーラで指定した接続先のLocal Agent管理サーバの設定情報は、下記の設定ファイルを編集することで変更可能です。
<Local Agentインストールフォルダ>\bin\AgentConnector\application.properties
<Local Agentインストールフォルダ>\bin\AgentService\application.properties
設定項目 |
設定内容 |
入力例 |
localAgent.managementId |
Local Agent管理サーバの管理ID |
installation1 |
mqtt.broker.url |
MosquittoのURL |
tcp://xxx.xxx.xxx.xxx:1883 |
mqtt.broker.username |
Mosquittoのユーザ名 |
localagent |
mqtt.broker.password |
Mosquittoのパスワード |
12345qwerty |
minio.url |
MinioのURL |
http://xxx.xxx.xxx.xxx:9000 |
【Local Agentの開始】
- Windowsのサービス「Magic xpi 4.13 Local Agent」を右クリック>開始をクリックします。
![Local Agentの開始](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agentの開始.png)
【Local Agentの停止】
- Windowsのサービス「Magic xpi 4.13 Local Agent」を右クリック>停止をクリックします。
![Local Agentの停止](https://www.magicsoftware.com/wp-content/uploads/2021/06/Local-Agentの停止.png)
4.1 magic.iniの編集
- xpiサーバの接続先となるLocal Agent管理サーバの設定情報を、magic.iniファイルの[MAGICXPI_LA]セクションに記載します。
設定項目 |
設定内容 |
入力例 |
ManagementID |
Local Agent管理サーバの管理ID |
installation1 |
Broker |
MosquittoのURL |
tcp://xxx.xxx.xxx.xxx:1883 |
BrokerUsername |
Mosquittoのユーザ名 |
localagent |
BrokerPassword |
Mosquittoのパスワード |
12345qwerty |
DataTransfer |
MinioのURL |
http://xxx.xxx.xxx.xxx:9000 |
※magic.iniファイルは<xpiインストールフォルダ>\Runtime\Magic xpaフォルダにあります