Skip to main content

Templates

Localization

The documentation provides a description of the interface in Russian.

Templates are prepared sets of attributes for creating agents, tasks, and objects. Templates allow you to:

  • create typical agents (for example, couriers), typical tasks (for example, delivery tasks), and typical objects (for example, buildings)
  • filter agents and tasks by type when planning shifts
  • filter agents by type and view agent performance metrics on the monitoring dashboard
  • filter objects by type on the monitoring dashboard and in the mobile application using layers

With the Main administrator and Company administrator roles, you can work with templates on the Management → Templates tab:

With the Dispatcher and Agent group manager roles, you can view the list of templates and their information.

Working with templates

Creating an agent template​

Creating an agent template

  1. Go to the Management → Templates tab.

  2. Click Add template.

  3. Select Agent from the dropdown list.

  4. To create a custom agent template, leave the Pre-fill from set field empty. To use a pre-filled template, select one of the ready-made agent types in this field:

    • Operator: an employee who performs tasks.
    • Courier: an employee who delivers documents or packages.
    • Special vehicle: vehicles or machines that perform work. For example, a courier vehicle, fuel truck, excavator, etc.

    The parameters below will be filled in automatically for the selected type. You can edit them if necessary.

  5. In the Agent metric field, select the metric that will be used to calculate the agent's performance and displayed during monitoring of the shift in the agent's card on the Metrics tab:

    • Disabled: agent performance data will not be displayed.
    • Task completion performance: ratio of the number of tasks completed during a shift to the number of tasks assigned in the shift.
    • Work performance: ratio of the time the agent was in geofences to the time since the shift started.

  6. In the Name field, enter a general name for the agent type.

  7. (Optional) In the Map appearance block, specify the display of the agent icon on the map. Click the map preview and specify the parameters:

    • Icon: agent icon.
    • Color: icon color.

    Click Save.

  8. In the Attributes block, specify the list of fields for creating agents of this type. Some attributes are required and are added to the template by default. For all attributes, you can select the Required field checkbox to make them required for creating an agent.

    To add an additional attribute, click Add attribute. To delete an attribute, click Delete icon next to it. To change the order of attributes, hold Drag icon next to the attribute and drag it.

    Data typeRequired attributeDescription
    Text fieldOne attribute is required to specify the agent’s unique identifier (for example, employee ID or full name).Single-line text.
    TransportYes.Transportation type of an agent: bicycle, car, scooter, on foot, truck.
    Multi-line textNo.Multi-line text.
    Numeric fieldNo.Numeric value.
    CheckboxNo.Boolean value.
    PhoneNo.Phone number.
    EmailNo.Email address.
    DirectoryNo.Used to select directory objects when creating an agent. Attribute values:
    • Directory.
    • Allow multiple selection: to allow selecting multiple values from the directory when creating an agent, select the checkbox.
    SkillsNo.Used to select skills when creating an agent.

  9. Click Save.

Creating a task template​

Creating a task template

  1. Go to the Management → Templates tab.

  2. Click Add template.

  3. Select Task from the dropdown list.

  4. To create a custom task template, leave the Pre-fill from set field empty. To use a pre-filled template, select the Standard ready-made task type in this field.

    The parameters below will be filled in automatically for the selected type. You can edit them if necessary.

  5. In the Name field, enter a general name for the task type.

  6. In the Attributes block, specify the list of fields for creating tasks of this type. Some attributes are required and are added to the template by default. For all attributes, you can select the Required field checkbox to make them required for creating a task.

    To add an additional attribute, click Add attribute. To delete an attribute, click Delete icon next to it. To change the order of attributes, hold Drag icon next to the attribute and drag it.

    Data typeRequired attributeDescription
    Date and timeYes.Date and time of task execution. To limit the time for completing a task, enable Time to complete the task in minutes.
    Text fieldNo.Single-line text.
    Multi-line textNo.Multi-line text.
    PhoneNo.Phone number.
    Numeric fieldNo.Numeric value.
    EmailNo.Email address.
    CheckboxNo.Boolean value.
    DirectoryNo.Used to select directory objects when creating a task. Attribute values:
    • Directory.
    • Allow multiple selection: to allow selecting multiple values from the directory when creating a task, select the checkbox.
    NameNo.Name or title of the task.
    DescriptionNo.Text description of the task.
    LocationNo.Destination (location): geofence, coordinates, or address.
    SkillsNo.Used to select skills when creating a task.
    ContactsNo.Attribute values:
    • Name: contact person's name.
    • Phone: contact person's phone number.
    • Email: contact person's email address.
    Completion reportNo.Used for an agent to send a report in the mobile application. The files will be available for viewing in the administrator web panel. Attribute values:
    • Attachments: fields that the agent must fill in when completing a task in the mobile application:
      • Camera photos only: upload of a photo taken with the device camera.
      • Files: upload of a photo from the camera, selection of a photo from the gallery, or attachment of files in PDF, DOC, DOCX, XLS, and XLSX formats.
    • Required to close: select the checkbox so that the agent cannot complete the task without sending a report.
    FilesNo.Used to attach files (photos and documents) in JPG, JPEG, PNG, PDF, DOC, DOCX, XLS, and XLSX formats to a task. You can attach up to 10 files of up to 10 MB each. The files will be available for viewing in the administrator web panel and in the mobile application.

  7. Click Save.

Creating an object template​

Creating an object template

  1. Go to the Management → Templates tab.

  2. Click Add template.

  3. Select Object from the dropdown list.

  4. In the Name field, enter a general name for the object type.

  5. (Optional) In the Map appearance block, specify the display of the object icon on the map. Click the map preview and specify the parameters:

    • Color: icon color.
    • Shape: icon shape.

    Click Save.

  6. In the Attributes block, specify the list of fields for creating objects of this type. Some attributes are required and are added to the template by default. For all attributes, you can select the Required field checkbox to make them required for creating an object.

    To add an additional attribute, click Add attribute. To delete an attribute, click Delete icon next to it. To change the order of attributes, hold Drag icon next to the attribute and drag it.

    Data typeRequired attributeDescription
    Text fieldOne attribute is required to specify the object unique identifier (for example, numeric identifier).Single-line text.
    LocationYes.Object location: geofence, coordinates, or address.
    Text fieldNo.Single-line text.
    Multi-line textNo.Multi-line text.
    Numeric fieldNo.Numeric value.
    DateNo.Date.
    CheckboxNo.Boolean value.
    ContactsNo.Attribute values:
    • Name: contact person's name.
    • Position: contact person's position.
    • Phone: contact person's phone number.
    • Email: contact person's email address.
    • Note: comment.
    FilesNo.Used to attach files (photos and documents) in JPG, JPEG, PNG, PDF, DOC, DOCX, XLS, and XLSX formats to an object. You can attach up to 10 files of up to 10 MB each. The files will be available for viewing in the administrator web panel and in the mobile application.

  7. Click Save.

Editing a template​

warning

Editing a template (for example, its attributes) changes the settings of all agents, tasks, or objects created from this template.

You can:

  • Rename the template.
  • Change the list of attributes, their names, type, and whether they are required.
  • Additionally for agent templates: change the agent metric. The performance indicators for the new metric will be calculated from the start of the next shift.
  • Additionally for agent templates and object templates: change the icon appearance on the map.

To edit a template:

  1. Go to the Management → Templates tab.
  2. In the template row, click Template menu icon and select Edit.
  3. Apply changes to the template.
  4. Click Save.

Duplicating a template​

  1. Go to the Management → Templates tab.
  2. In the template row, click Template menu icon and select Duplicate.
  3. (Optional) Apply changes to the template.
  4. Click Save.