AppSuiteコマンドラインツール

インポートツール

【モジュール名】
appsimport

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

【コマンド例】
Windows版

"C:\Program Files\desknet's NEO\bin\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	[接続設定ファイルのフルパス]	必ず指定してください。インポート対象のdesknet's NEOを記述した接続設定ファイルを指定します。 接続設定ファイルの書き方は、接続設定 をご覧ください。
-access_key	[アクセスキー]	必ず指定してください。インポートツールを実行するユーザーのアクセスキーを指定します。
-app_alias	[アプリケーション識別子]	必ず指定してください。インポート対象のアプリケーションの[アプリケーション設定 > オプション機能 > API設定]を参照し、アプリケーション識別子を指定します。 実行するには、実行するユーザーがそのアプリケーションに管理権限がある必要があります。
-f	[インポート対象のCSVファイル]	必ず指定してください。CSVファイルの書き方については、画面に「インポートファイルの詳細」が記載されています。 [AppSuite > その他の機能 > Excel/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ファイルのタイトルに合わせてインポート先の部品を自動設定します。 部品設定ファイルの書き方は、部品設定をご覧ください。 ※書式内の"field_name"を空欄にした場合、その列はインポートされません。 ※文字コードはBOM無しのUTF-8で保存してください。 ※Windows付属の「メモ帳」はBOM付きのUTF-8で保存されるため、使用しないでください。
-match_with_title	[on | off]	CSVファイルの1行目にタイトルがあるとき、タイトルからインポート先の部品を自動設定します。 この起動引数を指定しなかった場合、"-fields_file"の指定があればインポート先部品設定ファイルに従ってインポートを行い、"-fields_file"の指定がなければタイトルからインポート先の部品を自動設定してインポートを行います。 [on]: タイトルからインポート先の部品を自動設定する [off]: タイトルからインポート先の部品を設定しない
-key_field_name	[照合を行う部品]	データを変更または削除するとき、照合を行う部品を指定します。 この起動引数を指定しなかった場合、照合は行いません。
-exec_user	[login | super]	[super]を指定した場合、本来とは異なり、以下の動作になります。 データを新規追加するとき、登録者が必須になります。 データを変更するときに更新日時、更新者が自動的に変更されません。 データ変更履歴に記録されません。
-error_stop	[on | off]	インポート中にエラーが発生したとき、インポートを続行するかを指定します。 この起動引数を指定しなかった場合、エラーが発生したときインポートを中断します。 [on]: エラーが発生したときインポートを中断する [off]: エラーが発生したときインポートを最後まで続行する
-attach_dir	[添付ファイルディレクトリパス]	添付ファイルをインポートするとき、インポートしたいファイルが格納されたディレクトリのパスを指定します。 この起動引数を指定しなかった場合、添付ファイルのインポートはできません。

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

CSVファイルの例

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

エクスポートツール

【モジュール名】
appsexport

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

【コマンド例】
Windows版

"C:\Program Files\desknet's NEO\bin\appsexport.exe" -conf "C:\tmp\conf.txt" -access_key sampleAccessKey -app_alias sample -f "C:\tmp\export.csv" -l "C:\tmp\export.log" -char_code sjis -delimiter comma -title_header on -user id -group id -fields_file "C:\tmp\export.json" -filter_file "C:\tmp\filter.json"

【起動引数】

起動引数	指定する値	説明
-conf	[接続設定ファイルのフルパス]	必ず指定してください。エクスポート対象のdesknet's NEOを記述した接続設定ファイルを指定します。 接続設定ファイルの書き方は、接続設定 をご覧ください。
-access_key	[アクセスキー]	必ず指定してください。エクスポートツールを実行するユーザーのアクセスキーを指定します。
-app_alias	[アプリケーション識別子]	必ず指定してください。エクスポート対象のアプリケーションの[アプリケーション設定 > オプション機能 > API設定]を参照し、アプリケーション識別子を指定します。 実行するには、実行するユーザーがそのアプリケーションに管理権限がある必要があります。
-f	[CSVファイルの出力先]	必ず指定してください。エクスポートされた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]: タブ
-group	[id | org_code | name]	組織選択の出力書式を指定します。 この起動引数を指定しなかった場合、組織システムIDで出力します。 [id]: 組織システムID (例：*246) [org_code]: 企業内組織コード (例：@NEO0001) [name]: 組織名 (例：情報システム室)
-user	[id | login | name]	ユーザー選択、[登録者]、[更新者]の出力書式を指定します。 この起動引数を指定しなかった場合、ユーザーシステムIDで出力します。 [id]: ユーザーシステムID (例：*246) [login]: ログインID (例：@YAMADA0001) [name]: 氏名 (例：山田太郎)
-title_header	[on | off]	CSVファイルの1行目にタイトルを出力するかを指定します。 この起動引数を指定しなかった場合、CSVファイルのタイトルありで出力します。 [on]: タイトルあり [off]: タイトルなし
-fields_file	[エクスポート対象部品設定ファイルのフルパス]	エクスポート対象部品を記述した部品設定ファイルのフルパスを指定します。 この起動引数を指定しなかった場合、すべての部品の値を出力します。 部品設定ファイルの書き方は、部品設定をご覧ください。 ※書式内の"field_name"を空欄にした場合、その列の値は空で出力されます。 ※文字コードはBOM無しのUTF-8で保存してください。 ※Windows付属の「メモ帳」はBOM付きのUTF-8で保存されるため、使用しないでください。
-filter_file	[絞り込み条件ファイルのフルパス]	絞り込み条件を記述したファイルのフルパスを指定します。 この起動引数を指定しなかった場合、全件出力されます。 絞り込み条件ファイルの書き方は、後述の 【絞り込み条件ファイル】 をご覧ください。

絞り込み条件ファイルの例

{  "filter":{   "item":[    {"field_id": "101", "operator": ">", "value": "1"},    {"field_id": "102", "operator": "is_null"},    {"field_id": "103", "operator": "contains", "value": "1\t2", "type":"id"}   ]  } }

以下の情報をjson形式（{}で囲まれた、キーと値の組）で記入します。

キー	指定する値	説明
filter	[検索条件の配列]	絞り込み条件をご覧ください。