Form ID: (FS304000)
You can use this form to edit any generated route execution or create new route executions
manually. On this form, you can assign a driver, assign a vehicle, create new appointments,
delete or move existing appointments, or change the order in which the appointments are
attended.
Form Toolbar
The form toolbar includes standard buttons and
form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands can be
shown as buttons on the form toolbar, as commands on the More menu, or in both places.
These commands are listed in the following table in alphabetical order.
| Command |
Description |
| Calculate Route Statistics
|
Recalculates the statistics of the route, which are displayed in the
Route Statistics section of the Summary area, if you have
made changes to the route. This button is available only if the
Calculate Route Statistics Automatically check box is
cleared on the Routes tab of the Service Management Preferences (FS100100) form. |
| Cancel |
Changes the route execution status to Canceled. You can cancel routes
with the Open or In Process status only. After you invoke this action,
the route can now be reopened or closed. |
| Complete |
Changes the status of the route execution to Completed, indicating that
all the activities related to the route are completed. This action automatically
completes all the appointments associated with the route if they have not been
completed. After you invoke this action, the route can be reopened or
closed. |
| Delete |
Opens the Confirm Delete Current Route dialog box, in
which you can confirm deleting the route executions document with all related
appointments and service orders by clicking YES, or cancel
deleting by clicking NO. |
| Open Driver Calendar
|
Opens the Staff Calendar Board (FS300400) form for the driver
assigned to execute the route. |
| Open Route on Map
|
Opens the Routes on Map (FS300900) form, which displays the
executed route on a map. |
| Reopen |
Changes the route execution status to Open, which is the initial status.
The route can now be started, canceled, or completed. This action is available only
if the route has the Completed or Canceled status. |
| Start |
Changes the status of the route execution to In Process, indicating that
the route is being attended. This action is available only if the route has the
Open status. After you invoke this action, you can process the route
appointments and complete the route. |
| Unclose |
Changes the status of the previously closed route execution to
Completed. This action is available only if the route has the Closed
status. |
Summary Area
Here you can create a new route execution or select an existing route execution for
modification. In this area, you can also view the general statistics of the route, as well
as assign drivers or vehicles to the route.
| Element |
Description |
| Route Nbr.
|
The reference number of the route execution. When you save new route
executions, the system generates reference numbers according to the numbering
sequence selected in the Route Numbering Sequence box on the
Service Management Preferences (FS100100) form. |
| Branch
|
The identifier of the branch that is associated with the route
execution. |
| Route
|
The identifier of the route to be executed. |
| Trip Nbr. |
The number of the trip for the selected route on the specified date. |
| Date
|
The date when the route is executed. |
| Start Time
|
The starting time of the route execution. By default, this is the time that is
defined in the route on the Routes (FS203700) form. |
| Status
|
The status of the route execution, which the system fills in based on user
actions and which can be one of the following:
- Open (default): The route execution has been created but it has not
been started yet. You can edit, start, complete, or cancel a route execution
with this status.
- In Process: The route execution has been started. You can edit,
complete, reopen, or cancel this route execution.
- Canceled: The route execution has been canceled. You can reopen the
route execution.
- Completed: All the activities related to the route execution have been
completed. You can edit the details of the route execution , and you can close
or reopen the route execution.
- Closed: All the data of the route is filled in and correct. If needed,
you can unclose the route execution.
|
| Driver
|
The driver assigned to execute the route. You can assign a new driver to the
route by clicking the magnifier icon and selecting the driver from the list of staff
members with the necessary skills. You also can assign a driver by clicking the
Driver Selector button and selecting the driver based on
the skills and availability in the Driver Selector dialog
box. |
| Driver Selector
|
Opens the Driver Selector dialog box, which you can use
to assign a staff member as a driver. |
| Additional Driver
|
The assigned second driver to execute the route if multiple drivers execute the
route. You can assign a new driver to the route by clicking the magnifier icon and
selecting the driver from the list of staff members with the necessary
skills. |
| Vehicle
|
The vehicle assigned to the route. You can assign a vehicle to the route by
clicking the magnifier icon and selecting the vehicle from the list of vehicles. You
also can assign a vehicle by clicking the Vehicle Selector
button and selecting the vehicle from the list in the Vehicle
Selector dialog box. |
| Vehicle Selector
|
Opens the Vehicle Selector dialog box, which you can use
to assign a vehicle to perform the route. |
| Additional Vehicle 1
|
The second vehicle assigned to the route if multiple vehicles execute the
route. You can assign a vehicle to the route by clicking the magnifier icon and
selecting the vehicle from the list of vehicles. |
| Additional Vehicle 2
|
The third vehicle assigned to the route if multiple vehicles execute the route.
You can assign a vehicle to the route by clicking the magnifier icon and selecting
the vehicle from the list of vehicles. |
Table 1. Route Statistics Section
This section displays the statistics of the route, such as number of appointments and
services, total distance of the route, and time. This section is automatically updated
if the
Calculate Route Statistics Automatically check box is
selected on the
Routes tab of the
Service Management Preferences
(FS100100) form. If this check box is cleared, to update statistics, you should click
the
Calculate Route Statistics button on the current
form.
Note: The statistics marked with an asterisk [*] are approximated values and
should be used for reference only.
| Element |
Description |
| Number of Appointments
|
The number of appointments in the route. |
| Total Services
|
The total number of services that are performed during the appointments of the
route. |
| Total Distance [*]
|
The total estimated distance in miles of the route. |
| Total Services Duration
|
The total estimated time needed to perform the services of the route. |
| Total Drive Duration [*]
|
The total estimated driving time needed to perform the route. |
| Total Route Duration [*]
|
The total estimated time needed to perform the route. This is the sum of the
duration times of the driving and services. |
Table 2. Actual Time SectionIn this section, you can edit or view the information related to the actual time when
the route is performed.
| Element |
Description |
| Actual Start Time
|
The actual time when the route execution begins. |
| Actual End Time
|
The actual time when the route execution ends. |
| Actual Duration
|
The actual duration of the route execution, which the system calculates based
on the actual start and end times. |
Table 3. Driver Selector Dialog BoxBy using the Driver Selector dialog box, you can select a driver with
the skills to execute the route available for the specific day. | Element | Description |
|---|
| Route Nbr. | The reference number of the selected route execution. |
| Route Info Section |
| Route ID | The identifier of the route. |
| Date | The date when the route is executed. |
| Current Selection Section |
| Driver | The driver currently assigned to execute the route. |
| Vehicle | The vehicle currently assigned to the route execution. |
| Filter Options Section |
| Show Available Drivers for this Route only
| A check box that indicates (if selected) that only available drivers for the route are
displayed in the table. A driver is available if he or she is not
assigned to a different route on the specified day. |
| The Drivers table contains the following columns. |
| Employee ID | The identifier of the driver. |
| Employee Name | The name of the driver. |
| Already Assigned | Read-only. A check box that indicates (if selected) that the staff member is already assigned
to execute a route. |
| Priority Preference | The priority factor of the driver to execute the route. |
| The dialog box has the following buttons. |
| Select Driver | Assigns the staff member as the driver in the route. |
| Close | Closes the dialog box. |
Table 4. Vehicle Selector Dialog BoxBy using the Vehicle Selector dialog box, you can select a vehicle to
execute the route available for the given day. | Element | Description |
|---|
| Route Nbr. | The reference number of the selected route execution. |
| Route Info Section |
| Route ID | The identifier of the route. |
| Date | The date when the route is executed. |
| Current Selection Section |
| Driver | The driver currently assigned to execute the route. |
| Vehicle | The vehicle currently assigned to the route execution. |
| Filter Option Section |
| Show Available Vehicles for this Route only | A check box that indicates (if selected) that only available vehicles for the route are
displayed in the table. A vehicle is available if it is not assigned to
a different route on the specified day. |
| The Vehicles table contains the following columns. |
| Vehicle ID | The identifier of the vehicle. |
| Already Assigned | Read-only. A check box that indicates (if selected) that the vehicle is already assigned to a
route. |
| The dialog box has the following buttons. |
| Select Vehicle | Assigns the vehicle to the route. |
| Close | Closes the dialog box. |
Appointments Tab
On this tab, you can view information about the appointments that are related to the route
execution as well as change the order of the appointments, reassign them, or delete them.
Table 5. Table Toolbar
The table toolbar includes standard buttons and
buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are
listed below.
| Button |
Description |
| Create New Appointment |
Opens the Select the Service Order Type for the New
Appointment dialog box, where you select the type of an appointment to
add and proceed to the Appointments (FS300200) form to create the
appointment. |
| Delete Appointment |
Deletes the selected appointment from the system after you confirm in the
Confirm Unassign Appointment dialog box that this is what
you want. |
| Move Up |
Moves up the selected appointment within the route execution. |
| Move Down |
Moves down the selected appointment within the route execution. |
| Reassign
|
Opens the Route Appointment Assignment dialog box, in
which you can reassign the selected appointment to another route execution. |
Table 6. Table Columns
| Column |
Description |
| Service Order Type
|
The service order type of the appointment. Only appointments with service order
types of the Route behavior can be selected here. |
| Source Service Contract ID |
The identifier of the route service contract for which the route was
generated. |
| Customer Contract Nbr. |
The reference number of the route service contract for the particular
customer. |
| Source Schedule ID |
The identifier of the schedule of the contract according to which the route was
generated. |
|
Appointment Nbr.
|
The reference number of the appointment. |
| Description
|
A brief description of the appointment. |
| Customer ID
|
The identifier of the customer for which the appointment is performed. |
| Location ID |
The unique identifier of the customer location where the appointment is
performed.
This box is available only if the Business Account Locations feature is
enabled on the Enable/Disable Features (CS100000) form.
|
| Status
|
The status of the appointment. |
| Scheduled Date
|
The date when the appointment is scheduled. |
| Scheduled Start Time
|
The time when the staff member is expected to start attending the
appointment. |
| Scheduled End Time
|
The time when the staff member is expected to finish attending the
appointment. |
| Estimated Duration
|
The estimated duration of the appointment. |
| Address Line 1
|
The first line of the appointment's address. |
| Address Line 2
|
The second line of the address. |
|
City
|
The appointment's city. |
|
State
|
The appointment's state or province. |
|
Postal Code
|
The appointment's postal code. |
Table 7. Select the Service Order Type for the New Appointment Dialog Box This dialog box appears when you click the Create New Appointment
button on the Appointments tab of the form. You use
this dialog box to specify the service order type for the new appointment.
| Element |
Description |
| Service Order Type
|
The service order type of the new appointment. Only service order types with
the Route behavior are available for selection. |
| The dialog box has the following buttons. |
| Proceed
|
Opens the Appointments (FS300200) form. |
| Close
|
Closes the dialog box. |
Table 8. Route Appointment Assignment Dialog Box You use this dialog box to move the appointment to another route.
| Element |
Description |
|
Appointment Nbr.
|
Read-only. The reference number of the selected appointment. |
| Service Order Type
|
Read-only. The service order type of the selected appointment. |
| Customer ID
|
Read-only. The identifier of the customer related to the appointment. |
| Scheduled Date
|
Read-only. The scheduled date and time of the appointment in the original
route. |
| Address Line 1
|
Read-only. The first line of the appointment's address. |
| Address Line 2
|
Read-only. The second line of the address. |
| City
|
Read-only. The appointment's city. |
| State
|
Read-only. The appointment's state or province. |
| Estimated Duration
|
Read-only. The estimated duration of the appointment. |
| Filter Options section |
| Route Date
|
The date to which the appointment is reassigned. |
| Route
|
The route to which the appointment is going to be reassigned. You can specify
the route to filter route executions in the Available Routes
table or leave this box blank to see all available routes. |
| Available Routes table |
|
Route Nbr.
|
The reference number of the route execution. |
| Route ID
|
The identifier of the route. |
| Route Short
|
The short identifier of the route. |
| Date
|
The date of the route execution. |
| Driver
|
The staff member assigned to execute the route. |
| Vehicle
|
The vehicle assigned to the route execution. |
| Total Driving Duration [*]
|
The total estimated driving time needed to execute the route. |
| Number of Appointments
|
The number of appointment in the route execution. |
| Total Services
|
The total number of services that are performed among the appointments in the
route execution. |
| The dialog box has the following buttons. |
| Reassign to Current Route
|
Removes the appointment from the current route execution and moves it to the
route execution selected in the Available Routes
table. |
|
Close
|
Closes the dialog box. |
Additional Info Tab
On this tab, you can specify additional information about route, such as the distance
traveled, the weight of goods transferred, and fuel information.
Table 9. Additional Info Tab Elements| Element | Description |
|---|
| Miles | The total distance (in miles) of the route execution. |
| Weight | The weight of the transferred goods. |
| Fuel Qty. | The amount of fuel used during the execution of the route. |
| Fuel Type | The type of the fuel used by the vehicle during the execution of the route, which is one of
the following options:
- Regular Unleaded
- Premium Unleaded
- Diesel
- Other
|
| Oil |
The amount of oil used during the execution of the route. |
| Antifreeze |
The amount of antifreeze used during the execution of the
route. |
| DEF |
The amount of diesel exhaust fluid used during the execution of the
route. |
| Propane |
The amount of propane used during the execution of the route. |
Attributes Tab
On this tab, you can view the list of attributes for the route execution, specify the
values of these attributes, and change these values, if necessary. This tab is populated
with the list of active attributes (and any default values) that have been defined for the
selected route on the Attributes tab of the Routes (FS203700) form.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
| Column |
Description |
| Attribute |
The description of the attribute. |
| Required |
A read-only check box that indicates (if selected) that a value must be
specified for the attribute. This setting is copied from the
Attributes tab of the Routes (FS203700) form
for the selected route. |
| Value |
The value of the attribute. If the system has inserted a default value for the
attribute, you can overwrite it, if necessary. The default value is defined on the
Attributes tab of the Routes (FS203700) form
for the selected route. |
Location Tab
On this tab, you can view the GPS coordinates of the start and end locations.
Table 10. Start Location Section
| Element |
Description |
| Latitude |
Read-only. The latitude of the start location address. |
| Longitude |
Read-only. The longitude of the start location address. |
| The section has the following button. |
| View on Map |
A button you can click to open the map viewer and fill in the latitude and
longitude. |
Table 11. Complete Location Section
| Element |
Description |
| Latitude |
Read-only. The latitude of the end location address. |
| Longitude |
Read-only. The longitude of the end location address. |
| GPS Latitude Longitude |
Read-only. The GPS coordinates of the location received from the mobile app.
|
| The section has the following button. |
| View on Map |
A button you can click to open the map viewer and fill in the latitude and
longitude. |
