Difference between revisions of "Command reference"
Jump to navigation
Jump to search
old>Admin |
(→scan) |
||
| (19 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== Understanding commands == | |||
Commands are specified in the '''command''' parameter when calling the '''main''' servlet | |||
https://acme.com/TempusServa/main?command=index | |||
The core commands are | |||
* index | |||
* list | |||
* edit | |||
* new | |||
View commands can also be used in [[Integration/Content_source]] | |||
== Command reference == | |||
ARTICLE IS DRAFT / UNDER DEVELOPMENT | ARTICLE IS DRAFT / UNDER DEVELOPMENT | ||
= | === Navigation === | ||
== | |||
{| | {| | ||
!command | !command | ||
| Line 32: | Line 38: | ||
|} | |} | ||
== Single item == | === Single item === | ||
{| | {| | ||
!command | !command | ||
| Line 65: | Line 71: | ||
|} | |} | ||
== Single item related data == | === Single item related data === | ||
{| | {| | ||
!command | !command | ||
| Line 98: | Line 104: | ||
|} | |} | ||
== Items list nested data == | === Items list nested data === | ||
{| | {| | ||
!command | !command | ||
| Line 126: | Line 132: | ||
|} | |} | ||
== Lists / reports == | === Lists / reports === | ||
{| | {| | ||
| Line 150: | Line 156: | ||
|- | |- | ||
|dist | |dist | ||
|Distributions of all | |Distributions of all categories | ||
|SagID | |SagID | ||
| | | | ||
| Line 180: | Line 186: | ||
|} | |} | ||
== Statistics == | === Statistics === | ||
{| | {| | ||
!command | !command | ||
| Line 228: | Line 234: | ||
|} | |} | ||
== System == | === System === | ||
{| | {| | ||
!command | !command | ||
| Line 240: | Line 246: | ||
| | | | ||
|} | |} | ||
== Other services == | |||
=== scan === | |||
The scan servlet will take input from HTTP calls, usually triggered from an QR or NFC scan. | |||
The use is either | |||
# Make an Object call, then an Action call (within 1 minute). | |||
# Make an Action call, then an Object call (within 1 minute). | |||
# Make a combined call with both Object and Action. | |||
Required parameters is a Object, Action or both. | |||
Object | |||
* entity [string] (Entity system name) | |||
* object [int] (DataID) | |||
Action | |||
* field [string] | |||
* value [string] | |||
Options | |||
* result | |||
=== barcode === | |||
Required | |||
* data | |||
Optional | |||
* type | |||
* appid | |||
* width | |||
* height | |||
* resolution | |||
Latest revision as of 10:38, 8 February 2024
Understanding commands
Commands are specified in the command parameter when calling the main servlet
https://acme.com/TempusServa/main?command=index
The core commands are
- index
- list
- edit
- new
View commands can also be used in Integration/Content_source
Command reference
ARTICLE IS DRAFT / UNDER DEVELOPMENT
| command | function | required | optional |
|---|---|---|---|
| <none> | Default command | ||
| index | Nested accordion list of all solutions | ||
| board | Display default dashboard | Dashboard |
Single item
| command | function | required | optional |
|---|---|---|---|
| show | Open record in display mode | SagID DataID | |
| edit | Open record in edit mode | SagID DataID | |
| new | Create new record in edit mode | SagID DataID | |
| save | Post changes to data | SagID DataID | |
| export | Display default dashboard | SagID DataID |
| command | function | required | optional |
|---|---|---|---|
| measure | Summary of time usage on this item | SagID DataID | |
| status | Timeline of status changes | SagID DataID | |
| access | List of access to this item | SagID DataID | |
| revision | List of all data revisions | SagID DataID | |
| timeline | Summary changes, status & actions | SagID DataID |
Items list nested data
| command | function | required | optional |
|---|---|---|---|
| task | List of all tasks | SagID | QUERY_PageOffset |
| file | List of all files | SagID | QUERY_PageOffset |
| name | List of all contacts | SagID | QUERY_PageOffset |
| List of all emails | SagID | QUERY_PageOffset |
Lists / reports
| command | function | required | optional |
|---|---|---|---|
| list | List records | SagID | QUERY_PageOffset |
| xtab | Pivot table | SagID | |
| grid | Two dimensional grid | SagID | |
| dist | Distributions of all categories | SagID | |
| calm | Month calendar view | SagID | |
| gant | GANT chart | SagID | |
| maps | Large map of all positions | SagID | |
| heat | Columnar heatmap | SagID | |
| sums | SagID |
Statistics
| command | function | required | optional |
|---|---|---|---|
| stav | Analyze variable (count/sum) | SagID | |
| stat | Chi or T2 test of groups | SagID | |
| stas | Regression analysis | SagID | |
| staa | Anova test of 1 or 2 groups | SagID | |
| stap | Pareto diagram from variable | SagID | |
| star | Interactive runchart | SagID | |
| stac | Interval grouping | SagID | |
| staf | Fisher exact tests | SagID |
System
| command | function | required | optional |
|---|---|---|---|
| sync | Synchronizes DB tables with model | SagID |
Other services
scan
The scan servlet will take input from HTTP calls, usually triggered from an QR or NFC scan.
The use is either
- Make an Object call, then an Action call (within 1 minute).
- Make an Action call, then an Object call (within 1 minute).
- Make a combined call with both Object and Action.
Required parameters is a Object, Action or both.
Object
- entity [string] (Entity system name)
- object [int] (DataID)
Action
- field [string]
- value [string]
Options
- result
barcode
Required
- data
Optional
- type
- appid
- width
- height
- resolution