6. 取込設定

取込設定についてのリファレンスです。

6.1. 取込設定登録・編集画面

6.1.1. 基本情報

../../_images/import_maintenance_01.jpg
  • 取込ID
    取込IDを設定します。
  • 取込処理名
    取込処理名を設定します。
  • 有効期間
    有効期間 開始日/有効期間 終了日を設定します。
  • 正常ログ出力先
    正常ログ出力先を設定します。
    詳細については、『 ログ 』を参照してください。
  • エラーログ出力先
    エラーログ出力先を設定します。
    詳細については、『 ログ 』を参照してください。
  • バリデーションチェック
    バリデーションチェックを設定します。
    詳細については、『 バリデーション 』を参照してください。
  • 取込方法
    取込方法を一括・分割から選択します。
    詳細については、『 一括取込と分割取込 』を参照してください。
  • 更新モード
    更新モードをマージ・書き換えから選択します。
    詳細については、『 更新モード 』を参照してください。
  • 日付フォーマットパターン
    取込対象ファイルの項目のうち、日付を表す項目のフォーマットを選択します。
    未指定の場合は、設定ファイル『imic-constant.properties』で定義されているフォーマットとなります。
    詳細については、『 日付フォーマットパターン 』を参照してください。
  • 取込基準開始日
    取込基準開始日を設定します。
    未指定の場合は、取込処理実行日が取込基準開始日となります。
    日付を指定した場合は、設定された日付が取込基準開始日となります。
    ※マッピング定義でレコード単位期間指定取込設定をしている場合は、取込データのレコード毎に設定する取込基準開始日が適用されます。
    詳細については、『 取込基準日 』を参照してください。
    レコード単位期間指定取込については、『 レコード単位期間指定取込 』を参照してください。
  • 取込基準終了日
    取込基準終了日を設定します。
    未指定の場合は、intra-mart上のシステム最大日付が取込基準終了日となります。
    日付を指定した場合は、設定された日付が取込基準終了日となります。
    ※マッピング定義でレコード単位期間指定取込設定をしている場合は、取込データのレコード毎に設定する取込基準終了日が適用されます。
    詳細については、『 取込基準日 』を参照してください。
    レコード単位期間指定取込については、『 レコード単位期間指定取込 』を参照してください。
  • 差分抽出
    差分取込を実施する場合は選択します。
    詳細については、『 差分抽出 』を参照してください。
  • 結果通知区分
    結果通知区分を選択します。
    詳細については、『 通知メール設定 』を参照してください。
  • 通知メール
    通知メールを設定します。
    詳細については、『 通知メール設定 』を参照してください。
  • 備考
    備考を設定します。

6.1.2. 取込設定明細

マッピング定義の順序は、登録・更新処理時に、intra-martのインポート基準に従い並び替えを行います。
詳しい内容については、『 ドメインと取込実施順序 』を参照してください。
../../_images/import_maintenance_02.jpg
  • マッピング定義
    取込対象にするマッピング定義を設定します。
  • ドメインカテゴリ
    マッピング定義に設定されているドメインのカテゴリが表示されます。
  • ドメイン分類
    マッピング定義に設定されているドメイン分類が表示されます。
  • ファイル定義
    マッピング定義に設定されているファイル定義が表示されます。

取込設定登録・編集画面の詳しい操作方法は、『 Accel-KNIGHT 操作ガイド - 取込設定 - 取込設定 登録・編集 』を参照してください。

6.2. 取込実行画面

6.2.1. 基本情報

