Batch Program

How to Start

[Windows]

• Create a batch file.
  Start a text editor such as "Notepad" that comes with Windows and enter the start command in the file.
  
  Batch file example
  

  "C:\Inetpub\Scripts\dneo\appsbatimport.exe" -h "C:\Inetpub\Scripts\dneo" -s "C:\tmp" -f "C:\tmp\import.csv" -l "C:\tmp" -c sjis -m comma -t ignore -app_id 1 -proc_type update -fields "C:\tmp\import.json" -login 1

  
  After filling in the files with the extension ".bat" (example: Save as C:\tmp\import.bat)
  
  
• Execute the batch file.
  Execute the batch file using the Windows command prompt.
  

  > C:\tmp\import.bat

  * For Windows Server 2016, you can start the command prompt from [Windows System Tools]-[Command Prompt] on the Start menu.
  
  
  

【Linux】

• Create a shell script file.
  1-1. Use a text editor such as vi to create a file with the extension ".sh" (eg /tmp/import.sh) and enter the startup command.

  [root@xxxxxx ~]# vi /tmp/import.sh

  
  Shell script file example
  

  #!/bin/bash export LD_LIBRARY_PATH=/var/www/cgi-bin/dneo/lib /var/www/cgi-bin/dneo/appsbatimport -h /var/www/cgi-bin/dneo -s /tmp -f /tmp/import.csv -l /tmp -c sjis -m comma -t ignore -app_id 1 -proc_type update -fields /tmp/import.json -login 1

  
  1-2. Grant execute permission to the shell script file.
  

  [root@xxxxxx ~]# chmod 755 /tmp/import.sh

  
  
• Execute a shell script.
  Become the running user of your web server and run the shell script from the console.
  

  # sudo -u apache /tmp/import.sh

  * For the user name "apache" specified in [-u], specify the execution user name of your Web server.
  
  
* Precautions
If you execute the shell script as the root user, the files created will be owned by the root user, and AppSuite may not operate properly.
In such a case, change the owner of all the files below where desknet's NEO is installed to the execution user of your web server.

Data Import Batch

[Module name]
appsimport

[Summary]
Import the data from the Excel or CSV file.

[Command example]
Windows version

"C:\Inetpub\Scripts\dneo\appsbatimport.exe" -h "C:\Inetpub\Scripts\dneo" -s "C:\tmp" -f "C:\tmp\import.csv" -l "C:\tmp" -c sjis -m comma -t ignore -app_id 1 -proc_type update -fields "C:\tmp\import.json" -login 1

Linux version

/var/www/cgi-bin/dneo/appsbatimport -h /var/www/cgi-bin/dneo -s /tmp -f /tmp/import.csv -l /tmp -c sjis -m comma -t ignore -app_id 1 -proc_type update -fields /tmp/import.json -login 1

[Boot argument]

Boot Argument	Specified Value	Description
-h	[Full path to install desknet's NEO]	Be sure to specify it.
-s	[Output destination of execution result file]	Be sure to specify it. Importing has been failed to output the cause to the status file "import.status".
-f	[Full path of Excel/CSV file to be imported]	Be sure to specify it. For how to write a CSV file, please refer to: Import File
-l	[Log file output destination]	Be sure to specify it. The line that failed to be imported and its cause, and the number of successful and unsuccessful imports are output to the log file "import_[application ID].log".
-c	[ sjis | utf8n | utf8 ]	CSV file only. 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)
-m	[comma | tab]	CSV file only. Specify the delimiter for the CSV file. If you do not specify this boot argument, separate the values with commas. [comma]: Comma [tab]: Tab
-sheet_index	[Sheet position]	Excel worksheet only. Specify the position from top (start with 0) of the sheet to import. If you do not specify this boot argument, top sheet will be imported.
-sheet_range_start	[Left top cell]	Excel worksheet only. Specify the left top cell (c.f. A1) in range to import. If you do not specify this boot argument, the left top cell in range which has data will be specified.
-sheet_range_end	[Right bottom cell]	Excel worksheet only. Specify the right bottom cell (c.f. Z100) in range to import. If you do not specify this boot argument, the right bottom cell in range which has data will be specified.
-t	ignore	If this startup argument is specified, the first line of the file will be ignored and the second line will be imported.
-app_id	[Application ID]	Be sure to specify it. Specify the value of "app_id" from the URL of TOP (Browse screen) of the import destination application.
-fields	[Full path of import settings file]	Be sure to specify it. Specify the full path of the plug-in setting file that describes the plug-in to be imported. For how to write a part setting file, see [Import setting file]
-proc_type	[update | delete]	Be sure to specify it. Specify the processing to be executed. [update]: Add/change data [delete]: Delete data To change or delete data, it is necessary to specify "Parts to be verified" in the import setting file.
-login	[User system ID]	Specify the "id" value from the URL on the [User List> Application Management> Change User Information] screen. The "Added By" and "Updated By" of the data will be the users specified in this startup argument. In addition, the time zone of the user specified by this startup argument is applied to the date and time parts. (If not specified, the time zone set by the administrator will be applied.) * If this startup argument is not specified, it is necessary to specify "Added By" in the file when adding data. * If this startup argument is not specified, "Updated By" and "Date/Time Updated" will not be changed when updating data. * If this startup argument is not specified, it is not recorded to data change log.

