User guide for version 7.10
Previous versions: 7.9 | 7.8 | 7.7
×

Template parameters

Parameters are the fields used to build the task card. They allow users to enter information about the applicant, task, assignee, vehicle, addresses, and other entities.
For each parameter, you can configure:
  • data type
  • field name and group
  • display order
  • default value
  • whether the field is required
  • link to a dictionary
  • relationships with other parameters
Basic parameters are usually already created in the system. You do not need to create them agai — simply select the required fields and configure their properties. Adding new parameters and changing technical settings should be performed by an administrator or support specialist.
 

Opening template parameters

1. Open Dictionary → Templates
2. Select the required template
3. Open the Parameters section
Template parameters
The table displays the parameters included in the selected template.
The following buttons are available above the table:
  • Add — create a new parameter
  • Edit — edit the selected parameter
  • Remove — remove a parameter from the template
  • Relations — configure value transfer between parameters
  • Save — save changes and the field order
Template parameters
 

Parameter table

The table may contain the following columns:
  • Field Notation — the technical field alias
  • Field Type — the value format
  • Group Name — the section where the field is displayed
  • Field Name — the field label in the task card
  • Default value — the value inserted automatically
  • Allow blank — whether the field may be left empty
  • Active — whether the field is used in the template
  • Removable — whether the field value can be removed from the task card
  • Auto Complete — whether browser autofill is used
  • Key field — whether the field is used to search for similar tasks and autofill data
Parameters are organized into groups, for example:
  • Initiator information
  • Executor information
  • Task information
Each group is displayed as a separate section in the task card.
 

Adding a parameter

1. Open the required template
2. Open the Parameters section
3. Click Add
Template parameters
4. Complete the main parameter fields
5. Configure additional settings if necessary
6. Click Save
After saving, the new parameter will appear in the list and become available in the task card.
 

Main parameter fields

Type

Select the data type. The system may support the following types:
  • string — single-line text
  • textarea — multi-line text
  • integer — whole number
  • boolean — logical value
  • datetime — date and time
  • address — address
  • combobox — drop-down list
  • timeperiod — time period
  • combocount — list with numeric values
The type determines the appearance of the field and the format of the data that can be entered.

Alias

The alias is the technical name of the parameter. It is used in the system, integrations, and export settings.
Use Latin characters for the alias, for example: cargo_name.

Name

The name is displayed in the task card. For example: Cargo Name.

Group name

Select the group where the parameter will be displayed. For example:
  • Initiator information
  • Task information
  • Executor information
If the required group is not available, creating or editing it may be restricted to administrators.

Default value

Enter the value that the system will insert automatically when creating a task.
For example:
  • minimum temperature — 2
  • maximum temperature — 8
  • number of packages — 1
The field may be left empty if the value must be entered manually.

Weight

Weight determines the display order of parameters within a group.
 

Additional settings

The available settings depend on the field type. In the Settings section, you can enable the following options:
  • Value is result formula? — calculates the value automatically using a formula
  • Field is allow blank — allows the field to be left empty
  • Field is active — enables the field in the template
  • Field is hidden — hides the field in the standard view
  • Field is removable — allows the field to be removed from the task card
  • Field is auto complete — enables automatic completion of previously entered values
  • Field is key — uses the field to search for previous tasks and related data
  • Field is propagate — allows the field value to be propagated to related records
  • Field visibility only when editing — displays the field only when editing a task
  • Show warehouse name — displays the warehouse name for an address field
  • Check working hours — checks the working hours for the specified address
  • Show Ticket ID — displays the ticket ID in the field
  • is the index of the key to search — uses the field as a special search index
  • Address is point in route? — includes the address in the route
  • Address is current point executor? — uses the executor’s current location as the address
  • Enter the date of arrival to the specified address — allows an arrival date to be entered
  • Entering the time of loading/unloading at the specified address — allows loading or unloading time to be entered
  • Entering radius geofence — allows a geofence radius to be entered
Additional settings may be available below the options, including Temperature limit, Permissions templates, and Disable editing for permissions templates.
For a combobox field, you can connect a dictionary and specify the keys used for saving and displaying values.
After completing the form, click Save. The new parameter will appear in the parameter list for the selected template.

Drop-down lists and dictionaries

A dictionary can be connected to a combobox field. The list of values will then be loaded from the selected dictionary.
In the dictionary settings:
1. Select the required dictionary from the list
2. Select the key whose value will be saved in the task
3. Select the key whose value will be displayed to the user
Select one key for each purpose. The Format column shows the data type of the selected field, such as integer or string. The type of the value key must match the data saved in the field.
  • Value key — the value saved in the task data, such as a record ID
  • Display key — the value shown to the user in the drop-down list, such as a vehicle name
For example, the user selects BMW X5 from the list, while the vehicle ID is saved in the task data.
 

Field display order

You can change the field order in the parameter list by dragging and dropping the rows.
The order determines how fields are arranged in the task card and in the user interface.
Template parameters
After changing the order, click Save.