取込設定の情報を一部変更して取込処理を行うことが可能です。
../../_images/import_execute_01.jpg
  • 取込ID
    取込IDと取込処理名が表示されます。
  • タイトル(ヘッダ行)
    取り込まれるファイルのタイトル(ヘッダ行)のあり・なしを選択します。
    ありを選択した場合、取込ファイル定義で設定されているヘッダ行に関わらず、全てのファイルの先頭行をヘッダ行として、1行目を読み込みません。
    なしを選択した場合、取込ファイル定義で設定されているヘッダ行に関わらず、全てのファイルを1行目から読み込みます。
  • 結果通知先メールアドレス
    結果通知先メールアドレス(To、Cc、Bcc)を設定します。
    詳細については、『 通知メール設定 』を参照してください。
  • 正常ログ出力
    正常ログを出力するか選択します。
    詳細については、『 ログ 』を参照してください。
  • エラーログ出力
    エラーログを出力するか選択します。
    詳細については、『 ログ 』を参照してください。
  • バリデーションチェック
    バリデーションチェックを全件行うか選択します。
    詳細については、『 バリデーション 』を参照してください。
  • 取込方法
    取込方法を一括・分割から選択します。
    詳細については、『 一括取込と分割取込 』を参照してください。
  • 更新モード
    更新モードをマージ・書き換えから選択します。
    詳細については、『 更新モード 』を参照してください。
  • 日付フォーマットパターン
    取込対象ファイルの項目のうち、日付を表す項目のフォーマットを選択します。
    詳細については、『 日付フォーマットパターン 』を参照してください。
  • 取込基準開始日
    取込基準開始日を設定します。
    ※マッピング定義でレコード単位期間指定取込設定をしている場合は、取込データのレコード毎に設定する取込基準開始日が適用されます。
    詳細については、『 取込基準日 』を参照してください。
    レコード単位期間指定取込については、『 レコード単位期間指定取込 』を参照してください。
  • 取込基準終了日
    取込基準終了日を設定します。
    ※マッピング定義でレコード単位期間指定取込設定をしている場合は、取込データのレコード毎に設定する取込基準終了日が適用されます。
    詳細については、『 取込基準日 』を参照してください。
    レコード単位期間指定取込については、『 レコード単位期間指定取込 』を参照してください。
  • 差分抽出
    差分取込を実施する場合は選択します。
    詳細については、『 差分抽出 』を参照してください。

6.2.2. 取込設定明細

../../_images/import_execute_02.jpg
  • マッピングID
    マッピングIDが表示されます。
  • マッピング定義名
    マッピング定義名が表示されます。
  • ドメインカテゴリ
    マッピング定義に設定されているドメインカテゴリが表示されます。
  • ドメイン分類
    マッピング定義に設定されているドメイン分類が表示されます。
  • 取込ファイルパス
    マッピング定義に紐付く取込ファイルパスが表示されます。
    一時的に、取込先ファイルパスを変更する事が可能です。
    詳しい設定方法は、『 取込ファイル設定 - 基本情報 』を参照してください。

取込実行画面の詳しい操作方法は、『 Accel-KNIGHT 操作ガイド - 取込設定 - 取込実行 』を参照してください。

6.3. ログ

正常ログ出力先、エラーログ出力先は取込設定登録・編集画面で設定します。

6.3.1. 出力先を指定した場合

取込設定登録・編集画面で設定した正常/エラーログ出力先にログファイルを出力します。
既にファイルがある場合は、追記モードでログを出力します。
../../_images/import_log_01.jpg
  • パブリックストレージを指定
    パブリックストレージを指定する場合は
    <ストレージパス>/public/storage/<テナントID>/をルートとした相対パスを指定してください。
  • ネットワーク上を指定
    ネットワーク上を指定する場合は
    ネットワーク上のファイルを指定する場合は、フルパスで入力してください。
    指定するファイルは、サーバOS上のイントラマートプロセスを実行しているアカウントがアクセス権を持っているファイルを指定してください。
    アクセス権のない出力先を指定した場合には、取込処理時にエラーとなります。
入力規則については、『 Accel-KNIGHT 操作ガイド - リファレンス - 入力規則 』を参照してください。

6.3.2. 出力先を指定しない場合

6.4. バリデーション

取込処理時、またはバリデーションチェック実行時にはバリデーションチェックを行います。
検出されたエラー内容は、取込処理時はエラーログファイルから、バリデーションチェック実行時は取込実行画面のバリデーションエラー詳細から確認できます。

6.4.1. 全件チェック

取込設定登録・編集画面、または取込実行画面でバリデーションチェックを全件行うか設定します。
通常、バリデーションチェック処理時にエラーが検出された場合にはその時点でバリデーションチェック処理を中断しますが、
バリデーションチェックの全件を選択すると、全件のバリデーションチェックを行います。
../../_images/import_validation_01.jpg

6.4.2. 取込ファイルバリデーション

取込ファイル定義登録・編集画面の項目明細で「バリデーション」が選択されている項目に対して
設定された条件(桁数/必須/日付フォーマット区分/数値フォーマット区分)でバリデーションチェックを行います。
../../_images/import_validation_02.jpg
詳しい設定方法は、『 取込ファイル設定-項目明細 』を参照してください。

6.4.3. ドメイン分類バリデーション

6.4.3.1. IM-共通マスタ/アプリケーション共通マスタバリデーション

マッピング定義登録・編集画面の項目明細でマッピングした項目に対して
IM-共通マスタ 入力項目定義書に従ったバリデーションチェックを行います。
※IM-共通マスタ間のデータの整合性はチェックしていません。
../../_images/import_validation_03.jpg
IM-共通マスタの入力項目チェック仕様については、『 IM-共通マスタ 入力項目定義書 』を参照してください。

