Report Templates

Report Templates

Report Templates


You can generate a report only on the basis of a previously created template. The list of all available templates is displayed in the lower-left part of the window on the Reports tab. Here you can create, edit, copy, and delete report templates.

The template contains information about which tables and charts will be included in the report, what kind of content will be presented in the tables, the order of the columns in tables and sections in the report, which graphical elements will be rendered on the map, and many other parameters which define the look of the resulting report.

When you point to a report template, the following information is available:

  • report template name;
  • resource to which it belongs (if you have access to more than one)
  • report template type;
  • list of tables and charts that it contains;
  • list of bound objects.

When you click on a report template, it is selected in the Template field automatically.

The templates in the list are arranged in alphabetical order. You can use the dynamic filter above the list. In the drop-down list to the left of the search, you can select a resource.

The following actions are available:

  •  or  : edit or view a report template (depends on your access rights);
  • : create a new template based on the selected one;
  • : delete a template (if you do not have enough access rights, the icon is dimmed).
Idea
If a template belongs to the resource to which you do not have the Create, edit, and delete report templates access right, you cannot edit or delete this template.

Creating a Report Template

To create a new report template, press the New button. If you have access to more than one resource, select the required one and click Next.

In the report template, specify its name and select the type.



The available types are described below.
Type                         Description
Unit                                           The template is used to analyse the data from any single unit.
Unit groupThe template is used to analyse the data from several units simultaneously.
UserThe template is used to analyse the activity of users.
DriverThe template is used to analyse the work of drivers.
TrailerThe template is used to analyse the use of trailers.
ResourceThe template is used to track the changes in the contents of the resource.
RetranslatorThe template is used to analyse the work of retranslators.
RouteThe template is used to analyse the passing of routes.
Group of driversThe template is used to analyse the work of several drivers at the same time.
Group of trailersThe template is used to analyse the operation of several trailers simultaneously.
PassengersThe template is used to analyse passenger traffic.
Group of passengersThe template is used to analyse the traffic of the groups of passengers.
GeofenceThe template is used to analyse which units have visited a geofence.
Group of geofencesThe template is used to analyse which units have visited a group of geofences.

It is not recommended to change the report type later, because when you change the type, all the contents and settings of the template are lost.

Below are the Report ContentsSettings and Bind tabs, on each of which the properties of the future report template are configured.

A list of the content added to the report template is shown below. To rename a component, click on it with the left mouse button and make the necessary changes. When working with the content list, the following actions are available:

  • : drag the component up/down;
  • : edit the properties of the table/chart;
  • : copy the table/chart;
  • : delete the component.

After executing the report, the result section first shows statistics (if added to the template), and then tables and charts in the order specified in the template.

Report Contents


On the contents tab, you can add tables, charts or statistics to the report template.

To add the required component, click on one of the three available buttons: New table, New chart, Statistics


Tables

You can add any number of tables to a report template, including tables of the same type. To add a new table, open the Contents tab in the properties of the required report template and click on the New table button.

In the table properties, specify its name and type and select the columns you want to include in it. If necessary, add custom columns and configure additional settings.



Columns Section
The set of available columns depends on the selected table type. To add a column to the table, check the box to the left of its name. To add all columns at once, hold down Ctrl and mark any column which is not selected. You can cancel the selection of all columns in the same way. To quickly search for columns, use the dynamic filter in the upper-right corner.

To edit the name of a column, click on it with the left mouse button. To use the default name of the column, click on the icon  in its line. The icon is inactive is the default name is used.

If necessary, you can change the sequence of columns in the table. To do this, click on the icon   to the left of a column and drag it to the required place while holding down the left mouse button.

Adding Custom Columns

You can add custom columns to all the tables except for Images and Video. They are used to calculate values on the basis of data from other columns, unit parameters, the report interval, and so on. Custom columns can also display text values such as the unique ID, profile properties of the unit, and text values of custom fields.

