データベースCSV取込み

CSVファイルの取り込み処理は、画面から実行する方法と、バッチ処理にて実行する方法の2種類があります。
当項では、バッチ処理によりデータ取り込みを実行する方法のみご説明します。
なお、事前準備として、バッチを実行する端末において、バッチ実行用ファイルのダウンロード・配置、Javaのインストール、Webサービス認証用キーの発行を行う必要があります。
取り込みに関する留意事項、CSVファイルの作成方法や画面からの取り込み等は、ユーザーズマニュアル データベース利用編 を参照してください。

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

当項は、Webデータベース および CRMデータベースに対する説明となります。image3 汎用申請データベースに対するCSV取り込み(申請データの取り込み)は、ユーザーズマニュアル 汎用申請設定編「汎用申請データ取込み」を参照してください。

バッチ実行の準備を行う

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

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

  • Javaのインストール

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

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

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

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

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

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

    image21 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. image6 > MIU:セットアップ処理 をクリックします。

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

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

    image22 frame

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

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

項目名 説明

権限

発行する認証キーが処理できる操作を選択します。
取込み処理の場合は、“参照”、“追加”、“ファイルアップロード” の権限が必要です。

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

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

処理者

バッチを実行する社員を選択します。選択された社員が操作ログの実行社員に記録されます。
ここで指定するユーザは、「Webデータベース」ライセンスが付与され、取り込み先のデータベースに対してデータベース管理者の権限が必要です。また、データベースを格納するすべての上位フォルダに対し参照権限が必要となります。
取り込むフィールドは、表示編集画面に配置し、取り込み処理を実行するユーザが参照できる必要があります(どの表示編集画面でも参照できないフィールドは取り込めません)。
image4 CRMデータベースの場合は、管理単位の参照権限も必要です。

バッチ処理にてCSVデータを取り込む

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

    java -jar C:\tool\BatchClient.jar -server http://<サーバー名>[:ポート]/pe4j -apikey <認証キー> -type <実行処理> -processTimeout <タイムアウト時間> -targetDatabase <データベース名> -file <ZIPファイル名> -replaceComma <区切文字置換文字> -replaceCrlf <改行コード置換文字> -notification <通知> -removeRecords <既存レコード削除> -notifyFollow <フォロー通知> -systemClass <システム区分> -external <外部連携> -key <キー項目> -fileEncoding <文字コード>

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

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

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

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

    認証キー *

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

    実行処理 *

    webdbimportを指定してください。

    タイムアウト時間

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

    データベース名 *

    取り込み先のデータベースを指定します。
    フォルダ名+“/”+データベース名を指定します。フォルダが階層になっている場合は最上位のフォルダからすべて指定してください。
    フォルダ名・データベース名に「/」は使用できません。また、OSのコマンド実行において特別な意味を持つ記号(「"」、「<」、「>」、「|」、「%」など)は使用できません。

    ZIPファイル名 *

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

    区切文字置換文字

    CSVデータ内に指定した文字列が存在していた場合に、半角カンマに置換します。半角10文字以内で指定してください。
    “@”(全角)、“/”(全角)、“:”(半角)は、使用できません。

    改行コード置換文字

    CSVデータ内に指定した文字列が存在していた場合に、改行コードに置換します。半角10文字以内で指定してください。
    “@”(全角)、“/”(全角)、“:”(半角)は、使用できません。

    通知

    CSVで取り込むデータを、ユーザへの通知対象とするかどうかを指定します。
    <指定値>

    通知対象とする場合

    true

    通知対象としない場合

    false

    未指定の場合は、通知対象となりません。
    なお、取り込み先のデータベースに通知先の設定がされている場合のみ、その設定条件に従って通知されます。

    既存レコード削除

    取り込み時に、データベースの登録済みデータを全件削除するかどうかを指定します。削除しない場合は、登録済みのレコードに対し更新されます。
    <指定値>

    削除する場合

    true

    削除しない場合

    false

    未指定の場合は、“削除しない” として取り込まれます。

    フォロー通知

    ライセンス「CRM」が登録されており、取り込み対象のデータベースが顧客ポータル(会社情報照会画面)に配置されている場合のみ有効なパラメタです。
    顧客情報のフォロー設定を行っているユーザに対して、CSV取り込み時に新着通知を行うかどうかを指定します。
    <指定値>

    通知する場合

    true

    通知しない場合

    false

    未指定の場合は、通知されません。

    システム区分

    出力対象のデータベースの種類を指定します。
    <指定値>

    Webデータベース

    0

    CRMデータベース

    2

    未指定の場合は「Webデータベース」が対象となります。

    外部連携

    取り込み対象のデータベースに外部連携設定がされている場合にのみ有効なパラメタです。CSV取り込み時に外部連携処理を実行するかどうかを指定します。
    <指定値>

    実行する場合

    true

    実行しない場合

    false

    未指定の場合は、“実行する” として取り込まれます。

    キー項目

    指定されたデータベースから、レコードの新規登録/更新を判定するキー項目として利用するフィールド名を指定します。
    指定できるのは、フィールド設定時にキー項目として設定されている文字列(1行)のフィールド、もしくは、システム標準項目「No」のみとなります。
    未指定の場合は、システム標準項目「No」をキー項目として取り込まれます。

    文字コード

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

    <サンプル>

    java -jar C:\tool\BatchClient.jar -server http://d-circle/pe4j -apikey 19999999-a7aa-4444-9cc9-666aaa222222 -type webdbimport -processTimeout 10800 -targetDatabase システム管理/PC管理台帳 -file C:\work\pclist201804.zip -replaceComma , -replaceCrlf \n -notification true -removeRecords false -notifyFollow true -systemClass 0 -external false -key 管理番号 -fileEncoding utf-8

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

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

  3. バッチ実行が終了後、実行結果を確認します。
    正常終了時には、コマンドプロンプトに正常終了した旨のメッセージが表示されます。
    異常終了時には、コマンドプロンプトに、警告またはエラーが発生した旨のメッセージが表示されます。
    実行した取り込み処理(バッチ処理)の結果確認は、実行履歴の確認画面から行います。
    なお、異常終了した場合、警告やエラーの詳細の確認は、実行履歴の確認画面およびログ照会画面から行います。

    実行履歴の確認画面は、次のように起動します。

    • image2 Webデータベースの場合
      image23 > Webデータベース管理業務 > CSV取り込み をクリック

    • image4 CRMデータベースの場合
      image24 > お客様情報の管理 > CRMデータベースCSV取り込み をクリック
      各取り込み画面からimage25をクリックします。

    実行履歴の確認画面については、ユーザーズマニュアル データベース利用編「CSV取り込みの実行」を参照してください。

    ログ照会画面については、「ログ照会」の項を参照してください。
    なお、ログ照会では取り込みの開始・終了ログも確認できます。

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