6.4.3.2. 業務テーブルバリデーション

マッピング定義登録・編集画面の項目明細でマッピングした項目に対して、Accel-KNIGHTのマスタに登録済みの業務テーブル情報に従ったバリデーションチェックを行います。
Accel-KNIGHTのマスタに業務テーブル情報を登録する方法は、『 業務テーブル連携設定 』を参照してください。

6.6. 取込基準日

取込基準開始日/終了日は、取込設定登録・編集画面、または取込実行画面で設定します。
但し、マッピング定義でレコード単位期間指定取込設定をしている場合は、取込ファイルデータ内でレコード毎に設定する取込基準開始日/終了日が適用されるため、取込実行画面で設定した取込基準開始日/終了日は無視されます。

6.6.1. 日付を指定する

取込設定登録・編集画面で固定の日付を指定した場合や、取込実行画面で日付指定を行った場合は、取込処理実行日に関わらず指定された日付でデータが取り込まれます。
その為、定期的に取込処理が実行された場合でも取込基準日は変化しません。
  • 取込設定登録・編集画面
    日付指定を選択し、「年指定」・「月指定」・「日指定」を設定します。

    例:「2022年4月1日」から「2030年3月31日」までデータを登録したい
    以下のように設定すると、いつ取込処理を実行しても「2022年4月1日」から「2030年3月31日」までの期間、データを登録します。
    ../../_images/import_referencedate_01.jpg

  • 取込実行画面
    日付指定を選択し、「yyyy/MM/dd」形式で日付を設定します。
    ../../_images/import_referencedate_02.jpg

6.6.2. 定期的な取込をする場合

取込設定登録・編集画面で「当年/翌年」・「当月/翌月」・「当日/翌日/月末」を設定することで
取込処理実行日に応じた相対的な日付でデータが取り込まれます。

例1:「当年/当月/当日」を指定した場合
取込処理実行日が設定されます。
../../_images/import_referencedate_03.jpg

取込処理実行日 取込基準日
2016年 4月 1日 2016年 4月 1日
2016年 5月 1日 2016年 5月 1日
2016年 6月 1日 2016年 6月 1日

例2:「翌年/翌月/翌日」を指定した場合
取込処理実行日の年、月、日をそれぞれ1ずつ加算した日付が設定されます。
../../_images/import_referencedate_04.jpg

取込処理実行日 取込基準日
2016年 4月 1日 2017年 5月 2日
2016年 8月30日 2017年10月 1日
2016年12月 1日 2018年 1月 2日

例3:「当年/翌月/月末」を指定した場合
取込処理実行日の翌月末が設定されます。
../../_images/import_referencedate_05.jpg

取込処理実行日 取込基準日
2016年 4月 1日 2016年 5月31日
2016年12月10日 2017年 1月31日
2017年 1月 1日 2017年 2月28日

6.6.3. intra-mart上の期間データについて

