.. include:: ../../definition.txt 出力処理設定 ############################################################################################################################### | 出力処理設定についてのリファレンスです。 .. contents:: :local: :depth: 1 :backlinks: none .. ************************************************* .. 本章へのリンク .. |exp-link-01| raw:: html ログ .. |exp-link-01-scheduler| raw:: html ジョブスケジューラ/運用管理ソフトから実行した場合 .. |exp-link-03| raw:: html 通知メール設定 .. 操作ガイドへのリンク .. |opr_exp-exec_header_link_01| raw:: html Accel-KNIGHT ADオプション操作ガイド - 6. AD出力処理設定 - 6.3. AD出力実行 .. |exp-link-op-01| raw:: html Accel-KNIGHT ADオプション操作ガイド - 6. AD出力処理設定 - 6.2. AD出力設定　登録・編集 .. |exp-link-op-02| raw:: html Accel-KNIGHT ADオプション操作ガイド - 6. AD出力処理設定 - 6.3. AD出力実行 .. |exp-link-op-03| raw:: html Accel-KNIGHT ADオプション操作ガイド - 9. リファレンス - 9.5. 入力規則 .. |exp-link-op-04| raw:: html Accel-KNIGHT ADオプション操作ガイド - 8. 補助画面 - 8.5. 通知メール設定 .. バッチ処理仕様書へのリンク .. intra-martへの外部リンク .. |exp-link-im-02| raw:: html intra-mart Accel Platform / 設定ファイルリファレンス - メールモジュール - メール設定 .. ************************************************* .. 赤太文字 .. |annotation-config-01| raw:: html 各設定については、適宜変更をしてください。
※設定の反映にはサーバの再起動が必要になります。 .. リストテーブルヘッダー用 .. |exp-list-title-01| raw:: html 設定ファイル imic-constant.properties .. |exp-list-title-02| raw:: html 置換パラメータ一覧 .. |exp-list-title-03| raw:: html 結果通知区分 .. その他 .. brより細い空行 .. |blankLine| raw:: html .. ************************************************* 出力設定登録・編集画面 ******************************************************************************************************************************* 基本情報 =============================================================================================================================== .. figure:: /_static/images/adexp/adexp_maintenance_01.* :width: 800px * | **出力ID** | 出力IDを設定します。 * | **出力処理名** | 出力処理名を設定します。 * | **有効期間** | 有効期間 開始日/有効期間 終了日を設定します。 * | **正常ログ出力先** | 正常ログ出力先を設定します。 | 詳細については、『 |exp-link-01| 』を参照してください。 * | **エラーログ出力先** | エラーログ出力先を設定します。 | 詳細については、『 |exp-link-01| 』を参照してください。 * | **結果通知区分** | 結果通知区分を選択します。 | 詳細については、『 |exp-link-03| 』を参照してください。 * | **通知メール** | 通知メールを設定します。 | 詳細については、『 |exp-link-03| 』を参照してください。 * | **ファイル形式** | ファイル形式を設定します。 * | **文字コード** | 文字コード設定を設定します。 .. figure:: /_static/images/adexp/adexp_maintenance_02.* :width: 600px | Accel-KNIGHT 取込ファイル定義登録・編集画面で選択する文字コードと同じ文字コードが選択できます。 | システム標準で登録されている以外の文字コードを使用する場合は、汎用コードマスタに登録をしてください。 | マスタ登録手順に関しては、AccelKNIGHTマニュアルを参照してください。 * | **改行コード** | 改行コード設定についてのリファレンスです。 .. figure:: /_static/images/adexp/adexp_maintenance_03.* :width: 600px | Accel-KNIGHT 取込ファイル定義登録・編集画面で選択する改行コードと同じ改行コードが選択できます。 | 選択できる改行コードは、汎用コードマスタに登録されている改行コードが表示され、選択できます。 | 下記が標準登録されている改行コードです。 .. list-table:: :widths: 100 100 100 :header-rows: 1 * - 改行コード - - * - | + - | \\r\\n - | 0D0A | 標準で登録されている以外の改行コードを使用する場合は、汎用コードマスタに登録をしてください。 | マスタ登録手順に関しては、AccelKNIGHTのマニュアルを参照してください。 | .. _adexp-header-label: * | **ヘッダ行** | ヘッダについてのリファレンスです。 .. figure:: /_static/images/adexp/adexp_maintenance_04.* :width: 600px * | **ヘッダ行 無し を設定した場合** * | **AD出力処理** | ヘッダ行が付加されず出力されます。 * | **ヘッダ行 有り を設定した場合** * | **AD出力処理** | ヘッダ行が付加され出力されます。 | AD出力実行画面では、ヘッダ行の有無を一時的に変更して実行することができます。 | 詳しい操作方法については、下記の操作ガイドを参照してください。 | AD出力実行：『 |opr_exp-exec_header_link_01| 』 * | **区切り文字** | 区切り文字を設定します。 .. _adexp-header-delimiter-label: * | **囲み文字** | 出力時に指定した囲み文字でデータが出力されます。 * | **備考** | 備考を設定します。 出力設定明細 =============================================================================================================================== .. figure:: /_static/images/adexp/adexp_maintenance_05.* :width: 800px * | **AD連携定義ID** | 設定されたAD連携定義IDを表示します。 * | **AD連携定義名** | 出力対象にするAD連携定義を設定します。 * | **出力ファイルパス** | 出力先ファイルパスを設定します。 | | AD出力設定登録・編集画面の詳しい操作方法は、『 |exp-link-op-01| 』を参照してください。 出力実行画面 ******************************************************************************************************************************* 基本情報 =============================================================================================================================== | 出力設定の情報を一部変更して出力処理を行うことが可能です。 .. figure:: /_static/images/adexp/adexp_execute_01.* :width: 800px * | **出力ID** | 出力IDと出力処理名が表示されます。 * | **タイトル（ヘッダ行）** | 出力されるファイルのタイトル（ヘッダ行）のあり・なしを選択します。 | ありを選択した場合、AD出力設定で設定されているヘッダ行に関わらず、全てのファイルの先頭行にヘッダを出力します。 | なしを選択した場合、AD出力設定で設定されているヘッダ行に関わらず、全てのファイルにヘッダを出力しません。 * | **結果通知先メールアドレス** | 結果通知先メールアドレス（To、Cc、Bcc）を設定します。 | 詳細については、『 |exp-link-03| 』を参照してください。 * | **正常ログ出力** | 正常ログを出力するか選択します。 | 詳細については、『 |exp-link-01| 』を参照してください。 * | **エラーログ出力** | エラーログを出力するか選択します。 | 詳細については、『 |exp-link-01| 』を参照してください。 出力設定明細 =============================================================================================================================== .. figure:: /_static/images/adexp/adexp_execute_02.* :width: 800px * | **AD連携定義ID** | 設定されたAD連携定義IDを表示します。 * | **AD連携定義名** | 出力対象にするAD連携定義を設定します。 * | **出力ファイルパス** | マッピング定義に紐付く出力ファイルパスが表示されます。 | 一時的に、出力先ファイルパスを変更する事が可能です。 | 詳しい設定方法は、『 |adexp-main| 』を参照してください。 | | 出力実行画面の詳しい操作方法は、『 |exp-link-op-02| 』を参照してください。 .. _exp-link-01-label: .. _adexp-log-label: ログ ******************************************************************************************************************************* | 正常ログ出力先、エラーログ出力先は出力設定登録・編集画面で設定します。 .. _adexp-log-specify-label: 出力先を指定した場合 =============================================================================================================================== | 出力設定登録・編集画面で設定した正常/エラーログ出力先にログファイルを出力します。 | 既にファイルがある場合は、追記モードでログを出力します。 .. figure:: /_static/images/adexp/adexp_log_01.* :width: 800px * | **パブリックストレージを指定** | パブリックストレージを指定する場合は | <ストレージパス>/public/storage/<テナントID>/をルートとした相対パスを指定してください。 * | **ネットワーク上を指定** | ネットワーク上を指定する場合は | ネットワーク上のファイルを指定する場合は、フルパスで入力してください。 | 指定するファイルは、サーバOS上のイントラマートプロセスを実行しているアカウントがアクセス権を持っているファイルを指定してください。 | アクセス権のない出力先を指定した場合には、出力処理時にエラーとなります。 | 入力規則については、『 |exp-link-op-03| 』を参照してください。 出力先を指定しない場合 =============================================================================================================================== .. _exp-link-01-scheduler-label: * | **ジョブスケジューラ/運用管理ソフトから実行した場合** | IMパブリックストレージのバッチログ標準出力先の下に、処理IDディレクトリを作成し正常/エラーログファイルを出力します。 .. figure:: /_static/images/adexp/adexp_log_02.* | * | **バッチログ標準出力先** | バッチログ標準出力先は、設定ファイル『imicad-constant.properties』で変更可能です。 |exp-list-title-01| .. list-table:: :header-rows: 1 * - 名称 - 設定名 - デフォルト値 * - 標準出力先 - IMIC.BATCH.LOG.DEFAULT.PATH - imic/ad/batch * - 正常ログファイル - IMIC.BATCH.EXECUTE.INFO_LOG.PATH.DEFAULT - {0}/info.log * - エラーログファイル - IMIC.BATCH.EXECUTE.ERROR_LOG.PATH.DEFAULT - {0}/error.log | **※{0}には、バッチログ標準出力先と処理IDディレクトリが設定されます。** | |annotation-config-01| * | **処理IDディレクトリ** | 「IMIC_EXEC_ID-yyyyMMddhhmmssSSS」形式 * | **出力実行画面から実行した場合** | 「出力する」を選択すると、 |exp-link-01-scheduler| と同様にログが出力されます。 | 選択しない場合はログを出力しません。 .. figure:: /_static/images/adexp/adexp_log_03.* :width: 800px .. _exp-link-03-label: .. _adexp-referencedate-label: 通知メール設定 ******************************************************************************************************************************* | 出力処理時に送信される、通知メールの設定について説明します。 | 通知メール設定を利用してメールを送信する際には、intra-martのメールモジュールの設定を有効にしてください。 | 詳しい設定方法は、『 |exp-link-im-02| 』を参照してください。 送信元の設定 =============================================================================================================================== | 通知メールの送信元には、設定ファイル（imic-constant.properties）で定義されている通知メール送信元の値が設定されます。 | 下記に通知メール送信元の設定を記載します。 |exp-list-title-01| .. list-table:: :header-rows: 1 * - 名称 - 設定名 - デフォルト値 * - 通知メール送信元 - IMIC.MAIL.FROM_ADDRESS - postmaster\@test-imknight.co.jp | |annotation-config-01| 件名の設定 =============================================================================================================================== | 通知メールの件名には、設定ファイル（imic-constant.properties）に設定されている出力テンプレート内の値が設定されます。 | 下記に出力テンプレートパスの設定を記載します。 |exp-list-title-01| .. list-table:: :header-rows: 1 * - 名称 - 設定名 - デフォルト値 * - 結果通知メールテンプレートファイルルートパス - IMIC.MAIL.TEMPLATE.FILE.ROOT - imic/mail_template * - 出力結果通知メール件名テンプレートファイル名 - IMIC.MAIL.TEMPLATE.FILE_NAME.TITLE.adexp - title_adexp_notice.tpl | |annotation-config-01| |blankLine| | 件名には、置換パラメータを設定することができます。 | 初期設定では、件名テンプレートに下記の件名が設定されています。 | *【データ連携ツール】${exec_id} ${exec_name} ${exec_result}* 置換パラメータの詳細 =============================================================================================================================== | 件名・本文に使用できる置換パラメータは、下記となります。 |exp-list-title-02| .. list-table:: :header-rows: 1 * - パラメータ名 - キー名 - 設定内容 * - 処理実行ID - ${exec_id} - １回のAD出力に対して、システムから一意に付与されるID * - 開始時刻 - ${start_time} - AD出力処理の開始時刻 * - 終了時刻 - ${end_time} - AD出力処理の終了時刻 * - 処理名称 - ${exec_name} - 取込/出力処理の名称 * - 処理結果 - ${exec_result} - 処理結果 * - 処理実行ユーザコード - ${exec_user_cd} - 処理を実行したユーザのユーザコード * - 処理実行ユーザ名 - ${exec_user_name} - 処理を実行したユーザの名称 | **例：以下のような件名、本文に置換パラメータを設定した場合** .. list-table:: :stub-columns: 1 :widths: 10,90 * - 件名 - 【データ連携ツール】${exec_id} ${exec_name} ${exec_result} * - 本文 - | 出力処理名「${exec_name}」の出力処理を「${exec_user_cd}」が実行しました。 | 処理結果は「${exec_result}」です。 | \----------------------------------------------- | 処理実行ID：${exec_id} | 開始時刻：${start_time} | 終了時刻：${end_time} | 処理名称：${exec_name} | 処理結果：${exec_result} | 処理実行ユーザコード：${exec_user_cd} | 処理実行ユーザ名：${exec_user_name} | \----------------------------------------------- | 以下のようなメールが送信されます。 .. figure:: /_static/images/adexp/adexp_mail_01.* 送信先・本文の設定 =============================================================================================================================== | 出力設定登録・編集画面から通知メールの設定を行います。 | 通知メール画面の操作方法は、『 |exp-link-op-04| 』を参照してください。 | 出力実行画面では、送信先を一時的に変更することができます。 | 出力処理時のメール送信は、出力設定の結果通知区分に応じて行われます。 |exp-list-title-03| .. list-table:: * - すべて通知 - 出力処理結果に関わらず、メールを送信します。 * - 例外発生時のみ通知 - 出力処理がエラーで終了した場合、メールを送信します。 * - 正常終了時のみ通知 - 出力処理が正常に終了した場合、メールを送信します。 * - 通知しない - メールを送信しません。 同一の出力ファイルパスを設定した場合 ******************************************************************************************************************************* | 出力設定で同一の出力ファイルパスを設定している場合について説明します。 | 出力設定明細に同じ出力ファイルパスを設定している場合には、出力時に同ファイル名のファイルが既に存在した場合、ファイルを削除してから出力を行います。 | | 下記の場合においては、順序 3 の設定明細のファイルが最終的に残ります。 .. figure:: /_static/images/adexp/adexp_path_01.* :width: 800px .. _exp-link-04-label: