運用管理ソフト(外部接続モジュール)
###############################################################################################################################
.. |annotation-01| raw:: html
※ 記載内容はサンプルとなります。各種設定・実行ファイルの記述内容などは、ご利用の環境に合わせて対応してください。
| 取込設定、出力設定の実施スケジュールを、運用管理ソフト等を使用して行う場合のモジュール構成、必要な設定内容などについて説明します。
| AccelPlatformへの通信を行う為のモジュールはJavaで実装されていますので、外部モジュールを配置するサーバには、AccelPlatform設置サーバと同バージョンのJDKをインストールしてください。
| この機能は、intra-mart Accel Platform / 外部ソフトウェア接続モジュール の機能を利用しています。
| 機能概要、仕様については『`intra-mart Accel Platform / 外部ソフトウェア接続モジュール 仕様書 `_』も参照してください。
| |annotation-01|
運用管理ソフトを使用する場合のシステム構成例
*******************************************************************************************************************************
.. figure:: /_static/images/config/job_clinet/config_jobclient_01.*
:width: 650px
※運用にあたっては、運用管理ソフトの設定と起動バッチ(またはシェル等)をご用意いただく必要があります。
AccelPlatform APサーバの設定
*******************************************************************************************************************************
| 外部接続モジュールを利用する場合、%RESIN_HOME%/webapps/%テナントID%/WEB-INF/web.xmlの設定値を変更する必要があります。
| servlet/servlet-name=HTTPActionEventListener のinit-param/param-name=use.account.securityのparam-valueをtrueに設定してください。
構成例
*******************************************************************************************************************************
windows環境の例
-------------------------------------------------------------------------------------------------------------------------------
運用管理ソフトからバッチファイル起点で実行する場合のサンプルを示します。
上図の「外部モジュール」にあたる箇所の構成、設定例です。
[モジュールの構成例]
.. code-block:: none
<任意のフォルダ>
├─ bin
│ ├─ imic-batchconstant.properties
│ └─ jp
│ └─ co
│ └─ itc
│ └─ imic
│ └─ batch
│ └─ starter
│ └─ ImMasterInfoConnectStarter.class
│
├─ lib
│ └─ imaca_client-8.0.1-main.jar
└─ bat
└─ SampleImportStarter.bat
* | **bin**
| Accel-KNIGHT標準のモジュール、設定ファイルを格納するフォルダです。
| binフォルダの配置場所は任意で構いませんが、プロパティファイルとクラスファイルの配置は上記を維持してください。
| 変更するとモジュールが正常に動作しません。
* | **lib**
| intra-mart標準のライブラリを格納するフォルダです。
* | **bat**
| 管理モジュールから実行するバッチファイルです。
[設定ファイル]
.. list-table::
:widths: 50 350
:header-rows: 0
* - | 設定名
- | IMIC.BATCH.CLASS.NAME
* - | 内容
- | AccelPlatform APサーバ側モジュールの、バッチ起動クラス名を指定します。
* - | デフォルト値
- | jp.co.itc.imic.batch.event.BatchExecuteEvent
* - | 備考
- | この値は変更しないでください。
|
|
.. list-table::
:widths: 50 350
:header-rows: 0
* - | 設定名
- | IMIC.BATCH.ACTION.URL
* - | 内容
- | バッチ処理の依頼先URLを指定します。
* - | デフォルト値
- | http://localhost:8080/imart/HTTPActionEventListener
* - | 備考
- | [http または https]://<サーバアドレス>[:<ポート番号>]/[コンテキストパス]/HTTPActionEventListener
[バッチファイルの例]
.. code-block:: none
REM SampleImportStarter.bat
REM 自フォルダへ移動
cd %~dp0
REM 環境変数を設定
SET JAVA_HOME=C:\java\jdk1.8.0_45
SET PATH=%PATH%;%JAVA_HOME%\bin;
REM intra-martサーバへの処理実行依頼
java -classpath "..\bin";"..\lib\imaca_client-8.0.1-main.jar" jp.co.itc.imic.batch.starter.ImMasterInfoConnectStarter default itc001 00 import_sample
REM このバッチの呼出元へ終了コードを返却
exit %ERRORLEVEL%
作業フォルダ、環境変数の設定、呼出元へのコード返却などは運用環境に応じて対応してください。
* intra-martサーバへの処理実行依頼
* | -classpathオプション
| 「bin」ディレクトリと「lib」ディレクトリにパスを通します。
* | 実行クラス
| jp.co.itc.imic.batch.starter.ImMasterInfoConnectStarter(変更不可)
* | 実行クラスパラメータ
.. list-table::
:widths: 100 380
:header-rows: 0
* - | 第1パラメータ
- | テナントID
* - | 第2パラメータ
- | 実行ユーザID
| テナントマスタ上でアカウントライセンスが付与されているユーザIDを指定してください。
* - | 第3パラメータ
- | 処理区分(00:取込/10:出力)
* - | 第4パラメータ
- | 取込設定の場合:対象となる取込ID
| 出力設定の場合:対象となる出力ID
Linux系環境の例
-------------------------------------------------------------------------------------------------------------------------------
運用管理ソフトからバッチファイル起点で実行する場合のサンプルを示します。
上図の「外部モジュール」にあたる箇所の構成、設定例です。
[モジュールの構成例]
.. code-block:: none
<任意のフォルダ>
├─ bin
│ ├─ imic-batchconstant.properties
│ └─ jp
│ └─ co
│ └─ itc
│ └─ imic
│ └─ batch
│ └─ starter
│ └─ ImMasterInfoConnectStarter.class
│
├─ lib
│ └─ imaca_client-8.0.1-main.jar
└─ sh
└─ SampleImportStarter.sh
* | **bin**
| Accel-KNIGHT標準のモジュール、設定ファイルを格納するディレクトリです。
| binディレクトリの配置場所は任意で構いませんが、プロパティファイルとクラスファイルの配置は上記を維持してください。
| 変更するとモジュールが正常に動作しません。
* | **lib**
| intra-mart標準のライブラリを格納するディレクトリです。
* | **sh**
| 管理モジュールから実行するシェルスクリプトです。
[設定ファイル]
.. list-table::
:widths: 50 350
:header-rows: 0
* - | 設定名
- | IMIC.BATCH.CLASS.NAME
* - | 内容
- | AccelPlatform APサーバ側モジュールの、バッチ起動クラス名を指定します。
* - | デフォルト値
- | jp.co.itc.imic.batch.event.BatchExecuteEvent
* - | 備考
- | この値は変更しないでください。
|
.. list-table::
:widths: 50 350
:header-rows: 0
* - | 設定名
- | IMIC.BATCH.ACTION.URL
* - | 内容
- | バッチ処理の依頼先URLを指定します。
* - | デフォルト値
- | http://localhost:8080/imart/HTTPActionEventListener
* - | 備考
- | [http または https]://<サーバアドレス>[:<ポート番号>]/[コンテキストパス]/HTTPActionEventListener
[シェルスクリプトの例]
.. code-block:: none
#!/bin/sh
# SampleImportStarter.sh
# 自ディレクトリへ移動
cd `dirname ${0}`
# 環境変数を設定
JAVA_HOME=/usr/java/jdk1.8.0_45
PATH=${JAVA_HOME}/bin:${PATH}
# intra-martサーバへの処理実行依頼
java -classpath "../bin":"../lib/imaca_client-8.0.1-main.jar" jp.co.itc.imic.batch.starter.ImMasterInfoConnectStarter default itc001 00 import_sample
# このシェルの呼出元へ終了コードを返却
exit $?
作業ディレクトリ、環境変数の設定、呼出元へのコード返却などは運用環境に応じて対応してください。
* intra-martサーバへの処理実行依頼
* | -classpathオプション
| 「bin」ディレクトリと「lib」ディレクトリにパスを通します。
* | 実行クラス
| jp.co.itc.imic.batch.starter.ImMasterInfoConnectStarter(変更不可)
* | 実行クラスパラメータ
.. list-table::
:widths: 100 380
:header-rows: 0
* - | 第1パラメータ
- | テナントID
* - | 第2パラメータ
- | 実行ユーザID
| テナントマスタ上でアカウントライセンスが付与されているユーザIDを指定してください。
* - | 第3パラメータ
- | 処理区分(00:取込/10:出力)
* - | 第4パラメータ
- | 取込設定の場合:対象となる取込ID
| 出力設定の場合:対象となる出力ID