To add a custom column to the table, follow the steps below.

  1. On the Columns tab of the table properties, click on the Custom Column button

  2. Specify the formula for calculating the column value


    You can use the following components in the formula
  3. ComponentDescription
    Indexes of other columnsColumn indexes are shown to the left of column names after clicking on the Custom column button and don’t change regardless of the column position in the list. Indexes are indicated in the CN format, for example, C0C1C24, and so on. To add an index to the formula, click on it in the list or enter it manually.

    Next to the indexes of some columns (see below), you can specify the name of a sensor so that its readings are used when calculating the column value. Indicate the sensor name in parentheses after the index. For example, to calculate the value of the column with index C44 using the readings of the sensor named FLS1, type C44(FLS1) in the formula. If the sensor name contains a closing parenthesis, replace it with a question mark. For example, to calculate the value of the column with index C54 using the readings of the sensor named (FLS2), type C54((FLS2?) in the formula. Instead of the sensor name, you can use it's mask.

    Specifying the sensor name works only with the indexes of the following columns:
    • Avg consumption by ImpFCS/AbsFCS/InsFCS/FLS;
    • Consumed by ImpFCS/AbsFCS/InsFCS/FLS;
    • Engine efficiency duration;
    • Utilization;
    • Useful utilization;
    • Productivity;
    • Cargo weight;
    • Counter;
    • Columns with a custom sensor value;
    • Sensor (in the Digital sensors table);
    • Columns with a temperature value (in the Orders table);
    • Value (in the Sensor tracing and Messages tracing tables).

    Unit parametersYou can add the following unit parameters to the formula:
    • rcoef: consumption by rates;
    • dehr: daily engine hours rate;
    • mcoef: mileage coefficient;
    • imei: unique ID.

    To add a parameter to the formula, enter its key or select it from the menu which opens after clicking on the three-dot icon.

    You cannot use the unique ID together with other components in the formula. Otherwise, a dash is displayed in the custom column in the report.
    Unit profile propertiesThe profile properties of the unit are added to the formula in the profile_field(key) format. You can select them from the menu which opens after clicking on the three-dot icon in the Formula field. In addition to the properties from the Profile tab, you can also find the Unit type property here.

    If a profile property contains a text value, you can’t use it together with other components in the formula. Otherwise, a dash is displayed in the custom column in the report.
    Data on the report intervalYou can use the following data on the report interval in the formula:
    • interval_days: interval duration in days;
    • interval_hours: interval duration in hours;
    • interval_beginning: interval beginning;
    • interval_end: interval end.

    To add this data to the formula, enter the required key or select it from the menu which opens after clicking on the three-dot icon.
    Custom fieldsCustom columns in reports can display data from general and administrative custom fields that are defined in the properties of system objects such as units, users and drivers.

    Access rights

    The following access rights are required:
    • View custom fields, to add values from general custom fields.
    • View administrative fields, to add values from administrative custom fields.
    Functions for adding fields

    Depending on the type of field you want to display, use one of the following functions in the Formula field:
    • custom_field(field name), to display values from general custom fields (those not marked as administrative);
    • admin_field(field name), to display values from fields that are marked as administrative.
    Formula input rules
    • If the name of a custom field contains a closing parenthesis, replace it with a question mark. For example, to add the value of the custom field named (mass) to the formula, enter custom_field((mass?).
    • Instead of the field name, you can use it's mask. If the names of several custom fields correspond to the indicated mask, the report shows the value of the field that comes first in the list of custom fields in the properties of the object.
    • If a custom field has a numeric value (without the unit of measurement), you can use it in the formula either separately or together with other components. If it has a text value, you can use it only separately, or else a dash is displayed in the custom column.
    Supported report types

    General custom fields are displayed in reports on units, drivers, trailers, passengers, users and their groups.
    Administrative custom fields are displayed in reports on units, unit groups and users.
    Previous row valueThe formula can contain a value from the previous row of any column formatted as #CN, where CN is the column index.
    Constant valuesYou can use constant values formatted as constN where N stands for any number. For example, const-1.5, const10, and so on.
    Mathematical operationsThe following mathematical operations are allowed:
    • addition (+);
    • subtraction (-);
    • multiplication (*);
    • division (/).
    Parentheses of priorityParentheses are used to indicate the priority of an operation. For example, in the formula (C44+C54)/const2, the parentheses indicate that addition should be performed before division.

    Formula example(С1+С2+С7)*const1.5/rcoef

  4. Specify the name of the custom column.

  5. Indicate the unit of measurement (up to 10 characters).

  6. If you use the custom column to calculate duration, select how it should be displayed in the Conversion drop-down list. 

    ItemDescription
    Without conversionDuration is displayed in seconds.
    Duration formatThe Duration format option from the table settings is used. If there is no such option, the result is displayed in the hours:minutes:seconds format.
    Date and time formatThe date and time format indicated in the user settings is used.

    If the value cannot be converted to the selected format, a dash is displayed in the custom column. 

  7. Click Save. 

    The custom column automatically goes to the top of the list. However, you can change its position in the standard way if necessary. Such columns are highlighted in blue
    and do not have an index.

To edit the created column, click on the icon wrench icon, column name, formula, or unit of measurement, make the necessary changes and save them.

The value of the custom column in the Total row is calculated in the same way as for other rows, that is, in accordance with the specified formula that uses the values of the column.

Table Settings
For each table, in addition to selecting columns, there are additional settings, located in the Settings tab. 
The tab is divided into three sections:
  1. Parameters - configure grouping and sorting
  2. Settings - configure detailization, row numbering, total, time limitation as well as incomplete interval and duration format. 
  3. Intervals filtration


Report Settings

On the Settings tab of the report template creation dialog, the following sections may be present depending on the type of template. 
  1. Description - you can type a text which is displayed in the tooltip when pointing to the name of the report template. The text should not contain more than 10,000 characters
  2. General - the format of the date and time, the measurement systems 
  3. Map Output - elements can be drawn on the map as part of a report. They can be selected in this section. These can be tracks travelled by unit, goefences, as well as special markers in the form of small icons which can be put in the places of events, fillings, speedings etc
  4. Address - specify the format for displaying the address information. To do this select which elements of the address should be displayed
  5. Shifts - if this option is enabled, the information on the report is structured according to the shifts you specify

Binding

Depending on its type, a report template can be bound to units, drivers, trailers and passengers and their groups. Binding allows you to restrict the list of items for which the report is run. 

    • Related Articles

    • Sending a Report by Email

      Sending a Report by Email To create the Send a report by email job, you should have: the Create, edit, and delete jobs access right to the resource in which the job is created; the View report templates access right to the resource in which the ...
    • Settings

      In the application settings, you can select units of measurement, mao, algorithm for planning routes, notifications, create warehouses, custom fields for orders and so on. To go to the Settings page, open the user menu by clicking on the username in ...
    • Templates

      This page displays templates for creating routes. You can use them if you should create similar routes regularly. A template stores information about the route points and the assigned unit. The Templates page consists of the following components: ...
    • Reports

      In this section, you can get information about active, planned and fulfilled routes in the form of reports. Reports are necessary for analyzing key parameters and optimizing driver's work. Report Execution To execute a report, specify its parameters ...
    • Data in Reports

      Data in Reports Time The time of completion/start/end of any state is displayed in the reports in the format specified in the General section of a report template. In the tables that include the duration of a state, the hours may not be combined into ...