Command Line Tool

Import Tool

[Module name]
appsimport

[Summary]
Import the data from the CSV file. Customers in the cloud environment can also use it.

[Command example]
Windows version

"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 "Data ID" -exec_user login -error_stop on -attach_dir "C:\tmp\attach"

[Boot argument]

[Boot argument]	The specified value	Description
-conf	[Full path of connection setting file]	Be sure to specify it. Specify the connection setting file that describes desknet's NEO to be imported. For how to write a connection setting file, see Connection Setting
-access_key	[Access key]	Be sure to specify it. Specifies the access key of the user who runs the import tool.
-app_alias	[App Identifier]	Be sure to specify it. Refer to the [App Settings > Option Feature > API Settings] of the app to be imported and specify the app identifier. To run, the running user must have administrative privileges on the application.
-f	[CSV file to be imported]	Be sure to specify it. For how to write a CSV file, please refer to: Import File * Excel file can not be used with import tool.
-l	[Log file full path]	The line that failed to be imported and its cause, the number of successful imports and the number of failed imports will be output to the specified log file. When error occured, its cause and details will be outputed. If this boot argument is not specified, no log file will be output. * Some messages will be encrypted, they are used to research causes when you report problem to NEOJAPAN.
-char_code	[ sjis \| utf8n \| utf8 ]	Specify the character code of the CSV file. If you do not specify this startup argument, describe the CSV file in Shift JIS. [sjis] : Shift JIS (only Japanese and alphanumeric characters can be entered) [utf8n]: UTF-8 without BOM (Japanese, non-alphanumeric characters can be entered) [utf8] : UTF-8 with BOM (Japanese, non-alphanumeric characters can be entered)
-delimiter	[comma \| tab]	Specify the delimiter for the CSV file. If you do not specify this boot argument, separate the values with commas. [comma]: Comma [tab]: Tab
-title_except	[on \| off]	Specify whether the title is on the first line of the CSV file. If you do not specify this boot argument, import with CSV file title. [on]: With title [off]: No title
-import_type	[update \| delete]	Specify the processing to be executed. If this boot argument is not specified, data will be added or changed. [update]: Add/update data [delete]: Delete data * To update or delete the data, it is necessary to specify the "part to be verified" with "-key_field_name".
-fields_file	[Full path of the import destination part setting file]	Specify the full path of the plug-in setting file that describes the plug-in to be imported. If this boot argument is not specified, the import destination part will be automatically set according to the CSV file title. For how to write a connection setting file, see Parts setting * If "field_name" in the format is left blank, that column will not be imported. * Please save the character code as UTF-8 without BOM. * Do not use the "Notepad" that comes with Windows, as it is saved as UTF-8 with a BOM.
-match_with_title	[on \| off]	When there is a title in the first line of the CSV file, the import destination part is automatically set from the title. If this boot argument is not specified, if "-fields_file" is specified, import will be performed according to the import destination part setting file, and if "-fields_file" is not specified, the import destination part will be automatically set from the title and imported. to hold. [on]: Automatically set the import destination parts from the title [off]: Do not set import destination parts from title
-key_field_name	[Parts to be verified]	When changing or deleting data, specify the parts to be verified. If you do not specify this boot argument, no matching is done.
-exec_user	[login \| super]	Specify [super] to be changed to following specifications. When data is added, it is necessary to specify "Added By" in the CSV file. When data is updated, "Updated By" and "Date/Time Updated" will not be changed It is not recorded to data change log.
-error_stop	[on \| off]	Specifies whether to continue the import when an error occurs during the import. If you do not specify this startup argument, the import is aborted when an error occurs. [on]: Stop import when an error occurs [off]: Continue import to the end when an error occurs
-attach_dir	[Attachment file directory path]	When importing an attachment, specify the path of the directory that contains the file you want to import. If you do not specify this boot argument, you cannot import the attachment. * The all Files in the specified directory (includes subdirectories) will be uploaded. Then the files which is specified in [CSV file to be imported] with "-f" will be imported. * Do not specify a directory which has too many files not to be imported, to avoid heavy load to the server and network.

[Import attachment]
Attachment files can be imported with the import tool.
For more details, please refer to: Import File

* When changing the data, the attached file cannot be imported.

[Exit Code]

