AppSuite (Additional)

This is a detailed document for using the features of AppSuite.

Print Button

Connection Settings


Connection settings are information for connecting to AppSuite.

Example
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

Enter the following information in the key=value format.
Key The specified value Description
url [URL of desknet's NEO] Be sure to specify it.
Describe the URL of desknet's NEO.
basic_auth_userid [Basic authentication user ID] Specify when using Basic authentication when logging in to desknet's NEO.
This item is not required if Basic authentication is not performed.
basic_auth_password [Basic authentication password]
proxy_host [Proxy server host name] Specify when using a proxy server at desknet's NEO.
If you do not use a proxy server, this item is not required.
proxy_port [Proxy server port number]
proxy_auth_userid [Proxy Authentication User ID] Specify when using proxy authentication at desknet's NEO.
If you do not use proxy authentication, this item is not required.
proxy_auth_password [Proxy Authentication Password]
* You cannot access the desknet's NEO server with a combination of HTTPS and proxy authentication.


Parts Setting


Set the parts to be processed and the order.

Example
[
  { "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
field_name [Target part name] Be sure to specify it.” Describe the target part name in "field_name".


Narrowing Conditions


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

Please specify the search condition array in "item".
If there are multiple specified search conditions, AND search is executed.
The information to be entered in the search conditions is as follows.
Key The specified value Description
field_id [Part ID to search] Be sure to specify it. Specify the ID of the part to be searched.
You can check the component ID in [Application Settings> Component Management].
operator [= | ! = | &gt | &gt= | &lt | &lt= | includes | not_includes | starts_with | ends_with | contains | not_contains | is_null | is_not_null | matches] Be sure to specify it. Specify the search method.
value [Value to search for] Specify the value to search for.

If the value to be searched includes the following characters, please convert and enter as follows. (Tabs are used as delimiters when specifying multiple conditions.)
(Tab) → \t
\ → \\
" → \"
type [id | textbox | number | date | datetime | interval | field_id] Specifies the type of value to search for.

[List of search condition combinations]
The combination of "operator", "value" and "type" of the component specified by "field_id" is described below.
In order to specify the search conditions, it is necessary to combine the values of "operator", "value", and "type" for each component type specified in "field_id". The combinations that can be specified are as follows.

Part type operator value type
[Data ID] = (equal) Any integer greater than or equal to 1 (no input)
Text (1 Line) = (match) Arbitrary characters (no input)
!= (not match)
includes (contains | contains any of these words) Arbitrary characters (multiple values can be specified by separating with tab)
not_includes (doesn't contain | does not contain any of these words)
starts_with (begins with) Arbitrary characters
ends_with (ends with)
is_not_null (with value) (no input)
is_null (without value)
Text (Multi Line)
Rich Text
includes (contains | contains any of these words) Arbitrary characters (multiple values can be specified by separating with tab) (no input)
not_includes (doesn't contain | does not contain any of these words)
is_not_null (with value) (no input)
is_null (without value)
Check Box contains (match any selections) Choice value (multiple values can be specified by separating with tab) (no input)
not_contains (not match any selections)
includes (contains) Arbitrary characters
not_includes (doesn't contain)
is_not_null (with selection value) (no input)
is_null (without selection value)
Radio Button = (match any) Choice value (multiple values can be specified by separating with tab) (no input)
!= (not match any)
includes (contains) Arbitrary characters
not_includes (doesn't contain)
is_not_null (with selection value) (no input)
is_null (without selection value)
Pull Down = (match any) Choice value (multiple values can be specified by separating with tab) (no input)
!= (not match any)
is_not_null (with selection value) (no input)
is_null (without selection value)
List box contains (match any selections) Choice value (multiple values can be specified by separating with tab) (no input)
not_contains (not match any selections)
is_not_null (with selection value) (no input)
is_null (without selection value)
Number = (equal) Numerical values that can be entered in number parts (no input)
!= (not equal)
< (smaller than)
<= (smaller or equal than)
> (bigger than)
>= (bigger or equal than)
is_not_null (with value) (no input)
is_null (without value)
Date = (equal) - "yyyy", "yyyy-MM", or "yyyy-MM-dd" format
Example: "2018", "2018-01" or "2018-01-10"
- "[+|-]n days", "[+|-]n months:[*|1-31|e]" or "[+|-]n years:[1-12]:[*|1-31|e]" format
Example: "+3 days" (3 days after today)
Example: "-1 months:10" (10th of last month)
Example: "+1 months:*" (any day in the next month)
Example: "-2 years:3:e" (the end of March two years ago)
(no input)
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
= (equal) ID of the part to compare field_id
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
is_not_null (with value) (no input) (no input)
is_null (without value)
Time = (equal) "hh:mm" format (no input)
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
is_not_null (with value) (no input)
is_null (without value)
[Date/Time Added]
[Date/Time Updated]
Date/Time
= (equal) - "yyyy", "yyyy-MM", "yyyy-MM-dd", "yyyy-MM-ddThh" or "yyyy-MM-ddThh:mm" format
Example: "2018", "2018-01", "2018-01-10", "2018-01-10T09" or "2018-01-10T09:30"
- "[+|-]n days", "[+|-]n months:[*|1-31|e]" or "[+|-]n years:[1-12]:[*|1-31|e]" format
Example: "+3 days" (3 days after today)
Example: "-1 months:10" (10th of last month)
Example: "+1 months:*" (any day in the next month)
Example: "-2 years:3:e" (the end of March two years ago)
(no input)
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
= (equal) ID of the part to compare field_id
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
is_not_null (with value) (no input) (no input)
is_null (without value)
Attachment Files includes (include in file name) Arbitrary characters (no input)
matches (include in file name or attachment)
is_not_null (file exists) (no input)
is_null (file does not exist)
Auto Calculation = (match) Arbitrary characters textbox
!= (not match)
includes (contains | contains any of these words) Arbitrary characters (multiple values can be specified by separating with tab)
not_includes (doesn't contain | does not contain any of these words)
starts_with (begins with) Arbitrary characters
ends_with (ends with)
= (equal) Numerical values that can be entered in number parts number
!= (not equal)
< (smaller than)
<= (smaller or equal tha)
> (bigger than)
>= (bigger or equal than)
includes (contains) Arbitrary characters
= (equal) - "yyyy", "yyyy-MM", or "yyyy-MM-dd" format
Example: "2018", "2018-01" or "2018-01-10"
- "[+|-]n days", "[+|-]n months:[*|1-31|e]" or "[+|-]n years:[1-12]:[*|1-31|e]" format
Example: "+3 days" (3 days after today)
Example: "-1 months:10" (10th of last month)
Example: "+1 months:*" (any day in the next month)
Example: "-2 years:3:e" (the end of March two years ago)
date
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
includes (contains) Arbitrary characters
= (equal) - "yyyy", "yyyy-MM", "yyyy-MM-dd", "yyyy-MM-ddThh" or "yyyy-MM-ddThh:mm" format
Example: "2018", "2018-01", "2018-01-10", "2018-01-10T09" or "2018-01-10T09:30"
- "[+|-]n days", "[+|-]n months:[*|1-31|e]", "[+|-]n years:[1-12]:[*|1-31|e]" format
Example: "+3 days" (3 days after today)
Example: "-1 months:10" (10th of last month)
Example: "+1 months:*" (any day in the next month)
Example: "-2 years:3:e" (the end of March two years ago)
datetime
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
includes (contains) Arbitrary characters
= (equal) Any integer (converted to seconds) interval
!= (not equal)
< (less than)
<= (less or equal than)
> (greater than)
>= (greater or equal than)
includes (contains) Arbitrary characters
is_not_null (with value) (no input) (no input)
is_null (without value)
[Added by]
[Updated by]
Select User
contains (contains any of these words) User system ID (multiple values can be specified by separating with tab) id
not_contains (does not contain any of these words)
is_not_null (with selection value) (no input) (no input)
is_null (without selection value)
Select Group contains (contains any of these words) Group system ID (multiple values can be specified by separating with tab) id
not_contains (does not contain any of these words)
is_not_null (with selection value) (no input) (no input)
is_null (without selection value)

Sample 1

Search conditions that include "Installation cost" or "Cloud" in the total evaluation and the number of minimum contract months is less than "12"
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "includes", "value": "Installation cost\tCloud"},
   {"field_id": "102", "operator": ">", "value": "12"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Text (Multi Line) Total estimation
102 Number Minimum contract months

Sample 2

Search condition in which the department system ID of the department in charge is "3" or "4" and the number of sales results (auto calculation) is "1000000" or more
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "contains", "value": "3\t4", "type": "id"},
   {"field_id": "102", "operator": ">", "value": "1000000", "type": "number"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Select Group Department in charge
102 Auto Calculation Sales results

Sample 3

Search conditions that include "Chiyoda ward, Tokyo" in the address and last visited before "20th day 3 months ago"
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "includes", "value": "Chiyoda ward, Tokyo"},
   {"field_id": "102", "operator": "<", "value": "-3 months:20"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Text (1 Line) address
102 Date Last visit date

Sample 4

Search conditions when the contract status is other than "Contract Delete" and "Contract Expiration" and the contract start date is "April 1, 2017" or later
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "!=", "value": "Contract Delete\tContract Expired"},
   { field_id ": "102", "operator": ">=", "value": "2017-04-01"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Pull Down Contract status
102 Date Contract start date

Sample 5

Search conditions when the equipment rental date is "April 1, 2017 09:00" and the equipment return date has not been entered.
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": ">=", "value": "2017-04-01T09:00"},
   {"field_id": "102", "operator": "is_null"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Date/Time Equipment rental date and time
102 Date/Time Equipment return date and time

Sample 6

Search conditions when the employee's user system ID is "10" and the leaving time is "22:00" or later
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "contains", "value": "10", "type": "id"},
   {"field_id": "102", "operator": ">=", "value": "22:00"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Select User Employee
102 Time Leave time

Sample 7

Search conditions that have the same start and end dates
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "=", "value": "102", "type": "field_id"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Date Start Date
102 Date End Date

Sample 8

Search conditions that include "Estimates" in the file name of the documents to be sent
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "includes", "value": "Estimates"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Attachment Files Documents to be sent

Sample 9

Search conditions with a travel time (auto calculation) of "1 hour and a half (5400 seconds)" or more
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": ">=", "value": "5400", "type": "interval"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Auto Calculation Travel time

Sample 10

Search conditions for which the correctable date (auto calculation) is before "the end of this month"
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "<", "value": "+0 months:e", "type": "date"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Auto Calculation Correctable date

Sample 11

Search conditions before the estimated arrival date and time (auto calculation) "April 1, 2017 17:00"
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "<=", "value": "2017-04-01T17:00", "type": "datetime"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Auto Calculation Estimated arrival date and time

Sample 12

Search conditions that include "Heisei" or "Showa" in the Japanese calendar conversion (auto calculation)
{
 "filter": {
  "item": [
   {"field_id": "101", "operator": "includes", "value": "Heisei\tShowa", "type": "textbox"}
  ]
 }
}

Parts used in the sample
Part ID (field_id) Part type Part name
101 Auto Calculation Western calendar conversion


Import File


You can add/update data to app with a Excel worksheet (xlsx, 5MB or less) or a text file which is separeted with comma/tab in (csv).
Value formats for each type are the following.
Part Type Description
Number Specify number without unit. But number which formatted with Excel worksheet can be imported even if it has unit.
Date Specify string which is formatted with "YYYY/MM/DD","YYYY-MM-DD" or "YYYYMMDD". But date which is formatted with Excel worksheet can be imported.
Time Specify string which is formatted with "HH:MM" or "HHMM". But time which is formatted with Excel worksheet can be imported.
Date/Time Specify string which is formatted with "YYYY/MM/DD HH:MM", "YYYY-MM-DD HH:MM" or "YYYYMMDDHHMM". But date/time which is formatted with Excel worksheet can be imported.
Check Box Specify new line separeted chosen values.
List Box Specify new line separeted chosen values.
Select User Specify new line separete user system ID, login ID or name.
  • "* (Asterisk)" + "User System ID" (e.g. *246)
  • "@ (At mark)" + "Login ID" (e.g. @john0001)
  • "Name" (e.g. John Smith)
Select Group Specify new line separete group system ID, internal organization code or group name.
  • "* (Asterisk)" + "Group ystem ID" (e.g. *246)
  • "@ (At mark)" + "Internal Organization Code" (e.g. @NEO0001)
  • "Group Name" (e.g. Information System)
Attachment Files Data Import Batch
  Specify relative path from working directory or absolute path. Separate with new line to specify multiple files.

Import Tool
  Specify relative path from the directory which is specified with "-attach_dir". Files in the subdirectories can be specified with relative path. Separate with new line to specify multiple files.

* Attachment files can be imported only with data import batch and import tool.
* When a file has too long name, the file can fail to be imported.
  In the following case, a file with name with 149 characters (with bytes) can be imported.
  • The directory which is specified with "-attach_dir" is within 59 characters.
  • Desknet's NEO has been installed to within 59 characters path.
* Excel worksheet can not be imported with import tool. * Values which are formatted with Excel worksheet may not be imported as formatted value. (e.g. Percentage formatted "10%" will be imported as "0.1")
* Merged cells of Excel worksheet count as unmerged one (only the 1 left top cell has the value).
* Password protected Excel worksheet can be used.

[Import Attachment Files]

Example of data import batch with a CSV file on Windows
Name, Photo
John Smith,"C:\tmp\image\1\file.png"
Chris Doe,"C:\tmp\image\2\file1.png
C:\tmp\image\2\file2.png"

Example of data import batch with a CSV file on Linux
Name, Photo
John Smith,"/tmp/image/1/file.png"
Chris Doe,"/tmp/image/2/file1.png
/tmp/image/2/file2.png"

Example of import tool with a CSV file(Specify "C:\tmp\image" to "-attach_dir")
Name, Photo
John Smith,"1/file.png"
Chris Doe,"2/file1.png
2/file2.png"

* To import multiple files to one attachment file, separate file path with new line and wrap with double quotations.

Imported data
Name Photo
John Smith file.png
Chris Doe file1.png
file2.png