以下のケースを例に、取込基準日を指定して取込処理を行った場合、intra-mart上の画面ではどのように表示されるかを説明します。
  • 新規登録
    取込基準開始日:2016年 4月 1日
    取込基準終了日:未指定※
    ※レコード単位期間指定取込の場合は取込基準終了日を未指定にできませんので、上記取込基準終了日をintra-mart上のシステム最大日付に読み替えてください。
    • 取込前
      データなし
    • 取込後
      取込基準開始日からintra-mart上のシステム最大日付までは有効な期間として作成され、選択すると濃い緑で表示されます。
      ../../_images/import_referencedate_06.png
      1900年1月1日から取込基準開始日の前日までは無効な期間として作成され、灰色で表示されます。
      ../../_images/import_referencedate_07.png

  • 更新
    取込基準開始日:2020年11月22日
    取込基準終了日:未指定※
    ※レコード単位期間指定取込の場合は取込基準終了日を未指定にできませんので、上記取込基準終了日をintra-mart上のシステム最大日付に読み替えてください。
    • 取込前
      2016年4月1日からintra-mart上のシステム最大日付までが有効なデータです。
      ../../_images/import_referencedate_08.png

    • 取込後
      取込基準開始日からintra-mart上のシステム最大日付まで新しく有効な期間が作成され、取込データの内容が反映されます。
      有効な期間は、選択中の場合は濃い緑、選択していない場合は薄い緑で表示されます。
      ../../_images/import_referencedate_09.png
      期間を切り替えると、取込基準開始日以前のデータの状態が確認できます。
      ../../_images/import_referencedate_10.png

  • 削除
    取込基準開始日:2025年 4月 1日
    取込基準終了日:未指定※
    ※レコード単位期間指定取込の場合は取込基準終了日を未指定にできませんので、上記取込基準終了日をintra-mart上のシステム最大日付に読み替えてください。
    • 取込前
      2016年4月1日からintra-mart上のシステム最大日付までが有効なデータです。
      ../../_images/import_referencedate_11.png

    • 取込後
      取込基準開始日からintra-mart上のシステム最大日付まで新しく無効な期間が作成されます。
      無効化されている期間は灰色で表示されます。
      ../../_images/import_referencedate_12.png

  • 新規登録
    取込基準開始日:2020年 4月 1日
    取込基準終了日:2023年 3月31日
    • 取込前
      データなし
    • 取込後
      取込基準開始日から取込基準終了日までは有効な期間として作成されます。
      ../../_images/import_referencedate_13.png
      1900年1月1日から取込基準開始日の前日までは無効な期間として作成されます。
      ../../_images/import_referencedate_14.png
      取込基準終了日の翌日からintra-mart上のシステム最大日付まで無効な期間として作成されます。
      ../../_images/import_referencedate_15.png

  • 補足
    取込処理時には、期間化情報を持つドメインすべてに対して設定された取込基準開始日から取込基準終了日までの1期間を作成します。
    作成される期間と既存のマスタ情報に存在する期間が重複する部分は、既存の期間が短縮、または削除されます。
    期間化情報を持たないドメインに対しては期間に関係なく登録/更新されます。
       
    期間化情報を持つドメイン ユーザ
    ユーザ分類所属
    組織
    組織内包
    役職
    組織所属/所属役職
    組織分類所属
    パブリックグループ
    パブリックグループ内包
    役割
    パブリックグループ所属/所属役割
    パブリックグループ分類所属
    会社グループ
    会社グループ内包
    会社グループ所属
    期間化情報を持たないドメイン ユーザ分類
    ユーザ分類項目
    組織分類
    組織分類項目
    パブリックグループ分類
    パブリックグループ分類項目
    ※取込基準開始日と取込基準終了日の相関が不正な場合は、取込処理は行いません。
    ※レコード単位期間指定取込において取込基準開始日と取込基準終了日の相関が不正な場合は、intra-mart標準の取込用APIで取込を実施した際に相関エラーとなります。

    注釈

    「取込処理実行日」は、取込処理が開始された時の日付になります。取込処理中に日付を跨いだ場合でも、取込処理実行日は変化しません。

6.7. 通知メール設定

取込処理時に送信される、通知メールの設定について説明します。
通知メール設定を利用してメールを送信する際には、intra-martのメールモジュールの設定を有効にしてください。
詳しい設定方法は、『 intra-mart Accel Platform / 設定ファイルリファレンス - メールモジュール - メール設定 』を参照してください。

6.7.1. 送信元の設定

通知メールの送信元には、設定ファイル(imic-constant.properties)で定義されている通知メール送信元の値が設定されます。
下記に通知メール送信元の設定を記載します。

設定ファイル imic-constant.properties

名称 設定名 デフォルト値
通知メール送信元 IMIC.MAIL.FROM_ADDRESS postmaster@test-imknight.co.jp
各設定については、適宜変更をしてください。
※設定の反映にはサーバの再起動が必要になります。

6.7.2. 件名の設定

通知メールの件名には、設定ファイル(imic-constant.properties)で定義されている取込テンプレート内の値が設定されます。
下記に取込テンプレートパスの設定を記載します。

設定ファイル imic-constant.properties

名称 設定名 デフォルト値
結果通知メールテンプレートファイルルートパス IMIC.MAIL.TEMPLATE.FILE.ROOT imic/mail_template
取込結果通知メール件名テンプレートファイル名 IMIC.MAIL.TEMPLATE.FILE_NAME.TITLE.IMPORT title_import_notice.tpl
各設定については、適宜変更をしてください。
※設定の反映にはサーバの再起動が必要になります。

件名には、置換パラメータを設定することができます。
初期設定では、件名テンプレートに下記の件名が設定されています。
【データ連携ツール】${exec_id} ${exec_name} ${exec_result}

6.7.3. 置換パラメータの詳細

件名・本文に使用できる置換パラメータは、下記となります。

置換パラメータ一覧