Exit Code	Description
0	It returns when command line tool have successfully terminated. * When "-error_stop" have beed specified to "off", skipped errors can exist.
1	It returns when command line tool have terminated with error. * When command line tool have terminated with [Ctrl+C] during executing, import/export will be aborted and terminated with error.

Exit code can be gotten with following method.

Create a batch file.
Activete a text editor (e.g. Notepad of Windows) and input the command.

Example of batch file

@echo off
"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 "Data ID" -exec_user login -error_stop on -attach_dir "C:\tmp\attach"

echo code=%errorlevel% >> "C:\tmp\exitcode.log"

On complete to input, save a file with ".bat" extension(e.g. C:\tmp\import.bat).

Execute the batch file with command prompt on Windows.

> C:\tmp\import.bat

* On Windows Server 2016, you can execute command prompt with [Windows System Tools] - [Command Prompt] in start menu.
Get the execution result.
Exit code have been outputed in "C:\tmp\exitcode.log", so you should get the result in the file.

Example of the execution result
code=0

Export Tools

[Module name]
appsimport

[Summary]
Export the data to a CSV file. Customers in the cloud environment can also use it.

[Command example]
Windows version

"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"

[Boot argument]

[Boot argument]	The specified value	Description
-conf	[Full path of connection setting file]	Be sure to specify it. Specify the connection setting file that describes desknet's NEO to be exported. For how to write a connection setting file, see Connection Setting
-access_key	[Access key]	Be sure to specify it. Specifies the access key of the user who runs the export tool.
-app_alias	[App Identifier]	Be sure to specify it. Refer to the [App Settings > Option Feature > API Settings] of the app to be exported and specify the app identifier. To run, the running user must have administrative privileges on the application.
-f	[CSV file output destination]	Be sure to specify it. The exported CSV file will be output here.
-l	[Log file full path]	When error occured, its cause and details will be outputed to the specified log file. If this boot argument is not specified or no error occured, no log file will be output. * Some messages will be encrypted, they are used to research causes when you report problem to NEOJAPAN.
-char_code	[ sjis \| utf8n \| utf8 ]	Specify the character code of the CSV file. If this startup argument is not specified, the CSV file will be output in Shift JIS. [sjis] : Shift JIS (only Japanese and alphanumeric characters can be entered) [utf8n]: UTF-8 without BOM (Japanese, non-alphanumeric characters can be entered) [utf8] : UTF-8 with BOM (Japanese, non-alphanumeric characters can be entered)
-delimiter	[comma \| tab]	Specify the delimiter for the CSV file. If you do not specify this startup argument, the values are output separated by commas. [comma]: Comma [tab]: Tab
-group	[id \| org_code \| name]	Specify the output format of group selection. If this startup argument is not specified, it will be output with the group system ID. [id]: Group system ID (Example: *246) [org_code]: Internal organization code (Example: @NEO0001) [name]: Group name (example: Information Systems Department
-user	[id \| login \| name]	Specify the output format for Select User, [Added By], and [Updated By]. If this boot argument is not specified, the user system ID will be output. [id]: User's "System ID (Example: *246) [login]: Login ID (Example: @YAMADA0001) [name]: Name (example: Taro Yamada)
-title_header	[on \| off]	Specify whether to output the title in the first line of the CSV file. If this boot argument is not specified, the CSV file title will be output. [on]: With title [off]: No title
-fields_file	[Full path of settings file for export target]	Specify the full path of the plug-in setting file that describes the plug-in to be exported. If this startup argument is not specified, the values of all parts will be output. For how to write a component setting file, see Parts setting * If "field_name" in the format is left blank, the value in that column will be output as blank. * Please save the character code as UTF-8 without BOM. * Do not use the "Notepad" that comes with Windows, as it is saved as UTF-8 with a BOM.
-filter_file	[Full path of narrowing condition file]	Specify the full path of the file that describes the narrowing conditions. If this startup argument is not specified, all items will be output. For details on how to write a narrowing condition file, refer to [Narrowing condition file]

[Narrowing condition file]

* Please save the character code as UTF-8 without BOM.
* Do not use the "Notepad" that comes with Windows, as it is saved as UTF-8 with a BOM.

Example of narrowing condition 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"}
  ]
}
}

Enter the following information in json format (key and value pairs enclosed in {}).

Key	The specified value	Description
filter	[Search condition array]	Please see"Refinement conditions".