AppSuite(付録)

AppSuiteの機能を利用するための詳しい資料です。
ここで説明しているツールは、desknet's NEO公式ページよりダウンロードして使用できます。

印刷ボタン

AppSuiteコマンドラインツール

インポートツール


【モジュール名】
appsimport

【概要】
CSVファイルからデータをインポートします。クラウド環境のお客様も使用可能です。

【コマンド例】
Windows版
"appsimport.exe" -conf "C:\tmp\conf.txt" -access_key sampleAccessKey -app_alias sample -f "C:\tmp\import.csv" -l "C:\tmp\import.log" -char_code sjis -delimiter comma -title_except on -import_type update -fields_file "C:\tmp\import.json" -match_with_title off -key_field_name "データID" -exec_user login -error_stop on -attach_dir "C:\tmp\attach"

【起動引数】
起動引数 指定する値 説明
-conf [設定ファイルのフルパス] 必ず指定してください。設定ファイルの書き方は、後述の 【設定ファイル】 をご覧ください。
-access_key [アクセスキー] 必ず指定してください。インポートツールを実行するユーザーのアクセスキーを指定します。
インポートツールを実行できるユーザーはシステム管理者またはAppSuiteの機能管理者です。
-app_alias [アプリケーション識別子] 必ず指定してください。インポート対象のアプリケーションの[アプリケーション設定 > 詳細]内にある「API設定」タブを参照し、アプリケーション識別子を指定します。
-f [インポート対象のCSVファイル] 必ず指定してください。CSVファイルの書き方については、画面に「使い方」が記載されています。
[AppSuite > その他の機能 > CSVファイルからインポート]ダイアログ内の「使い方」を参照してください。
-l [ログファイルのフルパス] インポートに失敗した行とその原因および、インポートに成功した件数と失敗した件数が、指定したログファイルに出力されます。
この起動引数を指定しなかった場合、ログファイルは出力されません。
-char_code [sjis | utf8n | utf8] CSVファイルの文字コードを指定します。この起動引数を指定しなかった場合、CSVファイルはシフトJISで記述してください。
[sjis] : シフトJIS(日本語、英数字のみ入力可能)
[utf8n]: BOMなしUTF-8 (日本語、英数字以外も入力可能)
[utf8] : BOM付きUTF-8 (日本語、英数字以外も入力可能)
-delimiter [comma | tab] CSVファイルの区切り文字を指定します。この起動引数を指定しなかった場合、値はカンマで区切ってください。
[comma]: カンマ
[tab]: タブ
-title_except [on | off] CSVファイルの1行目にタイトルがあるかを指定します。
この起動引数を指定しなかった場合、CSVファイルのタイトルありでインポートを行います。
[on]: タイトルあり
[off]: タイトルなし
-import_type [update | delete] 実行する処理を指定します。この起動引数を指定しなかった場合、データの追加・変更を行います。
[update]:データの追加・変更
[delete]:データの削除
※データを変更または削除するには、"-key_field_name"で「照合を行う部品」を指定する必要があります。
-fields_file [インポート先部品設定ファイルのフルパス] インポート先部品設定ファイルのフルパスを指定します。
この起動引数を指定しなかった場合、CSVファイルのタイトルに合わせてインポート先の部品を自動設定します。
インポート設定ファイルの書き方は、後述の 【インポート先部品設定ファイル】 をご覧ください。
-match_with_title [on | off] CSVファイルの1行目にタイトルがあるとき、タイトルからインポート先の部品を自動設定します。
この起動引数を指定しなかった場合、"-fields_file"の指定があればインポート先部品設定ファイルに従ってインポートを行い、"-fields_file"の指定がなければタイトルからインポート先の部品を自動設定してインポートを行います。
[on]: タイトルからインポート先の部品を自動設定する
[off]: タイトルからインポート先の部品を設定しない
-key_field_name [照合を行う部品] データを変更または削除するとき、照合を行う部品を指定します。
この起動引数を指定しなかった場合、照合は行いません。
-exec_user [login | super] インポートツールでデータの登録または変更をするとき、データの登録者と更新者について指定をします。
この起動引数を指定しなかった場合、アクセスキーで指定したユーザーが登録者と更新者になります。
[login]: アクセスキーで指定したユーザーを登録者、更新者とする。
[super]: データの登録では登録者、登録日時を指定する。データの変更では更新者、更新日時を更新前のままとする。
※データの登録者、登録日時を指定するときは、ユーザー選択部品、日時部品と同じ方法でCSVファイル内に記載します。
-error_stop [on | off] インポート中にエラーが発生したとき、インポートを続行するかを指定します。
この起動引数を指定しなかった場合、エラーが発生したときインポートを中断します。
[on]: エラーが発生したときインポートを中断する
[off]: エラーが発生したときインポートを最後まで続行する
-attach_dir [添付ファイルディレクトリパス] 添付ファイルをインポートするとき、インポートしたいファイルが格納されたディレクトリのパスを指定します。
この起動引数を指定しなかった場合、添付ファイルのインポートはできません。

【設定ファイル】

設定ファイルはAppSuiteに接続するための情報を記載したファイルです。

設定ファイルの例
url=http://sample/dneo.cgi
basic_auth_userid=sampleid
basic_auth_password=samplepass
proxy_host=samplehost
proxy_port=1234
proxy_auth_userid=proxyid
proxy_auth_password=proxypass

以下の情報をキー=値の形式で記入します。
キー 指定する値 説明
url [desknet's NEOのURL] 必ず指定してください。
desknet's NEOのURLを記述します。
basic_auth_userid [Basic認証ユーザーID] desknet's NEOへのログインにて、Basic認証を使用する場合指定します。
Basic認証をしない場合、この項目は記載不要です。
basic_auth_password [Basic認証パスワード]
proxy_host [プロキシサーバーホスト名] desknet's NEOにて、プロキシサーバーを使用する場合指定します。
プロキシサーバーを使用しない場合、この項目は記載不要です。
proxy_port [プロキシサーバーポート番号]
proxy_auth_userid [プロキシ認証ユーザーID] desknet's NEOにて、プロキシ認証を使用する場合指定します。
プロキシ認証を使用しない場合、この項目は記載不要です。
proxy_auth_password [プロキシ認証パスワード]
※HTTPSとプロキシ認証の組み合わせでdesknet's NEOのサーバーにアクセスすることはできません。


【インポート先部品設定ファイル】

※文字コードはBOM無しのUTF-8で保存してください。
※Windows付属の「メモ帳」はBOM付きのUTF-8で保存されるため、使用しないでください。

インポート先部品設定ファイルの例
[
  { "field_name": "担当"},
  { "field_name": ""},
  { "field_name": "顧客"}
 ]

以下の情報をjson形式({}で囲まれた、キーと値の組)で記入します。
キー 指定する値 説明
field_name [インポート対象部品名] 必ず指定してください。"field_name"にインポート対象の部品名を記述します。
この値の並び順が、CSVファイルの列の順番と一致します。
"field_name"を空で指定すると、その列の値はインポートされません。

【添付ファイルのインポート】
"-attach_dir"で指定した添付ファイルディレクトリを起点パスとして、インポートしたいファイルを相対パスでCSVファイルに記載すると、添付ファイルのインポートができます。
サブディレクトリにあるファイルも相対パスで指定してインポートができます。

CSVファイルの例
添付ファイル
"sample.txt"
"subdir/sample.png"
"file1.jpg
file2.jpg"