Templates

To create, edit and delete report templates, use the command report/update_report:

svc=report/update_report&params={"itemId":<long>,
				 "id":<long>,
				 "callMode":<text>,
				 "n":<text>,
				 "ct":<text>,
				 "p":<text>,
				 "tbl":[
					 {
						"n":<text>,
						"l":<text>,
						"c":<text>,
						"cl":<text>,
						"s":<text>,
						"sl":<text>,
						"p":<text>,
						"sch":{	
							"f1":<uint>,
							"f2":<uint>,
							"t1":<uint>,
							"t2":<uint>,
							"m":<uint>,
							"y":<uint>,
							"w":<uint>,
							"fl":<uint>
						},
						"f":<uint>
					}
				]}

Other parameters are required only to create and edit templates. They are described in the chapter Get templates data.

In this param specifies the grouping of the table and other settings.

Example

"p":"{
	\"grouping\":\"	
	{\\\"type\\\":\\\"total\\\",\\\"nested\\\":		/* enable grouping "Total" */
		{\\\"type\\\":\\\"year\\\"}}\"			/* enable nested grouping "Year" */
	}

Basic grouping types

Advanced grouping types you can find with request (parameter gt) Get list of table types

For account_tree table next parameters can be used:

"p": "{
        \"account_tree\":{
                \"group\":<bool>,
                \"types\":<text>
        }
}" 

Example (all double quotes within the value must be escaped):

    "p":"{\"account_tree\":{\"group\":1,\"types\":\"avl_account,avl_resource,user,avl_unit,avl_unit_group,avl_retranslator,avl_route\"}}"

For driver_ddd table (“Driver activity”) can be used parameter:

drv_activity (Driver activity source)

"p": "{
	\"drv_activity\":<text>
}" 

For driver_orders table (“Orders”) can be used parameter:

order_filter (“Filtration”)

"p":"{
	\"order_filter\":<uint>
}"

For unit_counter_sensors (“Counter sensors”) can be used parameters:

sensor_val:min (minimum sensor value) sensor_val:max (maximum sensor value)

"p": "{
	\"sensor_val\":{\"min\":\"10\",\"max\":\"14\"}
}" 

For charts:

"p":"{
	\"sensor_mask\":<text>,		/* sensor mask */
	\"instant_speed_base\":{
		\"mask\":<text>}}	/* sensor mask to paint chart line by sensor */

For tables with shifts, to split shift - use params:

"p":{\"split_shifts\":1},
"s":{\"split_shifts\"}

Chart is a table in template. To add markers on the chart - add marker table to the template and add markers flags to the chart table.

Marker table codesample.

{"n":"unit_events",
 "l":"",
 "f":0,
 "c":"",
 "cl":"",
 "p":"",
 "sch":{
   "y":0,
   "m":0,
   "w":0,
   "f1":0,
   "f2":0,
   "t1":0,
   "t2":0},
 "sl":"",
 "s":"[\"chart_unit_events\"]"},

Markers flags codesample.

"p":"{
  \"chart_markers\":{
    \"f\":2556}
  }"
}

Available markers/states.

To change charts background according to units state - add marker/state to the template and add chart_regions param to the chart table.

Charts background change codesample.

"p":"{...,
\"chart_regions\":[
  {\"id\":\"chart_stops_regions\",\"color\":14413564,\"priority\":5,\"name\":\"Stops\"},
  {\"id\":\"chart_engine_hours_regions\",\"color\":16381105,\"priority\":4,\"name\":\"Engine hours\"},
  {\"id\":\"chart_conn_quality_regions\",\"color\":14474460,\"priority\":3,\"name\":\"Connection loss\"},
  {\"id\":\"chart_stays_regions\",\"color\":16773056,\"priority\":2,\"name\":\"Parkings\"},
  {\"id\":\"chart_trips_regions\",\"color\":16766408,\"priority\":1,\"name\":\"Trips\"}],
  ... }

Available state.

Each setting of template is a column of the table. To activate an option - add to the template corresponding column.

Accesible settings

Adress format, time format, shift and measurement specified in “p”.

On create and edit:

[
	<long>,		/* template ID */
	{
		"id":<long>,	/* template ID */
		"n":<text>,	/* name */
		"ct":<text>,	/* template type */
		"c":<uint>	/* check sum (crc16) */
	}
]

Template types are described in the chapter Get templates data.

On delete:

[
	<long>,		/* template ID */
	null
]