パラメータ名 キー名 設定内容
処理実行ID ${exec_id} 1回の取込/出力に対して、システムから一意に付与されるID
開始時刻 ${start_time} 取込/出力処理の開始時刻
終了時刻 ${end_time} 取込/出力処理の終了時刻
処理名称 ${exec_name} 取込/出力処理の名称
処理結果 ${exec_result} 処理結果
処理実行ユーザコード ${exec_user_cd} 処理を実行したユーザのユーザコード
処理実行ユーザ名 ${exec_user_name} 処理を実行したユーザの名称
例:以下のような件名、本文に置換パラメータを設定した場合
件名 【データ連携ツール】${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}
———————————————–
以下のようなメールが送信されます。
../../_images/import_mail_01.png

6.7.4. 送信先・本文の設定

取込設定登録・編集画面から通知メールの設定を行います。
通知メール画面の操作方法は、『 Accel-KNIGHT 操作ガイド - 補助画面 - 通知メール設定 』を参照してください。
取込実行画面では、送信先を一時的に変更することができます。
取込処理時のメール送信は、取込設定の結果通知区分に応じて行われます。

結果通知区分

すべて通知 取込処理結果に関わらず、メールを送信します。
例外発生時のみ通知 取込処理がエラーで終了した場合、メールを送信します。
正常終了時のみ通知 取込処理が正常に終了した場合、メールを送信します。
通知しない メールを送信しません。

6.13. データベース取込

テーブル、ビュー、SQL文を発行して取込を行うことが可能です。シェアードデータベースのデータベースを指定することも可能です。

6.13.1. 実行方法

テーブルを指定する場合、取込ファイル定義画面でテーブルを指定します。
../../_images/import_db_01.jpg

ビューを指定する場合、取込ファイル定義画面でビューを指定します。

../../_images/import_db_02.jpg

SQL文を指定する場合、取込ファイル定義画面でSQL文を記載します。

../../_images/import_db_03.jpg
マッピング定義以降は通常のマッピングと同様に登録を行います。。
マッピング定義の作成方法は『 マッピング設定 』を参照してください。

6.13.2. テーブルのカラムを明細に設定の動作イメージ


テーブル 指定されたテーブルのカラムを取得し明細に登録します。
ビュー 指定されたビューのカラムを取得し明細に登録します。
SQL 指定されたSQL文のSELECTカラムを取得し明細に登録します。
上記SQL文を設定し「テーブルのカラムを明細に設定」を行った場合
../../_images/import_db_04.jpg

6.13.3. 注意点

  • 桁数についての注意
    取込元のカラムの桁数と取込先の桁数がが異なる場合、エラーが発生し取り込めません。

6.14. JSON取込

JSON取込はロジックフローからサービスを経由しJSON文字列を取得し取り込むことが可能です。

6.14.1. 実行方法

取込可能なJSON文字列の例(オブジェクト型)
../../_images/import_json_01.jpg
取込可能なJSON文字列の例(配列型)
../../_images/import_json_02.jpg
JSONの各キー項目を明細に設定します。
../../_images/import_json_05.jpg
オブジェクト型で取込対象となったキー以外の情報を取込みたい場合はJSONオブジェクト明細に登録します。
../../_images/import_json_06.jpg
取込時のロジックフローの入出力設定、出力に「akJsonStr」を設定し取得したJSON文字列を「akJsonStr」にマッピングします。
../../_images/import_json_03.jpg
出力時のロジックフローの入出力設定、入力に「akJsonStr」を設定すると出力されたJSON文字列が「akJsonStr」にマッピングされます。
../../_images/import_json_04.jpg

6.15. 固定長取込

固定長ファイルを取り込むことが可能です。

6.15.1. ファイルパターン

固定長で取込を行えるファイルパターンは以下になります。
ヘッダとフッタ無しでかつデータ部に改行のないファイル
../../_images/import_fixed_01.jpg
ヘッダからエンドレコードまでが1ファイル内に1セットのみのファイル
../../_images/import_fixed_02.jpg
ヘッダからフッタまでが1ファイル内に複数セットあるファイル
../../_images/import_fixed_03.jpg
エンドレコード以降にもレコードがあるファイル
../../_images/import_fixed_04.jpg

6.15.2. チェック方式ごとの動作

取込を実施し、エンドコード以降のレコードは読み込まない
固定長ファイルにエンドレコードが存在しエンドレコード以降にデータが存在する場合エンドレコード以降は取込対象とせずに取込を行います。
取込は実施せずバリデーションチェックでエラーにし、ファイルを修正する
固定長ファイルにエンドレコードが存在しエンドレコード以降にデータが存在する場合エラーとして取込を行いません。

6.15.3. 注意点

  • 明細の桁数について
    明細の桁数の設定がずれますと意図しない取込がされる可能性がありますので注意してください。