Import configuration file example

{  "fields": [   { "field_name": “Responsible"},   { "field_name": ""},   { "field_name": “Client"}  ],  "key_field_name": “Responsible" }

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

Key	The specified value	Description
fields	[Array of import target part names]	Be sure to specify it. If "-login" of the start argument is not specified, "Date/Time Added" and "Added By" can also be specified as import targets. For more details, see Part settings * If "field_name" in the format is left blank, that column will not be imported.
key_field_name	[Parts to be verified]	Specify the name of the plug-in that is the key of the data to be changed or deleted.

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

Data Export Batch

[Module name]
appsimport

[Summary]
Export the data to a CSV file.

[Command example]
Windows version

"C:\Inetpub\Scripts\dneo\appsbatexport.exe" -h "C:\Inetpub\Scripts\dneo" -s "C:\tmp" -f "C:\tmp\export.csv" -c sjis -m comma -t off -app_id 1 -fields "C:\tmp\export.json" -filter "C:\tmp\export_filter.json" -login 1

Linux version

/var/www/cgi-bin/dneo/appsbatexport -h /var/www/cgi-bin/dneo -s /tmp -f /tmp/export.csv -c sjis -m comma -t off -app_id 1 -fields /tmp/export.json -filter /tmp/export_filter.json -login 1

[Boot argument]

[Boot argument]	The specified value	Description
-h	[Full path to install desknet's NEO]	Be sure to specify it.
-s	[Output destination of execution result file]	Be sure to specify it. Exporting has been failed to output the cause to the status file "export.status".
-f	[Full path of CSV file output destination]	Be sure to specify it.
-c	[ 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)
-m	[comma | tab]	Specify the delimiter for the CSV file. If you do not specify this startup argument, the delimiters are printed as commas. [comma]: Comma [tab]: Tab
-g	[i | o | n]	Specify the format of group output to CSV file. If this boot argument is not specified, it will be output with the group system ID. [i]: Group system ID [o]: Internal organization code [n]: Group Name
-u	[i | l | n]	Specify the user format to output to a CSV file. If this boot argument is not specified, the user system ID will be output. [i]: User system ID [l]: Login ID [n]: Name
-t	off	If this boot argument is specified, the component name will not be output to the first line of the CSV file.
-app_id	[Application ID]	Be sure to specify it. Specify the value of "app_id" from the URL of TOP (browse screen) of the application to be exported.
-fields	[Full path of export settings file]	Be sure to specify it. Specify the full path of the plug-in setting file that describes the plug-in to be exported. For how to write a part setting file, see [Export setting file] * 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	[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 how to write a narrowing condition file, refer to  [Narrowing condition file]
-login	[User system ID]	For the user system ID, specify the value of "id" from the URL on the [User List> Application Management> Change User Information] screen. The "time zone" of the user specified in this startup argument is applied to "Date/Time Added", "Date/Time Updated", and date and time parts. If this boot argument is not specified, the time zone of the [Administrator Settings> Basic Settings> Language and Time Zone Settings] screen will be applied.

Export configuration file example

{  "fields": [   { "field_name": “Responsible"},   { "field_name": ""},   { "field_name": “Client"}  ] }

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

Key	The specified value	Description
fields	[Array of export target part names]	Be sure to specify it. For more details, see Part settings * If "field_name" in the format is left blank, the value in that column will be output as blank.

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