アシストメッセージ生成バッチの設定および実行

作成したCSVファイルを取り込むためのアシストメッセージ生成バッチの設定および実行を行います。
なお、事前準備として、バッチを実行する端末において、バッチ実行用プログラムのダウンロード・配置、Javaのインストール、Webサービス認証用キーの発行を行う必要があります。
画面から実行する場合は、「アシストメッセージCSV取込み」を参照してください。

バッチ処理はクライアント端末からでも実行可能です。

バッチ実行の準備を行う

バッチ実行する端末にて、下記の準備を行います。

  • バッチ実行用ファイルのダウンロード・配置

  • Javaのインストール

また、バッチ実行時に必要となるWebサービス認証キーを事前に発行します。

(1)バッチ実行用ファイルのダウンロード・配置

バッチを実行する端末にて、実行用ファイルをダウンロードして配置します。

  1. image3 > MIU:セットアップ処理 をクリックします。

  2. 左ペインの image21 をクリックします。

  3. ダウンロード画面の image22 をクリックして、BatchClient.jarファイルをダウンロードします。

    image23 frame

  4. ダウンロードしたBatchClient.jarファイルを、バッチ実行する端末の任意のディレクトリに配置します。

(2)Javaのインストール

バッチを実行する端末には、Java Runtime Environment (JRE) 1.8のインストールが必要です。Oracle社が提供するJava8、オープンソースソフトウェアであるEclipse Temurin (OpenJDK) 8のいずれかを利用してください。

■Oracle Java8 を利用する場合
利用するにはOracle社からライセンス(Oracle Java SE Desktop Subscription)を購入していただく必要があります。購入手続き後、Oracle社のホームページからダウンロードし、インストールしてください。

■Eclipse Temurin 8 を利用する場合
当システム からEclipse Temurin 8JREのインストーラをダウンロードし、インストールしてください。

  1. image3 > MIU:セットアップ処理 をクリックします。

  2. 左ペインの image21 をクリックします。

  3. 「2.インストール前の準備」欄からJREのインストーラをダウンロードし、インストールします。
    インストール手順は、「付録2 Eclipse Temurin 8 の JRE のインストール手順」を参照してください。

    image24 frame

(3)Webサービス認証用キーの発行

バッチ実行に必要なWebサービス認証キーを発行します。
手順は、「Webサービス認証キー発行」を参照してください。
なお、発行画面で認証キーの情報を登録する際、「権限」、「ファイルアップロード最大サイズ」、「処理者」の項目については下記の内容で登録してください。

項目名 説明

権限

発行する認証キーが処理できる操作を選択します。
アシストメッセージ生成バッチ処理の場合は、“参照”、“追加”、“ファイルアップロード” の権限が必要です。

ファイルアップロード最大サイズ *

一回の取込みで使用するCSVファイルの最大サイズを指定します。単位はキロバイトです。最大サイズを制限しない場合は、“0” を指定してください。

処理者

バッチを実行する社員を選択します。選択された社員が操作ログの実行社員に記録されます。

アシストメッセージ生成バッチを実行する

  1. バッチファイルを作成します。
    以下を参考に、お客様の環境に合わせバッチファイルを作成してください。
    例)バッチ実行用ファイルの配置ディレクトリが「C:\tool」の場合

    java -jar C:\tool\BatchClient.jar -server http://<サーバー名>[:ポート]/pe4j -apikey <認証キー> -type <実行処理> -processTimeout <タイムアウト時間> -file <CSVファイル名> -fileEncoding <文字コード> -deleteProcessId <削除オプション>

    ※上記は1行で記載します。

    ■指定するパラメタ
    項目名 説明

    http://<サーバー名>[:ポート]/pe4j *

    当システムにアクセスする際のURLを指定します。

    認証キー *

    バッチ実行の準備を行う」の項で発行した認証キーを指定してください。

    実行処理 *

    assistmsgimportを指定してください。

    タイムアウト時間

    バッチ処理のタイムアウト時間(秒)を指定してください。1 から 518,400 までの間で指定してください。
    未指定の場合は、21,600秒(6時間)となります。

    CSVファイル名 *

    取り込みに使用するCSVファイルの格納先およびファイル名をフルパスで指定してください。

    文字コード

    CSVファイルの文字コードをshift-jisまたはutf-8で指定してください。
    未指定の場合は、shift-jisとして取り込まれます。

    削除オプション

    取込済みのアシストメッセージを削除する条件を指定してください。

    取込済みのメッセージを全て
    削除する場合

    ”ALL” を指定してください。(半角英字で指定。大文字/小文字はいずれでも可)

    特定のアシストメッセージ連携区分のデータのみ削除する場合

    削除するアシストメッセージ連携区分を指定します。複数の場合は、「,」(半角カンマ)で区切ってください。

    削除しない場合

    省略してください。

    <サンプル>

    java -jar C:\tool\BatchClient.jar -server http://d-circle/pe4j -apikey 19999999-a7aa-4444-9cc9-666aaa222222 -type assistmsgimport -processTimeout 10800 -file c:\yoshin.csv -fileEncoding utf-8 -deleteProcessId ALL

    ※上記は1行で記載します。

  2. 作成したバッチファイルを実行します。
    実行時のパラメタに問題がある場合やバッチ処理起動時にエラーが発生した場合は、コマンドプロンプトにエラーメッセージが表示され、取り込みが行われません。エラーメッセージから原因を確認のうえ、エラー原因を取り除き、再度バッチファイルを実行してください。

  3. バッチ実行が終了後、実行結果を確認します。
    正常終了時には、コマンドプロンプトに正常終了した旨のメッセージが表示されます。
    異常終了時には、コマンドプロンプトに警告またはエラーが発生した旨のメッセージが表示されます。
    実行した取り込み処理(バッチ処理)の結果は、image3 > 外部システム連携設定 > アシストメッセージCSV取込み を起動し、「実行履歴の確認」タブをクリックしたバッチ実行履歴一覧にて確認します。バッチ実行履歴の詳細については、「アシストメッセージCSV取込み」を参照してください。
    なお、異常終了した場合、警告やエラーの詳細の確認は、バッチ実行履歴一覧およびログ照会画面から行います。ログ照会については、「ログ照会」の項を参照してください。

    また、バッチファイルの実行の開始、終了のログもログ照会画面にて確認できます。

    なお、システム環境の設定で、「バッチ処理の結果通知」を「メールで受け取る」に設定されている場合、バッチ実行時のパラメタに問題があり取り込みが実行されなかった場合はメールが送信されます。システム環境の設定については、「メール環境」の「バッチ処理の結果をメールで受信する」を参照してください。

    バッチファイルをOSのタスクスケジューラー機能などを利用し実行することにより、定期的にアシストメッセージの取り込み処理を行うことができます。OSのタスクスケジューラー機能については、OSのマニュアルをご確認ください。