Templates

Localization

The documentation provides a description of the interface in Russian.

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

• create typical agents (for example, couriers) and typical tasks (for example, delivery tasks)
• filter agents and tasks by type when creating route plans

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

• create agent templates
• create task templates
• edit templates
• duplicate templates

With the Dispatcher role, you can view the list of templates and their information.

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 Disabled. To calculate agent performance, use the 2GIS GeoFlow solution along with 2GIS Logistics. In the common web panel, administrators will be able to monitor agent performance.

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.

   For each template, add the required attributes:

   Data type	Description
   Text field	Unique identifier of the agent. For pre-filled templates, it is Identifier, and for custom templates, it is Name. As the attribute value, you can specify any unique set of characters (for example, a personnel number or full name).
   Transport	Agent's vehicle. As the attribute value, you can select a transportation type from the list: bicycle, car, scooter, on foot, truck.

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

   All attributes have parameters:

   • Title: attribute name.
   • Data type: type of the attribute data.
   • Required field: to make the field required when creating an agent, select the checkbox.

   For attributes with some data types, the additional parameters are available:

   Data type	Additional parameters
   Directory	Directory: directory with agent features. Allow multiple selection: to allow selecting multiple values from the directory when creating an agent, select the checkbox.
   Capacity	Description of the cargo that the agent can carry: Number of seats: number of cargo spaces. Weight in kg: maximum weight of the cargo in kilograms. Volume in m³: maximum volume of the cargo in cubic meters. Dimensions in m: maximum dimensions of the cargo in meters. The agent's load percentage within route plans is calculated based on the values of these parameters if values for parameters with the Cargo type are specified for tasks. The total agent load for all tasks in the route plan is divided by the parameter value: If one parameter is specified, the load is calculated based on it. For example, the value of the Weight in kg parameter for an agent is 100 kg, and the total agent load for all tasks in the route plan is 30 kg. The load value is 30%. If two or more parameters are specified, the load is calculated based on each of them, and the maximum value is taken. For example, the following values are specified for an agent: Number of seats is 20, Weight in kg is 100 kg. The total agent load for all tasks in the route plan is 3 seats and 98 kg. The load value is 98%. If none of the parameters are specified, the load is not calculated.

9. Click Save.

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 Logistics 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.

   For each template, add the required attribute:

   Data type	Description
   Date and time	Task completion time. To limit the time for completing a task, select the Time to complete the task in minutes checkbox.
   Location	Address to which the cargo must be delivered or the task must be performed.
   Depot	Depot from which the agent must pick up the cargo: Depot: indicates that the point is a depot. Cargo readiness time: time required to prepare the cargo at the depot. Loading time in minutes: time required to load the cargo at the depot, in minutes.

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

   All attributes have parameters:

   • Title: attribute name.
   • Data type: type of the attribute data.
   • Required field: to make the field required when creating a task, select the checkbox.

   For attributes with some data types, the additional parameters are available:

   Data type	Additional parameters
   Directory	Directory: directory with task features. Allow multiple selection: to allow selecting multiple values from the directory when creating a task, select the checkbox.
   Cargo	Description of the cargo to carry: Number of seats: number of cargo spaces. Weight in kg: maximum weight of the cargo in kilograms. Volume in m³: maximum volume of the cargo in cubic meters. Dimensions in m: maximum dimensions of the cargo in meters. The agent's load percentage within route plans is calculated based on the values of these parameters if values for parameters with the Capacity type are specified for agents. For more information on calculating load, see the Creating an agent template section.
   Contacts	Name: contact person's name. Phone: contact person's phone number. Email: contact person's email address.

7. Click Save.

Editing a template

warning

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

You can edit templates:

• rename the template
• change the list of attributes, their names, type, and whether they are required
• additionally for agent templates: change the agent icon appearance on the map

To edit a template:

1. Go to the Management → Templates tab.
2. In the template row, click 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 icon and select Duplicate.
3. (Optional) Specify new template parameters.
4. Click Save.