Hub: Environment Settings
- Ondrej Pribyl
- Krystyna Dereviaha
- Krystyna Obertynska (Deactivated)
- 1 Introduction
- 2 Environment Settings
- 2.1 Address
- 2.2 Users
- 2.3 Display Preferences
- 2.4 Depots
- 2.4.1 Add Depots
- 2.4.2 Import Depots
- 2.4.2.1 Import Options
- 2.4.2.2 Spreadsheet Example
- 2.5 Vehicles
- 2.5.1 Add Vehicles
- 2.5.2 Import Vehicles
- 2.5.2.1 Import Options
- 2.5.2.2 Spreadsheet Example
- 2.6 Vehicle categories
- 2.7 Areas
- 2.8 Channels
- 2.9 Geo Code
- 2.10 Routes
- 2.11 POD Notification
- 2.12 Public tracking
- 2.13 Failure Reason Codes
- 2.14 Custom Fields
- 2.15 Devices
- 2.16 Reporting
- 3 Create Environment
Introduction
Environments let you represent teams within a single company or provide separate spaces for testing and productive use. An organization can contain one or more environments. See Data Ownership for the different uses to which you may want to put environments.
Environment Settings
During the registration of a new account and setting up your first depot, the address entered will be saved as the environment’s address as well. If you create an organization manually, its first default environment is created automatically. By default, the name of a new environment is Default environment. You can change the name at the top of the page. Remember to press the Change button to save.
If you are invited to the environment and you have Environment Admin role, you can reach environment settings by pressing the environment name in the header toolbar. You can also create a new environment.
Address
Your organization address will be populated to the environment address once it is created. The environment address is used in documents created in the environment, such as POD's. Required fields are Address line 1, City, Postal code, and Country. You can provide the address manually by typing it into Address line 1 and selecting the relevant address. If there is no variant you were looking for, just provide your data to the address form and we will save it.
Users
You can manage the users who have access to the environment and set their roles. See how to do it:
You can add users from your organization using the Add button.
The Add users dialog will appear with 3 fields - User, Role, and Vehicle categories. By clicking on the User field, you can choose multiple users for adding them to the environment, assigning them a role and vehicle categories. The role will apply to all the selected users. It is not possible to add users to the environment who are not defined in your Geo2 organization. If all organization users are added to the environment already, the Add button will be disabled. You need to add users to your organization first.
The vehicle categories will apply to all selected users. See Vehicle categories for more information about vehicle categories and their usage.
By pressing the Add button, users will be added to the environment.
Once a new user is added, you will see it in the table with the next columns: name, email, status, role, vehicle categories and subscription.
Property | Description |
|---|---|
Name | Full name of the user's Geo2 account. |
Email of the user's Geo2 account. | |
Status |
|
Role |
See User Roles for more information about environment user roles. |
Vehicle categories | Categories that let you match users and vehicles for a load assignment. By default, standard driving categories (A, B, C, etc.) are listed. You can edit or delete them and create custom categories for your environment. See Vehicle categories for more information about vehicle categories and their usage. |
Subscription | A subscription assigned to a user by an Organization Admin. |
When you modify a user setting such as Role, you can save the change using the Update button.
When you select one or more users and press the Delete button, the users are removed from the environment, i.e. lose access to it. When Deleted are hidden is selected, there is an option to restore a deleted user to give them access once again. You cannot remove your own user from the environment.
Display Preferences
Display preferences determine the visual aspects of the user interface:
Setting | Description |
|---|---|
Default address country format | Address format to use when addresses are formatted as blocks of text, on-screen, and in PDF layouts. |
Default phone country code | Default country code for phone number entry. |
Default timezone | You can select the timezone, according to a specific country/city. |
Default length unit | You can select whether lengths are shown in metric or imperial units. |
Default distance unit | You can select whether distances are shown in metric or imperial units. |
Default weight unit | You can select whether weight is shown in metric or imperial units. |
Default volume unit | You can select whether volume is shown in metric or imperial units. |
Consider weight | When selected, weight is shown and can be edited for orders and routes. |
Consider volume | When selected, volume is shown and can be edited for orders and routes. |
Logo | The logo gives the environment a distinct visual identity when selecting an environment in the user interface and in PDF layouts. |
If the country inside an order matches with the default address country format in Environment settings, we do not show the country field on the next pages:
Order card on Orders page
Stop card on Route plan page
POD PDF (POD PDF, POD email PDF).
Remember to press the Update button to save changes.
Depots
Depots can be optionally selected as the start and end points for routes. During the registration of a new account, your first depot is created automatically with the address you provided. You can add more depots either one by one by pressing the Add button or all at once by pressing the Import button.
Add Depots
See how to add a depot:
To add a depot, press the Add button. You will see a dialog where you have to provide the next information - key, name, and address (Address line 1, City and Country fields). All other fields are optional. You can provide the address manually by typing it into Address line 1 and selecting the relevant address. If there is no variant you were looking for, just provide your data to the address form and we will save it. For routes, it is important that depot addresses are geo-coded accurately.
The properties of each depot are:
Property | Description |
|---|---|
Key | Depot identifier which is required to be unique within the environment. For example, Depot 1. |
Name | User-definable depot name to describe a depot, for example, Storage for materials. It is for internal usage only. |
Сontact name | Contact name of a person responsible for a depot. For example, Jane Doe. |
Email address of a person responsible for a depot. It must be in a valid email format - recipient@domain_name.domain_suffix. For example, janedoe@gmail.com. | |
Phone | Phone number of a person responsible for a depot. It must start with "+" and have from 5 to 16 digits. No spaces, brackets, or other special symbols. For example, +441172345678. |
Mobile phone | Mobile phone number of a person responsible for a depot. It must start with "+" and have from 5 to 16 digits. No spaces, brackets, or other special symbols. For example, +441172345678. |
Company name | Company name as a part of a depot address. For example, BalloonOne. |
Address lines 1,2,3 | Address lines 1,2,3 as a part of a depot address. For example, 71 Cherry Court. |
City | City as a part of a depot address. For example, Southampton. |
Postal code | Postal code as a part of a depot address. For example, SO53 5PD. |
Region | Region as a part of a depot address. |
State | State as a part of a depot address. |
Country | Country as a part of a depot address. It must be provided as the two-letter ISO country code, for example, GB for the United Kingdom. |
Once information is provided, press the Create button and a depot will be created. Optionally, you can select it as a default one. The default depot will be used for route creation but it can be changed. Learn more about planning routes. The default depot will be used for order import if the Depot field is blank. Learn more about order import.
In the Depots table, you will see information from the key fields. Values of other fields can be shown and edited by clicking the Edit icon. Remember to press the Save button to save changes.
You can Delete a depot, though this is only recommended before it has started to be used.
Import Depots
The spreadsheet interface column headings guide you on the type of data expected in each column. If you have prepared the data in another spreadsheet, you can copy and paste them in. It is also possible to import a file from your device.
The limit for the import of depots is 500. You cannot paste more into the spreadsheet.
Column Heading | Data Type | Details | Mandatory |
|---|---|---|---|
Depot key | String | Depot identifier unique within the environment, for example, 01. It is used for displaying depots for route and order assignment and vehicle check creation. If the key already exists in the environment, the matching depot can optionally be updated. | Y |
Depot name | String | User-definable depot name to describe a depot, for example, Storage for materials. It is for internal usage only. | Y |
Contact name | String | Contact name of a person responsible for a depot. For example, Jane Doe. | N |
String | Email address of a person responsible for a depot. It must be in a valid email format - recipient@domain_name.domain_suffix. For example, janedoe@gmail.com. | N | |
Phone | String | Phone number of a person responsible for a depot. It must start with "+" and have from 5 to 16 digits. No spaces, brackets, or other special symbols. For example, +441172345678. | N |
Mobile phone | String | Mobile phone number of a person responsible for a depot. It must start with "+" and have from 5 to 16 digits. No spaces, brackets, or other special symbols. For example, +441172345678. | N |
Company name | String | Company name as a part of a depot address. For example, BalloonOne. | N |
Address line 1 | String | Address line 1 as a part of a depot address. For example, 71 Cherry Court. | Y |
Address line 2 | String | Address line 2 as a part of a depot address. | N |
Address line 3 | String | Address line 3 as a part of a depot address. | N |
City | String | City as a part of a depot address. For example, Southampton. | Y |
Postal code | String | Postal code as a part of a depot address. For example, SO53 5PD. | N |
Region | String | Region as a part of a depot address. | N |
State | String | State as a part of a depot address. | N |
Country | String | Country as a part of a depot address. It must be provided as the two-letter ISO country code, for example, GB for the United Kingdom. | Y |
Once information is provided, press:
Closeto exit the spreadsheet interface with no actionResetto clear the spreadsheetImportto start the data import
Import Options
The import options are:
Option | Functionality |
|---|---|
Existing depots will be updated (if any) | If a depot with the same key already exists, update its data with those in the spreadsheet. If not selected, attempting to import a depot with an existing key will fail. |
Empty fields will clear existing depot property values | If updating a depot and a field value in the spreadsheet is empty, blank the existing depot property even though it has some data in it. If not selected, an empty field value will not overwrite an existing depot value. |
Save these options as default | Remember this configuration of options for subsequent imports. |
Click the Import button to import depots. The import process feeds back any errors that it encounters.
Depots will be imported and displayed in the Depots list in Environment settings.
Spreadsheet Example
You can also download the example of the spreadsheet with typed-in information for a depot import.
Vehicles
Vehicles are assigned to deliver routes with orders. You can add vehicles either one by one by pressing the Add button or all at once by pressing the Import button.
Add Vehicles
See how to add vehicles:
You will see the dialog to fill in the information. Required fields are Key, Type, Depot, and Speed factor. All other fields are optional. Hovering over the Question on a field will display a prompt explaining its meaning and the expected data to put there.
By pressing the Measures button, you will see additional fields like Weight and Volume capacity, Gross weight, Height, Width, Length, Emission factor, and Speed factor.
The properties of each vehicle are:
Property | Description |
|---|---|
Key | Your unique identifier for the vehicle in this environment, for example, Van 1. It is used for displaying vehicles for route assignment and vehicle check creation. |
Registration | Vehicle registration number to help identify your vehicle, for example, ABCD012. |
Type | Vehicle type used to consider average speed for route optimization and planned timing adjustments - truck, van, car, motorbike, bicycle. For each type, the speed factor is pre-defined but you can change it by pressing |
Depot to which the vehicle is assigned. This determines which loads the vehicle can be assigned to, based on the route depot. Press "Add depots" to add more depots to your environment. | |
Vehicle categories | Categories that let you match users and vehicles for a route assignment. By default, standard driving categories (A, B, C, etc.) are listed. You can edit or delete them and create custom categories for your environment. See Vehicle categories for more information about vehicle categories and their usage. |
Description | Free text notes to describe the vehicle. For example, DAF 2800 ATI DKSE. |
Available for route building | Vehicle availability for AI route building functionality. |
Weight capacity | Number to specify the total vehicle weight capacity in the weight units specified in Environment settings → Display preferences, for example, 1000. It is used for calculating the feasibility of a route to which the vehicle is assigned. |
Volume capacity | Number to specify the total vehicle volume capacity in the volume units specified in Environment settings → Display preferences, for example, 300. It is used for calculating the feasibility of a route to which the vehicle is assigned. |
Gross weight | Number to specify the maximum vehicle weight in the weight units specified in Environment settings → Display preferences, for example, 5000. It is considered for route optimization and calibration with vehicle restrictions. |
Height | Number to specify the maximum vehicle height based on the length units specified in Environment settings → Display preferences, for example, 4. This is considered for route optimization and calibration with vehicle restrictions. For metric environment settings (cm), the value is in metres. For imperial environment settings (in), the value is in feet. |
Width | Number to specify the maximum vehicle width based on the length units specified in Environment settings → Display preferences, for example, 2. This is considered for route optimization and calibration with vehicle restrictions. For metric environment settings (cm), the value is in metres. For imperial environment settings (in), the value is in feet. |
Length | Number to specify the maximum vehicle length based on the length units specified in Environment settings → Display preferences, for example, 10. This is considered for route optimization and calibration with vehicle restrictions. For metric environment settings (cm), the value is in metres. For imperial environment settings (in), the value is in feet. |
Emission factor | Factor to denote environment impact of your vehicle - CO2 emissions in grams/kilometre or mile depending on the distance unit selected in Environment settings → Display preferences. |
Speed factor | Average speed as a multiple of an average car. For realistic route timings, this is typically set below 1 for heavier vehicles, such as vans and lorries. |
Once information is provided, press the Create button to save changes. In the Vehicles table, you will see information from the key fields. Values of other fields can be shown and edited by clicking the Edit icon. Remember to press the Save button to save changes.
You can select a vehicle to Delete it. For data integrity, it is best to not delete a vehicle once it has started to be used.
Import Vehicles
The spreadsheet interface column headings guide you on the type of data expected in each column. If you have prepared the data in another spreadsheet, you can copy and paste them in. It's also possible to import a file from your device.
The limit for the import of vehicles is 500. You cannot paste more into the spreadsheet.
Column Heading | Data Type | Details | Mandatory |
|---|---|---|---|
Vehicle key | String | Vehicle identifier unique within the environment, for example, Van 1. It is used for displaying vehicles for route assignment and vehicle check creation. If the key already exists in the environment, the matching vehicle can optionally be updated. | Y |
Registration | String | Vehicle registration number to help identify the vehicle, for example, ABCD 012. | N |
Type | Pre-defined string option | Vehicle type used to consider average speed for route optimization and planned timing adjustments - truck, van, car, motorbike, bicycle. For each type, the speed factor is pre-defined but you can change it by providing your own value in the Speed factor column. | Y |
Depot | String unique identifier | Depot to which the vehicle is assigned. This determines which routes the vehicle can be assigned to, based on the route depot. Provide the depot key already existing in Environment settings -> Depots. | Y |
Description | String | Free text notes to describe the vehicle. For example, DAF 2800 ATI DKSE. | N |
Route building | Pre-defined string option | Vehicle availability for AI route building functionality. Put "Yes" if the vehicle is available for route building, put "No" if the vehicle is not available. | Y |
Weight capacity | Numerical | Number to specify the total vehicle weight capacity in the weight units specified in Environment settings -> Display preferences. For example, 1000. | N |
Volume capacity | Numerical | Number to specify the total vehicle volume capacity in the volume units specified in Environment settings -> Display preferences. For example, 300. | N |
Gross weight | Numerical | Number to specify the maximum vehicle weight in the weight units specified in Environment settings → Display preferences, for example, 5000. It is considered for route optimization and calibration with vehicle restrictions. | N |
Height | Numerical | Number to specify the maximum vehicle height based on the length units specified in Environment settings → Display preferences, for example, 4. This is considered for route optimization and calibration with vehicle restrictions. For metric environment settings (cm), the value is in metres. For imperial environment settings (in), the value is in feet. | N |
Width | Numerical | Number to specify the maximum vehicle width based on the length units specified in Environment settings → Display preferences, for example, 2. This is considered for route optimization and calibration with vehicle restrictions. For metric environment settings (cm), the value is in metres. For imperial environment settings (in), the value is in feet. | N |
Length | Numerical | Number to specify the maximum vehicle length based on the length units specified in Environment settings → Display preferences, for example, 10. This is considered for route optimization and calibration with vehicle restrictions. For metric environment settings (cm), the value is in metres. For imperial environment settings (in), the value is in feet. | N |
Emission factor | Numerical | CO2 equivalent emissions in grams/kilometre or mile depending on Environment settings -> Display preferences. For example, 10. | N |
Speed factor | Numerical | Average speed as a multiple of an average car. For realistic route timings, this is typically set below 1 for heavier vehicles, such as vans and lorries, for example, 0.6. | Y |
Once information is provided, press:
Closeto exit the spreadsheet interface with no actionResetto clear the spreadsheetImportto start the data import
Import Options
The import options are:
Option | Functionality |
|---|---|
Existing vehicles will be updated (if any) | If a vehicle with the same key already exists, update its data with those in the spreadsheet. If not selected, attempting to import a vehicle with an existing key will fail. |
Empty fields will clear existing vehicle property values | If updating a vehicle and a field value in the spreadsheet is empty, blank the existing vehicle property even though it has some data in it. If not selected, an empty field value will not overwrite an existing vehicle value. |
Save these options as default | Remember this configuration of options for subsequent imports. |
Click the Import button to import vehicles. The import process feeds back any errors that it encounters.
Vehicles will be imported and displayed in the Vehicles list in Environment settings.
Spreadsheet Example
You can also download the example of the spreadsheet with typed-in information for a vehicle import.
Vehicle categories
Vehicle categories let you match users and vehicles for a route assignment. By default, standard driving categories (A, B, C, etc.) are listed. You can edit or delete them and create custom categories for your environment.
These categories can then be assigned to vehicles (via Environment settings → Vehicles) and users (via Environment settings → Users). It is possible to select multiple categories.
Assigning categories to users:
Remember to press Update to save changes.
Assigning categories to Vehicles:
Remember to press Save to save changes.
When planning a route on Route plan page in Hub or via Geo2 API, the system will match the user’s and vehicle’s categories. Users without categories can only be assigned to vehicles without categories. Vehicles without categories can be assigned to any user.
Areas
Areas let you tag depots and routes by user-defined geographical regions. To add an area, press the Add button.
Learn how to add areas:
You will see the form to fill in the information. Key and Name are required fields, others are optional. Key is an area identifier which is required to be unique within the environment, e.g. Area 1. Name is a user-definable name that is used to display areas for an order or route creation, e.g. West London.
You can select the default user and default vehicle for each area so it could be used for creating a route if other values for these fields are not selected.
To provide the expiry date, you can set up the Active from and Active to dates. Expired areas will not be possible to select for an order or route creation.
Press the Update button to save your edits.
To edit area information, click the Edit (pencil) icon by hovering over the area row. Remember to press the Update button.
You can select an area to Delete it. For data integrity, it is best to not delete an area once it has started to be used.
Channels
Channels are lightweight tags that let you classify delivery methods. They are reserved for future use. To add a channel, press the Add button.
Learn how to add channels:
You will see the form to fill in the information. Key and Name fields are required. Key is a channel identifier that is required to be unique within the environment, e.g. Channel 1. Name is a user-definable name that is used to display channels for an order creation, e.g. Own fleet. If you want to limit the dates during which the channel can be used, set the optional values Active from and Active to. A blank value for one of these fields means no limit. Press the Update button to save changes.
To edit channel information, click the Edit (pencil) icon in the channel row. Remember to press the Update button.
You can select a channel to Delete it. For data integrity, it is best to not delete a channel once it has started to be used.
Geo Code
Geo2 geo-codes determine the geographical location of different types of addresses:
Organization and environment addresses
Depot addresses
Order addresses
See how to set up geo-coding settings:
These settings let you control which address elements are used during geo-coding. The first geo-coding attempt is made using Default settings. If this does not lead to an accurate location, Auto retry settings are used instead.
Typical settings would be:
Default | Auto retry |
|---|---|
Address line 1 | Address line 1 |
Address line 2 | Postal code |
Address line 3 |
|
City |
|
Country |
|
Postal code |
|
Press Update to save the settings.
Routes
Route defaults are applied to routes when they are first created.
See how to set them up:
Setting | Description |
|---|---|
Stop duration | The default amount of time the delivery vehicle is expected to remain at a route stop. This is used when orders are first brought into a route and, together with drive times, stop durations are intended to lead to route durations that are more realistic than if only drive time was considered. |
Start time | Default route start time, i.e. the time when a vehicle sets off from the depot. |
Delivery ETA tolerance | A time range in which an agreed/committed arrival time is considered to be met. For example, if an order is committed to be delivered at 13:00 and the tolerance is set to 20 minutes, arrival in the range of 12:40-13:20 is considered acceptable. When the mobile app detects that a later arrival is likely, the mobile app user is alerted. Also, if the planned time doesn’t match the committed or required time, it will be highlighted with an orange or red colour depending on the difference, if it’s more than the delivery ETA tolerance, it will be highlighted with a red colour, if less - an orange colour. |
Maximum driving hours | The default amount of maximum driving hours used during route building. This value will be displayed on the Route building dialog whenever you click the Route building button. |
Allow depot change for routes with assigned orders | Allow changing a route depot even if it differs from the orders depot assigned to the route. It is best to keep this setting turned off. Otherwise, it can cause some inaccuracies during route planning. |
Vehicle check on route start | Activate vehicle check in the mobile app when the route is being started. |
Vehicle check on route completion | Activate vehicle check in the mobile app when the route is being completed. |
To save changes, remember to press the Update button.
POD Notification
A recipient can be sent an email with an order POD - both automatically when the POD is recorded and manually at any time from Geo2 Hub.
Learn how to set parameters for these notifications:
The sender address of email notifications is noreply@geo2.com if there is no indicated Sender name. Here are the configurable settings:
Setting | Description |
|---|---|
Sender name | The display name that will accompany the sender address, for example, your company name. |
Success/Failed | Settings from the relevant section will be used in the event of a successful/partially successful/failed delivery/collection. |
Automatic enabled | If selected, POD messages will be sent automatically to a recipient email address and fixed emails (for failed POD emails) when a POD is registered in Hub. |
Manual enabled | If selected, Hub users have the option to trigger the sending of the POD manually. Press the |
Attach PDF | Attach a PDF document with POD details to the message. |
Fixed recipient | For failure notifications only, a fixed email recipient for the notifications. Failed delivery emails can be sent to multiple fixed recipients, for example, to managers who are responsible for failed deliveries. Multiple email addresses can be entered, separated by a semi-colon (;) or by pressing For Partially successful POD emails, a Failed template will be used. If fixed recipients are provided, Partially successful POD emails will be sent to them as well (even though they are turned off on an order level). |
Subject | Subject line of notifications. You can use these tokens for POD emails: {ORDER_KEY} - order key {COMPANY_NAME} - сompany name {ENVIRONMENT_NAME} - environment name |
Body | Body of notifications. You can use these tokens for POD emails: {CONTACT_NAME} - recipient name {ORDER_KEY} - order key {PUBLIC_POD} - POD tracking link {COMPANY_NAME} - сompany name {ENVIRONMENT_NAME} - environment name |
Once all information is provided, click the Update button to save changes.
When the POD is created and an order has a recipient email address, the POD notification email will be sent (if it was enabled in Environment settings). Example:
By pressing the Check button, a recipient will see POD details.
If the "Attach PDF" option is enabled, the POD PDF will be attached to the POD email.
Public tracking
It's possible for external users such as recipients to optionally track the progress of their orders on a public web page. Public tracking links can be sent via email and SMS notifications.
See how to set up them:
Setting | Description |
|---|---|
Disclose calculated ETA | On Public tracking page, when an order has not been delivered/collected yet, show a calculated ETA based on the last known vehicle position. This can be expressed as a range. The calculated ETA is likely to fluctuate as the route progresses and you may find it too volatile for practical use. When the option is not enabled or when tracking data for the route is not available, the committed time for the order is displayed instead, if set. |
Disclose stop position | On Public tracking page, when an order has not been delivered/collected yet, show the last delivered stop on the route, giving the recipient an indication of how far away the delivery vehicle is from them in terms of the number of stops. |
Disclose vehicle position | On Public tracking page, when an order has not been delivered/collected yet, show the last known vehicle position on the map (requires the vehicle driver to have started load tracking in the mobile app). |
Tracking email/SMS enabled on | Send an email/SMS notification to the recipient, in which you can include the tracking page address, to enable them to track the order prior to delivery/collection. The possible triggers are: None - Do not send emails. Registered - When the order is created (via the Hub, mobile app, or API). Planning - When the order is assigned to a route in planning. Planned - When the order is assigned to a planned route. Released - When the order is assigned to a released route. In Transit - When the route, to which the order has been assigned, has been started. For this trigger, it is important that drivers explicitly start tracking routes in the mobile app. |
Sender name | Sender name for the notification email. Not available for an SMS notification. |
Subject | Subject for the notification email. Not available for an SMS notification. You can use these tokens for Public tracking emails: {ORDER_KEY} - order key {COMPANY_NAME} - сompany name {ENVIRONMENT_NAME} - environment name |
Body | Body of the notification email/SMS. Ensure that the wording of the email is appropriate for the trigger you have configured. You can use the next tokens for an email/SMS notification: {CONTACT_NAME} - recipient name {ORDER_KEY} - order key {PUBLIC_TRACKING} - public tracking link {COMPANY_NAME} - company name {ENVIRONMENT_NAME} - environment name {DELIVERY_ETA} - estimated time of arrival Without the token PUBLIC_POD, the public POD link will not be included in an SMS notification. The limit for an SMS notification is 120 symbols. |
Once the route status changes to the configured value (e.g. In Transit), an email/SMS notification with a public tracking link will be sent to the recipient's email address/mobile phone number. For this to work, it is important that the recipient’s contact details (email address and mobile phone number) are specified in the order.
Here is an example of the public tracking email:
By pressing the Check button, a recipient will see tracking details.
Failure Reason Codes
Failure reason codes let you classify reasons for failed deliveries/collections and are available to drivers in the mobile app when recording a POD. Once an environment is created, the first default failure reason code is added automatically. Thus, you can create a proof of delivery in the mobile app in a failed or partially successful status.
See how to add failure reason codes:
To add a failure reason code, press the Add button. A new row will be shown in the table for you to specify the details of the new failure reason code. Both fields are required. To save changes, press the Update button.
To edit a reason code, click the Edit (pencil) icon. Remember to press the Update button to save any changes.
You can select a reason code to Delete it. For data integrity, it is best to not delete a reason code once it has started to be used. It is not possible to delete all reason codes as it will impact a POD creation. Your environment needs at least 1 adede failure reason code.
Custom Fields
Custom fields let you collect and report on additional information in POD's and vehicle checks.
Learn how to add custom fields:
To add a new custom field, press the Add button. A new row will be shown in the table for you to specify the details of the new custom field. The properties of a custom field are:
Property | Description |
|---|---|
Page |
|
Type | The options are:
|
Key | Low-level/technical field identifier. This becomes significant when using the API. |
Label | Field description visible to mobile app users. |
Options | Options for the dropdown field type. At least one option must be provided. |
Required | If selected, the field value cannot be left blank. |
Press the Update button to save changes.
If you want to edit properties of an existing custom field, click the pencil icon on the right-hand side of the relevant row, edit the values as appropriate press the Update button.
You can select a field to Delete it. For data integrity, it is best to not delete a field once it has started to be used.
Once custom fields are added, they will be displayed either on POD or vehicle check pages (depending on the page you added them) in the mobile app and Hub:
Devices
Device settings control the behaviour of the mobile app:
You can define the minimum and maximum numbers of photos for POD's and vehicle checks recorded on the mobile app. With the default value of zero for the minimum, photos are optional, but when the value is greater, the driver will be required to record photos. You can also remove the possibility of adding photos for a POD or a vehicle check by setting both the minimum and maximum to zero.
To run auto-deletion of photos recorded during a POD or vehicle check creation, you can select the number of days after which photos will be deleted. By default, 30 days is selected. If you want to save these photos, select the None value in the Delete photos olden than field.
Permit multiple POD’s per order per route means that multiple POD's per order are allowed within the same route. When the option is disabled, it is not possible to create more than one POD per order in the same route, but it is possible for a POD for the order to be created once it is in another route. By default, this setting is enabled.
Allow order creation from POD makes it possible to create a POD referencing an order key that does not yet exist - a skeleton order will be created in Hub to match the POD. By default, this setting is enabled. When disabled, it is only possible to create a POD for an order key that already exists in the environment.
Record time at stop enables the future mobile app’s feature to record the actual time spent at a stop by a driver.
To save changes, press the Update button.
Reporting
Reporting settings let you define target values for analytics charts displayed on the Dashboard page:
Target % of on-time orders means the target value for % of total orders to be on-time, by default, it's 80% but you can change it. You can track the actual % of on-time orders on the “% On-Time Orders” analytics chart on Dashboard page.
Create Environment
If you want to create one more environment in your organization, press the environment selector in the menu bar and press Create environment. You will be redirected to Create environment page where you will have the option to clone settings and users from an existing environment.
It is up to you whether you decide to clone settings or users or start an entirely fresh environment definition.
If cloning settings and/or users from an existing environment, you will need to select an environment to clone them from.
By pressing the Create button, a new environment will be created. You will be redirected to the settings of the newly created environment.